org.bytedeco.javacpp

Class opencv_features2d.DescriptorMatcher

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.opencv_core.Algorithm

org.bytedeco.javacpp.opencv_features2d.DescriptorMatcher

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

opencv_features2d.BFMatcher, opencv_features2d.FlannBasedMatcher

Enclosing class:

opencv_features2d

@Namespace(value="cv")
@NoOffset
public static class opencv_features2d.DescriptorMatcher
extends opencv_core.Algorithm

\addtogroup features2d_match /** \{

/** \brief Abstract base class for matching keypoint descriptors.

It has two groups of match methods: for matching descriptors of an image with another image or with an image set.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
opencv_features2d.DescriptorMatcher(Pointer p) Pointer cast constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(opencv_core.MatVector descriptors) \brief Adds descriptors to train a CPU(trainDescCollectionis) or GPU(utrainDescCollectionis) descriptor collection.
void	clear() \brief Clears the train descriptor collections.
opencv_features2d.DescriptorMatcher	clone()
opencv_features2d.DescriptorMatcher	clone(boolean emptyTrainData) \brief Clones the matcher.
static opencv_features2d.DescriptorMatcher	create(BytePointer descriptorMatcherType) \brief Creates a descriptor matcher of a given type with the default parameters (using default constructor).
static opencv_features2d.DescriptorMatcher	create(String descriptorMatcherType)
boolean	empty() \brief Returns true if there are no train descriptors in the both collections.
opencv_core.MatVector	getTrainDescriptors() \brief Returns a constant link to the train descriptor collection trainDescCollection .
boolean	isMaskSupported() \brief Returns true if the descriptor matcher supports masking permissible matches.
void	knnMatch(opencv_core.Mat queryDescriptors, opencv_core.DMatchVectorVector matches, int k)
void	knnMatch(opencv_core.Mat queryDescriptors, opencv_core.DMatchVectorVector matches, int k, opencv_core.MatVector masks, boolean compactResult) \overload
void	knnMatch(opencv_core.Mat queryDescriptors, opencv_core.Mat trainDescriptors, opencv_core.DMatchVectorVector matches, int k)
void	knnMatch(opencv_core.Mat queryDescriptors, opencv_core.Mat trainDescriptors, opencv_core.DMatchVectorVector matches, int k, opencv_core.Mat mask, boolean compactResult) \brief Finds the k best matches for each descriptor from a query set.
void	match(opencv_core.Mat queryDescriptors, opencv_core.DMatchVector matches)
void	match(opencv_core.Mat queryDescriptors, opencv_core.DMatchVector matches, opencv_core.MatVector masks) \overload
void	match(opencv_core.Mat queryDescriptors, opencv_core.Mat trainDescriptors, opencv_core.DMatchVector matches)
void	match(opencv_core.Mat queryDescriptors, opencv_core.Mat trainDescriptors, opencv_core.DMatchVector matches, opencv_core.Mat mask) \brief Finds the best match for each descriptor from a query set.
void	radiusMatch(opencv_core.Mat queryDescriptors, opencv_core.DMatchVectorVector matches, float maxDistance)
void	radiusMatch(opencv_core.Mat queryDescriptors, opencv_core.DMatchVectorVector matches, float maxDistance, opencv_core.MatVector masks, boolean compactResult) \overload
void	radiusMatch(opencv_core.Mat queryDescriptors, opencv_core.Mat trainDescriptors, opencv_core.DMatchVectorVector matches, float maxDistance)
void	radiusMatch(opencv_core.Mat queryDescriptors, opencv_core.Mat trainDescriptors, opencv_core.DMatchVectorVector matches, float maxDistance, opencv_core.Mat mask, boolean compactResult) \brief For each query descriptor, finds the training descriptors not farther than the specified distance.
void	read(opencv_core.FileNode arg0) \brief Reads algorithm parameters from a file storage
void	train() \brief Trains a descriptor matcher
void	write(opencv_core.FileStorage arg0) \brief Stores algorithm parameters in a file storage

Methods inherited from class org.bytedeco.javacpp.opencv_core.Algorithm

getDefaultName, position, save, save

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, hashCode, isNull, limit, limit, maxBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, position, put, setNull, sizeof, toString, totalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

opencv_features2d.DescriptorMatcher

public opencv_features2d.DescriptorMatcher(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Method Detail

add

public void add(@ByVal
       opencv_core.MatVector descriptors)

\brief 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.

Parameters:

descriptors - Descriptors to add. Each descriptors[i] is a set of descriptors from the same train image.

getTrainDescriptors

@Const
@ByRef
public opencv_core.MatVector getTrainDescriptors()

\brief Returns a constant link to the train descriptor collection trainDescCollection .

clear

public void clear()

\brief Clears the train descriptor collections.

Overrides:

clear in class opencv_core.Algorithm

empty

@Cast(value="bool")
public boolean empty()

\brief Returns true if there are no train descriptors in the both collections.

Overrides:

empty in class opencv_core.Algorithm

isMaskSupported

@Cast(value="bool")
public boolean isMaskSupported()

\brief Returns true if the descriptor matcher supports masking permissible matches.

train

public void train()

\brief 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 ).

match

public void match(@ByVal
         opencv_core.Mat queryDescriptors,
         @ByVal
         opencv_core.Mat trainDescriptors,
         @ByRef
         opencv_core.DMatchVector matches,
         @ByVal(nullValue="cv::noArray()")
         opencv_core.Mat mask)

\brief Finds the best match for each descriptor from a query set.

Parameters:

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\(i,j) is non-zero.

match

public void match(@ByVal
         opencv_core.Mat queryDescriptors,
         @ByVal
         opencv_core.Mat trainDescriptors,
         @ByRef
         opencv_core.DMatchVector matches)

knnMatch

public void knnMatch(@ByVal
            opencv_core.Mat queryDescriptors,
            @ByVal
            opencv_core.Mat trainDescriptors,
            @ByRef
            opencv_core.DMatchVectorVector matches,
            int k,
            @ByVal(nullValue="cv::noArray()")
            opencv_core.Mat mask,
            @Cast(value="bool")
            boolean compactResult)

\brief Finds the k best matches for each descriptor from a query set.

Parameters:

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.

knnMatch

public void knnMatch(@ByVal
            opencv_core.Mat queryDescriptors,
            @ByVal
            opencv_core.Mat trainDescriptors,
            @ByRef
            opencv_core.DMatchVectorVector matches,
            int k)

radiusMatch

public void radiusMatch(@ByVal
               opencv_core.Mat queryDescriptors,
               @ByVal
               opencv_core.Mat trainDescriptors,
               @ByRef
               opencv_core.DMatchVectorVector matches,
               float maxDistance,
               @ByVal(nullValue="cv::noArray()")
               opencv_core.Mat mask,
               @Cast(value="bool")
               boolean compactResult)

\brief For each query descriptor, finds the training descriptors not farther than the specified distance.

Parameters:

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.

radiusMatch

public void radiusMatch(@ByVal
               opencv_core.Mat queryDescriptors,
               @ByVal
               opencv_core.Mat trainDescriptors,
               @ByRef
               opencv_core.DMatchVectorVector matches,
               float maxDistance)

match

public void match(@ByVal
         opencv_core.Mat queryDescriptors,
         @ByRef
         opencv_core.DMatchVector matches,
         @ByVal(nullValue="cv::noArray()")
         opencv_core.MatVector masks)

\overload

Parameters:

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].

match

public void match(@ByVal
         opencv_core.Mat queryDescriptors,
         @ByRef
         opencv_core.DMatchVector matches)

knnMatch

public void knnMatch(@ByVal
            opencv_core.Mat queryDescriptors,
            @ByRef
            opencv_core.DMatchVectorVector matches,
            int k,
            @ByVal(nullValue="cv::noArray()")
            opencv_core.MatVector masks,
            @Cast(value="bool")
            boolean compactResult)

\overload

Parameters:

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.

knnMatch

public void knnMatch(@ByVal
            opencv_core.Mat queryDescriptors,
            @ByRef
            opencv_core.DMatchVectorVector matches,
            int k)

radiusMatch

public void radiusMatch(@ByVal
               opencv_core.Mat queryDescriptors,
               @ByRef
               opencv_core.DMatchVectorVector matches,
               float maxDistance,
               @ByVal(nullValue="cv::noArray()")
               opencv_core.MatVector masks,
               @Cast(value="bool")
               boolean compactResult)

\overload

Parameters:

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.

radiusMatch

public void radiusMatch(@ByVal
               opencv_core.Mat queryDescriptors,
               @ByRef
               opencv_core.DMatchVectorVector matches,
               float maxDistance)

read

public void read(@Const@ByRef
        opencv_core.FileNode arg0)

Description copied from class: opencv_core.Algorithm

\brief Reads algorithm parameters from a file storage

Overrides:

read in class opencv_core.Algorithm

write

public void write(@ByRef
         opencv_core.FileStorage arg0)

Description copied from class: opencv_core.Algorithm

\brief Stores algorithm parameters in a file storage

Overrides:

write in class opencv_core.Algorithm

clone

@opencv_core.Ptr
public opencv_features2d.DescriptorMatcher clone(@Cast(value="bool")
                                                        boolean emptyTrainData)

\brief Clones the matcher.

Parameters:

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.

clone

@opencv_core.Ptr
public opencv_features2d.DescriptorMatcher clone()

Overrides:

clone in class Object

create

@opencv_core.Ptr
public static opencv_features2d.DescriptorMatcher create(@opencv_core.Str
                                                         BytePointer descriptorMatcherType)

\brief Creates a descriptor matcher of a given type with the default parameters (using default constructor).

Parameters:

descriptorMatcherType - Descriptor matcher type. Now the following matcher types are supported: - BruteForce (it uses L2 ) - BruteForce-L1 - BruteForce-Hamming - BruteForce-Hamming(2) - FlannBased

create

@opencv_core.Ptr
public static opencv_features2d.DescriptorMatcher create(@opencv_core.Str
                                                         String descriptorMatcherType)