Struct opencv::features2d::FlannBasedMatcher

pub struct FlannBasedMatcher { /* private fields */ }

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

Implementations

impl FlannBasedMatcher

pub fn new( index_params: &Ptr<IndexParams>, search_params: &Ptr<SearchParams> ) -> Result<FlannBasedMatcher>

C++ default parameters

• index_params: makePtrflann::KDTreeIndexParams()
• search_params: makePtrflann::SearchParams()

pub fn new_def() -> Result<FlannBasedMatcher>

Note

This alternative version of [new] function uses the following default values for its arguments:

• index_params: makePtrflann::KDTreeIndexParams()
• search_params: makePtrflann::SearchParams()

pub fn create() -> Result<Ptr<FlannBasedMatcher>>

Trait Implementations

impl AlgorithmTrait for FlannBasedMatcher

fn as_raw_mut_Algorithm(&mut self) -> *mut c_void

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

Clears the algorithm state

fn read(&mut self, fn_: &impl FileNodeTraitConst) -> Result<()>

Reads algorithm parameters from a file storage

impl AlgorithmTraitConst for FlannBasedMatcher

fn as_raw_Algorithm(&self) -> *const c_void

fn write(&self, fs: &mut impl FileStorageTrait) -> Result<()>

Stores algorithm parameters in a file storage

fn write_1(&self, fs: &mut impl FileStorageTrait, name: &str) -> Result<()>

Stores algorithm parameters in a file storage

fn write_with_name(&self, fs: &Ptr<FileStorage>, name: &str) -> Result<()>

@deprecated

fn write_with_name_def(&self, fs: &Ptr<FileStorage>) -> Result<()>

👎Deprecated:

Note

Deprecated: ## Note This alternative version of AlgorithmTraitConst::write_with_name function uses the following default values for its arguments:

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 Boxed for FlannBasedMatcher

unsafe fn from_raw( ptr: <FlannBasedMatcher as OpenCVFromExtern>::ExternReceive ) -> Self

Wrap the specified raw pointer

fn into_raw( self ) -> <FlannBasedMatcher as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <FlannBasedMatcher as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut( &mut self ) -> <FlannBasedMatcher as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Debug for FlannBasedMatcher

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DescriptorMatcherTrait for FlannBasedMatcher

fn as_raw_mut_DescriptorMatcher(&mut self) -> *mut c_void

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

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

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

Clears the train descriptor collections.

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

Trains a descriptor matcher

fn match_( &mut self, query_descriptors: &impl ToInputArray, matches: &mut Vector<DMatch>, masks: &impl ToInputArray ) -> Result<()>

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

fn match__def( &mut self, query_descriptors: &impl ToInputArray, matches: &mut Vector<DMatch> ) -> Result<()>

@overload

fn knn_match( &mut self, query_descriptors: &impl ToInputArray, matches: &mut Vector<Vector<DMatch>>, k: i32, masks: &impl ToInputArray, compact_result: bool ) -> Result<()>

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

fn knn_match_def( &mut self, query_descriptors: &impl ToInputArray, matches: &mut Vector<Vector<DMatch>>, k: i32 ) -> Result<()>

@overload

fn radius_match( &mut self, query_descriptors: &impl ToInputArray, matches: &mut Vector<Vector<DMatch>>, max_distance: f32, masks: &impl ToInputArray, compact_result: bool ) -> Result<()>

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

fn radius_match_def( &mut self, query_descriptors: &impl ToInputArray, matches: &mut Vector<Vector<DMatch>>, max_distance: f32 ) -> Result<()>

@overload

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

fn read_from_node(&mut self, unnamed: &impl FileNodeTraitConst) -> Result<()>

impl DescriptorMatcherTraitConst for FlannBasedMatcher

fn as_raw_DescriptorMatcher(&self) -> *const c_void

fn get_train_descriptors(&self) -> Result<Vector<Mat>>

Returns a constant link to the train descriptor collection trainDescCollection .

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_match( &self, query_descriptors: &impl ToInputArray, train_descriptors: &impl ToInputArray, matches: &mut Vector<DMatch>, mask: &impl ToInputArray ) -> Result<()>

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

fn train_match_def( &self, query_descriptors: &impl ToInputArray, train_descriptors: &impl ToInputArray, matches: &mut Vector<DMatch> ) -> Result<()>

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

fn knn_train_match( &self, query_descriptors: &impl ToInputArray, train_descriptors: &impl ToInputArray, matches: &mut Vector<Vector<DMatch>>, k: i32, mask: &impl ToInputArray, compact_result: bool ) -> Result<()>

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

fn knn_train_match_def( &self, query_descriptors: &impl ToInputArray, train_descriptors: &impl ToInputArray, matches: &mut Vector<Vector<DMatch>>, k: i32 ) -> Result<()>

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

fn radius_train_match( &self, query_descriptors: &impl ToInputArray, train_descriptors: &impl ToInputArray, matches: &mut Vector<Vector<DMatch>>, max_distance: f32, mask: &impl ToInputArray, compact_result: bool ) -> Result<()>

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

fn radius_train_match_def( &self, query_descriptors: &impl ToInputArray, train_descriptors: &impl ToInputArray, matches: &mut Vector<Vector<DMatch>>, max_distance: f32 ) -> Result<()>

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

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

fn write_to_storage(&self, unnamed: &mut impl FileStorageTrait) -> Result<()>

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

Clones the matcher.

fn clone_def(&self) -> Result<Ptr<DescriptorMatcher>>

Clones the matcher.

fn write_to_storage_with_name( &self, fs: &mut impl FileStorageTrait, name: &str ) -> Result<()>

fn write_to_storage_ptr_with_name( &self, fs: &Ptr<FileStorage>, name: &str ) -> Result<()>

impl Drop for FlannBasedMatcher

fn drop(&mut self)

Executes the destructor for this type.

impl FlannBasedMatcherTrait for FlannBasedMatcher

fn as_raw_mut_FlannBasedMatcher(&mut self) -> *mut c_void

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

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

fn read(&mut self, unnamed: &impl FileNodeTraitConst) -> Result<()>

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

impl FlannBasedMatcherTraitConst for FlannBasedMatcher

fn as_raw_FlannBasedMatcher(&self) -> *const c_void

fn write(&self, unnamed: &mut impl FileStorageTrait) -> Result<()>

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

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

C++ default parameters

fn clone_def(&self) -> Result<Ptr<DescriptorMatcher>>

Note

impl From<FlannBasedMatcher> for Algorithm

fn from(s: FlannBasedMatcher) -> Self

Converts to this type from the input type.

impl From<FlannBasedMatcher> for DescriptorMatcher

fn from(s: FlannBasedMatcher) -> Self

Converts to this type from the input type.

impl TryFrom<DescriptorMatcher> for FlannBasedMatcher

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: DescriptorMatcher) -> Result<Self>

Performs the conversion.

impl Send for FlannBasedMatcher