lti::similarityMatrix::parameters Class Reference

the parameters for the class similarityMatrix More...

#include <ltiSimilarityMatrix.h>

Inheritance diagram for lti::similarityMatrix::parameters:

[legend]

Collaboration diagram for lti::similarityMatrix::parameters:

[legend]

List of all members.

Public Types
enum	eModeType { BorderBased, AreaBased }
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
eModeType	mode
double(*	distFunction )(const rgbPixel &, const rgbPixel &)

---

Detailed Description

the parameters for the class similarityMatrix

---

Member Enumeration Documentation

enum lti::similarityMatrix::parameters::eModeType

type to specify which kind of color similarity should be computed.

Enumerator:

BorderBased	compute the similarity measure using the mean value of square of the color differences at the border between two objects
AreaBased	compute the similarity measure using the magnitude of the difference of the mean colors of each object

---

Constructor & Destructor Documentation

lti::similarityMatrix::parameters::parameters

(

)

default constructor

Reimplemented from lti::functor::parameters.

lti::similarityMatrix::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

lti::similarityMatrix::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::similarityMatrix::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Implements lti::functor::parameters.

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

(

)

const [virtual]

returns name of this type

Reimplemented from lti::functor::parameters.

parameters& lti::similarityMatrix::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::similarityMatrix::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::similarityMatrix::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::similarityMatrix::parameters::distFunction)(const rgbPixel &, const rgbPixel &)

function pointer used when evaluating the distance between two colors.

Default value: lti::similarityMatrix::chromaticity2

eModeType lti::similarityMatrix::parameters::mode

Color similarity modus (see eModusType).

Default value: BorderBased

---

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

• ltiSimilarityMatrix.h