OpenCV for Unity  2.6.0
Enox Software / Please refer to OpenCV official document ( http://docs.opencv.org/4.9.0/index.html ) for the details of the argument of the method.
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
OpenCVForUnity.Features2dModule.KAZE Class Reference

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

Inheritance diagram for OpenCVForUnity.Features2dModule.KAZE:
OpenCVForUnity.Features2dModule.Feature2D OpenCVForUnity.CoreModule.Algorithm OpenCVForUnity.DisposableOpenCVObject OpenCVForUnity.DisposableObject

Public Member Functions

void setExtended (bool extended)
 
bool getExtended ()
 
void setUpright (bool upright)
 
bool getUpright ()
 
void setThreshold (double threshold)
 
double getThreshold ()
 
void setNOctaves (int octaves)
 
int getNOctaves ()
 
void setNOctaveLayers (int octaveLayers)
 
int getNOctaveLayers ()
 
void setDiffusivity (int diff)
 
int getDiffusivity ()
 
override string getDefaultName ()
 
- Public Member Functions inherited from OpenCVForUnity.Features2dModule.Feature2D
void detect (Mat image, MatOfKeyPoint keypoints, Mat mask)
 Detects keypoints in an image (first variant) or image set (second variant). More...
 
void detect (Mat image, MatOfKeyPoint keypoints)
 Detects keypoints in an image (first variant) or image set (second variant). More...
 
void detect (List< Mat > images, List< MatOfKeyPoint > keypoints, List< Mat > masks)
 
void detect (List< Mat > images, List< MatOfKeyPoint > keypoints)
 
void compute (Mat image, MatOfKeyPoint keypoints, Mat descriptors)
 Computes the descriptors for a set of keypoints detected in an image (first variant) or image set (second variant). More...
 
void compute (List< Mat > images, List< MatOfKeyPoint > keypoints, List< Mat > descriptors)
 
void detectAndCompute (Mat image, Mat mask, MatOfKeyPoint keypoints, Mat descriptors, bool useProvidedKeypoints)
 
void detectAndCompute (Mat image, Mat mask, MatOfKeyPoint keypoints, Mat descriptors)
 
int descriptorSize ()
 
int descriptorType ()
 
int defaultNorm ()
 
void write (string fileName)
 
void read (string fileName)
 
override bool empty ()
 Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read. More...
 
- Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
IntPtr getNativeObjAddr ()
 
virtual void clear ()
 Clears the algorithm state. More...
 
void save (string filename)
 
- Public Member Functions inherited from OpenCVForUnity.DisposableObject
void Dispose ()
 
void ThrowIfDisposed ()
 

Static Public Member Functions

static new KAZE __fromPtr__ (IntPtr addr)
 
static KAZE create (bool extended, bool upright, float threshold, int nOctaves, int nOctaveLayers, int diffusivity)
 The KAZE constructor. More...
 
static KAZE create (bool extended, bool upright, float threshold, int nOctaves, int nOctaveLayers)
 The KAZE constructor. More...
 
static KAZE create (bool extended, bool upright, float threshold, int nOctaves)
 The KAZE constructor. More...
 
static KAZE create (bool extended, bool upright, float threshold)
 The KAZE constructor. More...
 
static KAZE create (bool extended, bool upright)
 The KAZE constructor. More...
 
static KAZE create (bool extended)
 The KAZE constructor. More...
 
static KAZE create ()
 The KAZE constructor. More...
 
- Static Public Member Functions inherited from OpenCVForUnity.Features2dModule.Feature2D
static new Feature2D __fromPtr__ (IntPtr addr)
 
- Static Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
static Algorithm __fromPtr__ (IntPtr addr)
 
- Static Public Member Functions inherited from OpenCVForUnity.DisposableObject
static IntPtr ThrowIfNullIntPtr (IntPtr ptr)
 

Public Attributes

const int DIFF_PM_G1 = 0
 
const int DIFF_PM_G2 = 1
 
const int DIFF_WEICKERT = 2
 
const int DIFF_CHARBONNIER = 3
 

Protected Member Functions

override void Dispose (bool disposing)
 
- Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
 DisposableOpenCVObject ()
 
 DisposableOpenCVObject (IntPtr ptr)
 
 DisposableOpenCVObject (bool isEnabledDispose)
 
 DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)
 
- Protected Member Functions inherited from OpenCVForUnity.DisposableObject
 DisposableObject ()
 
 DisposableObject (bool isEnabledDispose)
 

Additional Inherited Members

- Properties inherited from OpenCVForUnity.DisposableObject
bool IsDisposed [get, protected set]
 
bool IsEnabledDispose [get, set]
 

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 Function Documentation

◆ __fromPtr__()

static new KAZE OpenCVForUnity.Features2dModule.KAZE.__fromPtr__ ( IntPtr  addr)
static

◆ create() [1/7]

static KAZE OpenCVForUnity.Features2dModule.KAZE.create ( bool  extended,
bool  upright,
float  threshold,
int  nOctaves,
int  nOctaveLayers,
int  diffusivity 
)
static

The KAZE constructor.

Parameters
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

◆ create() [2/7]

static KAZE OpenCVForUnity.Features2dModule.KAZE.create ( bool  extended,
bool  upright,
float  threshold,
int  nOctaves,
int  nOctaveLayers 
)
static

The KAZE constructor.

Parameters
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

◆ create() [3/7]

static KAZE OpenCVForUnity.Features2dModule.KAZE.create ( bool  extended,
bool  upright,
float  threshold,
int  nOctaves 
)
static

The KAZE constructor.

Parameters
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

◆ create() [4/7]

static KAZE OpenCVForUnity.Features2dModule.KAZE.create ( bool  extended,
bool  upright,
float  threshold 
)
static

The KAZE constructor.

Parameters
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

◆ create() [5/7]

static KAZE OpenCVForUnity.Features2dModule.KAZE.create ( bool  extended,
bool  upright 
)
static

The KAZE constructor.

Parameters
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

◆ create() [6/7]

static KAZE OpenCVForUnity.Features2dModule.KAZE.create ( bool  extended)
static

The KAZE constructor.

Parameters
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

◆ create() [7/7]

static KAZE OpenCVForUnity.Features2dModule.KAZE.create ( )
static

The KAZE constructor.

Parameters
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

◆ Dispose()

override void OpenCVForUnity.Features2dModule.KAZE.Dispose ( bool  disposing)
protectedvirtual

◆ getDefaultName()

override string OpenCVForUnity.Features2dModule.KAZE.getDefaultName ( )
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 OpenCVForUnity.Features2dModule.Feature2D.

◆ getDiffusivity()

int OpenCVForUnity.Features2dModule.KAZE.getDiffusivity ( )

◆ getExtended()

bool OpenCVForUnity.Features2dModule.KAZE.getExtended ( )

◆ getNOctaveLayers()

int OpenCVForUnity.Features2dModule.KAZE.getNOctaveLayers ( )

◆ getNOctaves()

int OpenCVForUnity.Features2dModule.KAZE.getNOctaves ( )

◆ getThreshold()

double OpenCVForUnity.Features2dModule.KAZE.getThreshold ( )

◆ getUpright()

bool OpenCVForUnity.Features2dModule.KAZE.getUpright ( )

◆ setDiffusivity()

void OpenCVForUnity.Features2dModule.KAZE.setDiffusivity ( int  diff)

◆ setExtended()

void OpenCVForUnity.Features2dModule.KAZE.setExtended ( bool  extended)

◆ setNOctaveLayers()

void OpenCVForUnity.Features2dModule.KAZE.setNOctaveLayers ( int  octaveLayers)

◆ setNOctaves()

void OpenCVForUnity.Features2dModule.KAZE.setNOctaves ( int  octaves)

◆ setThreshold()

void OpenCVForUnity.Features2dModule.KAZE.setThreshold ( double  threshold)

◆ setUpright()

void OpenCVForUnity.Features2dModule.KAZE.setUpright ( bool  upright)

Member Data Documentation

◆ DIFF_CHARBONNIER

const int OpenCVForUnity.Features2dModule.KAZE.DIFF_CHARBONNIER = 3

◆ DIFF_PM_G1

const int OpenCVForUnity.Features2dModule.KAZE.DIFF_PM_G1 = 0

◆ DIFF_PM_G2

const int OpenCVForUnity.Features2dModule.KAZE.DIFF_PM_G2 = 1

◆ DIFF_WEICKERT

const int OpenCVForUnity.Features2dModule.KAZE.DIFF_WEICKERT = 2

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