Class implementing the BRISK keypoint detector and descriptor extractor, described in [LCS11] . More...

Public Member Functions
override string	getDefaultName ()

int	getOctaves ()

float	getPatternScale ()

int	getThreshold ()

void	setOctaves (int octaves)
	Set detection octaves.

void	setPatternScale (float patternScale)
	Set detection patternScale.

void	setThreshold (int threshold)
	Set detection threshold.

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.

override string	getDefaultName ()

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

static BRISK	create ()
	The BRISK constructor.

static BRISK	create (int thresh)
	The BRISK constructor.

static BRISK	create (int thresh, int octaves)
	The BRISK constructor.

static BRISK	create (int thresh, int octaves, float patternScale)
	The BRISK constructor.

static BRISK	create (int thresh, int octaves, MatOfFloat radiusList, MatOfInt numberList)
	The BRISK constructor for a custom pattern, detection threshold and octaves.

static BRISK	create (int thresh, int octaves, MatOfFloat radiusList, MatOfInt numberList, float dMax)
	The BRISK constructor for a custom pattern, detection threshold and octaves.

static BRISK	create (int thresh, int octaves, MatOfFloat radiusList, MatOfInt numberList, float dMax, float dMin)
	The BRISK constructor for a custom pattern, detection threshold and octaves.

static BRISK	create (int thresh, int octaves, MatOfFloat radiusList, MatOfInt numberList, float dMax, float dMin, MatOfInt indexChange)
	The BRISK constructor for a custom pattern, detection threshold and octaves.

static BRISK	create (MatOfFloat radiusList, MatOfInt numberList)
	The BRISK constructor for a custom pattern.

static BRISK	create (MatOfFloat radiusList, MatOfInt numberList, float dMax)
	The BRISK constructor for a custom pattern.

static BRISK	create (MatOfFloat radiusList, MatOfInt numberList, float dMax, float dMin)
	The BRISK constructor for a custom pattern.

static BRISK	create (MatOfFloat radiusList, MatOfInt numberList, float dMax, float dMin, MatOfInt indexChange)
	The BRISK constructor for a custom pattern.

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
override void	Dispose (bool disposing)

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 BRISK keypoint detector and descriptor extractor, described in [LCS11] .

Member Function Documentation

◆ fromPtr()

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

static

◆ create() [1/12]

static BRISK OpenCVForUnity.Features2dModule.BRISK.create ( )

static

The BRISK constructor.

Parameters

thresh	AGAST detection threshold score.
octaves	detection octaves. Use 0 to do single scale.
patternScale	apply this scale to the pattern used for sampling the neighbourhood of a keypoint.

◆ create() [2/12]

static BRISK OpenCVForUnity.Features2dModule.BRISK.create ( int thresh )

static

The BRISK constructor.

Parameters

thresh	AGAST detection threshold score.
octaves	detection octaves. Use 0 to do single scale.
patternScale	apply this scale to the pattern used for sampling the neighbourhood of a keypoint.

◆ create() [3/12]

static BRISK OpenCVForUnity.Features2dModule.BRISK.create	(	int	thresh,
		int	octaves )

static

The BRISK constructor.

Parameters

thresh	AGAST detection threshold score.
octaves	detection octaves. Use 0 to do single scale.
patternScale	apply this scale to the pattern used for sampling the neighbourhood of a keypoint.

◆ create() [4/12]

static BRISK OpenCVForUnity.Features2dModule.BRISK.create	(	int	thresh,
		int	octaves,
		float	patternScale )

static

The BRISK constructor.

Parameters

thresh	AGAST detection threshold score.
octaves	detection octaves. Use 0 to do single scale.
patternScale	apply this scale to the pattern used for sampling the neighbourhood of a keypoint.

◆ create() [5/12]

static BRISK OpenCVForUnity.Features2dModule.BRISK.create	(	int	thresh,
		int	octaves,
		MatOfFloat	radiusList,
		MatOfInt	numberList )

static

The BRISK constructor for a custom pattern, detection threshold and octaves.

Parameters

thresh	AGAST detection threshold score.
octaves	detection octaves. Use 0 to do single scale.
radiusList	defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).
numberList	defines the number of sampling points on the sampling circle. Must be the same size as radiusList..
dMax	threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).
dMin	threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).
indexChange	index remapping of the bits.

◆ create() [6/12]

static BRISK OpenCVForUnity.Features2dModule.BRISK.create	(	int	thresh,
		int	octaves,
		MatOfFloat	radiusList,
		MatOfInt	numberList,
		float	dMax )

static

The BRISK constructor for a custom pattern, detection threshold and octaves.

Parameters

thresh	AGAST detection threshold score.
octaves	detection octaves. Use 0 to do single scale.
radiusList	defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).
numberList	defines the number of sampling points on the sampling circle. Must be the same size as radiusList..
dMax	threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).
dMin	threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).
indexChange	index remapping of the bits.

◆ create() [7/12]

static BRISK OpenCVForUnity.Features2dModule.BRISK.create	(	int	thresh,
		int	octaves,
		MatOfFloat	radiusList,
		MatOfInt	numberList,
		float	dMax,
		float	dMin )

static

The BRISK constructor for a custom pattern, detection threshold and octaves.

Parameters

thresh	AGAST detection threshold score.
octaves	detection octaves. Use 0 to do single scale.
radiusList	defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).
numberList	defines the number of sampling points on the sampling circle. Must be the same size as radiusList..
dMax	threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).
dMin	threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).
indexChange	index remapping of the bits.

◆ create() [8/12]

static BRISK OpenCVForUnity.Features2dModule.BRISK.create	(	int	thresh,
		int	octaves,
		MatOfFloat	radiusList,
		MatOfInt	numberList,
		float	dMax,
		float	dMin,
		MatOfInt	indexChange )

static

The BRISK constructor for a custom pattern, detection threshold and octaves.

Parameters

thresh	AGAST detection threshold score.
octaves	detection octaves. Use 0 to do single scale.
radiusList	defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).
numberList	defines the number of sampling points on the sampling circle. Must be the same size as radiusList..
dMax	threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).
dMin	threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).
indexChange	index remapping of the bits.

◆ create() [9/12]

static BRISK OpenCVForUnity.Features2dModule.BRISK.create	(	MatOfFloat	radiusList,
		MatOfInt	numberList )

static

The BRISK constructor for a custom pattern.

Parameters

radiusList	defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).
numberList	defines the number of sampling points on the sampling circle. Must be the same size as radiusList..
dMax	threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).
dMin	threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).
indexChange	index remapping of the bits.

◆ create() [10/12]

static BRISK OpenCVForUnity.Features2dModule.BRISK.create	(	MatOfFloat	radiusList,
		MatOfInt	numberList,
		float	dMax )

static

The BRISK constructor for a custom pattern.

Parameters

radiusList	defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).
numberList	defines the number of sampling points on the sampling circle. Must be the same size as radiusList..
dMax	threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).
dMin	threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).
indexChange	index remapping of the bits.

◆ create() [11/12]

static BRISK OpenCVForUnity.Features2dModule.BRISK.create	(	MatOfFloat	radiusList,
		MatOfInt	numberList,
		float	dMax,
		float	dMin )

static

The BRISK constructor for a custom pattern.

Parameters

radiusList	defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).
numberList	defines the number of sampling points on the sampling circle. Must be the same size as radiusList..
dMax	threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).
dMin	threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).
indexChange	index remapping of the bits.

◆ create() [12/12]

static BRISK OpenCVForUnity.Features2dModule.BRISK.create	(	MatOfFloat	radiusList,
		MatOfInt	numberList,
		float	dMax,
		float	dMin,
		MatOfInt	indexChange )

static

The BRISK constructor for a custom pattern.

Parameters

radiusList	defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).
numberList	defines the number of sampling points on the sampling circle. Must be the same size as radiusList..
dMax	threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).
dMin	threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).
indexChange	index remapping of the bits.

◆ Dispose()

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

protectedvirtual

Reimplemented from OpenCVForUnity.CoreModule.Algorithm.

◆ getDefaultName()

override string OpenCVForUnity.Features2dModule.BRISK.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.

◆ getOctaves()

int OpenCVForUnity.Features2dModule.BRISK.getOctaves ( )

◆ getPatternScale()

float OpenCVForUnity.Features2dModule.BRISK.getPatternScale ( )

◆ getThreshold()

int OpenCVForUnity.Features2dModule.BRISK.getThreshold ( )

◆ setOctaves()

void OpenCVForUnity.Features2dModule.BRISK.setOctaves ( int octaves )

Set detection octaves.

Parameters

octaves detection octaves. Use 0 to do single scale.

◆ setPatternScale()

void OpenCVForUnity.Features2dModule.BRISK.setPatternScale ( float patternScale )

Set detection patternScale.

Parameters

patternScale apply this scale to the pattern used for sampling the neighbourhood of a keypoint.

◆ setThreshold()

void OpenCVForUnity.Features2dModule.BRISK.setThreshold ( int threshold )

Set detection threshold.

Parameters

threshold AGAST detection threshold score.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ __fromPtr__()

◆ create() [1/12]

◆ create() [2/12]

◆ create() [3/12]

◆ create() [4/12]

◆ create() [5/12]

◆ create() [6/12]

◆ create() [7/12]

◆ create() [8/12]

◆ create() [9/12]

◆ create() [10/12]

◆ create() [11/12]

◆ create() [12/12]

◆ Dispose()

◆ getDefaultName()

◆ getOctaves()

◆ getPatternScale()

◆ getThreshold()

◆ setOctaves()

◆ setPatternScale()

◆ setThreshold()

◆ fromPtr()