lti::monteCarloEstimator::parameters Class Reference

The parameters for the class monteCarloEstimator. More...

#include <ltiMonteCarloEstimator.h>

Inheritance diagram for lti::monteCarloEstimator::parameters:

[legend]

Collaboration diagram for lti::monteCarloEstimator::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 transformEstimator &estimator)
bool	existsTransform () const
const transformEstimator &	getTransform () const
Public Attributes
double	maxError
Protected Attributes
transformEstimator *	transform

---

Detailed Description

The parameters for the class monteCarloEstimator.

---

Constructor & Destructor Documentation

lti::monteCarloEstimator::parameters::parameters

(

)

Default constructor.

Reimplemented from lti::robustEstimator::parameters.

Reimplemented in lti::ransacEstimator::parameters.

lti::monteCarloEstimator::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from lti::robustEstimator::parameters.

Reimplemented in lti::ransacEstimator::parameters.

lti::monteCarloEstimator::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from lti::robustEstimator::parameters.

Reimplemented in lti::ransacEstimator::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::monteCarloEstimator::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Reimplemented from lti::robustEstimator::parameters.

Reimplemented in lti::ransacEstimator::parameters.

parameters& lti::monteCarloEstimator::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::robustEstimator::parameters.

Reimplemented in lti::ransacEstimator::parameters.

bool lti::monteCarloEstimator::parameters::existsTransform

(

)

const

Is a transform estimator allocated ?

Returns:

true is a transform estimator is allocated and false otherwise.

const transformEstimator& lti::monteCarloEstimator::parameters::getTransform

(

)

const

Gets the transform to be estimated.

If no estimator is allocated an exception is thrown.

const char* lti::monteCarloEstimator::parameters::getTypeName

(

)

const [virtual]

Returns name of this type.

Reimplemented from lti::robustEstimator::parameters.

Reimplemented in lti::ransacEstimator::parameters.

parameters& lti::monteCarloEstimator::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 from lti::robustEstimator::parameters.

Reimplemented in lti::ransacEstimator::parameters.

virtual bool lti::monteCarloEstimator::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::robustEstimator::parameters.

Reimplemented in lti::ransacEstimator::parameters.

void lti::monteCarloEstimator::parameters::setTransform

(

const transformEstimator &

estimator

)

Sets a new estimated transform.

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:

estimator

the transform to be estimated.

void lti::monteCarloEstimator::parameters::setTransform

(

eTransformEstimatorType

name

)

Sets a new estimated transform.

Parameters:

name

the transform to be estimated.

virtual bool lti::monteCarloEstimator::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::robustEstimator::parameters.

Reimplemented in lti::ransacEstimator::parameters.

---

Member Data Documentation

double lti::monteCarloEstimator::parameters::maxError

The maximum error for a single correspondence or the averaged size of the residual.

Depending on the parameter settings the monteCarloEstimator normalizes the correspondences. This maximum error is not adjusted to the scaled data automatically. Thus supplying a meaningful value is left to the user.

Default: .8.

transformEstimator* lti::monteCarloEstimator::parameters::transform [protected]

The transform to be estimated.

Default: homography8Dof. Caution: May change in the near future.

---

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

• ltiMonteCarloEstimator.h