cvr::surfLocalDescriptor::surfLocalDescriptor::parameters Class Reference

The parameters for the class surfLocalDescriptor. More...

#include <cvrSurfLocalDescriptor.h>

Inheritance diagram for cvr::surfLocalDescriptor::surfLocalDescriptor::parameters:

[legend]

Collaboration diagram for cvr::surfLocalDescriptor::surfLocalDescriptor::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual const std::string &	name () const
virtual parameters *	clone () const
virtual parameters *	newInstance () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
eOrientationMode	orientationMode
int	orientationClusters
int	waveletSize
bool	signSplit
float	gaussianWeight
int	numberOfSubregions
int	subregionSamples
bool	normalize
eBoundaryType	boundaryType

---

Detailed Description

The parameters for the class surfLocalDescriptor.

---

Constructor & Destructor Documentation

cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::parameters

(

)

Default constructor.

Reimplemented from cvr::functor::functor::parameters.

cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from cvr::functor::functor::parameters.

cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from cvr::functor::functor::parameters.

---

Member Function Documentation

virtual parameters* cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Implements cvr::functor::functor::parameters.

parameters& cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::copy

(

const parameters &

other

)

Copy the contents of a parameters object.

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

virtual const std::string& cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::name

(

)

const [virtual]

Returns the complete name of the parameters class.

Implements cvr::functor::functor::parameters.

virtual parameters* cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a new instance of the parameters.

Implements cvr::functor::functor::parameters.

parameters& cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::operator=

(

const parameters &

other

)

Copy the contents of a parameters object.

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

virtual bool cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[virtual]

Read the parameters from the given ioHandler.

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from cvr::parametersManager::parametersManager::parameters.

virtual bool cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [virtual]

Write the parameters in the given ioHandler.

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from cvr::parametersManager::parametersManager::parameters.

---

Member Data Documentation

eBoundaryType cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::boundaryType

Boundary type.

If part of a location falls outside the image, how this part should be interpreted. (Note however, that the center of each location MUST lie within the image boundaries.

Default value: Constant

float cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::gaussianWeight

Std.

Deviation of the gaussian function for weights.

The weights of the wavelet responses are computed with a gaussian that reduces the effects of elements far away from the location center. This is the standard deviation used for the gaussian function.

Default value: 3.5

bool cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::normalize

Normalize descriptor length.

If set to true, the length of the vector will be normalized to 1. If set to false, the descriptors will be intensity variant.

Default value: true

int cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::numberOfSubregions

Number of subregions per dimension to be considered.

For example, if you specify 4, then there will be 4x4=16 regions, each one represented in the descriptor by several values.

Default value: 4

int cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::orientationClusters

Number of clusters.

If the orientation mode is set to Cluster, then this is the number of orientations being used.

Default value: 12

eOrientationMode cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::orientationMode

Mode for consideration of the orientation in the descriptor computation.

Depending on the speed requirements vs. precision, which at the same time depend on the nature of the images, several modes are provided for the descriptor computation, with respect to the consideration of the orientation stored in the location.

See also:

surfLocationDescriptor::eOrientationMode

Default value: Approximate

bool cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::signSplit

If true, the length of the descriptor will be multiplied by four, since the statistics are split in terms of the signs of the wavelet responses.

If you set to true with the other parameters untouched, then the SURF-128 features described in the original paper will be generated.

Default value: false;

int cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::subregionSamples

Number of samples per dimension considered in each subregion.

The step between samples is always s, i.e. the radius of the location (or the scale where the location has been detected).

Note that the size of the complete described window is given by this value multiplied by the numberOfSubregions.

Default value: 5

int cvr::surfLocalDescriptor::surfLocalDescriptor::parameters::waveletSize

Size of the wavelet employed to compute the descriptors.

This value will be multiplied by location radius to produce de correct wavelet size.

Default value: 2

---

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

• cvrSurfLocalDescriptor.h