lti::colorContrastGradient::parameters Class Reference

the parameters for the class gradientFunctor More...

#include <ltiColorContrastGradient.h>

Inheritance diagram for lti::colorContrastGradient::parameters:

[legend]

Collaboration diagram for lti::colorContrastGradient::parameters:

[legend]

List of all members.

Public Types
enum	eContrastFormat { MDD, Contrast, Maximum }
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
eContrastFormat	contrastFormat

---

Detailed Description

the parameters for the class gradientFunctor

---

Member Enumeration Documentation

enum lti::colorContrastGradient::parameters::eContrastFormat

Format types.

Enumerator:

MDD	Maximum Directional Derivative.
Contrast	Difference between maximum and minimum eigenvalues.
Maximum	Maximum among all color channels.

---

Constructor & Destructor Documentation

lti::colorContrastGradient::parameters::parameters

(

)

default constructor

Reimplemented from lti::gradientFunctor::parameters.

lti::colorContrastGradient::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::gradientFunctor::parameters.

lti::colorContrastGradient::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::gradientFunctor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::colorContrastGradient::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::gradientFunctor::parameters.

parameters& lti::colorContrastGradient::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::gradientFunctor::parameters.

const char* lti::colorContrastGradient::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::gradientFunctor::parameters.

parameters& lti::colorContrastGradient::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 from lti::gradientFunctor::parameters.

virtual bool lti::colorContrastGradient::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::gradientFunctor::parameters.

virtual bool lti::colorContrastGradient::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::gradientFunctor::parameters.

---

Member Data Documentation

eContrastFormat lti::colorContrastGradient::parameters::contrastFormat

The color gradient can be computed in several forms.

The maximum directional derivative (MDD) is not exactly contrast, but can provide a good edgeness measure. Its magnitude is the largest eigenvalue of the Jacobian matrix. The direction of the maximum directional derivative is used.

The Contrast activates the real color contrast form, equal to the difference of the eigenvalues of the square of the Jacobian matrix for each pixel.

The Maximum mode is not contrast any more. It just takes the largest scalar gradient of each color channel. The angle of the winner channel is used.

Default value: Contrast

---

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

• ltiColorContrastGradient.h