OpenCVForUnity.Features2dModule.BFMatcher Class Reference

Brute-force descriptor matcher. More...

Public Member Functions
	BFMatcher ()
	Brute-force matcher constructor (obsolete). Please use BFMatcher.create()
	BFMatcher (int normType)
	Brute-force matcher constructor (obsolete). Please use BFMatcher.create()
	BFMatcher (int normType, bool crossCheck)
	Brute-force matcher constructor (obsolete). Please use BFMatcher.create()
Public Member Functions inherited from OpenCVForUnity.Features2dModule.DescriptorMatcher
void	add (List< Mat > descriptors)
	Adds descriptors to train a CPU(trainDescCollectionis) or GPU(utrainDescCollectionis) descriptor collection.
override void	clear ()
	Clears the train descriptor collections.
DescriptorMatcher	clone ()
	Clones the matcher.
DescriptorMatcher	clone (bool emptyTrainData)
	Clones the matcher.
override bool	empty ()
	Returns true if there are no train descriptors in the both collections.
List< Mat >	getTrainDescriptors ()
	Returns a constant link to the train descriptor collection trainDescCollection .
bool	isMaskSupported ()
	Returns true if the descriptor matcher supports masking permissible matches.
void	knnMatch (Mat queryDescriptors, List< MatOfDMatch > matches, int k)
void	knnMatch (Mat queryDescriptors, List< MatOfDMatch > matches, int k, List< Mat > masks)
void	knnMatch (Mat queryDescriptors, List< MatOfDMatch > matches, int k, List< Mat > masks, bool compactResult)
void	knnMatch (Mat queryDescriptors, Mat trainDescriptors, List< MatOfDMatch > matches, int k)
	Finds the k best matches for each descriptor from a query set.
void	knnMatch (Mat queryDescriptors, Mat trainDescriptors, List< MatOfDMatch > matches, int k, Mat mask)
	Finds the k best matches for each descriptor from a query set.
void	knnMatch (Mat queryDescriptors, Mat trainDescriptors, List< MatOfDMatch > matches, int k, Mat mask, bool compactResult)
	Finds the k best matches for each descriptor from a query set.
void	match (Mat queryDescriptors, Mat trainDescriptors, MatOfDMatch matches)
	Finds the best match for each descriptor from a query set.
void	match (Mat queryDescriptors, Mat trainDescriptors, MatOfDMatch matches, Mat mask)
	Finds the best match for each descriptor from a query set.
void	match (Mat queryDescriptors, MatOfDMatch matches)
void	match (Mat queryDescriptors, MatOfDMatch matches, List< Mat > masks)
void	radiusMatch (Mat queryDescriptors, List< MatOfDMatch > matches, float maxDistance)
void	radiusMatch (Mat queryDescriptors, List< MatOfDMatch > matches, float maxDistance, List< Mat > masks)
void	radiusMatch (Mat queryDescriptors, List< MatOfDMatch > matches, float maxDistance, List< Mat > masks, bool compactResult)
void	radiusMatch (Mat queryDescriptors, Mat trainDescriptors, List< MatOfDMatch > matches, float maxDistance)
	For each query descriptor, finds the training descriptors not farther than the specified distance.
void	radiusMatch (Mat queryDescriptors, Mat trainDescriptors, List< MatOfDMatch > matches, float maxDistance, Mat mask)
	For each query descriptor, finds the training descriptors not farther than the specified distance.
void	radiusMatch (Mat queryDescriptors, Mat trainDescriptors, List< MatOfDMatch > matches, float maxDistance, Mat mask, bool compactResult)
	For each query descriptor, finds the training descriptors not farther than the specified distance.
void	read (string fileName)
void	train ()
	Trains a descriptor matcher.
void	write (string fileName)
Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
virtual string	getDefaultName ()
IntPtr	getNativeObjAddr ()
void	save (string filename)
Public Member Functions inherited from OpenCVForUnity.DisposableObject
void	Dispose ()
void	ThrowIfDisposed ()

Static Public Member Functions
static new BFMatcher	__fromPtr__ (IntPtr addr)
static BFMatcher	create ()
	Brute-force matcher create method.
static new BFMatcher	create (int normType)
	Brute-force matcher create method.
static BFMatcher	create (int normType, bool crossCheck)
	Brute-force matcher create method.
Static Public Member Functions inherited from OpenCVForUnity.Features2dModule.DescriptorMatcher
static new DescriptorMatcher	__fromPtr__ (IntPtr addr)
static DescriptorMatcher	create (int matcherType)
static DescriptorMatcher	create (string descriptorMatcherType)
	Creates a descriptor matcher of a given type with the default parameters (using default constructor).
Static Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
static Algorithm	__fromPtr__ (IntPtr addr)
Static Public Member Functions inherited from OpenCVForUnity.DisposableObject
static IntPtr	ThrowIfNullIntPtr (IntPtr ptr)

Protected Member Functions
override void	Dispose (bool disposing)
Protected Member Functions inherited from OpenCVForUnity.Features2dModule.DescriptorMatcher
override void	Dispose (bool disposing)
Protected Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
	DisposableOpenCVObject ()
	DisposableOpenCVObject (bool isEnabledDispose)
	DisposableOpenCVObject (IntPtr ptr)
	DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)
override void	Dispose (bool disposing)
Protected Member Functions inherited from OpenCVForUnity.DisposableObject
	DisposableObject ()
	DisposableObject (bool isEnabledDispose)

Additional Inherited Members
Static Public Attributes inherited from OpenCVForUnity.Features2dModule.DescriptorMatcher
const int	BRUTEFORCE = 2
const int	BRUTEFORCE_HAMMING = 4
const int	BRUTEFORCE_HAMMINGLUT = 5
const int	BRUTEFORCE_L1 = 3
const int	BRUTEFORCE_SL2 = 6
const int	FLANNBASED = 1
Package Functions inherited from OpenCVForUnity.Features2dModule.DescriptorMatcher
Package Functions inherited from OpenCVForUnity.CoreModule.Algorithm
Package Attributes inherited from OpenCVForUnity.DisposableOpenCVObject
Properties inherited from OpenCVForUnity.DisposableObject
bool	IsDisposed [get, protected set]
bool	IsEnabledDispose [get, set]

Detailed Description

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. This descriptor matcher supports masking permissible matches of descriptor sets.

Constructor & Destructor Documentation

BFMatcher() [1/3]

OpenCVForUnity.Features2dModule.BFMatcher.BFMatcher	(	int	normType,
		bool	crossCheck )

Brute-force matcher constructor (obsolete). Please use BFMatcher.create()

BFMatcher() [2/3]

OpenCVForUnity.Features2dModule.BFMatcher.BFMatcher

(

int

normType

)

Brute-force matcher constructor (obsolete). Please use BFMatcher.create()

BFMatcher() [3/3]

OpenCVForUnity.Features2dModule.BFMatcher.BFMatcher

(

)

Brute-force matcher constructor (obsolete). Please use BFMatcher.create()

Member Function Documentation

__fromPtr__()

static new BFMatcher OpenCVForUnity.Features2dModule.BFMatcher.__fromPtr__ ( IntPtr addr )

static

create() [1/3]

static BFMatcher OpenCVForUnity.Features2dModule.BFMatcher.create ( )

static

Brute-force matcher create method.

Parameters

normType

One of NORM_L1, NORM_L2, NORM_HAMMING, NORM_HAMMING2. L1 and L2 norms are preferable choices for SIFT and SURF descriptors, NORM_HAMMING should be used with ORB, BRISK and BRIEF, NORM_HAMMING2 should be used with ORB when WTA_K==3 or 4 (see ORB.ORB constructor description).

crossCheck

If it is false, this is will be default BFMatcher behaviour when it finds the k nearest neighbors for each query descriptor. If crossCheck==true, then the knnMatch() method with k=1 will only return pairs (i,j) such that for i-th query descriptor the j-th descriptor in the matcher's collection is the nearest and vice versa, i.e. the BFMatcher will only return consistent pairs. Such technique usually produces best results with minimal number of outliers when there are enough matches. This is alternative to the ratio test, used by D. Lowe in SIFT paper.

create() [2/3]

static new BFMatcher OpenCVForUnity.Features2dModule.BFMatcher.create ( int normType )

static

Brute-force matcher create method.

Parameters

normType

One of NORM_L1, NORM_L2, NORM_HAMMING, NORM_HAMMING2. L1 and L2 norms are preferable choices for SIFT and SURF descriptors, NORM_HAMMING should be used with ORB, BRISK and BRIEF, NORM_HAMMING2 should be used with ORB when WTA_K==3 or 4 (see ORB.ORB constructor description).

crossCheck

If it is false, this is will be default BFMatcher behaviour when it finds the k nearest neighbors for each query descriptor. If crossCheck==true, then the knnMatch() method with k=1 will only return pairs (i,j) such that for i-th query descriptor the j-th descriptor in the matcher's collection is the nearest and vice versa, i.e. the BFMatcher will only return consistent pairs. Such technique usually produces best results with minimal number of outliers when there are enough matches. This is alternative to the ratio test, used by D. Lowe in SIFT paper.

create() [3/3]

static BFMatcher OpenCVForUnity.Features2dModule.BFMatcher.create ( int normType, bool crossCheck )

static

Brute-force matcher create method.

Parameters

normType

One of NORM_L1, NORM_L2, NORM_HAMMING, NORM_HAMMING2. L1 and L2 norms are preferable choices for SIFT and SURF descriptors, NORM_HAMMING should be used with ORB, BRISK and BRIEF, NORM_HAMMING2 should be used with ORB when WTA_K==3 or 4 (see ORB.ORB constructor description).

crossCheck

If it is false, this is will be default BFMatcher behaviour when it finds the k nearest neighbors for each query descriptor. If crossCheck==true, then the knnMatch() method with k=1 will only return pairs (i,j) such that for i-th query descriptor the j-th descriptor in the matcher's collection is the nearest and vice versa, i.e. the BFMatcher will only return consistent pairs. Such technique usually produces best results with minimal number of outliers when there are enough matches. This is alternative to the ratio test, used by D. Lowe in SIFT paper.

Dispose()

override void OpenCVForUnity.Features2dModule.BFMatcher.Dispose ( bool disposing )

protectedvirtual

Reimplemented from OpenCVForUnity.CoreModule.Algorithm.

---

The documentation for this class was generated from the following file:

• OpenCVForUnity/Assets/OpenCVForUnity/org/opencv/features2d/BFMatcher.cs