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

#include <features2d.hpp>

Inheritance diagram for cv::AKAZE:

Public Types
enum	DescriptorType { DESCRIPTOR_KAZE_UPRIGHT = 2 , DESCRIPTOR_KAZE = 3 , DESCRIPTOR_MLDB_UPRIGHT = 4 , DESCRIPTOR_MLDB = 5 }

Public Member Functions
virtual CV_WRAP void	setDescriptorType (AKAZE::DescriptorType dtype)=0

virtual CV_WRAP AKAZE::DescriptorType	getDescriptorType () const =0

virtual CV_WRAP void	setDescriptorSize (int dsize)=0

virtual CV_WRAP int	getDescriptorSize () const =0

virtual CV_WRAP void	setDescriptorChannels (int dch)=0

virtual CV_WRAP int	getDescriptorChannels () const =0

virtual CV_WRAP void	setThreshold (double threshold)=0

virtual CV_WRAP double	getThreshold () const =0

virtual CV_WRAP void	setNOctaves (int octaves)=0

virtual CV_WRAP int	getNOctaves () const =0

virtual CV_WRAP void	setNOctaveLayers (int octaveLayers)=0

virtual CV_WRAP int	getNOctaveLayers () const =0

virtual CV_WRAP void	setDiffusivity (KAZE::DiffusivityType diff)=0

virtual CV_WRAP KAZE::DiffusivityType	getDiffusivity () const =0

virtual CV_WRAP String	getDefaultName () const CV_OVERRIDE

virtual CV_WRAP void	setMaxPoints (int max_points)=0

virtual CV_WRAP int	getMaxPoints () const =0

Public Member Functions inherited from cv::Feature2D
virtual	~Feature2D ()

virtual CV_WRAP void	detect (InputArray image, CV_OUT std::vector< KeyPoint > &keypoints, InputArray mask=noArray())
	Detects keypoints in an image (first variant) or image set (second variant). More...

virtual CV_WRAP void	detect (InputArrayOfArrays images, CV_OUT std::vector< std::vector< KeyPoint > > &keypoints, InputArrayOfArrays masks=noArray())

virtual CV_WRAP void	compute (InputArray image, CV_OUT CV_IN_OUT std::vector< KeyPoint > &keypoints, OutputArray descriptors)
	Computes the descriptors for a set of keypoints detected in an image (first variant) or image set (second variant). More...

virtual CV_WRAP void	compute (InputArrayOfArrays images, CV_OUT CV_IN_OUT std::vector< std::vector< KeyPoint > > &keypoints, OutputArrayOfArrays descriptors)

virtual CV_WRAP void	detectAndCompute (InputArray image, InputArray mask, CV_OUT std::vector< KeyPoint > &keypoints, OutputArray descriptors, bool useProvidedKeypoints=false)

virtual CV_WRAP int	descriptorSize () const

virtual CV_WRAP int	descriptorType () const

virtual CV_WRAP int	defaultNorm () const

CV_WRAP void	write (const String &fileName) const

CV_WRAP void	read (const String &fileName)

virtual void	write (FileStorage &) const CV_OVERRIDE
	Stores algorithm parameters in a file storage. More...

virtual CV_WRAP void	read (const FileNode &) CV_OVERRIDE
	Reads algorithm parameters from a file storage. More...

virtual CV_WRAP bool	empty () const CV_OVERRIDE
	Return true if detector object is empty. More...

CV_WRAP void	write (FileStorage &fs, const String &name) const

void	write (const Ptr< FileStorage > &fs, const String &name) const

Public Member Functions inherited from cv::Algorithm
	Algorithm ()

virtual	~Algorithm ()

virtual CV_WRAP void	clear ()
	Clears the algorithm state. More...

CV_WRAP void	write (FileStorage &fs, const String &name) const

void	write (const Ptr< FileStorage > &fs, const String &name=String()) const

virtual CV_WRAP void	save (const String &filename) const

Static Public Member Functions
static CV_WRAP Ptr< AKAZE >	create (AKAZE::DescriptorType descriptor_type=AKAZE::DESCRIPTOR_MLDB, int descriptor_size=0, int descriptor_channels=3, float threshold=0.001f, int nOctaves=4, int nOctaveLayers=4, KAZE::DiffusivityType diffusivity=KAZE::DIFF_PM_G2, int max_points=-1)
	The AKAZE constructor. More...

Static Public Member Functions inherited from cv::Algorithm
template<typename _Tp >
static Ptr< _Tp >	read (const FileNode &fn)
	Reads algorithm from the file node. More...

template<typename _Tp >
static Ptr< _Tp >	load (const String &filename, const String &objname=String())
	Loads algorithm from the file. More...

template<typename _Tp >
static Ptr< _Tp >	loadFromString (const String &strModel, const String &objname=String())
	Loads algorithm from a String. More...

Additional Inherited Members
Protected Member Functions inherited from cv::Algorithm
void	writeFormat (FileStorage &fs) const

Detailed Description

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

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.; AKAZE implements T-API. When image is passed as UMat some parts of the algorithm will use OpenCL.; [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.

Member Enumeration Documentation

◆ DescriptorType

enum cv::AKAZE::DescriptorType

Enumerator
DESCRIPTOR_KAZE_UPRIGHT	Upright descriptors, not invariant to rotation.
DESCRIPTOR_KAZE
DESCRIPTOR_MLDB_UPRIGHT	Upright descriptors, not invariant to rotation.
DESCRIPTOR_MLDB

Member Function Documentation

◆ create()

static CV_WRAP Ptr<AKAZE> cv::AKAZE::create	(	AKAZE::DescriptorType	descriptor_type = `AKAZE::DESCRIPTOR_MLDB`,
		int	descriptor_size = `0`,
		int	descriptor_channels = `3`,
		float	threshold = `0.001f`,
		int	nOctaves = `4`,
		int	nOctaveLayers = `4`,
		KAZE::DiffusivityType	diffusivity = `KAZE::DIFF_PM_G2`,
		int	max_points = `-1`
	)

static

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.

◆ getDefaultName()

virtual CV_WRAP String cv::AKAZE::getDefaultName ( ) const

virtual

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.

Reimplemented from cv::Feature2D.

◆ getDescriptorChannels()

virtual CV_WRAP int cv::AKAZE::getDescriptorChannels ( ) const

pure virtual

◆ getDescriptorSize()

virtual CV_WRAP int cv::AKAZE::getDescriptorSize ( ) const

pure virtual

◆ getDescriptorType()

virtual CV_WRAP AKAZE::DescriptorType cv::AKAZE::getDescriptorType ( ) const

pure virtual

◆ getDiffusivity()

virtual CV_WRAP KAZE::DiffusivityType cv::AKAZE::getDiffusivity ( ) const

pure virtual

◆ getMaxPoints()

virtual CV_WRAP int cv::AKAZE::getMaxPoints ( ) const

pure virtual

◆ getNOctaveLayers()

virtual CV_WRAP int cv::AKAZE::getNOctaveLayers ( ) const

pure virtual

◆ getNOctaves()

virtual CV_WRAP int cv::AKAZE::getNOctaves ( ) const

pure virtual

◆ getThreshold()

virtual CV_WRAP double cv::AKAZE::getThreshold ( ) const

pure virtual

◆ setDescriptorChannels()

virtual CV_WRAP void cv::AKAZE::setDescriptorChannels ( int dch )

pure virtual

◆ setDescriptorSize()

virtual CV_WRAP void cv::AKAZE::setDescriptorSize ( int dsize )

pure virtual

◆ setDescriptorType()

virtual CV_WRAP void cv::AKAZE::setDescriptorType ( AKAZE::DescriptorType dtype )

pure virtual

◆ setDiffusivity()

virtual CV_WRAP void cv::AKAZE::setDiffusivity ( KAZE::DiffusivityType diff )

pure virtual

◆ setMaxPoints()

virtual CV_WRAP void cv::AKAZE::setMaxPoints ( int max_points )

pure virtual

◆ setNOctaveLayers()

virtual CV_WRAP void cv::AKAZE::setNOctaveLayers ( int octaveLayers )

pure virtual

◆ setNOctaves()

virtual CV_WRAP void cv::AKAZE::setNOctaves ( int octaves )

pure virtual

◆ setThreshold()

virtual CV_WRAP void cv::AKAZE::setThreshold ( double threshold )

pure virtual

The documentation for this class was generated from the following file:

build/release/_deps/opencv-src/include/opencv4/opencv2/features2d.hpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ DescriptorType

Member Function Documentation

◆ create()

◆ getDefaultName()

◆ getDescriptorChannels()

◆ getDescriptorSize()

◆ getDescriptorType()

◆ getDiffusivity()

◆ getMaxPoints()

◆ getNOctaveLayers()

◆ getNOctaves()

◆ getThreshold()

◆ setDescriptorChannels()

◆ setDescriptorSize()

◆ setDescriptorType()

◆ setDiffusivity()

◆ setMaxPoints()

◆ setNOctaveLayers()

◆ setNOctaves()

◆ setThreshold()