cvr::labelAdjacencyMap::labelAdjacencyMap::parameters Class Reference

The parameters for the class labelAdjacencyMap. More...

#include <cvrLabelAdjacencyMap.h>

Inheritance diagram for cvr::labelAdjacencyMap::labelAdjacencyMap::parameters:

[legend]

Collaboration diagram for cvr::labelAdjacencyMap::labelAdjacencyMap::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
virtual const std::string &	name () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual parameters *	clone () const
virtual parameters *	newInstance () 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

---

Detailed Description

The parameters for the class labelAdjacencyMap.

---

Constructor & Destructor Documentation

cvr::labelAdjacencyMap::labelAdjacencyMap::parameters::parameters

(

)

default constructor

Reimplemented from cvr::functor::functor::parameters.

cvr::labelAdjacencyMap::labelAdjacencyMap::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from cvr::functor::functor::parameters.

cvr::labelAdjacencyMap::labelAdjacencyMap::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from cvr::functor::functor::parameters.

---

Member Function Documentation

virtual parameters* cvr::labelAdjacencyMap::labelAdjacencyMap::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Implements cvr::functor::functor::parameters.

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

virtual const std::string& cvr::labelAdjacencyMap::labelAdjacencyMap::parameters::name

(

)

const [virtual]

returns name of this type

Implements cvr::functor::functor::parameters.

virtual parameters* cvr::labelAdjacencyMap::labelAdjacencyMap::parameters::newInstance

(

)

const [virtual]

returns a pointer to a new instance of the parameters

Implements cvr::functor::functor::parameters.

parameters& cvr::labelAdjacencyMap::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 cvr::labelAdjacencyMap::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 cvr::parametersManager::parametersManager::parameters.

virtual bool cvr::labelAdjacencyMap::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 cvr::parametersManager::parametersManager::parameters.

---

Member Data Documentation

bool cvr::labelAdjacencyMap::labelAdjacencyMap::parameters::minColors

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

int cvr::labelAdjacencyMap::labelAdjacencyMap::parameters::neighborhood

Neighborhood used.

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

Default value: 8

palette cvr::labelAdjacencyMap::labelAdjacencyMap::parameters::thePalette

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: {cvr::Black,cvr::Red,cvr::Green,cvr::Blue,cvr::Yellow, cvr::Cyan,cvr::Magenta,cvr::DarkOrange,cvr::Lemon, cvr::Violet}

This default palette can be accessed anytime as cvr::labelAdjacencyMap::defaultPalette

---

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

• cvrLabelAdjacencyMap.h