FlannBasedMatcher Class OpenCvSharp Class Library
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.
Inheritance Hierarchy

SystemObject
  OpenCvSharpDisposableObject
    OpenCvSharpDisposableCvObject
      OpenCvSharp.CPlusPlusAlgorithm
        OpenCvSharp.CPlusPlusDescriptorMatcher
          OpenCvSharp.CPlusPlusFlannBasedMatcher

Namespace:  OpenCvSharp.CPlusPlus
Assembly:  OpenCvSharp.CPlusPlus (in OpenCvSharp.CPlusPlus.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax

public class FlannBasedMatcher : DescriptorMatcher

The FlannBasedMatcher type exposes the following members.

Constructors

  NameDescription
Public methodFlannBasedMatcher
Initializes a new instance of the FlannBasedMatcher class
Top
Properties

  NameDescription
Protected propertyAllocatedMemory
Gets or sets a memory address allocated by AllocMemory.
(Inherited from DisposableObject.)
Protected propertyAllocatedMemorySize
Gets or sets the byte length of the allocated memory
(Inherited from DisposableObject.)
Public propertyCvPtr
Native pointer of OpenCV structure
(Inherited from DisposableCvObject.)
Public propertyInfo
Algorithm information
(Inherited from Algorithm.)
Public propertyInfoPtr
Pointer to algorithm information (cv::AlgorithmInfo*)
(Overrides DescriptorMatcherInfoPtr.)
Public propertyIsDisposed
Gets a value indicating whether this instance has been disposed.
(Inherited from DisposableObject.)
Public propertyIsEnabledDispose
Gets or sets a value indicating whether you permit disposing this instance.
(Inherited from DisposableObject.)
Public propertyName
Returns the algorithm name
(Inherited from Algorithm.)
Top
Methods

  NameDescription
Public methodAdd
Add descriptors to train descriptor collection.
(Overrides DescriptorMatcherAdd(IEnumerableMat).)
Protected methodAllocGCHandle
Pins the object to be allocated by cvSetData.
(Inherited from DisposableObject.)
Protected methodAllocMemory
Allocates the specified size of memory.
(Inherited from DisposableObject.)
Public methodClear
Clear train descriptors collection.
(Overrides DescriptorMatcherClear.)
Public methodDispose
Releases the resources
(Inherited from DisposableObject.)
Protected methodDispose(Boolean)
Releases the resources
(Overrides DescriptorMatcherDispose(Boolean).)
Public methodEmpty
Return true if there are not train descriptors in collection.
(Inherited from DescriptorMatcher.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize
Destructor
(Inherited from DisposableObject.)
Public methodGetAlgorithm
Returns the algorithm parameter
(Inherited from Algorithm.)
Public methodGetBool
Returns the algorithm parameter
(Inherited from Algorithm.)
Public methodGetDouble
Returns the algorithm parameter
(Inherited from Algorithm.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetInt
Returns the algorithm parameter
(Inherited from Algorithm.)
Public methodGetMat
Returns the algorithm parameter
(Inherited from Algorithm.)
Public methodGetMatVector
Returns the algorithm parameter
(Inherited from Algorithm.)
Public methodGetParams
(Inherited from Algorithm.)
Public methodGetString
Returns the algorithm parameter
(Inherited from Algorithm.)
Public methodGetTrainDescriptors
Get train descriptors collection.
(Inherited from DescriptorMatcher.)
Public methodGetType (Inherited from Object.)
Public methodIsMaskSupported
Return true if the matcher supports mask in match methods.
(Overrides DescriptorMatcherIsMaskSupported.)
Public methodKnnMatch(Mat, Int32, Mat, Boolean)
Find k best matches for each query descriptor (in increasing order of distances). compactResult is used when mask is not empty. If compactResult is false matches vector will have the same size as queryDescriptors rows. If compactResult is true matches vector will not contain matches for fully masked out query descriptors.
(Inherited from DescriptorMatcher.)
Public methodKnnMatch(Mat, Mat, Int32, Mat, Boolean)
Find k best matches for each query descriptor (in increasing order of distances). compactResult is used when mask is not empty. If compactResult is false matches vector will have the same size as queryDescriptors rows. If compactResult is true matches vector will not contain matches for fully masked out query descriptors.
(Inherited from DescriptorMatcher.)
Public methodMatch(Mat, Mat)
Find one best match for each query descriptor (if mask is empty).
(Inherited from DescriptorMatcher.)
Public methodMatch(Mat, Mat, Mat)
Find one best match for each query descriptor (if mask is empty).
(Inherited from DescriptorMatcher.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodNotifyMemoryPressure
Notifies the allocated size of memory.
(Inherited from DisposableObject.)
Public methodParamHelp
(Inherited from Algorithm.)
Public methodParamType
(Inherited from Algorithm.)
Public methodRadiusMatch(Mat, Single, Mat, Boolean)
Find best matches for each query descriptor which have distance less than maxDistance (in increasing order of distances).
(Inherited from DescriptorMatcher.)
Public methodRadiusMatch(Mat, Mat, Single, Mat, Boolean)
Find best matches for each query descriptor which have distance less than maxDistance (in increasing order of distances).
(Inherited from DescriptorMatcher.)
Public methodRelease
Clean up any resources being used.
(Inherited from Algorithm.)
Public methodSetAlgorithm
Sets the algorithm parameter
(Inherited from Algorithm.)
Public methodSetBool
Sets the algorithm parameter
(Inherited from Algorithm.)
Public methodSetDouble
Sets the algorithm parameter
(Inherited from Algorithm.)
Public methodSetInt
Sets the algorithm parameter
(Inherited from Algorithm.)
Public methodSetMat
Sets the algorithm parameter
(Inherited from Algorithm.)
Public methodSetMatVector
Sets the algorithm parameter
(Inherited from Algorithm.)
Public methodSetString
Sets the algorithm parameter
(Inherited from Algorithm.)
Public methodThrowIfDisposed
If this object is disposed, then ObjectDisposedException is thrown.
(Inherited from DisposableObject.)
Public methodToString
Returns a string that represents this Algorithm.
(Inherited from Algorithm.)
Public methodTrain
Train matcher (e.g. train flann index). In all methods to match the method train() is run every time before matching. Some descriptor matchers (e.g. BruteForceMatcher) have empty implementation of this method, other matchers really train their inner structures (e.g. FlannBasedMatcher trains flann::Index). So nonempty implementation of train() should check the class object state and do traing/retraining only if the state requires that (e.g. FlannBasedMatcher trains flann::Index if it has not trained yet or if new descriptors have been added to the train collection).
(Overrides DescriptorMatcherTrain.)
Top
Fields

  NameDescription
Protected fielddataHandle
Gets or sets a handle which allocates using cvSetData.
(Inherited from DisposableObject.)
Protected fieldptr
Data pointer
(Inherited from DisposableCvObject.)
Top
See Also

Reference