lti::opponentColor::parameters Class Reference

the parameters for the class opponentColor More...

#include <ltiOpponentColor.h>

Inheritance diagram for lti::opponentColor::parameters:

[legend]

Collaboration diagram for lti::opponentColor::parameters:

[legend]

List of all members.

Public Types
enum	eFunctionType { Normal, Abs, Ramp }
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
lti::ubyte	centerLevel
float	centerSign
lti::ubyte	surroundLevel
float	surroundSign
eFunctionType	outFunc

---

Detailed Description

the parameters for the class opponentColor

---

Member Enumeration Documentation

enum lti::opponentColor::parameters::eFunctionType

Type to specify the way negative values should be considered.

Enumerator:

Normal	linear condition, the negative values are keep as they are
Abs	absolute value, the negative values are multiplied with -1
Ramp	rectification, negative values are not allowed, and will be mapped to zero

---

Constructor & Destructor Documentation

lti::opponentColor::parameters::parameters

(

)

default constructor

Reimplemented from lti::transform::parameters.

lti::opponentColor::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::transform::parameters.

lti::opponentColor::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::opponentColor::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::transform::parameters.

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

Reimplemented from lti::transform::parameters.

const char* lti::opponentColor::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::transform::parameters.

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

lti::ubyte lti::opponentColor::parameters::centerLevel

defines the level of the GaussianPyramid for the center channel.

default: 0

float lti::opponentColor::parameters::centerSign

Multiply factor for the center channel before adding to the opponent channel (i.e.

the sourround channel) default: -1

eFunctionType lti::opponentColor::parameters::outFunc

defines the handle with the negative values in the dest-image Normal: no changes Abs : absolute value Ramp : values<0 to zero

lti::ubyte lti::opponentColor::parameters::surroundLevel

defines the level of the GaussianPyramid for the surround channel.

default: 1

float lti::opponentColor::parameters::surroundSign

Multiply factor for the surround channel before adding to the opponent channel (i.e.

the center channel) default: +1

---

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

• ltiOpponentColor.h