Flann-based descriptor matcher. More...
#include <opencv2/features2d.hpp>
Public Types | |
enum | MatcherType { FLANNBASED = 1, BRUTEFORCE = 2, BRUTEFORCE_L1 = 3, BRUTEFORCE_HAMMING = 4, BRUTEFORCE_HAMMINGLUT = 5, BRUTEFORCE_SL2 = 6 } |
Public Member Functions | |
FlannBasedMatcher (const Ptr< flann::IndexParams > &indexParams=makePtr< flann::KDTreeIndexParams >(), const Ptr< flann::SearchParams > &searchParams=makePtr< flann::SearchParams >()) | |
virtual void | add (InputArrayOfArrays descriptors) CV_OVERRIDE |
Adds descriptors to train a CPU(trainDescCollectionis) or GPU(utrainDescCollectionis) descriptor collection. More... | |
virtual void | clear () CV_OVERRIDE |
Clears the train descriptor collections. More... | |
virtual Ptr< DescriptorMatcher > | clone (bool emptyTrainData=false) const CV_OVERRIDE |
Clones the matcher. More... | |
virtual bool | empty () const CV_OVERRIDE |
Returns true if there are no train descriptors in the both collections. More... | |
virtual String | getDefaultName () const |
Returns the algorithm string identifier. More... | |
const std::vector< Mat > & | getTrainDescriptors () const |
Returns a constant link to the train descriptor collection trainDescCollection . More... | |
virtual bool | isMaskSupported () const CV_OVERRIDE |
Returns true if the descriptor matcher supports masking permissible matches. More... | |
void | knnMatch (InputArray queryDescriptors, InputArray trainDescriptors, std::vector< std::vector< DMatch > > &matches, int k, InputArray mask=noArray(), bool compactResult=false) const |
Finds the k best matches for each descriptor from a query set. More... | |
void | knnMatch (InputArray queryDescriptors, std::vector< std::vector< DMatch > > &matches, int k, InputArrayOfArrays masks=noArray(), bool compactResult=false) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
void | match (InputArray queryDescriptors, InputArray trainDescriptors, std::vector< DMatch > &matches, InputArray mask=noArray()) const |
Finds the best match for each descriptor from a query set. More... | |
void | match (InputArray queryDescriptors, std::vector< DMatch > &matches, InputArrayOfArrays masks=noArray()) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
void | radiusMatch (InputArray queryDescriptors, InputArray trainDescriptors, std::vector< std::vector< DMatch > > &matches, float maxDistance, InputArray mask=noArray(), bool compactResult=false) const |
For each query descriptor, finds the training descriptors not farther than the specified distance. More... | |
void | radiusMatch (InputArray queryDescriptors, std::vector< std::vector< DMatch > > &matches, float maxDistance, InputArrayOfArrays masks=noArray(), bool compactResult=false) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
void | read (const String &fileName) |
virtual void | read (const FileNode &) CV_OVERRIDE |
Reads algorithm parameters from a file storage. More... | |
virtual void | save (const String &filename) const |
Saves the algorithm to a file. More... | |
virtual void | train () CV_OVERRIDE |
Trains a descriptor matcher. More... | |
void | write (const String &fileName) const |
void | write (const Ptr< FileStorage > &fs, const String &name=String()) const |
virtual void | write (FileStorage &) const CV_OVERRIDE |
Stores algorithm parameters in a file storage. More... | |
Static Public Member Functions | |
static Ptr< DescriptorMatcher > | create (const String &descriptorMatcherType) |
Creates a descriptor matcher of a given type with the default parameters (using default constructor). More... | |
static Ptr< DescriptorMatcher > | create (const DescriptorMatcher::MatcherType &matcherType) |
static Ptr< FlannBasedMatcher > | create () |
template<typename _Tp > | |
static Ptr< _Tp > | load (const String &filename, const String &objname=String()) |
Loads algorithm from the file. More... | |
template<typename _Tp > | |
static Ptr< _Tp > | loadFromString (const String &strModel, const String &objname=String()) |
Loads algorithm from a String. More... | |
Protected Member Functions | |
void | checkMasks (InputArrayOfArrays masks, int queryDescriptorsCount) const |
virtual void | knnMatchImpl (InputArray queryDescriptors, std::vector< std::vector< DMatch > > &matches, int k, InputArrayOfArrays masks=noArray(), bool compactResult=false) CV_OVERRIDE |
In fact the matching is implemented only by the following two methods. More... | |
virtual void | radiusMatchImpl (InputArray queryDescriptors, std::vector< std::vector< DMatch > > &matches, float maxDistance, InputArrayOfArrays masks=noArray(), bool compactResult=false) CV_OVERRIDE |
void | writeFormat (FileStorage &fs) const |
Static Protected Member Functions | |
static Mat | clone_op (Mat m) |
static void | convertToDMatches (const DescriptorCollection &descriptors, const Mat &indices, const Mat &distances, std::vector< std::vector< DMatch > > &matches) |
static bool | isMaskedOut (InputArrayOfArrays masks, int queryIdx) |
static bool | isPossibleMatch (InputArray mask, int queryIdx, int trainIdx) |
Protected Attributes | |
int | addedDescCount |
Ptr< flann::Index > | flannIndex |
Ptr< flann::IndexParams > | indexParams |
DescriptorCollection | mergedDescriptors |
Ptr< flann::SearchParams > | searchParams |
std::vector< Mat > | trainDescCollection |
Collection of descriptors from train images. More... | |
std::vector< UMat > | utrainDescCollection |
Flann-based descriptor matcher.
This matcher trains cv::flann::Index on a train descriptor collection and calls its nearest search methods to find the best matches. So, this matcher may be faster when matching a large train collection than the brute force matcher. FlannBasedMatcher does not support masking permissible matches of descriptor sets because flann::Index does not support this. :
|
inherited |
cv::FlannBasedMatcher::FlannBasedMatcher | ( | const Ptr< flann::IndexParams > & | indexParams = makePtr< flann::KDTreeIndexParams >() , |
const Ptr< flann::SearchParams > & | searchParams = makePtr< flann::SearchParams >() |
||
) |
|
virtual |
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.
descriptors | Descriptors to add. Each descriptors[i] is a set of descriptors from the same train image. |
Reimplemented from cv::DescriptorMatcher.
|
protectedinherited |
|
virtual |
Clears the train descriptor collections.
Reimplemented from cv::DescriptorMatcher.
|
virtual |
Clones the matcher.
emptyTrainData | If emptyTrainData is false, the method creates a deep copy of the object, that is, copies both parameters and train data. If emptyTrainData is true, the method creates an object copy with the current parameters but with empty train data. |
Implements cv::DescriptorMatcher.
|
staticprotected |
|
staticinherited |
Creates a descriptor matcher of a given type with the default parameters (using default constructor).
descriptorMatcherType | Descriptor matcher type. Now the following matcher types are supported:
|
|
staticinherited |
|
static |
|
virtualinherited |
Returns true if there are no train descriptors in the both collections.
Reimplemented from cv::Algorithm.
|
virtualinherited |
Returns the algorithm string identifier.
This string is used as top level xml/yml node tag when the object is saved to a file or string.
Reimplemented in cv::AKAZE, cv::KAZE, cv::SimpleBlobDetector, cv::GFTTDetector, cv::AgastFeatureDetector, cv::FastFeatureDetector, cv::MSER, cv::ORB, cv::BRISK, and cv::Feature2D.
|
inherited |
Returns a constant link to the train descriptor collection trainDescCollection .
|
staticprotectedinherited |
|
virtual |
Returns true if the descriptor matcher supports masking permissible matches.
Implements cv::DescriptorMatcher.
|
staticprotectedinherited |
|
inherited |
Finds the k best matches for each descriptor from a query set.
queryDescriptors | Query set of descriptors. |
trainDescriptors | Train set of descriptors. This set is not added to the train descriptors collection stored in the class object. |
mask | Mask specifying permissible matches between an input query and train matrices of descriptors. |
matches | Matches. Each matches[i] is k or less matches for the same query descriptor. |
k | Count of best matches found per each query descriptor or less if a query descriptor has less than k possible matches in total. |
compactResult | Parameter used when the mask (or masks) is not empty. If compactResult is false, the matches vector has the same size as queryDescriptors rows. If compactResult is true, the matches vector does not contain matches for fully masked-out query descriptors. |
These extended variants of DescriptorMatcher::match methods find several best matches for each query descriptor. The matches are returned in the distance increasing order. See DescriptorMatcher::match for the details about query and train descriptors.
|
inherited |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
queryDescriptors | Query set of descriptors. |
matches | Matches. Each matches[i] is k or less matches for the same query descriptor. |
k | Count of best matches found per each query descriptor or less if a query descriptor has less than k possible matches in total. |
masks | Set of masks. Each masks[i] specifies permissible matches between the input query descriptors and stored train descriptors from the i-th image trainDescCollection[i]. |
compactResult | Parameter used when the mask (or masks) is not empty. If compactResult is false, the matches vector has the same size as queryDescriptors rows. If compactResult is true, the matches vector does not contain matches for fully masked-out query descriptors. |
|
protectedvirtual |
In fact the matching is implemented only by the following two methods.
These methods suppose that the class object has been trained already. Public match methods call these methods after calling train().
Implements cv::DescriptorMatcher.
|
inlinestaticinherited |
Loads algorithm from the file.
filename | Name of the file to read. |
objname | The optional name of the node to read (if empty, the first top-level node will be used) |
This is static template method of Algorithm. It's usage is following (in the case of SVM):
In order to make this method work, the derived class must overwrite Algorithm::read(const FileNode& fn).
References CV_Assert, cv::FileNode::empty(), cv::FileStorage::getFirstTopLevelNode(), cv::FileStorage::isOpened(), and cv::FileStorage::READ.
|
inlinestaticinherited |
Loads algorithm from a String.
strModel | The string variable containing the model you want to load. |
objname | The optional name of the node to read (if empty, the first top-level node will be used) |
This is static template method of Algorithm. It's usage is following (in the case of SVM):
References CV_WRAP, cv::FileNode::empty(), cv::FileStorage::getFirstTopLevelNode(), cv::FileStorage::MEMORY, and cv::FileStorage::READ.
|
inherited |
Finds the best match for each descriptor from a query set.
queryDescriptors | Query set of descriptors. |
trainDescriptors | Train set of descriptors. This set is not added to the train descriptors collection stored in the class object. |
matches | Matches. If a query descriptor is masked out in mask , no match is added for this descriptor. So, matches size may be smaller than the query descriptors count. |
mask | Mask specifying permissible matches between an input query and train matrices of descriptors. |
In the first variant of this method, the train descriptors are passed as an input argument. In the second variant of the method, train descriptors collection that was set by DescriptorMatcher::add is used. Optional mask (or masks) can be passed to specify which query and training descriptors can be matched. Namely, queryDescriptors[i] can be matched with trainDescriptors[j] only if mask.at<uchar>(i,j) is non-zero.
|
inherited |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
queryDescriptors | Query set of descriptors. |
matches | Matches. If a query descriptor is masked out in mask , no match is added for this descriptor. So, matches size may be smaller than the query descriptors count. |
masks | Set of masks. Each masks[i] specifies permissible matches between the input query descriptors and stored train descriptors from the i-th image trainDescCollection[i]. |
|
inherited |
For each query descriptor, finds the training descriptors not farther than the specified distance.
queryDescriptors | Query set of descriptors. |
trainDescriptors | Train set of descriptors. This set is not added to the train descriptors collection stored in the class object. |
matches | Found matches. |
compactResult | Parameter used when the mask (or masks) is not empty. If compactResult is false, the matches vector has the same size as queryDescriptors rows. If compactResult is true, the matches vector does not contain matches for fully masked-out query descriptors. |
maxDistance | Threshold for the distance between matched descriptors. Distance means here metric distance (e.g. Hamming distance), not the distance between coordinates (which is measured in Pixels)! |
mask | Mask specifying permissible matches between an input query and train matrices of descriptors. |
For each query descriptor, the methods find such training descriptors that the distance between the query descriptor and the training descriptor is equal or smaller than maxDistance. Found matches are returned in the distance increasing order.
|
inherited |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
queryDescriptors | Query set of descriptors. |
matches | Found matches. |
maxDistance | Threshold for the distance between matched descriptors. Distance means here metric distance (e.g. Hamming distance), not the distance between coordinates (which is measured in Pixels)! |
masks | Set of masks. Each masks[i] specifies permissible matches between the input query descriptors and stored train descriptors from the i-th image trainDescCollection[i]. |
compactResult | Parameter used when the mask (or masks) is not empty. If compactResult is false, the matches vector has the same size as queryDescriptors rows. If compactResult is true, the matches vector does not contain matches for fully masked-out query descriptors. |
|
protectedvirtual |
Implements cv::DescriptorMatcher.
|
inlineinherited |
References CV_OVERRIDE, CV_WRAP, cv::FileStorage::READ, and cv::FileStorage::root().
|
virtual |
Reads algorithm parameters from a file storage.
Reimplemented from cv::DescriptorMatcher.
|
virtualinherited |
Saves the algorithm to a file.
In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).
|
virtual |
Trains a descriptor matcher.
Trains a descriptor matcher (for example, the flann index). In all methods to match, the method train() is run every time before matching. Some descriptor matchers (for example, BruteForceMatcher) have an empty implementation of this method. Other matchers really train their inner structures (for example, FlannBasedMatcher trains flann::Index ).
Reimplemented from cv::DescriptorMatcher.
|
inlineinherited |
References cv::FileStorage::WRITE.
|
inlineinherited |
|
virtual |
Stores algorithm parameters in a file storage.
Reimplemented from cv::DescriptorMatcher.
|
protectedinherited |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protectedinherited |
Collection of descriptors from train images.
|
protectedinherited |