From c51f44ee098e9418db38642a1b2bd5391f5c712a Mon Sep 17 00:00:00 2001 From: Ronaldo Sc <37854996+ronaldosc@users.noreply.github.com> Date: Mon, 5 Jun 2023 16:06:20 -0300 Subject: [PATCH 1/7] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 8d3ecda0413..87e33501ef9 100644 --- a/README.md +++ b/README.md @@ -15,25 +15,25 @@ 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: + >Here is the CMake command line for you: -``` -$ cd -$ cmake -DOPENCV_EXTRA_MODULES_PATH=/modules -$ make -j5 +```bash +cd +cmake -D OPENCV_EXTRA_MODULES_PATH=/modules +make -j5 ``` As the result, OpenCV will be built in the `` 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: +use CMake's `BUILD_opencv_*` option where * is the given name of a module. Like in this example: -``` -$ cmake -DOPENCV_EXTRA_MODULES_PATH=/modules -DBUILD_opencv_legacy=OFF +```bash +cmake -D OPENCV_EXTRA_MODULES_PATH=/modules -D BUILD_opencv_=OFF ``` -If you also want to build the samples from the "samples" folder of each module, also include the "-DBUILD_EXAMPLES=ON" option. +If you also want to build the samples from the "samples" folder of each module, also include the `-D BUILD_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: + >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: 1. Start cmake-gui. From 1f05c4c4100100f2473124208489f7d4dd64bc93 Mon Sep 17 00:00:00 2001 From: Ronaldo Sc <37854996+ronaldosc@users.noreply.github.com> Date: Mon, 5 Jun 2023 16:06:58 -0300 Subject: [PATCH 2/7] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 87e33501ef9..2902f7afa1d 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,8 @@ cmake -D OPENCV_EXTRA_MODULES_PATH=/modules -D BUILD_opencv_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: 1. Start cmake-gui. From 6774ddfc571f7236336a4c0e47b2b7b34f95ea98 Mon Sep 17 00:00:00 2001 From: Ronaldo Sc <37854996+ronaldosc@users.noreply.github.com> Date: Mon, 5 Jun 2023 16:28:59 -0300 Subject: [PATCH 3/7] Update README.md --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2902f7afa1d..93d23ab35a6 100644 --- a/README.md +++ b/README.md @@ -25,15 +25,14 @@ make -j5 As the result, OpenCV will be built in the `` with all modules from `opencv_contrib` repository. If you don't want all of the modules, -use CMake's `BUILD_opencv_*` option where * is the given name of a module. Like in this example: +use CMake's `BUILD_opencv_*` option where * is the given name of a module as in this example: ```bash cmake -D OPENCV_EXTRA_MODULES_PATH=/modules -D BUILD_opencv_=OFF ``` -If you also want to build the samples from the "samples" folder of each module, also include the `-D BUILD_EXAMPLES=ON` option. - - +If you also want to build the samples from the "samples" folder of each module, also include the `-D BUILD_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: 1. Start cmake-gui. From 0ce2c47dbc6685cff4d1b2976d7dd8b27162c5c1 Mon Sep 17 00:00:00 2001 From: Ronaldo Sc <37854996+ronaldosc@users.noreply.github.com> Date: Mon, 5 Jun 2023 16:36:16 -0300 Subject: [PATCH 4/7] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 93d23ab35a6..f0767481514 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ cmake -D OPENCV_EXTRA_MODULES_PATH=/modules -D BUILD_opencv_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: From d41b7e37a4005502919945c382376415defff244 Mon Sep 17 00:00:00 2001 From: Ronaldo Sc <37854996+ronaldosc@users.noreply.github.com> Date: Mon, 5 Jun 2023 16:45:17 -0300 Subject: [PATCH 5/7] Update README.md --- modules/README.md | 72 +++++++++++++++++++++++------------------------ 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/modules/README.md b/modules/README.md index 28070d147ce..94c5645e04b 100644 --- a/modules/README.md +++ b/modules/README.md @@ -4,45 +4,45 @@ An overview of the opencv_contrib modules This list gives an overview of all modules available inside the contrib repository. To turn off building one of these module repositories, set the names in bold below to -``` -$ cmake -D OPENCV_EXTRA_MODULES_PATH=/modules -D BUILD_opencv_=OFF +```bash +cmake -D OPENCV_EXTRA_MODULES_PATH=/modules -D BUILD_opencv_=OFF ``` -- **alphamat**: Computer Vision based Alpha Matting -- Given an input image and a trimap, generate an alpha matte. +- **alphamat**: Computer Vision based Alpha Matting — Given an input image and a trimap, generate an alpha matte. -- **aruco**: ArUco and ChArUco Markers -- Augmented reality ArUco marker and "ChARUco" markers where ArUco markers embedded inside the white areas of the checker board. +- **aruco**: ArUco and ChArUco Markers — Augmented reality ArUco marker and "ChARUco" markers where ArUco markers embedded inside the white areas of the checker board. - **barcode**: Barcode detecting and decoding methods. - **bgsegm**: Background segmentation algorithm combining statistical background image estimation and per-pixel Bayesian segmentation. -- **bioinspired**: Biological Vision -- Biologically inspired vision model: minimize noise and luminance variance, transient event segmentation, high dynamic range tone mapping methods. +- **bioinspired**: Biological Vision — Biologically inspired vision model: minimize noise and luminance variance, transient event segmentation, high dynamic range tone mapping methods. -- **ccalib**: Custom Calibration -- Patterns for 3D reconstruction, omnidirectional camera calibration, random pattern calibration and multi-camera calibration. +- **ccalib**: Custom Calibration — Patterns for 3D reconstruction, omnidirectional camera calibration, random pattern calibration and multi-camera calibration. -- **cnn_3dobj**: Deep Object Recognition and Pose -- Uses Caffe Deep Neural Net library to build, train and test a CNN model of visual object recognition and pose. +- **cnn_3dobj**: Deep Object Recognition and Pose — Uses Caffe Deep Neural Net library to build, train and test a CNN model of visual object recognition and pose. -- **cvv**: Computer Vision Debugger -- Simple code that you can add to your program that pops up a GUI allowing you to interactively and visually debug computer vision programs. +- **cvv**: Computer Vision Debugger — Simple code that you can add to your program that pops up a GUI allowing you to interactively and visually debug computer vision programs. -- **datasets**: Datasets Reader -- Code for reading existing computer vision databases and samples of using the readers to train, test and run using that dataset's data. +- **datasets**: Datasets Reader — Code for reading existing computer vision databases and samples of using the readers to train, test and run using that dataset's data. -- **dnn_objdetect**: Object Detection using CNNs -- Implements compact CNN Model for object detection. Trained using Caffe but uses opencv_dnn module. +- **dnn_objdetect**: Object Detection using CNNs — Implements compact CNN Model for object detection. Trained using Caffe but uses opencv_dnn module. -- **dnn_superres**: Superresolution using CNNs -- Contains four trained convolutional neural networks to upscale images. +- **dnn_superres**: Superresolution using CNNs — Contains four trained convolutional neural networks to upscale images. -- **dnns_easily_fooled**: Subvert DNNs -- This code can use the activations in a network to fool the networks into recognizing something else. +- **dnns_easily_fooled**: Subvert DNNs — This code can use the activations in a network to fool the networks into recognizing something else. -- **dpm**: Deformable Part Model -- Felzenszwalb's Cascade with deformable parts object recognition code. +- **dpm**: Deformable Part Model — Felzenszwalb's Cascade with deformable parts object recognition code. -- **face**: Face Recognition -- Face recognition techniques: Eigen, Fisher and Local Binary Pattern Histograms LBPH methods. +- **face**: Face Recognition — Face recognition techniques: Eigen, Fisher and Local Binary Pattern Histograms LBPH methods. - **freetype**: Drawing text using freetype and harfbuzz. -- **fuzzy**: Fuzzy Logic in Vision -- Fuzzy logic image transform and inverse; Fuzzy image processing. +- **fuzzy**: Fuzzy Logic in Vision — Fuzzy logic image transform and inverse; Fuzzy image processing. -- **hdf**: Hierarchical Data Storage -- This module contains I/O routines for Hierarchical Data Format: https://en.m.wikipedia.org/wiki/Hierarchical_Data_Format meant to store large amounts of data. +- **hdf**: Hierarchical Data Storage — This module contains I/O routines for [Hierarchical Data Format](https://en.m.wikipedia.org/wiki/Hierarchical_Data_Format) meant to store large amounts of data. -- **hfs**: Hierarchical Feature Selection for Efficient Image Segmentation -- This module contains an efficient algorithm to segment an image. +- **hfs**: Hierarchical Feature Selection for Efficient Image Segmentation — This module contains an efficient algorithm to segment an image. - **img_hash**: This module contains algorithms to extract hash of an image allowing to efficiently estimate similarity between images. @@ -50,45 +50,45 @@ $ cmake -D OPENCV_EXTRA_MODULES_PATH=/modules -D BUILD_opencv_/modules -D BUILD_opencv_ Date: Mon, 5 Jun 2023 16:58:52 -0300 Subject: [PATCH 6/7] Update README.md formatting update --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f0767481514..c56de38de8e 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ 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 line for you: + >***Here is the CMake command line for you:*** ```bash cd @@ -34,7 +34,7 @@ cmake -D OPENCV_EXTRA_MODULES_PATH=/modules -D BUILD_opencv_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: + >***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:*** 1. Start cmake-gui. From 0a18abb6c68619874cc021745bbc7b16f976f2f1 Mon Sep 17 00:00:00 2001 From: Ronaldo Sc <37854996+ronaldosc@users.noreply.github.com> Date: Mon, 5 Jun 2023 17:01:47 -0300 Subject: [PATCH 7/7] Update README.md Added a line next to end to separate the two instructions, the last one is for addition of new module ones. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index c56de38de8e..b6991b9b228 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,8 @@ If you also want to build the samples from the "samples" folder of each module, 7. Build the `opencv` core with the method you chose (make and make install if you chose Unix makefile at step 6). 8. 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. + +------ ### Update the repository documentation