lti::pdmGenerator::parameters Class Reference

the parameters for the class pdmGenerator More...

#include <ltiPdmGenerator.h>

Inheritance diagram for lti::pdmGenerator::parameters:

[legend]

Collaboration diagram for lti::pdmGenerator::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
int	maxNumberOfWeights
float	maxRelativeWeights

---

Detailed Description

the parameters for the class pdmGenerator

---

Constructor & Destructor Documentation

lti::pdmGenerator::parameters::parameters

(

)

default constructor

Reimplemented from lti::functor::parameters.

lti::pdmGenerator::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

lti::pdmGenerator::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::pdmGenerator::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Implements lti::functor::parameters.

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

const char* lti::pdmGenerator::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::functor::parameters.

parameters& lti::pdmGenerator::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::pdmGenerator::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[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.

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

int lti::pdmGenerator::parameters::maxNumberOfWeights

This parameter is an upper limit to the number of eigenvectors to consider.

Eigenvectors are ordered by magnitude of eigenvalue, so that the ones with high eigenvalues are chosen first. All others are discarded.

Only the first 2*maxNumberOfWeights eigenVectors are taken into account from a total of 2*N, where N is the number of points in one shape. Reasonable values lie between 0 and N.

If set to 0 (default), all eigenVectors will be used.

float lti::pdmGenerator::parameters::maxRelativeWeights

This parameter is a lower limit to the number of eigenvectors to consider.

At least the first K eigenVectors are taken into account, for which holds: (eigenValue[0] + ... + eigenValue[K-1]) / sum(eigenValue) >= maxRelativeWeights reasonable values range from 0.0 (none) to 1.0 (all).

---

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

• ltiPdmGenerator.h