org.bytedeco.opencv.opencv_features2d

Class FlannBasedMatcher

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_core.Algorithm

org.bytedeco.opencv.opencv_features2d.DescriptorMatcher

org.bytedeco.opencv.opencv_features2d.FlannBasedMatcher

All Implemented Interfaces:

AutoCloseable

@Namespace(value="cv")
 @NoOffset
 @Properties(inherit=opencv_features2d.class)
public class FlannBasedMatcher
extends DescriptorMatcher

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

Nested Class Summary

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

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.opencv.opencv_features2d.DescriptorMatcher

BRUTEFORCE, BRUTEFORCE_HAMMING, BRUTEFORCE_HAMMINGLUT, BRUTEFORCE_L1, BRUTEFORCE_SL2, FLANNBASED

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
FlannBasedMatcher()
FlannBasedMatcher(IndexParams indexParams, SearchParams searchParams)
FlannBasedMatcher(long size) Native array allocator.
FlannBasedMatcher(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
void	add(GpuMatVector descriptors)
void	add(MatVector descriptors) \brief Adds descriptors to train a CPU(trainDescCollectionis) or GPU(utrainDescCollectionis) descriptor collection.
void	add(UMatVector descriptors)
void	clear() \brief Clears the train descriptor collections.
DescriptorMatcher	clone()
DescriptorMatcher	clone(boolean emptyTrainData) \brief Clones the matcher.
static FlannBasedMatcher	create()
boolean	isMaskSupported() \brief Returns true if the descriptor matcher supports masking permissible matches.
FlannBasedMatcher	position(long position)
void	read(FileNode arg0) \brief Reads algorithm parameters from a file storage
void	train() \brief Trains a descriptor matcher
void	write(FileStorage arg0) \brief Stores algorithm parameters in a file storage

Methods inherited from class org.bytedeco.opencv.opencv_features2d.DescriptorMatcher

create, create, create, empty, getTrainDescriptors, knnMatch, knnMatch, knnMatch, knnMatch, knnMatch, knnMatch, knnMatch, knnMatch, knnMatch, knnMatch, knnMatch, knnMatch, knnMatch, knnMatch, knnMatch, knnMatch, knnMatch, knnMatch, match, match, match, match, match, match, match, match, match, match, match, match, match, match, match, match, match, match, radiusMatch, radiusMatch, radiusMatch, radiusMatch, radiusMatch, radiusMatch, radiusMatch, radiusMatch, radiusMatch, radiusMatch, radiusMatch, radiusMatch, radiusMatch, radiusMatch, radiusMatch, radiusMatch, radiusMatch, radiusMatch, read, read, write, write, write, write

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

getDefaultName, save, save

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

FlannBasedMatcher

public FlannBasedMatcher(Pointer p)

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

FlannBasedMatcher

public FlannBasedMatcher(long size)

Native array allocator. Access with Pointer.position(long).

FlannBasedMatcher

public FlannBasedMatcher(@opencv_core.Ptr
                         IndexParams indexParams,
                         @opencv_core.Ptr
                         SearchParams searchParams)

FlannBasedMatcher

public FlannBasedMatcher()

Method Detail

position

public FlannBasedMatcher position(long position)

Overrides:

position in class Algorithm

add

public void add(@ByVal
                MatVector descriptors)

Description copied from class: DescriptorMatcher

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

Overrides:

add in class DescriptorMatcher

Parameters:

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

add

public void add(@ByVal
                UMatVector descriptors)

Overrides:

add in class DescriptorMatcher

add

public void add(@ByVal
                GpuMatVector descriptors)

Overrides:

add in class DescriptorMatcher

clear

public void clear()

Description copied from class: DescriptorMatcher

\brief Clears the train descriptor collections.

Overrides:

clear in class DescriptorMatcher

read

public void read(@Const @ByRef
                 FileNode arg0)

Description copied from class: Algorithm

\brief Reads algorithm parameters from a file storage

Overrides:

read in class DescriptorMatcher

write

public void write(@ByRef
                  FileStorage arg0)

Description copied from class: Algorithm

\brief Stores algorithm parameters in a file storage

Overrides:

write in class DescriptorMatcher

train

public void train()

Description copied from class: DescriptorMatcher

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

Overrides:

train in class DescriptorMatcher

isMaskSupported

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

Description copied from class: DescriptorMatcher

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

Overrides:

isMaskSupported in class DescriptorMatcher

create

@opencv_core.Ptr
public static FlannBasedMatcher create()

clone

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

Description copied from class: DescriptorMatcher

\brief Clones the matcher.

Overrides:

clone in class DescriptorMatcher

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 DescriptorMatcher clone()

Overrides:

clone in class DescriptorMatcher