Trait opencv::prelude::BinaryDescriptorMatcherTraitConst

source · 
pub trait BinaryDescriptorMatcherTraitConst: AlgorithmTraitConst {
    // Required method
    fn as_raw_BinaryDescriptorMatcher(&self) -> *const c_void;

    // Provided methods
    fn match_(
        &self,
        query_descriptors: &impl MatTraitConst,
        train_descriptors: &impl MatTraitConst,
        matches: &mut Vector<DMatch>,
        mask: &impl MatTraitConst
    ) -> Result<()> { ... }
    fn match__def(
        &self,
        query_descriptors: &impl MatTraitConst,
        train_descriptors: &impl MatTraitConst,
        matches: &mut Vector<DMatch>
    ) -> Result<()> { ... }
    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<()> { ... }
    fn knn_match_def(
        &self,
        query_descriptors: &impl MatTraitConst,
        train_descriptors: &impl MatTraitConst,
        matches: &mut Vector<Vector<DMatch>>,
        k: i32
    ) -> Result<()> { ... }
    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<()> { ... }
    fn radius_match_def(
        &self,
        query_descriptors: &impl MatTraitConst,
        train_descriptors: &impl MatTraitConst,
        matches: &mut Vector<Vector<DMatch>>,
        max_distance: f32
    ) -> Result<()> { ... }
}
Expand description

Constant methods for crate::line_descriptor::BinaryDescriptorMatcher

Required Methods§

source

fn as_raw_BinaryDescriptorMatcher(&self) -> *const c_void

Provided Methods§

source

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

§Parameters
  • queryDescriptors: query descriptors
  • trainDescriptors: dataset of descriptors furnished by user
  • matches: vector to host retrieved matches
  • mask: mask to select which input descriptors must be matched to one in dataset
§C++ default parameters
  • mask: Mat()
source

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

§Parameters
  • queryDescriptors: query descriptors
  • trainDescriptors: dataset of descriptors furnished by user
  • matches: vector to host retrieved matches
  • mask: mask to select which input descriptors must be matched to one in dataset
§Note

This alternative version of BinaryDescriptorMatcherTraitConst::match_ function uses the following default values for its arguments:

  • mask: Mat()
source

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

§Parameters
  • queryDescriptors: query descriptors
  • trainDescriptors: dataset of descriptors furnished by user
  • matches: vector to host retrieved matches
  • k: number of the closest descriptors to be returned for every input query
  • mask: mask to select which input descriptors must be matched to ones in dataset
  • compactResult: flag to obtain a compact result (if true, a vector that doesn’t contain any matches for a given query is not inserted in final result)
§C++ default parameters
  • mask: Mat()
  • compact_result: false
source

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

§Parameters
  • queryDescriptors: query descriptors
  • trainDescriptors: dataset of descriptors furnished by user
  • matches: vector to host retrieved matches
  • k: number of the closest descriptors to be returned for every input query
  • mask: mask to select which input descriptors must be matched to ones in dataset
  • compactResult: flag to obtain a compact result (if true, a vector that doesn’t contain any matches for a given query is not inserted in final result)
§Note

This alternative version of BinaryDescriptorMatcherTraitConst::knn_match function uses the following default values for its arguments:

  • mask: Mat()
  • compact_result: false
source

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

§Parameters
  • queryDescriptors: query descriptors
  • trainDescriptors: dataset of descriptors furnished by user
  • matches: vector to host retrieved matches
  • maxDistance: search radius
  • mask: mask to select which input descriptors must be matched to ones in dataset
  • compactResult: flag to obtain a compact result (if true, a vector that doesn’t contain any matches for a given query is not inserted in final result)
§C++ default parameters
  • mask: Mat()
  • compact_result: false
source

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

§Parameters
  • queryDescriptors: query descriptors
  • trainDescriptors: dataset of descriptors furnished by user
  • matches: vector to host retrieved matches
  • maxDistance: search radius
  • mask: mask to select which input descriptors must be matched to ones in dataset
  • compactResult: flag to obtain a compact result (if true, a vector that doesn’t contain any matches for a given query is not inserted in final result)
§Note

This alternative version of BinaryDescriptorMatcherTraitConst::radius_match function uses the following default values for its arguments:

  • mask: Mat()
  • compact_result: false

Object Safety§

This trait is not object safe.

Implementors§