Struct opencv::features2d::BFMatcher

pub struct BFMatcher { /* private fields */ }

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.

Implementations

impl BFMatcher

pub fn new(norm_type: i32, cross_check: bool) -> Result<BFMatcher>

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

C++ default parameters

• norm_type: NORM_L2
• cross_check: false

pub fn new_def() -> Result<BFMatcher>

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

Note

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

• norm_type: NORM_L2
• cross_check: false

pub fn create(norm_type: i32, cross_check: bool) -> Result<Ptr<BFMatcher>>

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.

C++ default parameters

• norm_type: NORM_L2
• cross_check: false

pub fn create_def() -> Result<Ptr<BFMatcher>>

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.

Note

This alternative version of BFMatcher::create function uses the following default values for its arguments:

• norm_type: NORM_L2
• cross_check: false

Trait Implementations

impl AlgorithmTrait for BFMatcher

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 BFMatcher

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 BFMatcherTrait for BFMatcher

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

impl BFMatcherTraitConst for BFMatcher

fn as_raw_BFMatcher(&self) -> *const c_void

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

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Debug for BFMatcher

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

Formats the value using the given formatter.

impl DescriptorMatcherTrait for BFMatcher

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 BFMatcher

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 BFMatcher

fn drop(&mut self)

Executes the destructor for this type.

impl From<BFMatcher> for Algorithm

fn from(s: BFMatcher) -> Self

Converts to this type from the input type.

impl From<BFMatcher> for DescriptorMatcher

fn from(s: BFMatcher) -> Self

Converts to this type from the input type.

impl TryFrom<DescriptorMatcher> for BFMatcher

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 BFMatcher