LTI-Lib latest version v1.9 - last update 24 Nov 2005
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

lti::blobEM::parameters Class Reference

the parameters for the class blobEM More...

#include <ltiBlobEM.h>

Inheritance diagram for lti::blobEM::parameters:

Inheritance graph
[legend]
Collaboration diagram for lti::blobEM::parameters:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 parameters ()
 parameters (const parameters &other)
 ~parameters ()
const char * getTypeName () const
parameterscopy (const parameters &other)
parametersoperator= (const parameters &other)
virtual functor::parametersclone () const
virtual bool write (ioHandler &handler, const bool complete=true) const
virtual bool read (ioHandler &handler, const bool complete=true)

Public Attributes

int maxIterations
double convergenceThreshold

Detailed Description

the parameters for the class blobEM


Constructor & Destructor Documentation

lti::blobEM::parameters::parameters  ) 
 

default constructor

Reimplemented from lti::functor::parameters.

lti::blobEM::parameters::parameters const parameters other  ) 
 

copy constructor

Parameters:
other the parameters object to be copied

lti::blobEM::parameters::~parameters  )  [virtual]
 

destructor

Reimplemented from lti::functor::parameters.


Member Function Documentation

virtual functor::parameters* lti::blobEM::parameters::clone  )  const [virtual]
 

returns a pointer to a clone of the parameters

Implements lti::functor::parameters.

parameters& lti::blobEM::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::blobEM::parameters::getTypeName  )  const [virtual]
 

returns name of this type

Reimplemented from lti::functor::parameters.

parameters& lti::blobEM::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::blobEM::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::functor::parameters.

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

double lti::blobEM::parameters::convergenceThreshold
 

If the difference of the Q value between two successive iterations (relative to the last Q value) falls below this threshold, then the iterations are aborted.

A value < zero enforces the maximum number of iterations. Default 1e-6

int lti::blobEM::parameters::maxIterations
 

Maximum number of iterations.

Default = 100


The documentation for this class was generated from the following file:
Generated on Thu Nov 24 16:35:17 2005 for LTI-Lib by Doxygen 1.4.4