Class cv::xfeatures2d::BRISK#

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

#include <opencv2/xfeatures2d.hpp>

Collaboration diagram for cv::xfeatures2d::BRISK:

Public Member Functions#

Public Member Functions inherited from cv::Feature2D

Return	Name	Description
	`~Feature2D()`
`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).
`void`	`compute(` `InputArrayOfArrays images,` `std::vector< std::vector< KeyPoint > > & keypoints,` `OutputArrayOfArrays descriptors )`
`int`	`defaultNorm()`
`int`	`descriptorSize()`
`int`	`descriptorType()`
`void`	`detect(` `InputArray image,` `std::vector< KeyPoint > & keypoints,` `InputArray mask = noArray() )`	Detects keypoints in an image (first variant) or image set (second variant).
`void`	`detect(` `InputArrayOfArrays images,` `std::vector< std::vector< KeyPoint > > & keypoints,` `InputArrayOfArrays masks = noArray() )`
`void`	`detectAndCompute(` `InputArray image,` `InputArray mask,` `std::vector< KeyPoint > & keypoints,` `OutputArray descriptors,` `bool useProvidedKeypoints = false )`
`bool`	`empty()`	Return true if detector object is empty.
`String`	`getDefaultName()`
`void`	`read(const FileNode & fn)`	Reads algorithm parameters from a file storage.
`void`	`read(const String & fileName)`
`void`	`write(const String & fileName)`
`void`	`write(FileStorage & fs)`	Stores algorithm parameters in a file storage.
`void`	`write(` `FileStorage & fs,` `const String & name )`

Public Member Functions inherited from cv::Algorithm

Return	Name	Description
	`Algorithm()`
	`~Algorithm()`
`void`	`clear()`	Clears the algorithm state.
`bool`	`empty()`	Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.
`String`	`getDefaultName()`
`void`	`read(const FileNode & fn)`	Reads algorithm parameters from a file storage.
`void`	`save(const String & filename)`
`void`	`write(` `const Ptr< FileStorage > & fs,` `const String & name = String() )`
`void`	`write(FileStorage & fs)`	Stores algorithm parameters in a file storage.
`void`	`write(` `FileStorage & fs,` `const String & name )`

Static Public Member Functions#

Static Public Member Functions inherited from cv::Algorithm

Return	Name	Description
`static Ptr< _Tp >`	`load(` `const String & filename,` `const String & objname = String() )`	Loads algorithm from the file.
`static Ptr< _Tp >`	`loadFromString(` `const String & strModel,` `const String & objname = String() )`	Loads algorithm from a String.
`static Ptr< _Tp >`	`read(const FileNode & fn)`	Reads algorithm from the file node.

Additional Inherited Members#

Detailed Description#

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

Member Function Documentation#

create()#

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

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()#

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

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()#

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

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()#

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

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.

getOctaves()#

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

getPatternScale()#

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

getThreshold()#

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

setOctaves()#

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

Set detection octaves.

Parameters

octaves — detection octaves. Use 0 to do single scale.

setPatternScale()#

void cv::xfeatures2d::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 cv::xfeatures2d::BRISK::setThreshold(int threshold)

Set detection threshold.

Parameters

threshold — AGAST detection threshold score.

Source file#

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

opencv2/xfeatures2d.hpp