OpenCV  4.9.0-dev
Open Source Computer Vision
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
cv::KAZE Class Referenceabstract

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

#include <opencv2/features2d.hpp>

Inheritance diagram for cv::KAZE:
Collaboration diagram for cv::KAZE:

Public Types

enum  DiffusivityType {
  DIFF_PM_G1 = 0 ,
  DIFF_PM_G2 = 1 ,

Public Member Functions

virtual String getDefaultName () const CV_OVERRIDE
virtual KAZE::DiffusivityType getDiffusivity () const =0
virtual bool getExtended () const =0
virtual int getNOctaveLayers () const =0
virtual int getNOctaves () const =0
virtual double getThreshold () const =0
virtual bool getUpright () const =0
virtual void setDiffusivity (KAZE::DiffusivityType diff)=0
virtual void setExtended (bool extended)=0
virtual void setNOctaveLayers (int octaveLayers)=0
virtual void setNOctaves (int octaves)=0
virtual void setThreshold (double threshold)=0
virtual void setUpright (bool upright)=0
- Public Member Functions inherited from cv::Feature2D
virtual ~Feature2D ()
virtual 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).
virtual void compute (InputArrayOfArrays images, std::vector< std::vector< KeyPoint > > &keypoints, OutputArrayOfArrays descriptors)
virtual int defaultNorm () const
virtual int descriptorSize () const
virtual int descriptorType () const
virtual void detect (InputArray image, std::vector< KeyPoint > &keypoints, InputArray mask=noArray())
 Detects keypoints in an image (first variant) or image set (second variant).
virtual void detect (InputArrayOfArrays images, std::vector< std::vector< KeyPoint > > &keypoints, InputArrayOfArrays masks=noArray())
virtual void detectAndCompute (InputArray image, InputArray mask, std::vector< KeyPoint > &keypoints, OutputArray descriptors, bool useProvidedKeypoints=false)
virtual bool empty () const CV_OVERRIDE
 Return true if detector object is empty.
virtual void read (const FileNode &) CV_OVERRIDE
 Reads algorithm parameters from a file storage.
void read (const String &fileName)
void write (const Ptr< FileStorage > &fs, const String &name) const
void write (const String &fileName) const
virtual void write (FileStorage &) const CV_OVERRIDE
 Stores algorithm parameters in a file storage.
void write (FileStorage &fs, const String &name) const
- Public Member Functions inherited from cv::Algorithm
 Algorithm ()
virtual ~Algorithm ()
virtual void clear ()
 Clears the algorithm state.
virtual void save (const String &filename) const
void write (const Ptr< FileStorage > &fs, const String &name=String()) const
void write (FileStorage &fs, const String &name) const

Static Public Member Functions

static Ptr< KAZEcreate (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< _Tpload (const String &filename, const String &objname=String())
 Loads algorithm from the file.
template<typename _Tp >
static Ptr< _TploadFromString (const String &strModel, const String &objname=String())
 Loads algorithm from a String.
template<typename _Tp >
static Ptr< _Tpread (const FileNode &fn)
 Reads algorithm from the file node.

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 [9] .

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


Member Function Documentation

◆ create()

static 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 
cv.KAZE.create([, extended[, upright[, threshold[, nOctaves[, nOctaveLayers[, diffusivity]]]]]]) -> retval
cv.KAZE_create([, extended[, upright[, threshold[, nOctaves[, nOctaveLayers[, diffusivity]]]]]]) -> retval

The KAZE constructor.

extendedSet to enable extraction of extended (128-byte) descriptor.
uprightSet to enable use of upright descriptors (non rotation-invariant).
thresholdDetector response threshold to accept point
nOctavesMaximum octave evolution of the image
nOctaveLayersDefault number of sublevels per scale level
diffusivityDiffusivity type. DIFF_PM_G1, DIFF_PM_G2, DIFF_WEICKERT or DIFF_CHARBONNIER

◆ getDefaultName()

virtual String cv::KAZE::getDefaultName ( ) const
cv.KAZE.getDefaultName() -> retval

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 KAZE::DiffusivityType cv::KAZE::getDiffusivity ( ) const
pure virtual
cv.KAZE.getDiffusivity() -> retval

◆ getExtended()

virtual bool cv::KAZE::getExtended ( ) const
pure virtual
cv.KAZE.getExtended() -> retval

◆ getNOctaveLayers()

virtual int cv::KAZE::getNOctaveLayers ( ) const
pure virtual
cv.KAZE.getNOctaveLayers() -> retval

◆ getNOctaves()

virtual int cv::KAZE::getNOctaves ( ) const
pure virtual
cv.KAZE.getNOctaves() -> retval

◆ getThreshold()

virtual double cv::KAZE::getThreshold ( ) const
pure virtual
cv.KAZE.getThreshold() -> retval

◆ getUpright()

virtual bool cv::KAZE::getUpright ( ) const
pure virtual
cv.KAZE.getUpright() -> retval

◆ setDiffusivity()

virtual void cv::KAZE::setDiffusivity ( KAZE::DiffusivityType  diff)
pure virtual
cv.KAZE.setDiffusivity(diff) -> None

◆ setExtended()

virtual void cv::KAZE::setExtended ( bool  extended)
pure virtual
cv.KAZE.setExtended(extended) -> None

◆ setNOctaveLayers()

virtual void cv::KAZE::setNOctaveLayers ( int  octaveLayers)
pure virtual
cv.KAZE.setNOctaveLayers(octaveLayers) -> None

◆ setNOctaves()

virtual void cv::KAZE::setNOctaves ( int  octaves)
pure virtual
cv.KAZE.setNOctaves(octaves) -> None

◆ setThreshold()

virtual void cv::KAZE::setThreshold ( double  threshold)
pure virtual
cv.KAZE.setThreshold(threshold) -> None

◆ setUpright()

virtual void cv::KAZE::setUpright ( bool  upright)
pure virtual
cv.KAZE.setUpright(upright) -> None

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