lti::transformEstimator::parameters Class Reference

The parameters for the class transformEstimator. More...

#include <ltiTransformEstimator.h>

Inheritance diagram for lti::transformEstimator::parameters:

[legend]

Collaboration diagram for lti::transformEstimator::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)
Public Attributes
bool	computeSqError

---

Detailed Description

The parameters for the class transformEstimator.

---

Constructor & Destructor Documentation

lti::transformEstimator::parameters::parameters

(

)

Default constructor.

Reimplemented from lti::functor::parameters.

Reimplemented in lti::fMatrixEstimator::parameters, lti::fMatrixEstimatorBase::parameters, lti::homography8DofEstimator::parameters, lti::homography9DofEstimator::parameters, lti::homographyEstimatorBase::parameters, and lti::translationScaleEstimator::parameters.

lti::transformEstimator::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented in lti::fMatrixEstimator::parameters, lti::fMatrixEstimatorBase::parameters, lti::homography8DofEstimator::parameters, lti::homography9DofEstimator::parameters, lti::homographyEstimatorBase::parameters, and lti::translationScaleEstimator::parameters.

lti::transformEstimator::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from lti::functor::parameters.

Reimplemented in lti::fMatrixEstimator::parameters, lti::fMatrixEstimatorBase::parameters, lti::homography8DofEstimator::parameters, lti::homography9DofEstimator::parameters, lti::homographyEstimatorBase::parameters, and lti::translationScaleEstimator::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::transformEstimator::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Implements lti::functor::parameters.

Reimplemented in lti::fMatrixEstimator::parameters, lti::fMatrixEstimatorBase::parameters, lti::homography8DofEstimator::parameters, lti::homography9DofEstimator::parameters, lti::homographyEstimatorBase::parameters, and lti::translationScaleEstimator::parameters.

parameters& lti::transformEstimator::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 in lti::fMatrixEstimator::parameters, lti::fMatrixEstimatorBase::parameters, lti::homography8DofEstimator::parameters, lti::homography9DofEstimator::parameters, lti::homographyEstimatorBase::parameters, and lti::translationScaleEstimator::parameters.

const char* lti::transformEstimator::parameters::getTypeName

(

)

const [virtual]

Returns name of this type.

Reimplemented from lti::functor::parameters.

Reimplemented in lti::fMatrixEstimator::parameters, lti::fMatrixEstimatorBase::parameters, lti::homography8DofEstimator::parameters, lti::homography9DofEstimator::parameters, lti::homographyEstimatorBase::parameters, and lti::translationScaleEstimator::parameters.

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

Reimplemented in lti::fMatrixEstimator::parameters, lti::fMatrixEstimatorBase::parameters, lti::homography8DofEstimator::parameters, lti::homography9DofEstimator::parameters, lti::homographyEstimatorBase::parameters, and lti::translationScaleEstimator::parameters.

virtual bool lti::transformEstimator::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.

Reimplemented in lti::fMatrixEstimator::parameters, lti::fMatrixEstimatorBase::parameters, lti::homography8DofEstimator::parameters, lti::homography9DofEstimator::parameters, lti::homographyEstimatorBase::parameters, and lti::translationScaleEstimator::parameters.

virtual bool lti::transformEstimator::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.

Reimplemented in lti::fMatrixEstimator::parameters, lti::fMatrixEstimatorBase::parameters, lti::homography8DofEstimator::parameters, lti::homography9DofEstimator::parameters, lti::homographyEstimatorBase::parameters, and lti::translationScaleEstimator::parameters.

---

Member Data Documentation

bool lti::transformEstimator::parameters::computeSqError

For runtime efficiency a squared error (e.g.

elementwise squared residual) may be computed, which spares taking the square root.

Default: false.

---

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

• ltiTransformEstimator.h