lti::fastICA< T >::parameters Class Reference

The parameters for the class fastICA. More...

#include <ltiFastICA.h>

Inheritance diagram for lti::fastICA< T >::parameters:

[legend]

Collaboration diagram for lti::fastICA< T >::parameters:

[legend]

List of all members.

Public Types
enum	eOrthogonalizationMethod { Deflationary, Symmetric }
enum	eNegentropyApproximation { Exp, Tanh, Kurt }
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	maxSteps
T	epsilon
eOrthogonalizationMethod	orthogonalizationMethod
eNegentropyApproximation	negentropyApproximation
T	expAlpha
T	tanhAlpha

Detailed Description

template<class T>
class lti::fastICA< T >::parameters

The parameters for the class fastICA.

Member Enumeration Documentation

template<class T>

enum lti::fastICA::parameters::eNegentropyApproximation

Enumeration of negentropyApproximation methods.

In fact the first and second derivation of the stated functions are used in the algorithm.

Enumerator:

Exp	using $G(x)=-\frac{1}{\alpha_{exp}}exp(-\frac{\alpha_{exp}}{2}u^2)$ as negentropy approximation function
Tanh	using $G(u)=\frac{1}{\alpha_{tanh}}log (cosh(\alpha_{tanh}u))$ as negentropy approximation function
Kurt	using as negentropy Approximation function

template<class T>

enum lti::fastICA::parameters::eOrthogonalizationMethod

Enumeration of orthogonalization methods.

Enumerator:

Deflationary	The ICs are computed one after another and orthogonalization is done dependent on the already computed ICs (first component has a free choice of direction).
Symmetric	The ICs are computed in parallel and orthogonalization is done after each iteration step considering all ICs.

Constructor & Destructor Documentation

template<class T>

lti::fastICA< T >::parameters::parameters ( void ) [inline]

Default constructor.

Reimplemented from lti::linearAlgebraFunctor::parameters.

References lti::fastICA< T >::parameters::Deflationary, lti::fastICA< T >::parameters::epsilon, lti::fastICA< T >::parameters::Exp, lti::fastICA< T >::parameters::expAlpha, lti::fastICA< T >::parameters::maxSteps, lti::fastICA< T >::parameters::negentropyApproximation, lti::fastICA< T >::parameters::orthogonalizationMethod, and lti::fastICA< T >::parameters::tanhAlpha.

Referenced by lti::fastICA< T >::parameters::clone().

template<class T>

lti::fastICA< T >::parameters::parameters ( const parameters & other ) [inline]

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from lti::linearAlgebraFunctor::parameters.

References lti::fastICA< T >::parameters::copy().

template<class T>

lti::fastICA< T >::parameters::~parameters ( ) [inline, virtual]

Destructor.

Reimplemented from lti::linearAlgebraFunctor::parameters.

Member Function Documentation

template<class T>

virtual functor::parameters* lti::fastICA< T >::parameters::clone ( ) const [inline, virtual]

Returns a pointer to a clone of the parameters.

Reimplemented from lti::linearAlgebraFunctor::parameters.

References lti::fastICA< T >::parameters::parameters().

template<class T>

parameters& lti::fastICA< T >::parameters::copy ( const parameters & other ) [inline]

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::linearAlgebraFunctor::parameters.

References lti::linearAlgebraFunctor::parameters::copy(), lti::fastICA< T >::parameters::epsilon, lti::fastICA< T >::parameters::expAlpha, lti::fastICA< T >::parameters::maxSteps, lti::fastICA< T >::parameters::negentropyApproximation, lti::fastICA< T >::parameters::orthogonalizationMethod, and lti::fastICA< T >::parameters::tanhAlpha.

Referenced by lti::fastICA< T >::parameters::operator=(), and lti::fastICA< T >::parameters::parameters().

template<class T>

const char* lti::fastICA< T >::parameters::getTypeName ( void ) const [inline, virtual]

Returns name of this type.

Reimplemented from lti::linearAlgebraFunctor::parameters.

template<class T>

parameters& lti::fastICA< T >::parameters::operator= ( const parameters & other ) [inline]

Copy the contents of a parameters object.

Parameters:

other

the parameters object to be copied

Returns:: a reference to this parameters object

References lti::fastICA< T >::parameters::copy().

template<class T>

virtual bool lti::fastICA< T >::parameters::read	(	ioHandler &	handler,
		const bool	complete = `true`
	)			`[inline, 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 read was successful

Reimplemented from lti::linearAlgebraFunctor::parameters.

template<class T>

virtual bool lti::fastICA< T >::parameters::write	(	ioHandler &	handler,
		const bool	complete = `true`
	)			const `[inline, 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.