some more changes

[profile/ivi/opencv.git] / modules / features2d / doc / common_interfaces_of_descriptor_matchers.rst

diff --git a/modules/features2d/doc/common_interfaces_of_descriptor_matchers.rst b/modules/features2d/doc/common_interfaces_of_descriptor_matchers.rst
index 2c2cf28..295cc83 100644 (file)
--- 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<Mat>& descriptors );
+        virtual void add( InputArrayOfArrays descriptors );
 
         const vector<Mat>& getTrainDescriptors() const;
         virtual void clear();
@@ -40,24 +40,24 @@ with an image set. ::
         /*
          * Group of methods to match descriptors from an image pair.
          */
-        void match( const Mat& queryDescriptors, const Mat& trainDescriptors,
-                    vector<DMatch>& matches, const Mat& mask=Mat() ) const;
-        void knnMatch( const Mat& queryDescriptors, const Mat& trainDescriptors,
+        void match( InputArray queryDescriptors, InputArray trainDescriptors,
+                    vector<DMatch>& matches, InputArray mask=noArray() ) const;
+        void knnMatch( InputArray queryDescriptors, InputArray trainDescriptors,
                        vector<vector<DMatch> >& matches, int k,
-                       const Mat& mask=Mat(), bool compactResult=false ) const;
-        void radiusMatch( const Mat& queryDescriptors, const Mat& trainDescriptors,
+                       InputArray mask=noArray(), bool compactResult=false ) const;
+        void radiusMatch( InputArray queryDescriptors, InputArray trainDescriptors,
                           vector<vector<DMatch> >& matches, float maxDistance,
-                          const Mat& mask=Mat(), bool compactResult=false ) const;
+                          InputArray mask=noArray(), bool compactResult=false ) const;
         /*
          * Group of methods to match descriptors from one image to an image set.
          */
-        void match( const Mat& queryDescriptors, vector<DMatch>& matches,
-                    const vector<Mat>& masks=vector<Mat>() );
-        void knnMatch( const Mat& queryDescriptors, vector<vector<DMatch> >& matches,
-                       int k, const vector<Mat>& masks=vector<Mat>(),
+        void match( InputArray queryDescriptors, vector<DMatch>& matches,
+                    InputArrayOfArrays masks=noArray() );
+        void knnMatch( InputArray queryDescriptors, vector<vector<DMatch> >& matches,
+                       int k, InputArrayOfArrays masks=noArray(),
                        bool compactResult=false );
-        void radiusMatch( const Mat& queryDescriptors, vector<vector<DMatch> >& matches,
-                          float maxDistance, const vector<Mat>& masks=vector<Mat>(),
+        void radiusMatch( InputArray queryDescriptors, vector<vector<DMatch> >& matches,
+                          float maxDistance, InputArrayOfArrays masks=noArray(),
                           bool compactResult=false );
 
         virtual void read( const FileNode& );
@@ -69,15 +69,16 @@ with an image set. ::
 
     protected:
         vector<Mat> trainDescCollection;
+        vector<UMat> 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<Mat>& 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<DMatch>& matches, const Mat& mask=Mat() ) const
+.. ocv:function:: void DescriptorMatcher::match( InputArray queryDescriptors, InputArray trainDescriptors, vector<DMatch>& matches, InputArray mask=noArray() ) const
 
-.. ocv:function:: void DescriptorMatcher::match( const Mat& queryDescriptors, vector<DMatch>& matches, const vector<Mat>& masks=vector<Mat>() )
+.. ocv:function:: void DescriptorMatcher::match(InputArray queryDescriptors, vector<DMatch>& matches, InputArrayOfArrays masks=noArray() )
 
     :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<vector<DMatch> >& matches,       int k, const Mat& 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( const Mat& 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,      InputArrayOfArrays masks=noArray(),       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<vector<DMatch> >& matches,           float maxDistance, const Mat& 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( const Mat& 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,      InputArrayOfArrays masks=noArray(),       bool compactResult=false )
 
     :param queryDescriptors: Query set of descriptors.
 
@@ -264,7 +265,7 @@ Flann-based descriptor matcher. This matcher trains :ocv:class:`flann::Index_` o
           const Ptr<flann::IndexParams>& indexParams=new flann::KDTreeIndexParams(),
           const Ptr<flann::SearchParams>& searchParams=new flann::SearchParams() );
 
-        virtual void add( const vector<Mat>& descriptors );
+        virtual void add( InputArrayOfArrays descriptors );
         virtual void clear();
 
         virtual void train();