LTI-Lib latest version v1.9 - last update 10 Apr 2010

lti::labelAdjacencyMap::parameters Class Reference

the parameters for the class labelAdjacencyMap More...

#include <ltiLabelAdjacencyMap.h>

Inheritance diagram for lti::labelAdjacencyMap::parameters:
Inheritance graph
[legend]
Collaboration diagram for lti::labelAdjacencyMap::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

bool minColors
palette thePalette
int neighborhood

Static Public Attributes

static const palette defaultPalette

Detailed Description

the parameters for the class labelAdjacencyMap


Constructor & Destructor Documentation

lti::labelAdjacencyMap::parameters::parameters (  ) 

default constructor

Reimplemented from lti::functor::parameters.

lti::labelAdjacencyMap::parameters::parameters ( const parameters other  ) 

copy constructor

Parameters:
other the parameters object to be copied
lti::labelAdjacencyMap::parameters::~parameters (  )  [virtual]

destructor

Reimplemented from lti::functor::parameters.


Member Function Documentation

virtual functor::parameters* lti::labelAdjacencyMap::parameters::clone (  )  const [virtual]

returns a pointer to a clone of the parameters

Implements lti::functor::parameters.

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

returns name of this type

Reimplemented from lti::functor::parameters.

parameters& lti::labelAdjacencyMap::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::labelAdjacencyMap::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::labelAdjacencyMap::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

If true, the mininum number of colors will be used, which will depend on the neighborhood used.

(a max of 4 colors is required for a 4 neighborhood, and a max of 8 color for a 8 neighborhood).

If false, all colors in the palette might be used.

Default: false

Neighborhood used.

Valid values are 4 and 8. Other values will be considered as 8-neighborhood.

Default value: 8

The colors used to denote the labels.

Note that the assigment is not 1 to 1, but will be done depending on the adjacency of the labels.

Default: {lti::Black,lti::Red,lti::Green,lti::Blue,lti::Yellow, lti::Cyan,lti::Magenta,lti::DarkOrange,lti::Lemon, lti::Violet}

This default palette can be access anytime as lti::labelAdjacencyMap::parameters::defaultPalette


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

Generated on Sat Apr 10 15:27:28 2010 for LTI-Lib by Doxygen 1.6.1