From 3b7683e72f6314a6f8d17eeb75806c16859ddcea Mon Sep 17 00:00:00 2001 From: Konstantin Matskevich Date: Wed, 15 Jan 2014 10:01:40 +0400 Subject: [PATCH] fixed docs --- .../common_interfaces_of_descriptor_matchers.rst | 41 +++++++++++----------- modules/features2d/include/opencv2/features2d.hpp | 2 +- modules/features2d/src/matchers.cpp | 6 ++-- 3 files changed, 26 insertions(+), 23 deletions(-) diff --git a/modules/features2d/doc/common_interfaces_of_descriptor_matchers.rst b/modules/features2d/doc/common_interfaces_of_descriptor_matchers.rst index 2c2cf28..ea9e13f 100644 --- a/modules/features2d/doc/common_interfaces_of_descriptor_matchers.rst +++ b/modules/features2d/doc/common_interfaces_of_descriptor_matchers.rst @@ -28,7 +28,7 @@ with an image set. :: public: virtual ~DescriptorMatcher(); - virtual void add( const vector& descriptors ); + virtual void add( InputArray descriptors ); const vector& getTrainDescriptors() const; virtual void clear(); @@ -40,23 +40,23 @@ with an image set. :: /* * Group of methods to match descriptors from an image pair. */ - void match( const Mat& queryDescriptors, const Mat& trainDescriptors, - vector& matches, const Mat& mask=Mat() ) const; - void knnMatch( const Mat& queryDescriptors, const Mat& trainDescriptors, + void match( InputArray queryDescriptors, InputArray trainDescriptors, + vector& matches, InputArray mask=Mat() ) const; + void knnMatch( InputArray queryDescriptors, InputArray trainDescriptors, vector >& matches, int k, - const Mat& mask=Mat(), bool compactResult=false ) const; - void radiusMatch( const Mat& queryDescriptors, const Mat& trainDescriptors, + InputArray mask=Mat(), bool compactResult=false ) const; + void radiusMatch( InputArray queryDescriptors, InputArray trainDescriptors, vector >& matches, float maxDistance, - const Mat& mask=Mat(), bool compactResult=false ) const; + InputArray mask=Mat(), bool compactResult=false ) const; /* * Group of methods to match descriptors from one image to an image set. */ - void match( const Mat& queryDescriptors, vector& matches, + void match( InputArray queryDescriptors, vector& matches, const vector& masks=vector() ); - void knnMatch( const Mat& queryDescriptors, vector >& matches, + void knnMatch( InputArray queryDescriptors, vector >& matches, int k, const vector& masks=vector(), bool compactResult=false ); - void radiusMatch( const Mat& queryDescriptors, vector >& matches, + void radiusMatch( InputArray queryDescriptors, vector >& matches, float maxDistance, const vector& masks=vector(), bool compactResult=false ); @@ -69,15 +69,16 @@ with an image set. :: protected: vector trainDescCollection; + vector utrainDescCollection; ... }; DescriptorMatcher::add -------------------------- -Adds descriptors to train a descriptor collection. If the collection ``trainDescCollectionis`` is not empty, the new descriptors are added to existing train descriptors. +Adds descriptors to train a CPU(``trainDescCollectionis``) or GPU(``utrainDescCollectionis``) descriptor collection. If the collection is not empty, the new descriptors are added to existing train descriptors. -.. ocv:function:: void DescriptorMatcher::add( const vector& descriptors ) +.. ocv:function:: void DescriptorMatcher::add( InputArrayOfArrays descriptors ) :param descriptors: Descriptors to add. Each ``descriptors[i]`` is a set of descriptors from the same train image. @@ -94,7 +95,7 @@ Returns a constant link to the train descriptor collection ``trainDescCollection DescriptorMatcher::clear ---------------------------- -Clears the train descriptor collection. +Clears the train descriptor collections. .. ocv:function:: void DescriptorMatcher::clear() @@ -102,7 +103,7 @@ Clears the train descriptor collection. DescriptorMatcher::empty ---------------------------- -Returns true if there are no train descriptors in the collection. +Returns true if there are no train descriptors in the both collections. .. ocv:function:: bool DescriptorMatcher::empty() const @@ -130,9 +131,9 @@ DescriptorMatcher::match ---------------------------- Finds the best match for each descriptor from a query set. -.. ocv:function:: void DescriptorMatcher::match( const Mat& queryDescriptors, const Mat& trainDescriptors, vector& matches, const Mat& mask=Mat() ) const +.. ocv:function:: void DescriptorMatcher::match( InputArray queryDescriptors, InputArray trainDescriptors, vector& matches, InputArray mask=Mat() ) const -.. ocv:function:: void DescriptorMatcher::match( const Mat& queryDescriptors, vector& matches, const vector& masks=vector() ) +.. ocv:function:: void DescriptorMatcher::match(InputArray queryDescriptors, vector& matches, const vector& masks=vector() ) :param queryDescriptors: Query set of descriptors. @@ -152,9 +153,9 @@ DescriptorMatcher::knnMatch ------------------------------- Finds the k best matches for each descriptor from a query set. -.. ocv:function:: void DescriptorMatcher::knnMatch( const Mat& queryDescriptors, const Mat& trainDescriptors, vector >& matches, int k, const Mat& mask=Mat(), bool compactResult=false ) const +.. ocv:function:: void DescriptorMatcher::knnMatch(InputArray queryDescriptors, InputArray trainDescriptors, vector >& matches, int k, InputArray mask=Mat(), bool compactResult=false ) const -.. ocv:function:: void DescriptorMatcher::knnMatch( const Mat& queryDescriptors, vector >& matches, int k, const vector& masks=vector(), bool compactResult=false ) +.. ocv:function:: void DescriptorMatcher::knnMatch( InputArray queryDescriptors, vector >& matches, int k, const vector& masks=vector(), bool compactResult=false ) :param queryDescriptors: Query set of descriptors. @@ -178,9 +179,9 @@ DescriptorMatcher::radiusMatch ---------------------------------- For each query descriptor, finds the training descriptors not farther than the specified distance. -.. ocv:function:: void DescriptorMatcher::radiusMatch( const Mat& queryDescriptors, const Mat& trainDescriptors, vector >& matches, float maxDistance, const Mat& mask=Mat(), bool compactResult=false ) const +.. ocv:function:: void DescriptorMatcher::radiusMatch( InputArray queryDescriptors, InputArray trainDescriptors, vector >& matches, float maxDistance, InputArray mask=Mat(), bool compactResult=false ) const -.. ocv:function:: void DescriptorMatcher::radiusMatch( const Mat& queryDescriptors, vector >& matches, float maxDistance, const vector& masks=vector(), bool compactResult=false ) +.. ocv:function:: void DescriptorMatcher::radiusMatch( InputArray queryDescriptors, vector >& matches, float maxDistance, const vector& masks=vector(), bool compactResult=false ) :param queryDescriptors: Query set of descriptors. diff --git a/modules/features2d/include/opencv2/features2d.hpp b/modules/features2d/include/opencv2/features2d.hpp index 5936d93..f43d85f 100644 --- a/modules/features2d/include/opencv2/features2d.hpp +++ b/modules/features2d/include/opencv2/features2d.hpp @@ -998,7 +998,7 @@ public: * Add descriptors to train descriptor collection. * descriptors Descriptors to add. Each descriptors[i] is a descriptors set from one image. */ - CV_WRAP virtual void add( InputArray descriptors ); + CV_WRAP virtual void add( InputArrayOfArrays descriptors ); /* * Get train descriptors collection. */ diff --git a/modules/features2d/src/matchers.cpp b/modules/features2d/src/matchers.cpp index 5b692b9..d35ea01 100644 --- a/modules/features2d/src/matchers.cpp +++ b/modules/features2d/src/matchers.cpp @@ -1085,9 +1085,10 @@ void BFMatcher::knnMatchImpl( InputArray _queryDescriptors, std::vector