Struct opencv::features2d::AKAZE

pub struct AKAZE { /* private fields */ }

Class implementing the AKAZE keypoint detector and descriptor extractor, described in ANB13.

@details AKAZE descriptors can only be used with KAZE or AKAZE keypoints. This class is thread-safe.

Note: When you need descriptors use Feature2D::detectAndCompute, which provides better performance. When using Feature2D::detect followed by Feature2D::compute scale space pyramid is computed twice.

Note: AKAZE implements T-API. When image is passed as UMat some parts of the algorithm will use OpenCL.

Note: [ANB13] Fast Explicit Diffusion for Accelerated Features in Nonlinear Scale Spaces. Pablo F. Alcantarilla, Jesús Nuevo and Adrien Bartoli. In British Machine Vision Conference (BMVC), Bristol, UK, September 2013.

Implementations

impl AKAZE

pub fn create( descriptor_type: AKAZE_DescriptorType, descriptor_size: i32, descriptor_channels: i32, threshold: f32, n_octaves: i32, n_octave_layers: i32, diffusivity: KAZE_DiffusivityType, max_points: i32 ) -> Result<Ptr<AKAZE>>

The AKAZE constructor

Parameters

• descriptor_type: Type of the extracted descriptor: DESCRIPTOR_KAZE, DESCRIPTOR_KAZE_UPRIGHT, DESCRIPTOR_MLDB or DESCRIPTOR_MLDB_UPRIGHT.
• descriptor_size: Size of the descriptor in bits. 0 -> Full size
• descriptor_channels: Number of channels in the descriptor (1, 2, 3)
• 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
• max_points: Maximum amount of returned points. In case if image contains more features, then the features with highest response are returned. Negative value means no limitation.

C++ default parameters

• descriptor_type: AKAZE::DESCRIPTOR_MLDB
• descriptor_size: 0
• descriptor_channels: 3
• threshold: 0.001f
• n_octaves: 4
• n_octave_layers: 4
• diffusivity: KAZE::DIFF_PM_G2
• max_points: -1

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

The AKAZE constructor

Parameters

• descriptor_type: Type of the extracted descriptor: DESCRIPTOR_KAZE, DESCRIPTOR_KAZE_UPRIGHT, DESCRIPTOR_MLDB or DESCRIPTOR_MLDB_UPRIGHT.
• descriptor_size: Size of the descriptor in bits. 0 -> Full size
• descriptor_channels: Number of channels in the descriptor (1, 2, 3)
• 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
• max_points: Maximum amount of returned points. In case if image contains more features, then the features with highest response are returned. Negative value means no limitation.

Note

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

• descriptor_type: AKAZE::DESCRIPTOR_MLDB
• descriptor_size: 0
• descriptor_channels: 3
• threshold: 0.001f
• n_octaves: 4
• n_octave_layers: 4
• diffusivity: KAZE::DIFF_PM_G2
• max_points: -1

Trait Implementations

impl AKAZETrait for AKAZE

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

fn set_descriptor_type(&mut self, dtype: AKAZE_DescriptorType) -> Result<()>

fn set_descriptor_size(&mut self, dsize: i32) -> Result<()>

fn set_descriptor_channels(&mut self, dch: i32) -> 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<()>

fn set_max_points(&mut self, max_points: i32) -> Result<()>

impl AKAZETraitConst for AKAZE

fn as_raw_AKAZE(&self) -> *const c_void

fn get_descriptor_type(&self) -> Result<AKAZE_DescriptorType>

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

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

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>

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

impl AlgorithmTrait for AKAZE

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 AKAZE

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 AKAZE

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Debug for AKAZE

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

Formats the value using the given formatter.

impl Drop for AKAZE

fn drop(&mut self)

Executes the destructor for this type.

impl Feature2DTrait for AKAZE

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 AKAZE

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<AKAZE> for Algorithm

fn from(s: AKAZE) -> Self

Converts to this type from the input type.

impl From<AKAZE> for Feature2D

fn from(s: AKAZE) -> Self

Converts to this type from the input type.

impl TryFrom<Feature2D> for AKAZE

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 AKAZE