cv::KAZE Class Reference

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

#include <features2d.hpp>

Inheritance diagram for cv::KAZE:

Public Types
enum	DiffusivityType { DIFF_PM_G1 = 0 , DIFF_PM_G2 = 1 , DIFF_WEICKERT = 2 , DIFF_CHARBONNIER = 3 }

Public Member Functions
virtual CV_WRAP void	setExtended (bool extended)=0
virtual CV_WRAP bool	getExtended () const =0
virtual CV_WRAP void	setUpright (bool upright)=0
virtual CV_WRAP bool	getUpright () 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
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).
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).
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.
virtual CV_WRAP void	read (const FileNode &) CV_OVERRIDE
	Reads algorithm parameters from a file storage.
virtual CV_WRAP bool	empty () const CV_OVERRIDE
	Return true if detector object is empty.
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.
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< KAZE >	create (bool extended=false, bool upright=false, float threshold=0.001f, int nOctaves=4, int nOctaveLayers=4, KAZE::DiffusivityType diffusivity=KAZE::DIFF_PM_G2)
	The KAZE constructor.
Static Public Member Functions inherited from cv::Algorithm
template<typename _Tp >
static Ptr< _Tp >	read (const FileNode &fn)
	Reads algorithm from the file node.
template<typename _Tp >
static Ptr< _Tp >	load (const String &filename, const String &objname=String())
	Loads algorithm from the file.
template<typename _Tp >
static Ptr< _Tp >	loadFromString (const String &strModel, const String &objname=String())
	Loads algorithm from a String.

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

Detailed Description

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.

Member Enumeration Documentation

DiffusivityType

enum cv::KAZE::DiffusivityType

Enumerator
DIFF_PM_G1
DIFF_PM_G2
DIFF_WEICKERT
DIFF_CHARBONNIER

Member Function Documentation

create()

static CV_WRAP Ptr< KAZE > cv::KAZE::create ( bool  extended = false, bool  upright = false, float  threshold = 0.001f, int  nOctaves = 4, int  nOctaveLayers = 4, KAZE::DiffusivityType  diffusivity = KAZE::DIFF_PM_G2  )

static

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

getDefaultName()

virtual CV_WRAP String cv::KAZE::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.

getDiffusivity()

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

pure virtual

getExtended()

virtual CV_WRAP bool cv::KAZE::getExtended ( ) const

pure virtual

getNOctaveLayers()

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

pure virtual

getNOctaves()

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

pure virtual

getThreshold()

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

pure virtual

getUpright()

virtual CV_WRAP bool cv::KAZE::getUpright ( ) const

pure virtual

setDiffusivity()

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

pure virtual

setExtended()

virtual CV_WRAP void cv::KAZE::setExtended ( bool  extended )

pure virtual

setNOctaveLayers()

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

pure virtual

setNOctaves()

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

pure virtual

setThreshold()

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

pure virtual

setUpright()

virtual CV_WRAP void cv::KAZE::setUpright ( bool  upright )

pure virtual

---

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

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