Struct opencv::features2d::KAZE

pub struct KAZE { /* private fields */ }

Class implementing the KAZE keypoint detector and descriptor extractor, described in ABD12 .

Note: AKAZE descriptor can only be used with KAZE or AKAZE keypoints .. [ABD12] KAZE Features. Pablo F. Alcantarilla, Adrien Bartoli and Andrew J. Davison. In European Conference on Computer Vision (ECCV), Fiorenze, Italy, October 2012.

Implementations

impl KAZE

pub fn create( extended: bool, upright: bool, threshold: f32, n_octaves: i32, n_octave_layers: i32, diffusivity: KAZE_DiffusivityType ) -> Result<Ptr<KAZE>>

The KAZE constructor

Parameters

• extended: Set to enable extraction of extended (128-byte) descriptor.
• upright: Set to enable use of upright descriptors (non rotation-invariant).
• threshold: Detector response threshold to accept point
• nOctaves: Maximum octave evolution of the image
• nOctaveLayers: Default number of sublevels per scale level
• diffusivity: Diffusivity type. DIFF_PM_G1, DIFF_PM_G2, DIFF_WEICKERT or DIFF_CHARBONNIER

C++ default parameters

• extended: false
• upright: false
• threshold: 0.001f
• n_octaves: 4
• n_octave_layers: 4
• diffusivity: KAZE::DIFF_PM_G2

pub fn create_def() -> Result<Ptr<KAZE>>

The KAZE constructor

Parameters

• extended: Set to enable extraction of extended (128-byte) descriptor.
• upright: Set to enable use of upright descriptors (non rotation-invariant).
• threshold: Detector response threshold to accept point
• nOctaves: Maximum octave evolution of the image
• nOctaveLayers: Default number of sublevels per scale level
• diffusivity: Diffusivity type. DIFF_PM_G1, DIFF_PM_G2, DIFF_WEICKERT or DIFF_CHARBONNIER

Note

This alternative version of KAZE::create function uses the following default values for its arguments:

• extended: false
• upright: false
• threshold: 0.001f
• n_octaves: 4
• n_octave_layers: 4
• diffusivity: KAZE::DIFF_PM_G2

Trait Implementations

impl AlgorithmTrait for KAZE

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 KAZE

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 Boxed for KAZE

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Debug for KAZE

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

Formats the value using the given formatter.

impl Drop for KAZE

fn drop(&mut self)

Executes the destructor for this type.

impl Feature2DTrait for KAZE

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

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).

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).

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).

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

@overload

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).

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).

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

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

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

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

impl Feature2DTraitConst for KAZE

fn as_raw_Feature2D(&self) -> *const c_void

fn descriptor_size(&self) -> Result<i32>

fn descriptor_type(&self) -> Result<i32>

fn default_norm(&self) -> Result<i32>

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

fn write_to_storage(&self, unnamed: &mut impl FileStorageTrait) -> Result<()>

fn empty(&self) -> Result<bool>

Return true if detector object is empty

fn get_default_name(&self) -> Result<String>

fn write_to_storage_with_name( &self, fs: &mut impl FileStorageTrait, name: &str ) -> Result<()>

fn write_to_storage_ptr_with_name( &self, fs: &Ptr<FileStorage>, name: &str ) -> Result<()>

impl From<KAZE> for Algorithm

fn from(s: KAZE) -> Self

Converts to this type from the input type.

impl From<KAZE> for Feature2D

fn from(s: KAZE) -> Self

Converts to this type from the input type.

impl KAZETrait for KAZE

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

fn set_extended(&mut self, extended: bool) -> Result<()>

fn set_upright(&mut self, upright: bool) -> Result<()>

fn set_threshold(&mut self, threshold: f64) -> Result<()>

fn set_n_octaves(&mut self, octaves: i32) -> Result<()>

fn set_n_octave_layers(&mut self, octave_layers: i32) -> Result<()>

fn set_diffusivity(&mut self, diff: KAZE_DiffusivityType) -> Result<()>

impl KAZETraitConst for KAZE

fn as_raw_KAZE(&self) -> *const c_void

fn get_extended(&self) -> Result<bool>

fn get_upright(&self) -> Result<bool>

fn get_threshold(&self) -> Result<f64>

fn get_n_octaves(&self) -> Result<i32>

fn get_n_octave_layers(&self) -> Result<i32>

fn get_diffusivity(&self) -> Result<KAZE_DiffusivityType>

fn get_default_name(&self) -> Result<String>

impl TryFrom<Feature2D> for KAZE

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: Feature2D) -> Result<Self>

Performs the conversion.

impl Send for KAZE