cv::SURF Class Reference

SURF implementation. More...

#include <features2d.hpp>

Inherits cv::Feature2D.

List of all members.

Public Types
typedef Algorithm *(*	Constructor )(void)
typedef int(Algorithm::*	Getter )() const
typedef void(Algorithm::*	Setter )(int)
Public Member Functions
CV_WRAP	SURF ()
	the default constructor
CV_WRAP	SURF (double hessianThreshold, int nOctaves=4, int nOctaveLayers=2, bool extended=true, bool upright=false)
	the full constructor taking all the necessary parameters
CV_WRAP int	descriptorSize () const
	returns the descriptor size in float's (64 or 128)
CV_WRAP int	descriptorType () const
	returns the descriptor type
void	operator() (InputArray img, InputArray mask, CV_OUT vector< KeyPoint > &keypoints) const
	finds the keypoints using fast hessian detector used in SURF
void	operator() (InputArray img, InputArray mask, CV_OUT vector< KeyPoint > &keypoints, OutputArray descriptors, bool useProvidedKeypoints=false) const
	finds the keypoints and computes their descriptors. Optionally it can compute descriptors for the user-provided keypoints
AlgorithmInfo *	info () const
	CV_WRAP_AS (detectAndCompute) virtual void operator()(InputArray image
CV_WRAP void	detect (const Mat &image, CV_OUT vector< KeyPoint > &keypoints, const Mat &mask=Mat()) const
void	detect (const vector< Mat > &images, vector< vector< KeyPoint > > &keypoints, const vector< Mat > &masks=vector< Mat >()) const
virtual CV_WRAP bool	empty () const
virtual CV_WRAP bool	empty () const
string	name () const
template<typename _Tp >
ParamType< _Tp >::member_type	get (const string &name) const
template<typename _Tp >
ParamType< _Tp >::member_type	get (const char *name) const
CV_WRAP int	getInt (const string &name) const
CV_WRAP double	getDouble (const string &name) const
CV_WRAP bool	getBool (const string &name) const
CV_WRAP string	getString (const string &name) const
CV_WRAP Mat	getMat (const string &name) const
CV_WRAP vector< Mat >	getMatVector (const string &name) const
CV_WRAP Ptr< Algorithm >	getAlgorithm (const string &name) const
void	set (const string &name, int value)
void	set (const string &name, double value)
void	set (const string &name, bool value)
void	set (const string &name, const string &value)
void	set (const string &name, const Mat &value)
void	set (const string &name, const vector< Mat > &value)
void	set (const string &name, const Ptr< Algorithm > &value)
template<typename _Tp >
void	set (const string &name, const Ptr< _Tp > &value)
void	set (const char *name, int value)
void	set (const char *name, double value)
void	set (const char *name, bool value)
void	set (const char *name, const string &value)
void	set (const char *name, const Mat &value)
void	set (const char *name, const vector< Mat > &value)
void	set (const char *name, const Ptr< Algorithm > &value)
template<typename _Tp >
void	set (const char *name, const Ptr< _Tp > &value)
CV_WRAP void	setInt (const string &name, int value)
void	setInt (const char *name, int value)
CV_WRAP void	setDouble (const string &name, double value)
void	setDouble (const char *name, double value)
CV_WRAP void	setBool (const string &name, bool value)
void	setBool (const char *name, bool value)
CV_WRAP void	setString (const string &name, const string &value)
void	setString (const char *name, const string &value)
CV_WRAP void	setMat (const string &name, const Mat &value)
void	setMat (const char *name, const Mat &value)
CV_WRAP void	setMatVector (const string &name, const vector< Mat > &value)
void	setMatVector (const char *name, const vector< Mat > &value)
CV_WRAP void	setAlgorithm (const string &name, const Ptr< Algorithm > &value)
template<typename _Tp >
void	setAlgorithm (const string &name, const Ptr< _Tp > &value)
void	setAlgorithm (const char *name, const Ptr< Algorithm > &value)
template<typename _Tp >
void	setAlgorithm (const char *name, const Ptr< _Tp > &value)
CV_WRAP string	paramHelp (const string &name) const
int	paramType (const char *name) const
CV_WRAP int	paramType (const string &name) const
CV_WRAP void	getParams (CV_OUT vector< string > &names) const
virtual void	write (FileStorage &fs) const
virtual void	read (const FileNode &fn)
CV_WRAP void	compute (const Mat &image, CV_OUT CV_IN_OUT vector< KeyPoint > &keypoints, CV_OUT Mat &descriptors) const
void	compute (const vector< Mat > &images, vector< vector< KeyPoint > > &keypoints, vector< Mat > &descriptors) const
Static Public Member Functions
static CV_WRAP Ptr< Feature2D >	create (const string &name)
static CV_WRAP void	getList (CV_OUT vector< string > &algorithms)
static CV_WRAP Ptr< Algorithm >	_create (const string &name)
Public Attributes
CV_PROP_RW double	hessianThreshold
CV_PROP_RW int	nOctaves
CV_PROP_RW int	nOctaveLayers
CV_PROP_RW bool	extended
CV_PROP_RW bool	upright
InputArray	mask
InputArray CV_OUT vector < KeyPoint > &	keypoints
InputArray CV_OUT vector < KeyPoint > OutputArray	descriptors
InputArray CV_OUT vector < KeyPoint > OutputArray bool	useProvidedKeypoints = false ) const = 0
Protected Member Functions
void	detectImpl (const Mat &image, vector< KeyPoint > &keypoints, const Mat &mask=Mat()) const
void	computeImpl (const Mat &image, vector< KeyPoint > &keypoints, Mat &descriptors) const
Static Protected Member Functions
static void	removeInvalidPoints (const Mat &mask, vector< KeyPoint > &keypoints)
static void	removeBorderKeypoints (vector< KeyPoint > &keypoints, Size imageSize, int borderSize)

---

Detailed Description

SURF implementation.

The class implements SURF algorithm by H. Bay et al.

---

Member Typedef Documentation

typedef Algorithm*(* cv::Algorithm::Constructor)(void) [inherited]

typedef int(Algorithm::* cv::Algorithm::Getter)() const [inherited]

typedef void(Algorithm::* cv::Algorithm::Setter)(int) [inherited]

---

Constructor & Destructor Documentation

CV_WRAP cv::SURF::SURF

(

)

the default constructor

CV_WRAP cv::SURF::SURF	(	double	hessianThreshold,
		int	nOctaves = 4,
		int	nOctaveLayers = 2,
		bool	extended = true,
		bool	upright = false
	)		[explicit]

the full constructor taking all the necessary parameters

---

Member Function Documentation

CV_WRAP int cv::SURF::descriptorSize

(

)

const [virtual]

returns the descriptor size in float's (64 or 128)

Implements cv::DescriptorExtractor.

CV_WRAP int cv::SURF::descriptorType

(

)

const [virtual]

returns the descriptor type

Implements cv::DescriptorExtractor.

void cv::SURF::operator()	(	InputArray	img,
		InputArray	mask,
		CV_OUT vector< KeyPoint > &	keypoints
	)		const

finds the keypoints using fast hessian detector used in SURF

void cv::SURF::operator()	(	InputArray	img,
		InputArray	mask,
		CV_OUT vector< KeyPoint > &	keypoints,
		OutputArray	descriptors,
		bool	useProvidedKeypoints = false
	)		const

finds the keypoints and computes their descriptors. Optionally it can compute descriptors for the user-provided keypoints

AlgorithmInfo* cv::SURF::info

(

)

const [virtual]

Reimplemented from cv::Algorithm.

void cv::SURF::detectImpl	(	const Mat &	image,
		vector< KeyPoint > &	keypoints,
		const Mat &	mask = Mat()
	)		const [protected, virtual]

Implements cv::FeatureDetector.

void cv::SURF::computeImpl	(	const Mat &	image,
		vector< KeyPoint > &	keypoints,
		Mat &	descriptors
	)		const [protected, virtual]

Implements cv::DescriptorExtractor.

cv::Feature2D::CV_WRAP_AS

(

detectAndCompute

)

[inherited]

static CV_WRAP Ptr<Feature2D> cv::Feature2D::create

(

const string &

name

)

[static, inherited]

Reimplemented from cv::FeatureDetector.

CV_WRAP void cv::FeatureDetector::detect	(	const Mat &	image,
		CV_OUT vector< KeyPoint > &	keypoints,
		const Mat &	mask = Mat()
	)		const [inherited]

void cv::FeatureDetector::detect	(	const vector< Mat > &	images,
		vector< vector< KeyPoint > > &	keypoints,
		const vector< Mat > &	masks = vector< Mat >()
	)		const [inherited]

virtual CV_WRAP bool cv::FeatureDetector::empty

(

)

const [virtual, inherited]

Reimplemented in cv::DynamicAdaptedFeatureDetector, cv::PyramidAdaptedFeatureDetector, and cv::GridAdaptedFeatureDetector.

virtual CV_WRAP bool cv::DescriptorExtractor::empty

(

)

const [virtual, inherited]

Reimplemented in cv::CalonderDescriptorExtractor< T >, and cv::OpponentColorDescriptorExtractor.

static void cv::FeatureDetector::removeInvalidPoints	(	const Mat &	mask,
		vector< KeyPoint > &	keypoints
	)		[static, protected, inherited]

string cv::Algorithm::name

(

)

const [inherited]

template<typename _Tp >

ParamType< _Tp >::member_type cv::Algorithm::get

(

const string &

name

)

const [inherited]

template<typename _Tp >

ParamType< _Tp >::member_type cv::Algorithm::get

(

const char *

name

)

const [inherited]

CV_WRAP int cv::Algorithm::getInt

(

const string &

name

)

const [inherited]

CV_WRAP double cv::Algorithm::getDouble

(

const string &

name

)

const [inherited]

CV_WRAP bool cv::Algorithm::getBool

(

const string &

name

)

const [inherited]

CV_WRAP string cv::Algorithm::getString

(

const string &

name

)

const [inherited]

CV_WRAP Mat cv::Algorithm::getMat

(

const string &

name

)

const [inherited]

CV_WRAP vector<Mat> cv::Algorithm::getMatVector

(

const string &

name

)

const [inherited]

CV_WRAP Ptr<Algorithm> cv::Algorithm::getAlgorithm

(

const string &

name

)

const [inherited]

void cv::Algorithm::set	(	const string &	name,
		int	value
	)		[inherited]

void cv::Algorithm::set	(	const string &	name,
		double	value
	)		[inherited]

void cv::Algorithm::set	(	const string &	name,
		bool	value
	)		[inherited]

void cv::Algorithm::set	(	const string &	name,
		const string &	value
	)		[inherited]

void cv::Algorithm::set	(	const string &	name,
		const Mat &	value
	)		[inherited]

void cv::Algorithm::set	(	const string &	name,
		const vector< Mat > &	value
	)		[inherited]

void cv::Algorithm::set	(	const string &	name,
		const Ptr< Algorithm > &	value
	)		[inherited]

template<typename _Tp >

void cv::Algorithm::set	(	const string &	name,
		const Ptr< _Tp > &	value
	)		[inherited]

void cv::Algorithm::set	(	const char *	name,
		int	value
	)		[inherited]

void cv::Algorithm::set	(	const char *	name,
		double	value
	)		[inherited]

void cv::Algorithm::set	(	const char *	name,
		bool	value
	)		[inherited]

void cv::Algorithm::set	(	const char *	name,
		const string &	value
	)		[inherited]

void cv::Algorithm::set	(	const char *	name,
		const Mat &	value
	)		[inherited]

void cv::Algorithm::set	(	const char *	name,
		const vector< Mat > &	value
	)		[inherited]

void cv::Algorithm::set	(	const char *	name,
		const Ptr< Algorithm > &	value
	)		[inherited]

template<typename _Tp >

void cv::Algorithm::set	(	const char *	name,
		const Ptr< _Tp > &	value
	)		[inherited]

CV_WRAP void cv::Algorithm::setInt	(	const string &	name,
		int	value
	)		[inherited]

void cv::Algorithm::setInt	(	const char *	name,
		int	value
	)		[inherited]

CV_WRAP void cv::Algorithm::setDouble	(	const string &	name,
		double	value
	)		[inherited]

void cv::Algorithm::setDouble	(	const char *	name,
		double	value
	)		[inherited]

CV_WRAP void cv::Algorithm::setBool	(	const string &	name,
		bool	value
	)		[inherited]

void cv::Algorithm::setBool	(	const char *	name,
		bool	value
	)		[inherited]

CV_WRAP void cv::Algorithm::setString	(	const string &	name,
		const string &	value
	)		[inherited]

void cv::Algorithm::setString	(	const char *	name,
		const string &	value
	)		[inherited]

CV_WRAP void cv::Algorithm::setMat	(	const string &	name,
		const Mat &	value
	)		[inherited]

void cv::Algorithm::setMat	(	const char *	name,
		const Mat &	value
	)		[inherited]

CV_WRAP void cv::Algorithm::setMatVector	(	const string &	name,
		const vector< Mat > &	value
	)		[inherited]

void cv::Algorithm::setMatVector	(	const char *	name,
		const vector< Mat > &	value
	)		[inherited]

CV_WRAP void cv::Algorithm::setAlgorithm	(	const string &	name,
		const Ptr< Algorithm > &	value
	)		[inherited]

template<typename _Tp >

void cv::Algorithm::setAlgorithm	(	const string &	name,
		const Ptr< _Tp > &	value
	)		[inherited]

void cv::Algorithm::setAlgorithm	(	const char *	name,
		const Ptr< Algorithm > &	value
	)		[inherited]

template<typename _Tp >

void cv::Algorithm::setAlgorithm	(	const char *	name,
		const Ptr< _Tp > &	value
	)		[inherited]

CV_WRAP string cv::Algorithm::paramHelp

(

const string &

name

)

const [inherited]

int cv::Algorithm::paramType

(

const char *

name

)

const [inherited]

CV_WRAP int cv::Algorithm::paramType

(

const string &

name

)

const [inherited]

CV_WRAP void cv::Algorithm::getParams

(

CV_OUT vector< string > &

names

)

const [inherited]

virtual void cv::Algorithm::write

(

FileStorage &

fs

)

const [virtual, inherited]

Reimplemented in cv::CalonderDescriptorExtractor< T >, cv::FlannBasedMatcher, cv::DescriptorMatcher, cv::BriefDescriptorExtractor, cv::OpponentColorDescriptorExtractor, and cv::SimpleBlobDetector.

virtual void cv::Algorithm::read

(

const FileNode &

fn

)

[virtual, inherited]

Reimplemented in cv::CalonderDescriptorExtractor< T >, cv::FlannBasedMatcher, cv::DescriptorMatcher, cv::BriefDescriptorExtractor, cv::OpponentColorDescriptorExtractor, cv::SimpleBlobDetector, and cv::EM.

static CV_WRAP void cv::Algorithm::getList

(

CV_OUT vector< string > &

algorithms

)

[static, inherited]

static CV_WRAP Ptr<Algorithm> cv::Algorithm::_create

(

const string &

name

)

[static, inherited]

CV_WRAP void cv::DescriptorExtractor::compute	(	const Mat &	image,
		CV_OUT CV_IN_OUT vector< KeyPoint > &	keypoints,
		CV_OUT Mat &	descriptors
	)		const [inherited]

void cv::DescriptorExtractor::compute	(	const vector< Mat > &	images,
		vector< vector< KeyPoint > > &	keypoints,
		vector< Mat > &	descriptors
	)		const [inherited]

static void cv::DescriptorExtractor::removeBorderKeypoints	(	vector< KeyPoint > &	keypoints,
		Size	imageSize,
		int	borderSize
	)		[static, protected, inherited]

---

Member Data Documentation

CV_PROP_RW double cv::SURF::hessianThreshold

CV_PROP_RW int cv::SURF::nOctaves

CV_PROP_RW int cv::SURF::nOctaveLayers

CV_PROP_RW bool cv::SURF::extended

CV_PROP_RW bool cv::SURF::upright

InputArray cv::Feature2D::mask [inherited]

InputArray CV_OUT vector<KeyPoint>& cv::Feature2D::keypoints [inherited]

InputArray CV_OUT vector<KeyPoint> OutputArray cv::Feature2D::descriptors [inherited]

InputArray CV_OUT vector<KeyPoint> OutputArray bool cv::Feature2D::useProvidedKeypoints = false ) const = 0 [inherited]

---

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

• include/opencv2/nonfree/features2d.hpp