Struct BinaryDescriptorMatcher 

pub struct BinaryDescriptorMatcher { /* private fields */ }

furnishes all functionalities for querying a dataset provided by user or internal to class (that user must, anyway, populate) on the model of [features2d_match]

Once descriptors have been extracted from an image (both they represent lines and points), it becomes interesting to be able to match a descriptor with another one extracted from a different image and representing the same line or point, seen from a differente perspective or on a different scale. In reaching such goal, the main headache is designing an efficient search algorithm to associate a query descriptor to one extracted from a dataset. In the following, a matching modality based on Multi-Index Hashing (MiHashing) will be described.

Multi-Index Hashing

The theory described in this section is based on MIH . Given a dataset populated with binary codes, each code is indexed m times into m different hash tables, according to m substrings it has been divided into. Thus, given a query code, all the entries close to it at least in one substring are returned by search as neighbor candidates. Returned entries are then checked for validity by verifying that their full codes are not distant (in Hamming space) more than r bits from query code. In details, each binary code h composed of b bits is divided into m disjoint substrings , each with length or bits. Formally, when two codes h and g differ by at the most r bits, in at the least one of their m substrings they differ by at the most bits. In particular, when (where is the Hamming norm), there must exist a substring k (with ) such that

That means that if Hamming distance between each of the m substring is strictly greater than , then must be larger that r and that is a contradiction. If the codes in dataset are divided into m substrings, then m tables will be built. Given a query q with substrings , i-th hash table is searched for entries distant at the most from and a set of candidates is obtained. The union of sets is a superset of the r-neighbors of q. Then, last step of algorithm is computing the Hamming distance between q and each element in , deleting the codes that are distant more that r from q.

Implementations

impl BinaryDescriptorMatcher

pub fn create_binary_descriptor_matcher() -> Result<Ptr<BinaryDescriptorMatcher>>

Create a BinaryDescriptorMatcher object and return a smart pointer to it.

pub fn default() -> Result<BinaryDescriptorMatcher>

Constructor.

The BinaryDescriptorMatcher constructed is able to store and manage 256-bits long entries.

Trait Implementations

impl AlgorithmTrait for BinaryDescriptorMatcher

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 BinaryDescriptorMatcher

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 BinaryDescriptorMatcherTrait for BinaryDescriptorMatcher

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

fn match_query( &mut self, query_descriptors: &impl MatTraitConst, matches: &mut Vector<DMatch>, masks: &Vector<Mat>, ) -> Result<()>

For every input query descriptor, retrieve the best matching one from a dataset provided from user or from the one internal to class

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

For every input query descriptor, retrieve the best matching one from a dataset provided from user or from the one internal to class

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

For every input query descriptor, retrieve the best k matching ones from a dataset provided from user or from the one internal to class

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

For every input query descriptor, retrieve the best k matching ones from a dataset provided from user or from the one internal to class

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

For every input query descriptor, retrieve, from a dataset provided from user or from the one internal to class, all the descriptors that are not further than maxDist from input query

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

For every input query descriptor, retrieve, from a dataset provided from user or from the one internal to class, all the descriptors that are not further than maxDist from input query

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

Store locally new descriptors to be inserted in dataset, without updating dataset.

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

Update dataset by inserting into it all descriptors that were stored locally by add function.

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

Clear dataset and internal data

impl BinaryDescriptorMatcherTraitConst for BinaryDescriptorMatcher

fn as_raw_BinaryDescriptorMatcher(&self) -> *const c_void

fn match_( &self, query_descriptors: &impl MatTraitConst, train_descriptors: &impl MatTraitConst, matches: &mut Vector<DMatch>, mask: &impl MatTraitConst, ) -> Result<()>

For every input query descriptor, retrieve the best matching one from a dataset provided from user or from the one internal to class

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

For every input query descriptor, retrieve the best matching one from a dataset provided from user or from the one internal to class

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

For every input query descriptor, retrieve the best k matching ones from a dataset provided from user or from the one internal to class

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

For every input query descriptor, retrieve the best k matching ones from a dataset provided from user or from the one internal to class

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

For every input query descriptor, retrieve, from a dataset provided from user or from the one internal to class, all the descriptors that are not further than maxDist from input query

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

For every input query descriptor, retrieve, from a dataset provided from user or from the one internal to class, all the descriptors that are not further than maxDist from input query

impl Boxed for BinaryDescriptorMatcher

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Debug for BinaryDescriptorMatcher

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

Formats the value using the given formatter.

impl Drop for BinaryDescriptorMatcher

fn drop(&mut self)

Executes the destructor for this type.

impl From<BinaryDescriptorMatcher> for Algorithm

fn from(s: BinaryDescriptorMatcher) -> Self

Converts to this type from the input type.

impl Send for BinaryDescriptorMatcher