lti::kernelPCA::parameters Class Reference

the parameters for the class principalComponents More...

#include <ltiKPCA.h>

Inheritance diagram for lti::kernelPCA::parameters:

[legend]

Collaboration diagram for lti::kernelPCA::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	setKernel (const kernelFunctor< double > &k)
void	attachKernel (kernelFunctor< double > *k)
void	useExternalKernel (kernelFunctor< double > *k)
kernelFunctor< double > *	createKernel (const std::string &name) const
Public Attributes
kernelFunctor< double > *	kernel
int	resultDim
bool	autoDim
eigenSystem< double > *	eigen
bool	whitening
double	relevance

---

Detailed Description

the parameters for the class principalComponents

---

Constructor & Destructor Documentation

lti::kernelPCA::parameters::parameters

(

)

default constructor

Reimplemented from lti::linearAlgebraFunctor::parameters.

lti::kernelPCA::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::linearAlgebraFunctor::parameters.

lti::kernelPCA::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::linearAlgebraFunctor::parameters.

---

Member Function Documentation

void lti::kernelPCA::parameters::attachKernel

(

kernelFunctor< double > *

k

)

Sets a new kernel function.

The kernel which is passed here as an argument must have been allocated with new; it must not be a local variable. On destruction of the parameters object, the kernel will be deleted, i.e. this parameters instance will be responsible for the memory managment of the object.

virtual functor::parameters* lti::kernelPCA::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::linearAlgebraFunctor::parameters.

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

kernelFunctor<double>* lti::kernelPCA::parameters::createKernel

(

const std::string &

name

)

const

create a new kernel function, using its class name.

A pointer to the kernel function is returned, so that the caller may modify the kernel's parameters.

const char* lti::kernelPCA::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::linearAlgebraFunctor::parameters.

parameters& lti::kernelPCA::parameters::operator=

(

const parameters &

other

)

[inline]

Assigns the contents of the other object to this object.

virtual bool lti::kernelPCA::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::linearAlgebraFunctor::parameters.

void lti::kernelPCA::parameters::setKernel

(

const kernelFunctor< double > &

k

)

Sets a new kernel function.

A copy of the kernel will be done (so it is useless to change the parameters of the given kernel instance, because the internal kernel will never notice the changes done to its "parent").

void lti::kernelPCA::parameters::useExternalKernel

(

kernelFunctor< double > *

k

)

Sets a new kernel function.

The kernel which is passed here as an argument is not deleted by the parameters object, the caller must ensure that there are no memory leaks.

virtual bool lti::kernelPCA::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::linearAlgebraFunctor::parameters.

---

Member Data Documentation

bool lti::kernelPCA::parameters::autoDim

This flag determines, if the functor should determine a maximum allowable dimension itself.

"Maximum dimension" means that the dimension is equal to the number of eigenvalues of the covariance matrix which are larger than zero.

Default value: false

eigenSystem<double>* lti::kernelPCA::parameters::eigen

The eigensystem functor used for computing eigenvectors.

Default value: lti::jacobi<double>

kernelFunctor<double>* lti::kernelPCA::parameters::kernel

The kernel function.

Try to use the kernel setting methods in order to ensure a consistent memory managment of the pointed instance.

See also:

setKernel(),attachKernel(),useExternalKernel()

Default value: "linearKernel"

double lti::kernelPCA::parameters::relevance

The factor which determines relevant eigenvectors.

An eigenvector is considered relevant if its eigenvalue is at least as large as the largest eigenvalue divided by this number. Usually, it takes values between 1e4 and 1e6.

int lti::kernelPCA::parameters::resultDim

This is the maximal dimension of the reduced vectors.

Default value: 3

bool lti::kernelPCA::parameters::whitening

This flag determines if the functor should perform a whitening transform of the data.

Whitening means that 1. A KPCA is performed 2. A scaling of the transformed data by the inverse of the square root of the eigenvalues.

The default is false.

---

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

• ltiKPCA.h