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

#include <features2d.hpp>

Inheritance diagram for cv::BRISK:

Public Member Functions
virtual CV_WRAP String	getDefaultName () const CV_OVERRIDE

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

virtual CV_WRAP int	getThreshold () const =0

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

virtual CV_WRAP int	getOctaves () const =0

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

virtual CV_WRAP float	getPatternScale () const =0

Public Member Functions inherited from cv::Feature2D
virtual	~Feature2D ()

virtual CV_WRAP void	detect (InputArray image, CV_OUT std::vector< KeyPoint > &keypoints, InputArray mask=noArray())
	Detects keypoints in an image (first variant) or image set (second variant). More...

virtual CV_WRAP void	detect (InputArrayOfArrays images, CV_OUT std::vector< std::vector< KeyPoint > > &keypoints, InputArrayOfArrays masks=noArray())

virtual CV_WRAP void	compute (InputArray image, CV_OUT CV_IN_OUT 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). More...

virtual CV_WRAP void	compute (InputArrayOfArrays images, CV_OUT CV_IN_OUT std::vector< std::vector< KeyPoint > > &keypoints, OutputArrayOfArrays descriptors)

virtual CV_WRAP void	detectAndCompute (InputArray image, InputArray mask, CV_OUT std::vector< KeyPoint > &keypoints, OutputArray descriptors, bool useProvidedKeypoints=false)

virtual CV_WRAP int	descriptorSize () const

virtual CV_WRAP int	descriptorType () const

virtual CV_WRAP int	defaultNorm () const

CV_WRAP void	write (const String &fileName) const

CV_WRAP void	read (const String &fileName)

virtual void	write (FileStorage &) const CV_OVERRIDE
	Stores algorithm parameters in a file storage. More...

virtual CV_WRAP void	read (const FileNode &) CV_OVERRIDE
	Reads algorithm parameters from a file storage. More...

virtual CV_WRAP bool	empty () const CV_OVERRIDE
	Return true if detector object is empty. More...

CV_WRAP void	write (FileStorage &fs, const String &name) const

void	write (const Ptr< FileStorage > &fs, const String &name) const

Public Member Functions inherited from cv::Algorithm
	Algorithm ()

virtual	~Algorithm ()

virtual CV_WRAP void	clear ()
	Clears the algorithm state. More...

CV_WRAP void	write (FileStorage &fs, const String &name) const

void	write (const Ptr< FileStorage > &fs, const String &name=String()) const

virtual CV_WRAP void	save (const String &filename) const

Static Public Member Functions
static CV_WRAP Ptr< BRISK >	create (int thresh=30, int octaves=3, float patternScale=1.0f)
	The BRISK constructor. More...

static CV_WRAP 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. More...

static CV_WRAP 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. More...

Static Public Member Functions inherited from cv::Algorithm
template<typename _Tp >
static Ptr< _Tp >	read (const FileNode &fn)
	Reads algorithm from the file node. More...

template<typename _Tp >
static Ptr< _Tp >	load (const String &filename, const String &objname=String())
	Loads algorithm from the file. More...

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

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 [LCS11] .

Member Function Documentation

◆ create() [1/3]

static CV_WRAP Ptr<BRISK> cv::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

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 CV_WRAP Ptr<BRISK> cv::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

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 CV_WRAP Ptr<BRISK> cv::BRISK::create	(	int	thresh = `30`,
		int	octaves = `3`,
		float	patternScale = `1.0f`
	)

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.

◆ getDefaultName()

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

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 cv::Feature2D.

◆ getOctaves()

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

pure virtual

◆ getPatternScale()

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

pure virtual

◆ getThreshold()

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

pure virtual

◆ setOctaves()

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

pure virtual

Set detection octaves.

Parameters

octaves detection octaves. Use 0 to do single scale.

◆ setPatternScale()

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

pure virtual

Set detection patternScale.

Parameters

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

◆ setThreshold()

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

pure virtual

Set detection threshold.

Parameters

threshold AGAST detection threshold score.

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

build/release/_deps/opencv-src/include/opencv4/opencv2/features2d.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()