Репозиторий для дополнительных модулей OpenCV

Этот репозиторий предназначен для разработки так называемых «дополнительных» модулей, предоставляющих дополнительную функциональность. Новые модули часто не имеют стабильного API и плохо протестированы. Поэтому их не следует выпускать как часть официального дистрибутива OpenCV, поскольку библиотека поддерживает двоичную совместимость и старается обеспечить достойную производительность и стабильность.

Таким образом, все новые модули должны разрабатываться отдельно и сначала публиковаться в репозитории opencv_contrib. Позже, когда модуль созреет и обретёт популярность, его перемещают в центральный репозиторий OpenCV, и команда разработчиков обеспечивает поддержку этого модуля на уровне продакшна.

Как собрать OpenCV с дополнительными модулями

Вы можете собрать OpenCV так, чтобы он включал модули из этого репозитория. Модули contrib находятся в постоянном развитии, и рекомендуется использовать их вместе с основной веткой или последними выпусками OpenCV.

Вот команда CMake для вас:

$ cd <каталог сборки opencv>
$ cmake -DOPENCV_EXTRA_MODULES_PATH=<путь к opencv_contrib>/modules <путь к исходному коду opencv>
$ make -j5

В результате OpenCV будет собран в каталоге <каталог сборки opencv> со всеми модулями из репозитория opencv_contrib. Если вам нужны не все модули, используйте параметры CMake BUILD_opencv_*. Например:

$ cmake -DOPENCV_EXTRA_MODULES_PATH=<opencv_contrib>/modules -DBUILD_opencv_legacy=OFF <opencv_source_directory>

Если вы также хотите собрать образцы из папки «samples» каждого модуля, также включите параметр -DBUILD_EXAMPLES=ON.

Если вы предпочитаете использовать графическую версию cmake (cmake-gui), то вы можете добавить модули opencv_contrib в ядро opencv, выполнив следующие действия:

1. Запустите cmake-gui.
2. Выберите папку исходного кода opencv и папку, где будут созданы двоичные файлы (две верхние формы интерфейса).
3. Нажмите кнопку «Настроить». Вы увидите все параметры сборки opencv в центральном интерфейсе.
4. Просмотрите параметры и найдите форму под названием OPENCV_EXTRA_MODULES_PATH (используйте форму поиска, чтобы быстро сосредоточиться на ней).
5. Заполните этот OPENCV_EXTRA_MODULES_PATH, указав правильный путь к значению <opencv_contrib>/modules, используя кнопку просмотра.
6. Нажмите кнопки «Настроить», а затем «Сгенерировать» (в первый раз вам будет предложено выбрать стиль файла makefile).
7. Соберите ядро opencv выбранным вами способом (make и make install, если вы выбрали Unix makefile на шаге 6).
8. Чтобы запустить, необходимо добавить флаги компоновщика для модулей contrib, чтобы использовать их в вашем коде/IDE. Например, чтобы использовать модуль aruco, будет добавлен флаг -lopencv_aruco.

Обновите документацию репозитория

Чтобы сохранить чистый обзор всех предоставленных модулей, необходимо создать или адаптировать следующие файлы:

1. Обновите файл README.md в папке modules. Здесь вы добавляете свой модуль с описанием в одну строку.
2. Добавьте файл README.md внутри собственной папки модуля. Этот README объясняет, какая функциональность (отдельные функции) доступна, ссылается на соответствующие образцы и несколько более подробно объясняет, что должен делать модуль. Если для беспроблемной сборки модуля требуются дополнительные требования, добавьте их сюда же.