modules/features2d/doc/feature_detection_and_description.rst

   1 Feature Detection and Description
   2 =================================
   3
   4 .. highlight:: cpp
   5
   6 .. note::
   7
   8    * An example explaining keypoint detection and description can be found at opencv_source_code/samples/cpp/descriptor_extractor_matcher.cpp
   9
  10 FAST
  11 ----
  12 Detects corners using the FAST algorithm
  13
  14 .. ocv:function:: void FAST( InputArray image, vector<KeyPoint>& keypoints, int threshold, bool nonmaxSupression=true )
  15
  16 .. ocv:function:: void FASTX( InputArray image, vector<KeyPoint>& keypoints, int threshold, bool nonmaxSupression, int type )
  17
  18     :param image: grayscale image where keypoints (corners) are detected.
  19
  20     :param keypoints: keypoints detected on the image.
  21
  22     :param threshold: threshold on difference between intensity of the central pixel and pixels of a circle around this pixel.
  23
  24     :param nonmaxSupression: if true, non-maximum suppression is applied to detected corners (keypoints).
  25
  26     :param type: one of the three neighborhoods as defined in the paper: ``FastFeatureDetector::TYPE_9_16``, ``FastFeatureDetector::TYPE_7_12``, ``FastFeatureDetector::TYPE_5_8``
  27
  28 Detects corners using the FAST algorithm by [Rosten06]_.
  29
  30 .. [Rosten06] E. Rosten. Machine Learning for High-speed Corner Detection, 2006.
  31
  32
  33 MSER
  34 ----
  35 .. ocv:class:: MSER : public FeatureDetector
  36
  37 Maximally stable extremal region extractor. ::
  38
  39     class MSER : public CvMSERParams
  40     {
  41     public:
  42         // default constructor
  43         MSER();
  44         // constructor that initializes all the algorithm parameters
  45         MSER( int _delta, int _min_area, int _max_area,
  46               float _max_variation, float _min_diversity,
  47               int _max_evolution, double _area_threshold,
  48               double _min_margin, int _edge_blur_size );
  49         // runs the extractor on the specified image; returns the MSERs,
  50         // each encoded as a contour (vector<Point>, see findContours)
  51         // the optional mask marks the area where MSERs are searched for
  52         void operator()( const Mat& image, vector<vector<Point> >& msers, const Mat& mask ) const;
  53     };
  54
  55 The class encapsulates all the parameters of the MSER extraction algorithm (see
  56 http://en.wikipedia.org/wiki/Maximally_stable_extremal_regions). Also see http://code.opencv.org/projects/opencv/wiki/MSER for useful comments and parameters description.
  57
  58 .. note::
  59
  60    * (Python) A complete example showing the use of the MSER detector can be found at opencv_source_code/samples/python2/mser.py
  61
  62
  63 ORB
  64 ---
  65 .. ocv:class:: ORB : public Feature2D
  66
  67 Class implementing the ORB (*oriented BRIEF*) keypoint detector and descriptor extractor, described in [RRKB11]_. The algorithm uses FAST in pyramids to detect stable keypoints, selects the strongest features using FAST or Harris response, finds their orientation using first-order moments and computes the descriptors using BRIEF (where the coordinates of random point pairs (or k-tuples) are rotated according to the measured orientation).
  68
  69 .. [RRKB11] Ethan Rublee, Vincent Rabaud, Kurt Konolige, Gary R. Bradski: ORB: An efficient alternative to SIFT or SURF. ICCV 2011: 2564-2571.
  70
  71 ORB::ORB
  72 --------
  73 The ORB constructor
  74
  75 .. ocv:function:: ORB::ORB(int nfeatures = 500, float scaleFactor = 1.2f, int nlevels = 8, int edgeThreshold = 31, int firstLevel = 0, int WTA_K=2, int scoreType=ORB::HARRIS_SCORE, int patchSize=31)
  76
  77     :param nfeatures: The maximum number of features to retain.
  78
  79     :param scaleFactor: Pyramid decimation ratio, greater than 1. ``scaleFactor==2`` means the classical pyramid, where each next level has 4x less pixels than the previous, but such a big scale factor will degrade feature matching scores dramatically. On the other hand, too close to 1 scale factor will mean that to cover certain scale range you will need more pyramid levels and so the speed will suffer.
  80
  81     :param nlevels: The number of pyramid levels. The smallest level will have linear size equal to ``input_image_linear_size/pow(scaleFactor, nlevels)``.
  82
  83     :param edgeThreshold: This is size of the border where the features are not detected. It should roughly match the ``patchSize`` parameter.
  84
  85     :param firstLevel: It should be 0 in the current implementation.
  86
  87     :param WTA_K: The number of points that produce each element of the oriented BRIEF descriptor. The default value 2 means the BRIEF where we take a random point pair and compare their brightnesses, so we get 0/1 response. Other possible values are 3 and 4. For example, 3 means that we take 3 random points (of course, those point coordinates are random, but they are generated from the pre-defined seed, so each element of BRIEF descriptor is computed deterministically from the pixel rectangle), find point of maximum brightness and output index of the winner (0, 1 or 2). Such output will occupy 2 bits, and therefore it will need a special variant of Hamming distance, denoted as ``NORM_HAMMING2`` (2 bits per bin).  When ``WTA_K=4``, we take 4 random points to compute each bin (that will also occupy 2 bits with possible values 0, 1, 2 or 3).
  88
  89     :param scoreType: The default HARRIS_SCORE means that Harris algorithm is used to rank features (the score is written to ``KeyPoint::score`` and is used to retain best ``nfeatures`` features); FAST_SCORE is alternative value of the parameter that produces slightly less stable keypoints, but it is a little faster to compute.
  90
  91     :param patchSize: size of the patch used by the oriented BRIEF descriptor. Of course, on smaller pyramid layers the perceived image area covered by a feature will be larger.
  92
  93 ORB::operator()
  94 ---------------
  95 Finds keypoints in an image and computes their descriptors
  96
  97 .. ocv:function:: void ORB::operator()(InputArray image, InputArray mask, vector<KeyPoint>& keypoints, OutputArray descriptors, bool useProvidedKeypoints=false ) const
  98
  99     :param image: The input 8-bit grayscale image.
 100
 101     :param mask: The operation mask.
 102
 103     :param keypoints: The output vector of keypoints.
 104
 105     :param descriptors: The output descriptors. Pass ``cv::noArray()`` if you do not need it.
 106
 107     :param useProvidedKeypoints: If it is true, then the method will use the provided vector of keypoints instead of detecting them.
 108
 109 BRISK
 110 -----
 111 .. ocv:class:: BRISK : public Feature2D
 112
 113 Class implementing the BRISK keypoint detector and descriptor extractor, described in [LCS11]_.
 114
 115 .. [LCS11] Stefan Leutenegger, Margarita Chli and Roland Siegwart: BRISK: Binary Robust Invariant Scalable Keypoints. ICCV 2011: 2548-2555.
 116
 117 BRISK::BRISK
 118 ------------
 119 The BRISK constructor
 120
 121 .. ocv:function:: BRISK::BRISK(int thresh=30, int octaves=3, float patternScale=1.0f)
 122
 123     :param thresh: FAST/AGAST detection threshold score.
 124
 125     :param octaves: detection octaves. Use 0 to do single scale.
 126
 127     :param patternScale: apply this scale to the pattern used for sampling the neighbourhood of a keypoint.
 128
 129 BRISK::BRISK
 130 ------------
 131 The BRISK constructor for a custom pattern
 132
 133 .. ocv:function:: BRISK::BRISK(std::vector<float> &radiusList, std::vector<int> &numberList, float dMax=5.85f, float dMin=8.2f, std::vector<int> indexChange=std::vector<int>())
 134
 135     :param radiusList: defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).
 136
 137     :param numberList: defines the number of sampling points on the sampling circle. Must be the same size as radiusList..
 138
 139     :param dMax: threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).
 140
 141     :param dMin: threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).
 142
 143     :param indexChanges: index remapping of the bits.
 144
 145 BRISK::operator()
 146 -----------------
 147 Finds keypoints in an image and computes their descriptors
 148
 149 .. ocv:function:: void BRISK::operator()(InputArray image, InputArray mask, vector<KeyPoint>& keypoints, OutputArray descriptors, bool useProvidedKeypoints=false ) const
 150
 151     :param image: The input 8-bit grayscale image.
 152
 153     :param mask: The operation mask.
 154
 155     :param keypoints: The output vector of keypoints.
 156
 157     :param descriptors: The output descriptors. Pass ``cv::noArray()`` if you do not need it.
 158
 159     :param useProvidedKeypoints: If it is true, then the method will use the provided vector of keypoints instead of detecting them.
 160
 161 FREAK
 162 -----
 163 .. ocv:class:: FREAK : public DescriptorExtractor
 164
 165 Class implementing the FREAK (*Fast Retina Keypoint*) keypoint descriptor, described in [AOV12]_. The algorithm propose a novel keypoint descriptor inspired by the human visual system and more precisely the retina, coined Fast Retina Key- point (FREAK). A cascade of binary strings is computed by efficiently comparing image intensities over a retinal sampling pattern. FREAKs are in general faster to compute with lower memory load and also more robust than SIFT, SURF or BRISK. They are competitive alternatives to existing keypoints in particular for embedded applications.
 166
 167 .. [AOV12] A. Alahi, R. Ortiz, and P. Vandergheynst. FREAK: Fast Retina Keypoint. In IEEE Conference on Computer Vision and Pattern Recognition, 2012. CVPR 2012 Open Source Award Winner.
 168
 169 .. note::
 170
 171    * An example on how to use the FREAK descriptor can be found at opencv_source_code/samples/cpp/freak_demo.cpp
 172
 173 FREAK::FREAK
 174 ------------
 175 The FREAK constructor
 176
 177 .. ocv:function:: FREAK::FREAK( bool orientationNormalized=true, bool scaleNormalized=true, float patternScale=22.0f, int nOctaves=4, const vector<int>& selectedPairs=vector<int>() )
 178
 179     :param orientationNormalized: Enable orientation normalization.
 180     :param scaleNormalized: Enable scale normalization.
 181     :param patternScale: Scaling of the description pattern.
 182     :param nOctaves: Number of octaves covered by the detected keypoints.
 183     :param selectedPairs: (Optional) user defined selected pairs indexes,
 184
 185 FREAK::selectPairs
 186 ------------------
 187 Select the 512 best description pair indexes from an input (grayscale) image set. FREAK is available with a set of pairs learned off-line. Researchers can run a training process to learn their own set of pair. For more details read section 4.2 in: A. Alahi, R. Ortiz, and P. Vandergheynst. FREAK: Fast Retina Keypoint. In IEEE Conference on Computer Vision and Pattern Recognition, 2012.
 188
 189 We notice that for keypoint matching applications, image content has little effect on the selected pairs unless very specific what does matter is the detector type (blobs, corners,...) and the options used (scale/rotation invariance,...). Reduce corrThresh if not enough pairs are selected (43 points --> 903 possible pairs)
 190
 191 .. ocv:function:: vector<int> FREAK::selectPairs(const vector<Mat>& images, vector<vector<KeyPoint> >& keypoints, const double corrThresh = 0.7, bool verbose = true)
 192
 193     :param images: Grayscale image input set.
 194     :param keypoints: Set of detected keypoints
 195     :param corrThresh: Correlation threshold.
 196     :param verbose: Prints pair selection informations.