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

Inheritance diagram for OpenCVForUnity.Features2dModule.AKAZE:

Public Member Functions
void	setDescriptorType (int dtype)

int	getDescriptorType ()

void	setDescriptorSize (int dsize)

int	getDescriptorSize ()

void	setDescriptorChannels (int dch)

int	getDescriptorChannels ()

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

void	setMaxPoints (int max_points)

int	getMaxPoints ()

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...

override string	getDefaultName ()

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 AKAZE	__fromPtr__ (IntPtr addr)

static AKAZE	create (int descriptor_type, int descriptor_size, int descriptor_channels, float threshold, int nOctaves, int nOctaveLayers, int diffusivity, int max_points)
	The AKAZE constructor. More...

static AKAZE	create (int descriptor_type, int descriptor_size, int descriptor_channels, float threshold, int nOctaves, int nOctaveLayers, int diffusivity)
	The AKAZE constructor. More...

static AKAZE	create (int descriptor_type, int descriptor_size, int descriptor_channels, float threshold, int nOctaves, int nOctaveLayers)
	The AKAZE constructor. More...

static AKAZE	create (int descriptor_type, int descriptor_size, int descriptor_channels, float threshold, int nOctaves)
	The AKAZE constructor. More...

static AKAZE	create (int descriptor_type, int descriptor_size, int descriptor_channels, float threshold)
	The AKAZE constructor. More...

static AKAZE	create (int descriptor_type, int descriptor_size, int descriptor_channels)
	The AKAZE constructor. More...

static AKAZE	create (int descriptor_type, int descriptor_size)
	The AKAZE constructor. More...

static AKAZE	create (int descriptor_type)
	The AKAZE constructor. More...

static AKAZE	create ()
	The AKAZE 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	DESCRIPTOR_KAZE_UPRIGHT = 2

const int	DESCRIPTOR_KAZE = 3

const int	DESCRIPTOR_MLDB_UPRIGHT = 4

const int	DESCRIPTOR_MLDB = 5

Protected Member Functions
override void	Dispose (bool disposing)

Protected Member Functions inherited from OpenCVForUnity.Features2dModule.Feature2D
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 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 Function Documentation

◆ fromPtr()

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

static

◆ create() [1/9]

static AKAZE OpenCVForUnity.Features2dModule.AKAZE.create	(	int	descriptor_type,
		int	descriptor_size,
		int	descriptor_channels,
		float	threshold,
		int	nOctaves,
		int	nOctaveLayers,
		int	diffusivity,
		int	max_points
	)

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.

◆ create() [2/9]

static AKAZE OpenCVForUnity.Features2dModule.AKAZE.create	(	int	descriptor_type,
		int	descriptor_size,
		int	descriptor_channels,
		float	threshold,
		int	nOctaves,
		int	nOctaveLayers,
		int	diffusivity
	)

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.

◆ create() [3/9]

static AKAZE OpenCVForUnity.Features2dModule.AKAZE.create	(	int	descriptor_type,
		int	descriptor_size,
		int	descriptor_channels,
		float	threshold,
		int	nOctaves,
		int	nOctaveLayers
	)

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.

◆ create() [4/9]

static AKAZE OpenCVForUnity.Features2dModule.AKAZE.create	(	int	descriptor_type,
		int	descriptor_size,
		int	descriptor_channels,
		float	threshold,
		int	nOctaves
	)

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.

◆ create() [5/9]

static AKAZE OpenCVForUnity.Features2dModule.AKAZE.create	(	int	descriptor_type,
		int	descriptor_size,
		int	descriptor_channels,
		float	threshold
	)

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.

◆ create() [6/9]

static AKAZE OpenCVForUnity.Features2dModule.AKAZE.create	(	int	descriptor_type,
		int	descriptor_size,
		int	descriptor_channels
	)

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.

◆ create() [7/9]

static AKAZE OpenCVForUnity.Features2dModule.AKAZE.create	(	int	descriptor_type,
		int	descriptor_size
	)

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.

◆ create() [8/9]

static AKAZE OpenCVForUnity.Features2dModule.AKAZE.create ( int descriptor_type )

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.

◆ create() [9/9]

static AKAZE OpenCVForUnity.Features2dModule.AKAZE.create ( )

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.

◆ Dispose()

override void OpenCVForUnity.Features2dModule.AKAZE.Dispose ( bool disposing )

protectedvirtual

Reimplemented from OpenCVForUnity.CoreModule.Algorithm.

◆ getDefaultName()

override string OpenCVForUnity.Features2dModule.AKAZE.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.CoreModule.Algorithm.

◆ getDescriptorChannels()

int OpenCVForUnity.Features2dModule.AKAZE.getDescriptorChannels ( )

◆ getDescriptorSize()

int OpenCVForUnity.Features2dModule.AKAZE.getDescriptorSize ( )

◆ getDescriptorType()

int OpenCVForUnity.Features2dModule.AKAZE.getDescriptorType ( )

◆ getDiffusivity()

int OpenCVForUnity.Features2dModule.AKAZE.getDiffusivity ( )

◆ getMaxPoints()

int OpenCVForUnity.Features2dModule.AKAZE.getMaxPoints ( )

◆ getNOctaveLayers()

int OpenCVForUnity.Features2dModule.AKAZE.getNOctaveLayers ( )

◆ getNOctaves()

int OpenCVForUnity.Features2dModule.AKAZE.getNOctaves ( )

◆ getThreshold()

double OpenCVForUnity.Features2dModule.AKAZE.getThreshold ( )

◆ setDescriptorChannels()

void OpenCVForUnity.Features2dModule.AKAZE.setDescriptorChannels ( int dch )

◆ setDescriptorSize()

void OpenCVForUnity.Features2dModule.AKAZE.setDescriptorSize ( int dsize )

◆ setDescriptorType()

void OpenCVForUnity.Features2dModule.AKAZE.setDescriptorType ( int dtype )

◆ setDiffusivity()

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

◆ setMaxPoints()

void OpenCVForUnity.Features2dModule.AKAZE.setMaxPoints ( int max_points )

◆ setNOctaveLayers()

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

◆ setNOctaves()

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

◆ setThreshold()

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

Member Data Documentation

◆ DESCRIPTOR_KAZE

const int OpenCVForUnity.Features2dModule.AKAZE.DESCRIPTOR_KAZE = 3

◆ DESCRIPTOR_KAZE_UPRIGHT

const int OpenCVForUnity.Features2dModule.AKAZE.DESCRIPTOR_KAZE_UPRIGHT = 2

◆ DESCRIPTOR_MLDB

const int OpenCVForUnity.Features2dModule.AKAZE.DESCRIPTOR_MLDB = 5

◆ DESCRIPTOR_MLDB_UPRIGHT

const int OpenCVForUnity.Features2dModule.AKAZE.DESCRIPTOR_MLDB_UPRIGHT = 4

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

OpenCVForUnity/Assets/OpenCVForUnity/org/opencv/features2d/AKAZE.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ __fromPtr__()

◆ create() [1/9]

◆ create() [2/9]

◆ create() [3/9]

◆ create() [4/9]

◆ create() [5/9]

◆ create() [6/9]

◆ create() [7/9]

◆ create() [8/9]

◆ create() [9/9]

◆ Dispose()

◆ getDefaultName()

◆ getDescriptorChannels()

◆ getDescriptorSize()

◆ getDescriptorType()

◆ getDiffusivity()

◆ getMaxPoints()

◆ getNOctaveLayers()

◆ getNOctaves()

◆ getThreshold()

◆ setDescriptorChannels()

◆ setDescriptorSize()

◆ setDescriptorType()

◆ setDiffusivity()

◆ setMaxPoints()

◆ setNOctaveLayers()

◆ setNOctaves()

◆ setThreshold()

Member Data Documentation

◆ DESCRIPTOR_KAZE

◆ DESCRIPTOR_KAZE_UPRIGHT

◆ DESCRIPTOR_MLDB

◆ DESCRIPTOR_MLDB_UPRIGHT

◆ fromPtr()