This repository is intended for development of so-called "extra" modules, contributed functionality. New modules quite often do not have stable API, and they are not well-tested. Thus, they shouldn't be released as a part of official OpenCV distribution, since the library maintains binary compatibility, and tries to provide decent performance and stability.
So, all the new modules should be developed separately, and published in the
opencv_contrib
repository at first. Later, when the module matures and gains
popularity, it is moved to the central OpenCV repository, and the development team
provides production quality support for this module.
You can build OpenCV, so it will include the modules from this repository. Contrib modules are under constant development and it is recommended to use them alongside the master branch or latest releases of OpenCV.
Here is the CMake command for you:
$ cd <opencv_build_directory>
$ cmake -DOPENCV_EXTRA_MODULES_PATH=<opencv_contrib>/modules <opencv_source_directory>
$ make -j5
As the result, OpenCV will be built in the <opencv_build_directory>
with all
modules from opencv_contrib
repository. If you don't want all of the modules,
use CMake's BUILD_opencv_*
options. Like in this example:
$ cmake -DOPENCV_EXTRA_MODULES_PATH=<opencv_contrib>/modules -DBUILD_opencv_legacy=OFF <opencv_source_directory>
If you also want to build the samples from the "samples" folder of each module, also include the "-DBUILD_EXAMPLES=ON" option.
If you prefer using the gui version of cmake (cmake-gui), then, you can add opencv_contrib
modules within opencv
core by doing the following:
start cmake-gui
select the opencv source code folder and the folder where binaries will be built (the 2 upper forms of the interface)
press the configure
button. you will see all the opencv build parameters in the central interface
browse the parameters and look for the form called OPENCV_EXTRA_MODULES_PATH
(use the search form to focus rapidly on it)
complete this OPENCV_EXTRA_MODULES_PATH
by the proper pathname to the <opencv_contrib>/modules
value using its browse button.
press the configure
button followed by the generate
button (the first time, you will be asked which makefile style to use)
build the opencv
core with the method you chose (make and make install if you chose Unix makefile at step 6)
to run, linker flags to contrib modules will need to be added to use them in your code/IDE. For example to use the aruco module, "-lopencv_aruco" flag will be added.
In order to keep a clean overview containing all contributed modules the following files need to be created/adapted.
Update the README.md file under the modules folder. Here you add your model with a single line description.
Add a README.md inside your own module folder. This README explains which functionality (separate functions) is available, links to the corresponding samples and explains in somewhat more detail what the module is expected to do. If any extra requirements are needed to build the module without problems, add them here also.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。