Feature2DTrait

Trait Feature2DTrait 

Source
pub trait Feature2DTrait: AlgorithmTrait + Feature2DTraitConst {
    // Required method
    fn as_raw_mut_Feature2D(&mut self) -> *mut c_void;

    // Provided methods
    fn detect(
        &mut self,
        image: &impl ToInputArray,
        keypoints: &mut Vector<KeyPoint>,
        mask: &impl ToInputArray,
    ) -> Result<()> { ... }
    fn detect_def(
        &mut self,
        image: &impl ToInputArray,
        keypoints: &mut Vector<KeyPoint>,
    ) -> Result<()> { ... }
    fn detect_multiple(
        &mut self,
        images: &impl ToInputArray,
        keypoints: &mut Vector<Vector<KeyPoint>>,
        masks: &impl ToInputArray,
    ) -> Result<()> { ... }
    fn detect_multiple_def(
        &mut self,
        images: &impl ToInputArray,
        keypoints: &mut Vector<Vector<KeyPoint>>,
    ) -> Result<()> { ... }
    fn compute(
        &mut self,
        image: &impl ToInputArray,
        keypoints: &mut Vector<KeyPoint>,
        descriptors: &mut impl ToOutputArray,
    ) -> Result<()> { ... }
    fn compute_multiple(
        &mut self,
        images: &impl ToInputArray,
        keypoints: &mut Vector<Vector<KeyPoint>>,
        descriptors: &mut impl ToOutputArray,
    ) -> Result<()> { ... }
    fn detect_and_compute(
        &mut self,
        image: &impl ToInputArray,
        mask: &impl ToInputArray,
        keypoints: &mut Vector<KeyPoint>,
        descriptors: &mut impl ToOutputArray,
        use_provided_keypoints: bool,
    ) -> Result<()> { ... }
    fn detect_and_compute_def(
        &mut self,
        image: &impl ToInputArray,
        mask: &impl ToInputArray,
        keypoints: &mut Vector<KeyPoint>,
        descriptors: &mut impl ToOutputArray,
    ) -> 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::Feature2D

Required Methods§

Provided Methods§

Source

fn detect( &mut self, image: &impl ToInputArray, keypoints: &mut Vector<KeyPoint>, mask: &impl ToInputArray, ) -> Result<()>

Detects keypoints in an image (first variant) or image set (second variant).

§Parameters
  • image: Image.
  • keypoints: The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .
  • mask: Mask specifying where to look for keypoints (optional). It must be a 8-bit integer matrix with non-zero values in the region of interest.
§C++ default parameters
  • mask: noArray()
Source

fn detect_def( &mut self, image: &impl ToInputArray, keypoints: &mut Vector<KeyPoint>, ) -> Result<()>

Detects keypoints in an image (first variant) or image set (second variant).

§Parameters
  • image: Image.
  • keypoints: The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .
  • mask: Mask specifying where to look for keypoints (optional). It must be a 8-bit integer matrix with non-zero values in the region of interest.
§Note

This alternative version of Feature2DTrait::detect function uses the following default values for its arguments:

  • mask: noArray()
Source

fn detect_multiple( &mut self, images: &impl ToInputArray, keypoints: &mut Vector<Vector<KeyPoint>>, masks: &impl ToInputArray, ) -> Result<()>

Detects keypoints in an image (first variant) or image set (second variant).

§Parameters
  • image: Image.
  • keypoints: The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .
  • mask: Mask specifying where to look for keypoints (optional). It must be a 8-bit integer matrix with non-zero values in the region of interest.
§Overloaded parameters
  • images: Image set.
  • keypoints: The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .
  • masks: Masks for each input image specifying where to look for keypoints (optional). masks[i] is a mask for images[i].
§C++ default parameters
  • masks: noArray()
Source

fn detect_multiple_def( &mut self, images: &impl ToInputArray, keypoints: &mut Vector<Vector<KeyPoint>>, ) -> Result<()>

Detects keypoints in an image (first variant) or image set (second variant).

§Parameters
  • image: Image.
  • keypoints: The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .
  • mask: Mask specifying where to look for keypoints (optional). It must be a 8-bit integer matrix with non-zero values in the region of interest.
§Overloaded parameters
  • images: Image set.
  • keypoints: The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .
  • masks: Masks for each input image specifying where to look for keypoints (optional). masks[i] is a mask for images[i].
§Note

This alternative version of Feature2DTrait::detect_multiple function uses the following default values for its arguments:

  • masks: noArray()
Source

fn compute( &mut self, image: &impl ToInputArray, keypoints: &mut Vector<KeyPoint>, descriptors: &mut impl ToOutputArray, ) -> Result<()>

Computes the descriptors for a set of keypoints detected in an image (first variant) or image set (second variant).

§Parameters
  • image: Image.
  • keypoints: Input collection of keypoints. Keypoints for which a descriptor cannot be computed are removed. Sometimes new keypoints can be added, for example: SIFT duplicates keypoint with several dominant orientations (for each orientation).
  • descriptors: Computed descriptors. In the second variant of the method descriptors[i] are descriptors computed for a keypoints[i]. Row j is the keypoints (or keypoints[i]) is the descriptor for keypoint j-th keypoint.
Source

fn compute_multiple( &mut self, images: &impl ToInputArray, keypoints: &mut Vector<Vector<KeyPoint>>, descriptors: &mut impl ToOutputArray, ) -> Result<()>

Computes the descriptors for a set of keypoints detected in an image (first variant) or image set (second variant).

§Parameters
  • image: Image.
  • keypoints: Input collection of keypoints. Keypoints for which a descriptor cannot be computed are removed. Sometimes new keypoints can be added, for example: SIFT duplicates keypoint with several dominant orientations (for each orientation).
  • descriptors: Computed descriptors. In the second variant of the method descriptors[i] are descriptors computed for a keypoints[i]. Row j is the keypoints (or keypoints[i]) is the descriptor for keypoint j-th keypoint.
§Overloaded parameters
  • images: Image set.
  • keypoints: Input collection of keypoints. Keypoints for which a descriptor cannot be computed are removed. Sometimes new keypoints can be added, for example: SIFT duplicates keypoint with several dominant orientations (for each orientation).
  • descriptors: Computed descriptors. In the second variant of the method descriptors[i] are descriptors computed for a keypoints[i]. Row j is the keypoints (or keypoints[i]) is the descriptor for keypoint j-th keypoint.
Source

fn detect_and_compute( &mut self, image: &impl ToInputArray, mask: &impl ToInputArray, keypoints: &mut Vector<KeyPoint>, descriptors: &mut impl ToOutputArray, use_provided_keypoints: bool, ) -> Result<()>

Detects keypoints and computes the descriptors

§C++ default parameters
  • use_provided_keypoints: false
Source

fn detect_and_compute_def( &mut self, image: &impl ToInputArray, mask: &impl ToInputArray, keypoints: &mut Vector<KeyPoint>, descriptors: &mut impl ToOutputArray, ) -> Result<()>

Detects keypoints and computes the descriptors

§Note

This alternative version of Feature2DTrait::detect_and_compute function uses the following default values for its arguments:

  • use_provided_keypoints: 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§

Source§

impl Feature2DTrait for BoxedRefMut<'_, CUDA_FastFeatureDetector>

Source§

impl Feature2DTrait for BoxedRefMut<'_, CUDA_Feature2DAsync>

Source§

impl Feature2DTrait for BoxedRefMut<'_, CUDA_ORB>

Source§

impl Feature2DTrait for BoxedRefMut<'_, AKAZE>

Source§

impl Feature2DTrait for BoxedRefMut<'_, AffineFeature>

Source§

impl Feature2DTrait for BoxedRefMut<'_, AgastFeatureDetector>

Source§

impl Feature2DTrait for BoxedRefMut<'_, BRISK>

Source§

impl Feature2DTrait for BoxedRefMut<'_, FastFeatureDetector>

Source§

impl Feature2DTrait for BoxedRefMut<'_, Feature2D>

Source§

impl Feature2DTrait for BoxedRefMut<'_, GFTTDetector>

Source§

impl Feature2DTrait for BoxedRefMut<'_, KAZE>

Source§

impl Feature2DTrait for BoxedRefMut<'_, MSER>

Source§

impl Feature2DTrait for BoxedRefMut<'_, ORB>

Source§

impl Feature2DTrait for BoxedRefMut<'_, SIFT>

Source§

impl Feature2DTrait for BoxedRefMut<'_, SimpleBlobDetector>

Source§

impl Feature2DTrait for BoxedRefMut<'_, AffineFeature2D>

Source§

impl Feature2DTrait for BoxedRefMut<'_, BEBLID>

Source§

impl Feature2DTrait for BoxedRefMut<'_, BoostDesc>

Source§

impl Feature2DTrait for BoxedRefMut<'_, BriefDescriptorExtractor>

Source§

impl Feature2DTrait for BoxedRefMut<'_, DAISY>

Source§

impl Feature2DTrait for BoxedRefMut<'_, FREAK>

Source§

impl Feature2DTrait for BoxedRefMut<'_, HarrisLaplaceFeatureDetector>

Source§

impl Feature2DTrait for BoxedRefMut<'_, LATCH>

Source§

impl Feature2DTrait for BoxedRefMut<'_, LUCID>

Source§

impl Feature2DTrait for BoxedRefMut<'_, MSDDetector>

Source§

impl Feature2DTrait for BoxedRefMut<'_, SURF>

Source§

impl Feature2DTrait for BoxedRefMut<'_, StarDetector>

Source§

impl Feature2DTrait for BoxedRefMut<'_, TBMR>

Source§

impl Feature2DTrait for BoxedRefMut<'_, TEBLID>

Source§

impl Feature2DTrait for BoxedRefMut<'_, VGG>

Source§

impl Feature2DTrait for Ptr<CUDA_FastFeatureDetector>

Source§

impl Feature2DTrait for Ptr<CUDA_Feature2DAsync>

Source§

impl Feature2DTrait for Ptr<CUDA_ORB>

Source§

impl Feature2DTrait for Ptr<AKAZE>

Source§

impl Feature2DTrait for Ptr<AffineFeature>

Source§

impl Feature2DTrait for Ptr<AgastFeatureDetector>

Source§

impl Feature2DTrait for Ptr<BRISK>

Source§

impl Feature2DTrait for Ptr<FastFeatureDetector>

Source§

impl Feature2DTrait for Ptr<Feature2D>

Source§

impl Feature2DTrait for Ptr<GFTTDetector>

Source§

impl Feature2DTrait for Ptr<KAZE>

Source§

impl Feature2DTrait for Ptr<MSER>

Source§

impl Feature2DTrait for Ptr<ORB>

Source§

impl Feature2DTrait for Ptr<SIFT>

Source§

impl Feature2DTrait for Ptr<SimpleBlobDetector>

Source§

impl Feature2DTrait for Ptr<AffineFeature2D>

Source§

impl Feature2DTrait for Ptr<BEBLID>

Source§

impl Feature2DTrait for Ptr<BoostDesc>

Source§

impl Feature2DTrait for Ptr<BriefDescriptorExtractor>

Source§

impl Feature2DTrait for Ptr<DAISY>

Source§

impl Feature2DTrait for Ptr<FREAK>

Source§

impl Feature2DTrait for Ptr<HarrisLaplaceFeatureDetector>

Source§

impl Feature2DTrait for Ptr<LATCH>

Source§

impl Feature2DTrait for Ptr<LUCID>

Source§

impl Feature2DTrait for Ptr<MSDDetector>

Source§

impl Feature2DTrait for Ptr<SURF>

Source§

impl Feature2DTrait for Ptr<StarDetector>

Source§

impl Feature2DTrait for Ptr<TBMR>

Source§

impl Feature2DTrait for Ptr<TEBLID>

Source§

impl Feature2DTrait for Ptr<VGG>

Source§

impl Feature2DTrait for CUDA_FastFeatureDetector

Source§

impl Feature2DTrait for CUDA_Feature2DAsync

Source§

impl Feature2DTrait for CUDA_ORB

Source§

impl Feature2DTrait for AKAZE

Source§

impl Feature2DTrait for AffineFeature

Source§

impl Feature2DTrait for AgastFeatureDetector

Source§

impl Feature2DTrait for BRISK

Source§

impl Feature2DTrait for FastFeatureDetector

Source§

impl Feature2DTrait for Feature2D

Source§

impl Feature2DTrait for GFTTDetector

Source§

impl Feature2DTrait for KAZE

Source§

impl Feature2DTrait for MSER

Source§

impl Feature2DTrait for ORB

Source§

impl Feature2DTrait for SIFT

Source§

impl Feature2DTrait for SimpleBlobDetector

Source§

impl Feature2DTrait for AffineFeature2D

Source§

impl Feature2DTrait for BEBLID

Source§

impl Feature2DTrait for BoostDesc

Source§

impl Feature2DTrait for BriefDescriptorExtractor

Source§

impl Feature2DTrait for DAISY

Source§

impl Feature2DTrait for FREAK

Source§

impl Feature2DTrait for HarrisLaplaceFeatureDetector

Source§

impl Feature2DTrait for LATCH

Source§

impl Feature2DTrait for LUCID

Source§

impl Feature2DTrait for MSDDetector

Source§

impl Feature2DTrait for SURF

Source§

impl Feature2DTrait for StarDetector

Source§

impl Feature2DTrait for TBMR

Source§

impl Feature2DTrait for TEBLID

Source§

impl Feature2DTrait for VGG