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

#include <opencv2/xfeatures2d.hpp>

Collaboration diagram for cv::xfeatures2d::BRISK:

Public Member Functions
virtual String	getDefaultName () const CV_OVERRIDE

virtual int	getOctaves () const =0

virtual float	getPatternScale () const =0

virtual int	getThreshold () const =0

virtual void	setOctaves (int octaves)=0
	Set detection octaves.

virtual void	setPatternScale (float patternScale)=0
	Set detection patternScale.

virtual void	setThreshold (int threshold)=0
	Set detection threshold.

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 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 (FileStorage &fs, const String &name) const

Static Public Member Functions
static Ptr< BRISK >	create (const std::vector< float > &radiusList, const std::vector< int > &numberList, float dMax=5.85f, float dMin=8.2f, const std::vector< int > &indexChange=std::vector< int >())
	The BRISK constructor for a custom pattern.

static Ptr< BRISK >	create (int thresh, int octaves, const std::vector< float > &radiusList, const std::vector< int > &numberList, float dMax=5.85f, float dMin=8.2f, const std::vector< int > &indexChange=std::vector< int >())
	The BRISK constructor for a custom pattern, detection threshold and octaves.

static Ptr< BRISK >	create (int thresh=30, int octaves=3, float patternScale=1.0f)
	The BRISK constructor.

Static Public Member Functions inherited from cv::Algorithm
template<typename _Tp >
static Ptr< _Tp >	load (const String &filename, const String &objname=String())
	Loads algorithm from the file.

template<typename _Tp >
static Ptr< _Tp >	loadFromString (const String &strModel, const String &objname=String())
	Loads algorithm from a String.

template<typename _Tp >
static Ptr< _Tp >	read (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 BRISK keypoint detector and descriptor extractor, described in [159] .

Member Function Documentation

◆ create() [1/3]

static Ptr< BRISK > cv::xfeatures2d::BRISK::create	(	const std::vector< float > &	radiusList,
		const std::vector< int > &	numberList,
		float	dMax = 5.85f,
		float	dMin = 8.2f,
		const std::vector< int > &	indexChange = std::vector< int >() )

static


cv.xfeatures2d.BRISK.create(	[, thresh[, octaves[, patternScale]]]	) ->	retval
cv.xfeatures2d.BRISK.create(	radiusList, numberList[, dMax[, dMin[, indexChange]]]	) ->	retval
cv.xfeatures2d.BRISK.create(	thresh, octaves, radiusList, numberList[, dMax[, dMin[, indexChange]]]	) ->	retval
cv.xfeatures2d.BRISK_create(	[, thresh[, octaves[, patternScale]]]	) ->	retval
cv.xfeatures2d.BRISK_create(	radiusList, numberList[, dMax[, dMin[, indexChange]]]	) ->	retval
cv.xfeatures2d.BRISK_create(	thresh, octaves, radiusList, numberList[, dMax[, dMin[, indexChange]]]	) ->	retval

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() [2/3]

static Ptr< BRISK > cv::xfeatures2d::BRISK::create	(	int	thresh,
		int	octaves,
		const std::vector< float > &	radiusList,
		const std::vector< int > &	numberList,
		float	dMax = 5.85f,
		float	dMin = 8.2f,
		const std::vector< int > &	indexChange = std::vector< int >() )

static


cv.xfeatures2d.BRISK.create(	[, thresh[, octaves[, patternScale]]]	) ->	retval
cv.xfeatures2d.BRISK.create(	radiusList, numberList[, dMax[, dMin[, indexChange]]]	) ->	retval
cv.xfeatures2d.BRISK.create(	thresh, octaves, radiusList, numberList[, dMax[, dMin[, indexChange]]]	) ->	retval
cv.xfeatures2d.BRISK_create(	[, thresh[, octaves[, patternScale]]]	) ->	retval
cv.xfeatures2d.BRISK_create(	radiusList, numberList[, dMax[, dMin[, indexChange]]]	) ->	retval
cv.xfeatures2d.BRISK_create(	thresh, octaves, radiusList, numberList[, dMax[, dMin[, indexChange]]]	) ->	retval

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() [3/3]

static Ptr< BRISK > cv::xfeatures2d::BRISK::create	(	int	thresh = 30,
		int	octaves = 3,
		float	patternScale = 1.0f )

static


cv.xfeatures2d.BRISK.create(	[, thresh[, octaves[, patternScale]]]	) ->	retval
cv.xfeatures2d.BRISK.create(	radiusList, numberList[, dMax[, dMin[, indexChange]]]	) ->	retval
cv.xfeatures2d.BRISK.create(	thresh, octaves, radiusList, numberList[, dMax[, dMin[, indexChange]]]	) ->	retval
cv.xfeatures2d.BRISK_create(	[, thresh[, octaves[, patternScale]]]	) ->	retval
cv.xfeatures2d.BRISK_create(	radiusList, numberList[, dMax[, dMin[, indexChange]]]	) ->	retval
cv.xfeatures2d.BRISK_create(	thresh, octaves, radiusList, numberList[, dMax[, dMin[, indexChange]]]	) ->	retval

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.

◆ getDefaultName()

virtual String cv::xfeatures2d::BRISK::getDefaultName ( ) const

virtual

Python:
	cv.xfeatures2d.BRISK.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.

◆ getOctaves()

virtual int cv::xfeatures2d::BRISK::getOctaves ( ) const

pure virtual

Python:
	cv.xfeatures2d.BRISK.getOctaves(		) ->	retval

◆ getPatternScale()

virtual float cv::xfeatures2d::BRISK::getPatternScale ( ) const

pure virtual

Python:
	cv.xfeatures2d.BRISK.getPatternScale(		) ->	retval

◆ getThreshold()

virtual int cv::xfeatures2d::BRISK::getThreshold ( ) const

pure virtual

Python:
	cv.xfeatures2d.BRISK.getThreshold(		) ->	retval

◆ setOctaves()

virtual void cv::xfeatures2d::BRISK::setOctaves ( int octaves )

pure virtual

Python:
	cv.xfeatures2d.BRISK.setOctaves(	octaves	) ->	None

Set detection octaves.

Parameters

octaves detection octaves. Use 0 to do single scale.

◆ setPatternScale()

virtual void cv::xfeatures2d::BRISK::setPatternScale ( float patternScale )

pure virtual

Python:
	cv.xfeatures2d.BRISK.setPatternScale(	patternScale	) ->	None

Set detection patternScale.

Parameters

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

◆ setThreshold()

virtual void cv::xfeatures2d::BRISK::setThreshold ( int threshold )

pure virtual

Python:
	cv.xfeatures2d.BRISK.setThreshold(	threshold	) ->	None

Set detection threshold.

Parameters

threshold AGAST detection threshold score.

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

opencv2/xfeatures2d.hpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create() [1/3]

◆ create() [2/3]

◆ create() [3/3]

◆ getDefaultName()

◆ getOctaves()

◆ getPatternScale()

◆ getThreshold()

◆ setOctaves()

◆ setPatternScale()

◆ setThreshold()