lti::crossCorrelationCoefficient::parameters Class Reference

The parameters for the class crossCorrelationCoefficient. More...

#include <ltiCrossCorrelationCoefficient.h>

Inheritance diagram for lti::crossCorrelationCoefficient::parameters:

[legend]

Collaboration diagram for lti::crossCorrelationCoefficient::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual functor::parameters *	clone () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
void	setTransform (eTransformEstimatorType name)
void	setTransform (const homographyEstimatorBase &method)
bool	existsTransform () const
const homographyEstimatorBase &	getTransform () const
Public Attributes
int	window
Protected Attributes
homographyEstimatorBase *	transform

---

Detailed Description

The parameters for the class crossCorrelationCoefficient.

---

Constructor & Destructor Documentation

lti::crossCorrelationCoefficient::parameters::parameters

(

)

Default constructor.

Reimplemented from lti::featureExtractor::parameters.

lti::crossCorrelationCoefficient::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from lti::featureExtractor::parameters.

lti::crossCorrelationCoefficient::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from lti::featureExtractor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::crossCorrelationCoefficient::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Reimplemented from lti::featureExtractor::parameters.

parameters& lti::crossCorrelationCoefficient::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

Reimplemented from lti::featureExtractor::parameters.

bool lti::crossCorrelationCoefficient::parameters::existsTransform

(

)

const

Is a transform estimator allocated ?

Returns:

true is the transform estimator is allocated and false otherwise.

const homographyEstimatorBase& lti::crossCorrelationCoefficient::parameters::getTransform

(

)

const

Gets the transform estimator.

If no transform estiamtor is allocated an exception is thrown.

const char* lti::crossCorrelationCoefficient::parameters::getTypeName

(

)

const [virtual]

Returns name of this type.

Reimplemented from lti::featureExtractor::parameters.

parameters& lti::crossCorrelationCoefficient::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 lti::crossCorrelationCoefficient::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 lti::functor::parameters.

void lti::crossCorrelationCoefficient::parameters::setTransform

(

const homographyEstimatorBase &

method

)

Sets a new transform estimator.

The transform estimator is only used by applies that pass a transform-vector. If no transform estimator is specified then no transform is performed. A copy of the functor will be done (so it is useless to change the parameters of the given functor instance, because the internal functor will never notice the changes done to its "parent").

Parameters:

method

the transform estimator to be used.

void lti::crossCorrelationCoefficient::parameters::setTransform

(

eTransformEstimatorType

name

)

Sets a new transform estimator.

The transform estimator is only used by applies that pass a transform-vector. If no transform estimator is specified then no transform is performed.

Parameters:

name

the transform estimator to be used.

virtual bool lti::crossCorrelationCoefficient::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 lti::functor::parameters.

---

Member Data Documentation

homographyEstimatorBase* lti::crossCorrelationCoefficient::parameters::transform [protected]

The transform estimator.

The transform estimator is only used by applies that pass a transform-vector. If no transform estimator is specified then no transform is performed. On default no point set is transformed. Default: 0.

int lti::crossCorrelationCoefficient::parameters::window

The size of the window inside which a cross correlation is computed.

This parameters is only used by applies that utilize control points, i.e. do not compute the cross correlation for the entire vector or image. Only uneven windows are supported. Event windows are extended by one. Default: 10.

---

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

• ltiCrossCorrelationCoefficient.h