lti::lkmColorQuantization::parameters Class Reference

the parameters for the class lkmColorQuantization More...

#include <ltiLkmColorQuantization.h>

Inheritance diagram for lti::lkmColorQuantization::parameters:

[legend]

Collaboration diagram for lti::lkmColorQuantization::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
double	neighbour
double	learnRate
double	shrinkLearnRate
int	maxIterations

---

Detailed Description

the parameters for the class lkmColorQuantization

---

Constructor & Destructor Documentation

lti::lkmColorQuantization::parameters::parameters

(

)

default constructor

Reimplemented from lti::colorQuantization::parameters.

lti::lkmColorQuantization::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::colorQuantization::parameters.

lti::lkmColorQuantization::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::colorQuantization::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::lkmColorQuantization::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::colorQuantization::parameters.

parameters& lti::lkmColorQuantization::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::colorQuantization::parameters.

const char* lti::lkmColorQuantization::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::colorQuantization::parameters.

parameters& lti::lkmColorQuantization::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::colorQuantization::parameters.

virtual bool lti::lkmColorQuantization::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::colorQuantization::parameters.

virtual bool lti::lkmColorQuantization::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::colorQuantization::parameters.

---

Member Data Documentation

double lti::lkmColorQuantization::parameters::learnRate

this parameter is the startvalue for the weight of a new pixel.

Default value: 0.6

int lti::lkmColorQuantization::parameters::maxIterations

this parameter sets the upper limit for the iterations, if the algorithm hasn't convergated yet Default value: 10

double lti::lkmColorQuantization::parameters::neighbour

This parameter defines how strong is the influence of an changing paletteIndex towards the neighbour paletteIndex is.

Default value: 0.1

double lti::lkmColorQuantization::parameters::shrinkLearnRate

This parameter is the factor, the learnRate will be multiplicated with in every iteration It defines how fast the learnRate convergates to zero Default value: 0.5.

---

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

• ltiLkmColorQuantization.h