opencv::features2d

Trait DescriptorMatcherTrait

Source 
pub trait DescriptorMatcherTrait: AlgorithmTrait + DescriptorMatcherTraitConst {
    // Required method
    fn as_raw_mut_DescriptorMatcher(&mut self) -> *mut c_void;

    // Provided methods
    fn add(&mut self, descriptors: &impl ToInputArray) -> Result<()> { ... }
    fn clear(&mut self) -> Result<()> { ... }
    fn train(&mut self) -> Result<()> { ... }
    fn match_(
        &mut self,
        query_descriptors: &impl ToInputArray,
        matches: &mut Vector<DMatch>,
        masks: &impl ToInputArray,
    ) -> Result<()> { ... }
    fn match__def(
        &mut self,
        query_descriptors: &impl ToInputArray,
        matches: &mut Vector<DMatch>,
    ) -> Result<()> { ... }
    fn knn_match(
        &mut self,
        query_descriptors: &impl ToInputArray,
        matches: &mut Vector<Vector<DMatch>>,
        k: i32,
        masks: &impl ToInputArray,
        compact_result: bool,
    ) -> Result<()> { ... }
    fn knn_match_def(
        &mut self,
        query_descriptors: &impl ToInputArray,
        matches: &mut Vector<Vector<DMatch>>,
        k: i32,
    ) -> Result<()> { ... }
    fn radius_match(
        &mut self,
        query_descriptors: &impl ToInputArray,
        matches: &mut Vector<Vector<DMatch>>,
        max_distance: f32,
        masks: &impl ToInputArray,
        compact_result: bool,
    ) -> Result<()> { ... }
    fn radius_match_def(
        &mut self,
        query_descriptors: &impl ToInputArray,
        matches: &mut Vector<Vector<DMatch>>,
        max_distance: f32,
    ) -> Result<()> { ... }
    fn read(&mut self, file_name: &str) -> Result<()> { ... }
    fn read_from_node(
        &mut self,
        unnamed: &impl FileNodeTraitConst,
    ) -> Result<()> { ... }
}
Expand description

Mutable methods for crate::features2d::DescriptorMatcher

Required Methods§

Source

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

Provided Methods§

Source

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

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

If the collection is not empty, the new descriptors are added to existing train descriptors.

§Parameters
  • descriptors: Descriptors to add. Each descriptors[i] is a set of descriptors from the same train image.
Source

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

Clears the train descriptor collections.

Source

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

Trains a descriptor matcher

Trains a descriptor matcher (for example, the flann index). In all methods to match, the method train() is run every time before matching. Some descriptor matchers (for example, BruteForceMatcher) have an empty implementation of this method. Other matchers really train their inner structures (for example, FlannBasedMatcher trains flann::Index ).

Source

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.

§Parameters
  • queryDescriptors: Query set of descriptors.
  • trainDescriptors: Train set of descriptors. This set is not added to the train descriptors collection stored in the class object.
  • 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.
  • mask: Mask specifying permissible matches between an input query and train matrices of descriptors.

In the first variant of this method, the train descriptors are passed as an input argument. In the second variant of the method, train descriptors collection that was set by DescriptorMatcher::add is used. Optional mask (or masks) can be passed to specify which query and training descriptors can be matched. Namely, queryDescriptors[i] can be matched with trainDescriptors[j] only if mask.at<uchar>(i,j) is non-zero.

§Overloaded 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].
§C++ default parameters
  • masks: noArray()
Source

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

@overload

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

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

  • masks: noArray()
Source

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.

§Parameters
  • queryDescriptors: Query set of descriptors.
  • trainDescriptors: Train set of descriptors. This set is not added to the train descriptors collection stored in the class object.
  • mask: Mask specifying permissible matches between an input query and train matrices 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.
  • 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.

These extended variants of DescriptorMatcher::match methods find several best matches for each query descriptor. The matches are returned in the distance increasing order. See DescriptorMatcher::match for the details about query and train descriptors.

§Overloaded 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.
§C++ default parameters
  • masks: noArray()
  • compact_result: false
Source

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

@overload

§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.
§Note

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

  • masks: noArray()
  • compact_result: false
Source

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.

§Parameters
  • queryDescriptors: Query set of descriptors.
  • trainDescriptors: Train set of descriptors. This set is not added to the train descriptors collection stored in the class object.
  • matches: Found matches.
  • 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.
  • 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)!
  • mask: Mask specifying permissible matches between an input query and train matrices of descriptors.

For each query descriptor, the methods find such training descriptors that the distance between the query descriptor and the training descriptor is equal or smaller than maxDistance. Found matches are returned in the distance increasing order.

§Overloaded 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.
§C++ default parameters
  • masks: noArray()
  • compact_result: false
Source

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

@overload

§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.
§Note

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

  • masks: noArray()
  • compact_result: false
Source

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

Source

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

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§