Class cv::xfeatures2d::AKAZE#

Class implementing the AKAZE keypoint detector and descriptor extractor, described in [12]. View details

#include <opencv2/xfeatures2d.hpp>

Collaboration diagram for cv::xfeatures2d::AKAZE:

Public Types#

enum cv::xfeatures2d::AKAZE {
    cv::xfeatures2d::DESCRIPTOR_KAZE_UPRIGHT = 2,
    cv::xfeatures2d::DESCRIPTOR_KAZE = 3,
    cv::xfeatures2d::DESCRIPTOR_MLDB_UPRIGHT = 4,
    cv::xfeatures2d::DESCRIPTOR_MLDB = 5
}

Public Member Functions#

Public Member Functions inherited from cv::Feature2D

Return	Name	Description
	`~Feature2D()`
`void`	`compute(` `InputArray image,` `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).
`void`	`compute(` `InputArrayOfArrays images,` `std::vector< std::vector< KeyPoint > > & keypoints,` `OutputArrayOfArrays descriptors )`
`int`	`defaultNorm()`
`int`	`descriptorSize()`
`int`	`descriptorType()`
`void`	`detect(` `InputArray image,` `std::vector< KeyPoint > & keypoints,` `InputArray mask = noArray() )`	Detects keypoints in an image (first variant) or image set (second variant).
`void`	`detect(` `InputArrayOfArrays images,` `std::vector< std::vector< KeyPoint > > & keypoints,` `InputArrayOfArrays masks = noArray() )`
`void`	`detectAndCompute(` `InputArray image,` `InputArray mask,` `std::vector< KeyPoint > & keypoints,` `OutputArray descriptors,` `bool useProvidedKeypoints = false )`
`bool`	`empty()`	Return true if detector object is empty.
`String`	`getDefaultName()`
`void`	`read(const FileNode & fn)`	Reads algorithm parameters from a file storage.
`void`	`read(const String & fileName)`
`void`	`write(const String & fileName)`
`void`	`write(FileStorage & fs)`	Stores algorithm parameters in a file storage.
`void`	`write(` `FileStorage & fs,` `const String & name )`

Public Member Functions inherited from cv::Algorithm

Return	Name	Description
	`Algorithm()`
	`~Algorithm()`
`void`	`clear()`	Clears the algorithm state.
`bool`	`empty()`	Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.
`String`	`getDefaultName()`
`void`	`read(const FileNode & fn)`	Reads algorithm parameters from a file storage.
`void`	`save(const String & filename)`
`void`	`write(` `const Ptr< FileStorage > & fs,` `const String & name = String() )`
`void`	`write(FileStorage & fs)`	Stores algorithm parameters in a file storage.
`void`	`write(` `FileStorage & fs,` `const String & name )`

Static Public Member Functions#

Static Public Member Functions inherited from cv::Algorithm

Return	Name	Description
`static Ptr< _Tp >`	`load(` `const String & filename,` `const String & objname = String() )`	Loads algorithm from the file.
`static Ptr< _Tp >`	`loadFromString(` `const String & strModel,` `const String & objname = String() )`	Loads algorithm from a String.
`static Ptr< _Tp >`	`read(const FileNode & fn)`	Reads algorithm from the file node.

Additional Inherited Members#

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.

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.

Examples: samples/cpp/stitching_detailed.cpp.

Member Typedef Documentation#

DescriptorType#

typedef int cv::xfeatures2d::AKAZE::DescriptorType

Member Enumeration Documentation#

enum AKAZE

`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 Ptr< AKAZE > cv::xfeatures2d::AKAZE::create(
int descriptor_type = AKAZE::DESCRIPTOR_MLDB,
int descriptor_size = 0,
int descriptor_channels = 3,
float threshold = 0.001f,
int nOctaves = 4,
int nOctaveLayers = 4,
int diffusivity = KAZE::DIFF_PM_G2,
int max_points = -1 )

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()#

String cv::xfeatures2d::AKAZE::getDefaultName()

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.

getDescriptorChannels()#

int cv::xfeatures2d::AKAZE::getDescriptorChannels()

getDescriptorSize()#

int cv::xfeatures2d::AKAZE::getDescriptorSize()

getDescriptorType()#

int cv::xfeatures2d::AKAZE::getDescriptorType()

getDiffusivity()#

int cv::xfeatures2d::AKAZE::getDiffusivity()

getMaxPoints()#

int cv::xfeatures2d::AKAZE::getMaxPoints()

getNOctaveLayers()#

int cv::xfeatures2d::AKAZE::getNOctaveLayers()

getNOctaves()#

int cv::xfeatures2d::AKAZE::getNOctaves()

getThreshold()#

double cv::xfeatures2d::AKAZE::getThreshold()

setDescriptorChannels()#

void cv::xfeatures2d::AKAZE::setDescriptorChannels(int dch)

setDescriptorSize()#

void cv::xfeatures2d::AKAZE::setDescriptorSize(int dsize)

setDescriptorType()#

void cv::xfeatures2d::AKAZE::setDescriptorType(int dtype)

setDiffusivity()#

void cv::xfeatures2d::AKAZE::setDiffusivity(int diff)

setMaxPoints()#

void cv::xfeatures2d::AKAZE::setMaxPoints(int max_points)

setNOctaveLayers()#

void cv::xfeatures2d::AKAZE::setNOctaveLayers(int octaveLayers)

setNOctaves()#

void cv::xfeatures2d::AKAZE::setNOctaves(int octaves)

setThreshold()#

void cv::xfeatures2d::AKAZE::setThreshold(double threshold)

Source file#

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

opencv2/xfeatures2d.hpp