Trait opencv::hub_prelude::DescriptorMatcherConst

source · [−]
pub trait DescriptorMatcherConst: AlgorithmTraitConst {
    fn as_raw_DescriptorMatcher(&self) -> *const c_void;

    fn get_train_descriptors(&self) -> Result<Vector<Mat>> { ... }
    fn empty(&self) -> Result<bool> { ... }
    fn is_mask_supported(&self) -> Result<bool> { ... }
    fn train_match(
        &self,
        query_descriptors: &dyn ToInputArray,
        train_descriptors: &dyn ToInputArray,
        matches: &mut Vector<DMatch>,
        mask: &dyn ToInputArray
    ) -> Result<()> { ... }
    fn knn_train_match(
        &self,
        query_descriptors: &dyn ToInputArray,
        train_descriptors: &dyn ToInputArray,
        matches: &mut Vector<Vector<DMatch>>,
        k: i32,
        mask: &dyn ToInputArray,
        compact_result: bool
    ) -> Result<()> { ... }
    fn radius_train_match(
        &self,
        query_descriptors: &dyn ToInputArray,
        train_descriptors: &dyn ToInputArray,
        matches: &mut Vector<Vector<DMatch>>,
        max_distance: f32,
        mask: &dyn ToInputArray,
        compact_result: bool
    ) -> Result<()> { ... }
    fn write(&self, file_name: &str) -> Result<()> { ... }
    fn write_1(&self, unnamed: &mut FileStorage) -> Result<()> { ... }
    fn clone(&self, empty_train_data: bool) -> Result<Ptr<dyn DescriptorMatcher>> { ... }
    fn write_2(&self, fs: &Ptr<FileStorage>, name: &str) -> Result<()> { ... }
}
Expand description

Abstract base class for matching keypoint descriptors.

It has two groups of match methods: for matching descriptors of an image with another image or with an image set.

Required Methods

Provided Methods

Returns a constant link to the train descriptor collection trainDescCollection .

Returns true if there are no train descriptors in the both collections.

Returns true if the descriptor matcher supports masking permissible matches.

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.

C++ default parameters
  • mask: noArray()

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.

C++ default parameters
  • mask: noArray()
  • compact_result: false

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.

C++ default parameters
  • mask: noArray()
  • compact_result: false

Clones the matcher.

Parameters
  • emptyTrainData: If emptyTrainData is false, the method creates a deep copy of the object, that is, copies both parameters and train data. If emptyTrainData is true, the method creates an object copy with the current parameters but with empty train data.
C++ default parameters
  • empty_train_data: false
C++ default parameters
  • name: String()

Implementors