cvr::colorQuantization::colorQuantization::parameters Class Reference

The parameters for the class colorQuantization. More...

#include <cvrColorQuantization.h>

Inheritance diagram for cvr::colorQuantization::colorQuantization::parameters:

[legend]

Collaboration diagram for cvr::colorQuantization::colorQuantization::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
virtual	~parameters ()
virtual const std::string &	name () const
virtual parameters *	clone () const
virtual parameters *	newInstance () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
int	numberOfColors

---

Detailed Description

The parameters for the class colorQuantization.

---

Constructor & Destructor Documentation

cvr::colorQuantization::colorQuantization::parameters::parameters

(

)

Default constructor.

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

Reimplemented in cvr::kMColorQuantization::kMColorQuantization::parameters.

cvr::colorQuantization::colorQuantization::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

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

Reimplemented in cvr::kMColorQuantization::kMColorQuantization::parameters.

virtual cvr::colorQuantization::colorQuantization::parameters::~parameters

(

)

[virtual]

Destructor.

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

Reimplemented in cvr::kMColorQuantization::kMColorQuantization::parameters.

---

Member Function Documentation

virtual parameters* cvr::colorQuantization::colorQuantization::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

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

Reimplemented in cvr::kMColorQuantization::kMColorQuantization::parameters.

parameters& cvr::colorQuantization::colorQuantization::parameters::copy

(

const parameters &

other

)

Copy the other instance.here.

Reimplemented in cvr::kMColorQuantization::kMColorQuantization::parameters.

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

(

)

const [virtual]

Returns the name of this type.

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

Reimplemented in cvr::kMColorQuantization::kMColorQuantization::parameters.

virtual parameters* cvr::colorQuantization::colorQuantization::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a new instance of the parameters.

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

Reimplemented in cvr::kMColorQuantization::kMColorQuantization::parameters.

parameters& cvr::colorQuantization::colorQuantization::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 in cvr::kMColorQuantization::kMColorQuantization::parameters.

virtual bool cvr::colorQuantization::colorQuantization::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.

Reimplemented in cvr::kMColorQuantization::kMColorQuantization::parameters.

virtual bool cvr::colorQuantization::colorQuantization::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.

Reimplemented in cvr::kMColorQuantization::kMColorQuantization::parameters.

---

Member Data Documentation

int cvr::colorQuantization::colorQuantization::parameters::numberOfColors

Number of colors that the resulting quantization must have.

Usually this value must be between 2 and 256, but each functor can modify this requirement.

Default value: 256

---

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

• cvrColorQuantization.h