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

doc fix

Browse Source
This commit is contained in:
Ilya Lavrenov 2014-01-25 14:44:28 +04:00
parent e559256719
commit 9968197ebf
2 changed files with 11 additions and 11 deletions

10
modules/features2d/doc/common_interfaces_of_descriptor_matchers.rst

@ -41,7 +41,7 @@ with an image set. ::
* Group of methods to match descriptors from an image pair. * Group of methods to match descriptors from an image pair.
*/ */
void match( InputArray queryDescriptors, InputArray trainDescriptors, void match( InputArray queryDescriptors, InputArray trainDescriptors,
vector<DMatch>& matches, InputArray mask=Mat() ) const; vector<DMatch>& matches, InputArray mask=noArray() ) const;
void knnMatch( InputArray queryDescriptors, InputArray trainDescriptors, void knnMatch( InputArray queryDescriptors, InputArray trainDescriptors,
vector<vector<DMatch> >& matches, int k, vector<vector<DMatch> >& matches, int k,
InputArray mask=Mat(), bool compactResult=false ) const; InputArray mask=Mat(), bool compactResult=false ) const;
@ -52,7 +52,7 @@ with an image set. ::
* Group of methods to match descriptors from one image to an image set. * Group of methods to match descriptors from one image to an image set.
*/ */
void match( InputArray queryDescriptors, vector<DMatch>& matches, void match( InputArray queryDescriptors, vector<DMatch>& matches,
const vector<Mat>& masks=vector<Mat>() ); const vector<Mat>& masks=noArray() );
void knnMatch( InputArray queryDescriptors, vector<vector<DMatch> >& matches, void knnMatch( InputArray queryDescriptors, vector<vector<DMatch> >& matches,
int k, const vector<Mat>& masks=vector<Mat>(), int k, const vector<Mat>& masks=vector<Mat>(),
bool compactResult=false ); bool compactResult=false );
@ -131,7 +131,7 @@ DescriptorMatcher::match
---------------------------- ----------------------------
Finds the best match for each descriptor from a query set. Finds the best match for each descriptor from a query set.
.. ocv:function:: void DescriptorMatcher::match( InputArray queryDescriptors, InputArray trainDescriptors, vector<DMatch>& matches, InputArray mask=Mat() ) const .. ocv:function:: void DescriptorMatcher::match( InputArray queryDescriptors, InputArray trainDescriptors, vector<DMatch>& matches, InputArray mask=noArray() ) const
.. ocv:function:: void DescriptorMatcher::match(InputArray queryDescriptors, vector<DMatch>& matches, const vector<Mat>& masks=vector<Mat>() ) .. ocv:function:: void DescriptorMatcher::match(InputArray queryDescriptors, vector<DMatch>& matches, const vector<Mat>& masks=vector<Mat>() )
@ -153,7 +153,7 @@ DescriptorMatcher::knnMatch
------------------------------- -------------------------------
Finds the k best matches for each descriptor from a query set. Finds the k best matches for each descriptor from a query set.
.. ocv:function:: void DescriptorMatcher::knnMatch(InputArray queryDescriptors, InputArray trainDescriptors, vector<vector<DMatch> >& matches, int k, InputArray mask=Mat(), bool compactResult=false ) const .. ocv:function:: void DescriptorMatcher::knnMatch(InputArray queryDescriptors, InputArray trainDescriptors, vector<vector<DMatch> >& matches, int k, InputArray mask=noArray(), bool compactResult=false ) const
.. ocv:function:: void DescriptorMatcher::knnMatch( InputArray queryDescriptors, vector<vector<DMatch> >& matches, int k, const vector<Mat>& masks=vector<Mat>(), bool compactResult=false ) .. ocv:function:: void DescriptorMatcher::knnMatch( InputArray queryDescriptors, vector<vector<DMatch> >& matches, int k, const vector<Mat>& masks=vector<Mat>(), bool compactResult=false )
@ -179,7 +179,7 @@ DescriptorMatcher::radiusMatch
---------------------------------- ----------------------------------
For each query descriptor, finds the training descriptors not farther than the specified distance. For each query descriptor, finds the training descriptors not farther than the specified distance.
.. ocv:function:: void DescriptorMatcher::radiusMatch( InputArray queryDescriptors, InputArray trainDescriptors, vector<vector<DMatch> >& matches, float maxDistance, InputArray mask=Mat(), bool compactResult=false ) const .. ocv:function:: void DescriptorMatcher::radiusMatch( InputArray queryDescriptors, InputArray trainDescriptors, vector<vector<DMatch> >& matches, float maxDistance, InputArray mask=noArray(), bool compactResult=false ) const
.. ocv:function:: void DescriptorMatcher::radiusMatch( InputArray queryDescriptors, vector<vector<DMatch> >& matches, float maxDistance, const vector<Mat>& masks=vector<Mat>(), bool compactResult=false ) .. ocv:function:: void DescriptorMatcher::radiusMatch( InputArray queryDescriptors, vector<vector<DMatch> >& matches, float maxDistance, const vector<Mat>& masks=vector<Mat>(), bool compactResult=false )

12
modules/features2d/doc/common_interfaces_of_feature_detectors.rst

@ -23,12 +23,12 @@ Abstract base class for 2D image feature detectors. ::
public: public:
virtual ~FeatureDetector(); virtual ~FeatureDetector();
void detect( const Mat& image, vector<KeyPoint>& keypoints, void detect( InputArray image, vector<KeyPoint>& keypoints,
const Mat& mask=Mat() ) const; InputArray mask=noArray() ) const;
void detect( const vector<Mat>& images, void detect( InputArrayOfArrays images,
vector<vector<KeyPoint> >& keypoints, vector<vector<KeyPoint> >& keypoints,
const vector<Mat>& masks=vector<Mat>() ) const; InputArrayOfArrays masks=noArray() ) const;
virtual void read(const FileNode&); virtual void read(const FileNode&);
virtual void write(FileStorage&) const; virtual void write(FileStorage&) const;
@ -43,9 +43,9 @@ FeatureDetector::detect
--------------------------- ---------------------------
Detects keypoints in an image (first variant) or image set (second variant). Detects keypoints in an image (first variant) or image set (second variant).
.. ocv:function:: void FeatureDetector::detect( const Mat& image, vector<KeyPoint>& keypoints, const Mat& mask=Mat() ) const .. ocv:function:: void FeatureDetector::detect( InputArray image, vector<KeyPoint>& keypoints, InputArray mask=noArray() ) const
.. ocv:function:: void FeatureDetector::detect( const vector<Mat>& images, vector<vector<KeyPoint> >& keypoints, const vector<Mat>& masks=vector<Mat>() ) const .. ocv:function:: void FeatureDetector::detect( InputArrayOfArrays images, vector<vector<KeyPoint> >& keypoints, InputArrayOfArrays masks=noArray() ) const
.. ocv:pyfunction:: cv2.FeatureDetector_create.detect(image[, mask]) -> keypoints .. ocv:pyfunction:: cv2.FeatureDetector_create.detect(image[, mask]) -> keypoints