Struct opencv::features2d::FlannBasedMatcher

pub struct FlannBasedMatcher { /* fields omitted */ }

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

Methods

impl FlannBasedMatcher

pub fn as_raw_FlannBasedMatcher(&self) -> *mut c_void

pub unsafe fn from_raw_ptr(ptr: *mut c_void) -> Self

impl FlannBasedMatcher

pub fn add(&mut self, descriptors: &VectorOfMat) -> Result<()>

pub fn clear(&mut self) -> Result<()>

pub fn train(&mut self) -> Result<()>

pub fn is_mask_supported(&self) -> Result<bool>

pub fn create() -> Result<PtrOfFlannBasedMatcher>

pub fn clone(&self, empty_train_data: bool) -> Result<PtrOfDescriptorMatcher>

C++ default parameters

• empty_train_data: false

Trait Implementations

impl Algorithm for FlannBasedMatcher

fn as_raw_Algorithm(&self) -> *mut c_void

fn clear(&mut self) -> Result<()>

Clears the algorithm state

fn empty(&self) -> Result<bool>

Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read

fn save(&self, filename: &str) -> Result<()>

Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).

fn get_default_name(&self) -> Result<String>

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.

impl DescriptorMatcher for FlannBasedMatcher

fn as_raw_DescriptorMatcher(&self) -> *mut c_void

fn add(&mut self, descriptors: &VectorOfMat) -> Result<()>

Adds descriptors to train a CPU(trainDescCollectionis) or GPU(utrainDescCollectionis) descriptor collection.

fn get_train_descriptors(&self) -> Result<VectorOfMat>

Returns a constant link to the train descriptor collection trainDescCollection .

fn clear(&mut self) -> Result<()>

Clears the train descriptor collections.

fn empty(&self) -> Result<bool>

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

fn is_mask_supported(&self) -> Result<bool>

Returns true if the descriptor matcher supports masking permissible matches.

fn train(&mut self) -> Result<()>

Trains a descriptor matcher

fn train_matches(
    &self,
    query_descriptors: &Mat,
    train_descriptors: &Mat,
    matches: &mut VectorOfDMatch,
    mask: &Mat
) -> Result<()>

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

fn knn_train_matches(
    &self,
    query_descriptors: &Mat,
    train_descriptors: &Mat,
    matches: &mut VectorOfVectorOfDMatch,
    k: i32,
    mask: &Mat,
    compact_result: bool
) -> Result<()>

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

fn train_radius_matches(
    &self,
    query_descriptors: &Mat,
    train_descriptors: &Mat,
    matches: &mut VectorOfVectorOfDMatch,
    max_distance: f32,
    mask: &Mat,
    compact_result: bool
) -> Result<()>

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

fn matches(
    &mut self,
    query_descriptors: &Mat,
    matches: &mut VectorOfDMatch,
    masks: &VectorOfMat
) -> Result<()>

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

fn knn_matches(
    &mut self,
    query_descriptors: &Mat,
    matches: &mut VectorOfVectorOfDMatch,
    k: i32,
    masks: &VectorOfMat,
    compact_result: bool
) -> Result<()>

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.

fn radius_matches(
    &mut self,
    query_descriptors: &Mat,
    matches: &mut VectorOfVectorOfDMatch,
    max_distance: f32,
    masks: &VectorOfMat,
    compact_result: bool
) -> Result<()>

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.

fn write(&self, file_name: &str) -> Result<()>

fn read(&mut self, file_name: &str) -> Result<()>

fn clone(&self, empty_train_data: bool) -> Result<PtrOfDescriptorMatcher>

Clones the matcher.

impl Send for FlannBasedMatcher

impl Drop for FlannBasedMatcher

fn drop(&mut self)

Executes the destructor for this type.