generic-library/opencv
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documentation: fixed class/struc members documentation; added warning on incorrectly documented member

Browse Source
This commit is contained in:
Andrey Kamaev
2012-05-29 16:55:46 +00:00
parent aaf043e7ba
commit a20248977c
14 changed files with 367 additions and 364 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
modules/features2d/doc/common_interfaces_of_descriptor_matchers.rst
View File

@@ -258,7 +258,7 @@ Creates a descriptor matcher of a given type with the default parameters (using
BFMatcher
-----------------
.. ocv:class::BFMatcher : public DescriptorMatcher
.. ocv:class:: BFMatcher : public DescriptorMatcher
Brute-force descriptor matcher. For each descriptor in the first set, this matcher finds the closest descriptor in the second set by trying each one. This descriptor matcher supports masking permissible matches of descriptor sets.

26
modules/features2d/doc/common_interfaces_of_feature_detectors.rst
View File

@@ -12,31 +12,31 @@ KeyPoint
--------
.. ocv:class:: KeyPoint
Data structure for salient point detectors.
Data structure for salient point detectors.
.. ocv:member:: Point2f pt
.. ocv:member:: Point2f pt
coordinates of the keypoint
coordinates of the keypoint
.. ocv:member:: float size
.. ocv:member:: float size
diameter of the meaningful keypoint neighborhood
diameter of the meaningful keypoint neighborhood
.. ocv:member:: float angle
.. ocv:member:: float angle
computed orientation of the keypoint (-1 if not applicable)
computed orientation of the keypoint (-1 if not applicable)
.. ocv:member:: float response
.. ocv:member:: float response
the response by which the most strong keypoints have been selected. Can be used for further sorting or subsampling
the response by which the most strong keypoints have been selected. Can be used for further sorting or subsampling
.. ocv:member:: int octave
.. ocv:member:: int octave
octave (pyramid layer) from which the keypoint has been extracted
octave (pyramid layer) from which the keypoint has been extracted
.. ocv:member:: int class_id
.. ocv:member:: int class_id
object id that can be used to clustered keypoints by an object they belong to
object id that can be used to clustered keypoints by an object they belong to
KeyPoint::KeyPoint
------------------