Class implementing the FREAK (Fast Retina Keypoint) keypoint descriptor, described in [AOV12] . More...

Public Member Functions
override string	getDefaultName ()

int	getNOctaves ()

bool	getOrientationNormalized ()

double	getPatternScale ()

bool	getScaleNormalized ()

void	setNOctaves (int nOctaves)

void	setOrientationNormalized (bool orientationNormalized)

void	setPatternScale (double patternScale)

void	setScaleNormalized (bool scaleNormalized)

Public Member Functions inherited from OpenCVForUnity.Features2dModule.Feature2D
void	compute (List< Mat > images, List< MatOfKeyPoint > keypoints, List< Mat > descriptors)

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

int	defaultNorm ()

int	descriptorSize ()

int	descriptorType ()

void	detect (List< Mat > images, List< MatOfKeyPoint > keypoints)

void	detect (List< Mat > images, List< MatOfKeyPoint > keypoints, List< Mat > masks)

void	detect (Mat image, MatOfKeyPoint keypoints)
	Detects keypoints in an image (first variant) or image set (second variant).

void	detect (Mat image, MatOfKeyPoint keypoints, Mat mask)
	Detects keypoints in an image (first variant) or image set (second variant).

void	detectAndCompute (Mat image, Mat mask, MatOfKeyPoint keypoints, Mat descriptors)

void	detectAndCompute (Mat image, Mat mask, MatOfKeyPoint keypoints, Mat descriptors, bool useProvidedKeypoints)

override bool	empty ()
	Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.

void	read (string fileName)

void	write (string fileName)

Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
virtual void	clear ()
	Clears the algorithm state.

IntPtr	getNativeObjAddr ()

void	save (string filename)

Public Member Functions inherited from OpenCVForUnity.DisposableObject
void	Dispose ()

void	ThrowIfDisposed ()

Static Public Member Functions
static new FREAK	__fromPtr__ (IntPtr addr)

static FREAK	create ()

static FREAK	create (bool orientationNormalized)

static FREAK	create (bool orientationNormalized, bool scaleNormalized)

static FREAK	create (bool orientationNormalized, bool scaleNormalized, float patternScale)

static FREAK	create (bool orientationNormalized, bool scaleNormalized, float patternScale, int nOctaves)

static FREAK	create (bool orientationNormalized, bool scaleNormalized, float patternScale, int nOctaves, MatOfInt selectedPairs)

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)

Protected Member Functions
override void	Dispose (bool disposing)

Protected Member Functions inherited from OpenCVForUnity.Features2dModule.Feature2D
Protected Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
	DisposableOpenCVObject ()

	DisposableOpenCVObject (bool isEnabledDispose)

	DisposableOpenCVObject (IntPtr ptr)

	DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)

Protected Member Functions inherited from OpenCVForUnity.DisposableObject
	DisposableObject ()

	DisposableObject (bool isEnabledDispose)

Additional Inherited Members
Package Functions inherited from OpenCVForUnity.Features2dModule.Feature2D
Package Functions inherited from OpenCVForUnity.CoreModule.Algorithm
Package Attributes inherited from OpenCVForUnity.DisposableOpenCVObject
Properties inherited from OpenCVForUnity.DisposableObject
bool	IsDisposed `[get, protected set]`

bool	IsEnabledDispose `[get, set]`

Detailed Description

Class implementing the FREAK (Fast Retina Keypoint) keypoint descriptor, described in [AOV12] .

The algorithm propose a novel keypoint descriptor inspired by the human visual system and more precisely the retina, coined Fast Retina Key- point (FREAK). A cascade of binary strings is computed by efficiently comparing image intensities over a retinal sampling pattern. FREAKs are in general faster to compute with lower memory load and also more robust than SIFT, SURF or BRISK. They are competitive alternatives to existing keypoints in particular for embedded applications.

Note

An example on how to use the FREAK descriptor can be found at opencv_source_code/samples/cpp/freak_demo.cpp

Member Function Documentation

◆ fromPtr()

static new FREAK OpenCVForUnity.Xfeatures2dModule.FREAK.__fromPtr__ ( IntPtr addr )

static

◆ create() [1/6]

static FREAK OpenCVForUnity.Xfeatures2dModule.FREAK.create ( )

static

Parameters

orientationNormalized	Enable orientation normalization.
scaleNormalized	Enable scale normalization.
patternScale	Scaling of the description pattern.
nOctaves	Number of octaves covered by the detected keypoints.
selectedPairs	(Optional) user defined selected pairs indexes,

◆ create() [2/6]

static FREAK OpenCVForUnity.Xfeatures2dModule.FREAK.create ( bool orientationNormalized )

static

Parameters

orientationNormalized	Enable orientation normalization.
scaleNormalized	Enable scale normalization.
patternScale	Scaling of the description pattern.
nOctaves	Number of octaves covered by the detected keypoints.
selectedPairs	(Optional) user defined selected pairs indexes,

◆ create() [3/6]

static FREAK OpenCVForUnity.Xfeatures2dModule.FREAK.create	(	bool	orientationNormalized,
		bool	scaleNormalized )

static

Parameters

orientationNormalized	Enable orientation normalization.
scaleNormalized	Enable scale normalization.
patternScale	Scaling of the description pattern.
nOctaves	Number of octaves covered by the detected keypoints.
selectedPairs	(Optional) user defined selected pairs indexes,

◆ create() [4/6]

static FREAK OpenCVForUnity.Xfeatures2dModule.FREAK.create	(	bool	orientationNormalized,
		bool	scaleNormalized,
		float	patternScale )

static

Parameters

orientationNormalized	Enable orientation normalization.
scaleNormalized	Enable scale normalization.
patternScale	Scaling of the description pattern.
nOctaves	Number of octaves covered by the detected keypoints.
selectedPairs	(Optional) user defined selected pairs indexes,

◆ create() [5/6]

static FREAK OpenCVForUnity.Xfeatures2dModule.FREAK.create	(	bool	orientationNormalized,
		bool	scaleNormalized,
		float	patternScale,
		int	nOctaves )

static

Parameters

orientationNormalized	Enable orientation normalization.
scaleNormalized	Enable scale normalization.
patternScale	Scaling of the description pattern.
nOctaves	Number of octaves covered by the detected keypoints.
selectedPairs	(Optional) user defined selected pairs indexes,

◆ create() [6/6]

static FREAK OpenCVForUnity.Xfeatures2dModule.FREAK.create	(	bool	orientationNormalized,
		bool	scaleNormalized,
		float	patternScale,
		int	nOctaves,
		MatOfInt	selectedPairs )

static

Parameters

orientationNormalized	Enable orientation normalization.
scaleNormalized	Enable scale normalization.
patternScale	Scaling of the description pattern.
nOctaves	Number of octaves covered by the detected keypoints.
selectedPairs	(Optional) user defined selected pairs indexes,

◆ Dispose()

override void OpenCVForUnity.Xfeatures2dModule.FREAK.Dispose ( bool disposing )

protectedvirtual

Reimplemented from OpenCVForUnity.Features2dModule.Feature2D.

◆ getDefaultName()

override string OpenCVForUnity.Xfeatures2dModule.FREAK.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.

◆ getNOctaves()

int OpenCVForUnity.Xfeatures2dModule.FREAK.getNOctaves ( )

◆ getOrientationNormalized()

bool OpenCVForUnity.Xfeatures2dModule.FREAK.getOrientationNormalized ( )

◆ getPatternScale()

double OpenCVForUnity.Xfeatures2dModule.FREAK.getPatternScale ( )

◆ getScaleNormalized()

bool OpenCVForUnity.Xfeatures2dModule.FREAK.getScaleNormalized ( )

◆ setNOctaves()

void OpenCVForUnity.Xfeatures2dModule.FREAK.setNOctaves ( int nOctaves )

◆ setOrientationNormalized()

void OpenCVForUnity.Xfeatures2dModule.FREAK.setOrientationNormalized ( bool orientationNormalized )

◆ setPatternScale()

void OpenCVForUnity.Xfeatures2dModule.FREAK.setPatternScale ( double patternScale )

◆ setScaleNormalized()

void OpenCVForUnity.Xfeatures2dModule.FREAK.setScaleNormalized ( bool scaleNormalized )

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

OpenCVForUnity/Assets/OpenCVForUnity/org/opencv_contrib/xfeatures2d/FREAK.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ __fromPtr__()

◆ create() [1/6]

◆ create() [2/6]

◆ create() [3/6]

◆ create() [4/6]

◆ create() [5/6]

◆ create() [6/6]

◆ Dispose()

◆ getDefaultName()

◆ getNOctaves()

◆ getOrientationNormalized()

◆ getPatternScale()

◆ getScaleNormalized()

◆ setNOctaves()

◆ setOrientationNormalized()

◆ setPatternScale()

◆ setScaleNormalized()

◆ fromPtr()