lti::SOFM2D::parameters Class Reference

the parameters for the class SOFM2D More...

#include <ltiSOFM2D.h>

Inheritance diagram for lti::SOFM2D::parameters:

[legend]

Collaboration diagram for lti::SOFM2D::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
virtual	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual classifier::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	calculateSize
int	sizeX
int	sizeY
int	area

---

Detailed Description

the parameters for the class SOFM2D

---

Constructor & Destructor Documentation

lti::SOFM2D::parameters::parameters

(

)

default constructor

Reimplemented from lti::SOFM::parameters.

lti::SOFM2D::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::SOFM::parameters.

virtual lti::SOFM2D::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::SOFM::parameters.

---

Member Function Documentation

virtual classifier::parameters* lti::SOFM2D::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::SOFM::parameters.

parameters& lti::SOFM2D::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::SOFM::parameters.

const char* lti::SOFM2D::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::SOFM::parameters.

parameters& lti::SOFM2D::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::SOFM::parameters.

virtual bool lti::SOFM2D::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::SOFM::parameters.

virtual bool lti::SOFM2D::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::SOFM::parameters.

---

Member Data Documentation

int lti::SOFM2D::parameters::area

approximate area of the grid when the dimension's sizes are calculated from the distribution of training points.

Default 0.

bool lti::SOFM2D::parameters::calculateSize

The dimensions of the grid can be given explicitely (calculateSize=false) by setting sizeX and sizeY or calculated from the distribution of the training points.

In the latter case, the two highest eigenvalues are calculated and multiplied by factor that after rounding the error to the given area is as small as possible. This method yields better unfolding of the grid at the cost of more calculations and possibly failure due to singularity of the covariance matrix of the training samples.

The default is false.

int lti::SOFM2D::parameters::sizeX

size of the grid of neurons in the first dimension.

Default 0.

int lti::SOFM2D::parameters::sizeY

size of the grid of neurons in the second dimension.

Default 0.

---

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

• ltiSOFM2D.h