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

#include <opencv2/features2d.hpp>

Inheritance diagram for cv::BRISK:

Collaboration diagram for cv::BRISK:

Public Member Functions
virtual void	clear ()
	Clears the algorithm state. More...

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

virtual void	compute (InputArrayOfArrays images, std::vector< std::vector< KeyPoint > > &keypoints, OutputArrayOfArrays descriptors)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

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

virtual void	detect (InputArrayOfArrays images, std::vector< std::vector< KeyPoint > > &keypoints, InputArrayOfArrays masks=noArray())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

virtual void	detectAndCompute (InputArray image, InputArray mask, std::vector< KeyPoint > &keypoints, OutputArray descriptors, bool useProvidedKeypoints=false)
	Detects keypoints and computes the descriptors. More...

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

virtual String	getDefaultName () const CV_OVERRIDE
	Returns the algorithm string identifier. More...

virtual int	getOctaves () const

virtual int	getThreshold () const

void	read (const String &fileName)

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

virtual void	save (const String &filename) const
	Saves the algorithm to a file. More...

virtual void	setOctaves (int octaves)
	Set detection octaves. More...

virtual void	setThreshold (int threshold)
	Set detection threshold. More...

void	write (const String &fileName) const

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

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

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

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

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

Protected Member Functions
void	writeFormat (FileStorage &fs) const

Detailed Description

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

Member Function Documentation

◆ clear()

virtual void cv::Algorithm::clear ( )

inlinevirtualinherited

Clears the algorithm state.

Reimplemented in cv::FlannBasedMatcher, and cv::DescriptorMatcher.

◆ compute() [1/2]

virtual void cv::Feature2D::compute	(	InputArray	image,
		std::vector< KeyPoint > &	keypoints,
		OutputArray	descriptors
	)

virtualinherited

Computes the descriptors for a set of keypoints detected in an image (first variant) or image set (second variant).

Parameters

image	Image.
keypoints	Input collection of keypoints. Keypoints for which a descriptor cannot be computed are removed. Sometimes new keypoints can be added, for example: SIFT duplicates keypoint with several dominant orientations (for each orientation).
descriptors	Computed descriptors. In the second variant of the method descriptors[i] are descriptors computed for a keypoints[i]. Row j is the keypoints (or keypoints[i]) is the descriptor for keypoint j-th keypoint.

◆ compute() [2/2]

virtual void cv::Feature2D::compute	(	InputArrayOfArrays	images,
		std::vector< std::vector< KeyPoint > > &	keypoints,
		OutputArrayOfArrays	descriptors
	)

virtualinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

images	Image set.
keypoints	Input collection of keypoints. Keypoints for which a descriptor cannot be computed are removed. Sometimes new keypoints can be added, for example: SIFT duplicates keypoint with several dominant orientations (for each orientation).
descriptors	Computed descriptors. In the second variant of the method descriptors[i] are descriptors computed for a keypoints[i]. Row j is the keypoints (or keypoints[i]) is the descriptor for keypoint j-th keypoint.

◆ create() [1/3]

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

◆ create() [2/3]

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

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

◆ defaultNorm()

virtual int cv::Feature2D::defaultNorm ( ) const

virtualinherited

◆ descriptorSize()

virtual int cv::Feature2D::descriptorSize ( ) const

virtualinherited

◆ descriptorType()

virtual int cv::Feature2D::descriptorType ( ) const

virtualinherited

◆ detect() [1/2]

virtual void cv::Feature2D::detect	(	InputArray	image,
		std::vector< KeyPoint > &	keypoints,
		InputArray	mask = `noArray()`
	)

virtualinherited

Detects keypoints in an image (first variant) or image set (second variant).

Parameters

image	Image.
keypoints	The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .
mask	Mask specifying where to look for keypoints (optional). It must be a 8-bit integer matrix with non-zero values in the region of interest.

◆ detect() [2/2]

virtual void cv::Feature2D::detect	(	InputArrayOfArrays	images,
		std::vector< std::vector< KeyPoint > > &	keypoints,
		InputArrayOfArrays	masks = `noArray()`
	)

virtualinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

images	Image set.
keypoints	The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .
masks	Masks for each input image specifying where to look for keypoints (optional). masks[i] is a mask for images[i].

◆ detectAndCompute()

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

virtualinherited

Detects keypoints and computes the descriptors.

◆ empty()

virtual bool cv::Feature2D::empty ( ) const

virtualinherited

Return true if detector object is empty.

Reimplemented from cv::Algorithm.

◆ getDefaultName()

virtual 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 int cv::BRISK::getOctaves ( ) const

inlinevirtual

◆ getThreshold()

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

inlinevirtual

◆ load()

template<typename _Tp >

static Ptr<_Tp> cv::Algorithm::load	(	const String &	filename,
		const String &	objname = `String()`
	)

inlinestaticinherited

Loads algorithm from the file.

Parameters

filename	Name of the file to read.
objname	The optional name of the node to read (if empty, the first top-level node will be used)

This is static template method of Algorithm. It's usage is following (in the case of SVM):

Ptr<SVM> svm = Algorithm::load<SVM>("my_svm_model.xml");

In order to make this method work, the derived class must overwrite Algorithm::read(const FileNode& fn).

References CV_Assert, cv::FileNode::empty(), cv::FileStorage::getFirstTopLevelNode(), cv::FileStorage::isOpened(), and cv::FileStorage::READ.

Here is the call graph for this function:

◆ loadFromString()

template<typename _Tp >

static Ptr<_Tp> cv::Algorithm::loadFromString	(	const String &	strModel,
		const String &	objname = `String()`
	)

inlinestaticinherited

Loads algorithm from a String.

Parameters

strModel	The string variable containing the model you want to load.
objname	The optional name of the node to read (if empty, the first top-level node will be used)

This is static template method of Algorithm. It's usage is following (in the case of SVM):

Ptr<SVM> svm = Algorithm::loadFromString<SVM>(myStringModel);

References CV_WRAP, cv::FileNode::empty(), cv::FileStorage::getFirstTopLevelNode(), cv::FileStorage::MEMORY, and cv::FileStorage::READ.

Here is the call graph for this function:

◆ read() [1/2]

void cv::Feature2D::read ( const String & fileName )

inherited

◆ read() [2/2]

virtual void cv::Feature2D::read ( const FileNode & fn )

virtualinherited

Reads algorithm parameters from a file storage.

Reimplemented from cv::Algorithm.

◆ save()

virtual void cv::Algorithm::save ( const String & filename ) const

virtualinherited

Saves the algorithm to a file.

In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).

◆ setOctaves()

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

inlinevirtual

Set detection octaves.

Parameters

octaves detection octaves. Use 0 to do single scale.

◆ setThreshold()

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

inlinevirtual

Set detection threshold.

Parameters

threshold AGAST detection threshold score.

◆ write() [1/3]

void cv::Feature2D::write ( const String & fileName ) const

inherited

◆ write() [2/3]

virtual void cv::Feature2D::write ( FileStorage & fs ) const

virtualinherited

Stores algorithm parameters in a file storage.

Reimplemented from cv::Algorithm.

◆ write() [3/3]

void cv::Feature2D::write	(	const Ptr< FileStorage > &	fs,
		const String &	name = `String()`
	)		const

inlineinherited

References cv::Algorithm::write().

Here is the call graph for this function:

◆ writeFormat()

void cv::Algorithm::writeFormat ( FileStorage & fs ) const

protectedinherited

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

opencv2/features2d.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ clear()

◆ compute() [1/2]

◆ compute() [2/2]

◆ create() [1/3]

◆ create() [2/3]

◆ create() [3/3]

◆ defaultNorm()

◆ descriptorSize()

◆ descriptorType()

◆ detect() [1/2]

◆ detect() [2/2]

◆ detectAndCompute()

◆ empty()

◆ getDefaultName()

◆ getOctaves()

◆ getThreshold()

◆ load()

◆ loadFromString()

◆ read() [1/2]

◆ read() [2/2]

◆ save()

◆ setOctaves()

◆ setThreshold()

◆ write() [1/3]

◆ write() [2/3]

◆ write() [3/3]

◆ writeFormat()