From f5deefefe21febf9e43095db42897cdd6a579c2d Mon Sep 17 00:00:00 2001 From: Gary Bradski Date: Sun, 27 Mar 2016 17:31:51 -0700 Subject: [PATCH] Extensive changes to master README.md Extensive changes to README.md opencv_contrib file to bring it up to date. --- modules/README.md | 70 +++++++++++++++++++++++++++-------------------- 1 file changed, 41 insertions(+), 29 deletions(-) diff --git a/modules/README.md b/modules/README.md index 0f245bee2..d42fea6b5 100644 --- a/modules/README.md +++ b/modules/README.md @@ -1,59 +1,71 @@ -An overview of the contrib modules and a small explanation ----------------------------------------------------------- +An overview of the opencv_contrib modules +----------------------------------------- This list gives an overview of all modules available inside the contrib repository. -These are also the correct names for disabling the building of a specific module by adding +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_reponame=OFF +$ cmake -D OPENCV_EXTRA_MODULES_PATH=/modules -D BUILD_opencv_=OFF ``` -1. **opencv_adas**: Advanced Driver Assistance Systems module with Forward Collision Warning. +1. **aruco**: ArUco and ChArUco Markers -- Augmented reality ArUco marker and "ChARUco" markers where ArUco markers embedded inside the white areas of the checker board. -2. **opencv_bgsegm**: Improved Adaptive Background Mixture Model for Real-time Tracking / Visual Tracking of Human Visitors under Variable-Lighting Conditions. +2. **bgsegm**: Background Segmentation -- Improved Adaptive Background Mixture Model and use for real time human tracking under Variable-Lighting Conditions. -3. **opencv_bioinspired**: Biologically inspired vision models and derivated tools. +3. **bioinspired**: Biological Vision -- Biologically inspired vision model: minimize noise and luminance variance, transient event segmentation, high dynamic range tone mapping methods. -4. **opencv_ ccalib**: Custom Calibration Pattern for 3D reconstruction. +4. **ccalib**: Custom Calibration -- Patterns for 3D reconstruction, omnidirectional camera calibration, random pattern calibration and multi-camera calibration. -5. **opencv_cvv**: GUI for Interactive Visual Debugging of Computer Vision Programs. +5. **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. -6. **opencv_datasets**: Interface for interfacing with existing computer vision databases. +6. **contrib_world**: opencv_contrib holder -- contrib_world is the module that when built, contains all other opencv_contrib modules. It may be used for the more convenient redistribution of opencv binaries. -7. **opencv_datasettools**: Tools for working with different datasets. +7. **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. -8. **opencv_face**: Recently added face recognition software which is not yet stabilized. +8. **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. -9. **opencv_latentsvm**: Implementation of the LatentSVM detector algorithm. +9. **dnn**: Deep Neural Networks (DNNs) -- This module can read in image recogniton networks trained in the Caffe neural netowrk library and run them efficiently on CPU. -10. **opencv_line_descriptor**: Binary descriptors for lines extracted from an image. +10. **dnns_easily_fooled**: Subvert DNNs -- This code can use the activations in a network to fool the networks into recognizing something else. -11. **opencv_matlab**: OpenCV Matlab Code Generator. +11. **dpm**: Deformable Part Model -- Felzenszwalb's Cascade with deformable parts object recognition code. -12. **opencv_optflow**: Optical Flow Algorithms for tracking points. +12. **face**: Face Recognition -- Face recognition techniques: Eigen, Fisher and Local Binary Pattern Histograms LBPH methods. -13. **opencv_reg**: Image Registration module. +13. **fuzzy**: Fuzzy Logic in Vision -- Fuzzy logic image transform and inverse; Fuzzy image processing. -14. **opencv_rgbd**: RGB-Depth Processing module. +14. **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. -15. **opencv_saliency**: Saliency API, understanding where humans focus given a scene. +15. **line_descriptor**: Line Segment Extract and Match -- Methods of extracting, describing and latching line segments using binary descriptors. -16. **opencv_surface_matching**: Surface Matching Algorithm Through 3D Features. +16. **matlab**: Matlab Interface -- OpenCV Matlab Mex wrapper code generator for certain opencv core modules. -17. **opencv_text**: Scene Text Detection and Recognition in Natural Scene Images. +17. **optflow**: Optical Flow -- Algorithms for running and evaluating deepflow, simpleflow, sparsetodenseflow and motion templates (silhouette flow). -18. **opencv_tracking**: Long-term optical tracking API. +18. **plot**: Plotting -- The plot module allows you to easily plot data in 1D or 2D. -19. **opencv_xfeatures2d**: Extra 2D Features Framework containing experimental and non-free 2D feature algorithms. +19. **reg**: Image Registration -- Pixels based image registration for precise alignment. Follows the paper "Image Alignment and Stitching: A Tutorial", by Richard Szeliski. -20. **opencv_ximgproc**: Extended Image Processing: Structured Forests / Domain Transform Filter / Guided Filter / Adaptive Manifold Filter / Joint Bilateral Filter / Superpixels. +20. **rgbd**: RGB-Depth Processing module -- Linemod 3D object recognition; Fast surface normals and 3D plane finding. 3D visual odometry -21. **opencv_xobjdetect**: Integral Channel Features Detector Framework. +21. **saliency**: Saliency API -- Where humans would look in a scene. Has routines for static, motion and "objectness" saliency. -22. **opencv_xphoto**: Additional photo processing algorithms: Color balance / Denoising / Inpainting. +22. **sfm**: Structure from Motion -- This module contains algorithms to perform 3d reconstruction from 2d images. The core of the module is a light version of Libmv. -23. **opencv_stereo**: Stereo Correspondence done with different descriptors: Census / CS-Census / MCT / BRIEF / MV. +23. **stereo**: Stereo Correspondence -- Stereo matching done with different descriptors: Census / CS-Census / MCT / BRIEF / MV. -24. **opencv_hdf**: Hierarchical Data Format I/O. +24. **structured_light**: Structured Light Use -- How to generate and project gray code patterns and use them to find dense depth in a scene. -25. **opencv_fuzzy**: New module focused on the fuzzy image processing. +25. **surface_matching**: Point Pair Features -- Implements 3d object detection and localization using multimodal point pair features. + +26. **text**: Visual Text Matching -- In a visual scene, detect text, segment words and recognise the text. + +27. **tracking**: Vision Based Object Tracking -- Use and/or evaluate one of 5 different visual object tracking techniques. + +28. **xfeatures2d**: Features2D extra -- Extra 2D Features Framework containing experimental and non-free 2D feature detector/descriptor algorithms. SURF, SIFT, BRIEF, Censure, Freak, LUCID, Daisy, Self-similar. + +29. **ximgproc**: Extended Image Processing -- Structured Forests / Domain Transform Filter / Guided Filter / Adaptive Manifold Filter / Joint Bilateral Filter / Superpixels. + +30. **xobjdetect**: Boosted 2D Object Detection -- Uses a Waldboost cascade and local binary patterns computed as integral features for 2D object detection. + +31. **xphoto**: Extra Computational Photography -- Additional photo processing algorithms: Color balance / Denoising / Inpainting.