lti::kullbackContrast::parameters Class Reference

the parameters for the class kullbackContrast More...

#include <ltiKullbackContrast.h>

Inheritance diagram for lti::kullbackContrast::parameters:

[legend]

Collaboration diagram for lti::kullbackContrast::parameters:

[legend]

List of all members.

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
int	resolutions
bool	useGaussian
int	gaussianSize
double	gaussianVariance
bool	useHistogram
int	histogramSize

---

Detailed Description

the parameters for the class kullbackContrast

---

Constructor & Destructor Documentation

lti::kullbackContrast::parameters::parameters

(

)

default constructor

Reimplemented from lti::statisticsFunctor::parameters.

lti::kullbackContrast::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::statisticsFunctor::parameters.

lti::kullbackContrast::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::statisticsFunctor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::kullbackContrast::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::statisticsFunctor::parameters.

parameters& lti::kullbackContrast::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::statisticsFunctor::parameters.

const char* lti::kullbackContrast::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::statisticsFunctor::parameters.

parameters& lti::kullbackContrast::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::kullbackContrast::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[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.

virtual bool lti::kullbackContrast::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

int lti::kullbackContrast::parameters::gaussianSize

Size for the gaussian kernel used in the image diffusion (Default: 5).

double lti::kullbackContrast::parameters::gaussianVariance

Variance for the gaussian kernel used in the image diffusion.

(Default: 1.0)

int lti::kullbackContrast::parameters::histogramSize

indicates how many bins the histogram will have.

(Default: 256)

int lti::kullbackContrast::parameters::resolutions

Number of resolutions to be evaluated (Default 7 => 128 pixel).

bool lti::kullbackContrast::parameters::useGaussian

if useGaussian is true, a gaussian filter will be used, with the size and variance given in gaussianSize and gaussianVariance.

Otherwise a squareFilter will approximate the filter pyramid. Default: true

bool lti::kullbackContrast::parameters::useHistogram

if false, the channel contents will be directly used as a probability distribution.

If true, a histogram of the channel will be generated to approximate the probability distribution. The number of bins can be specified using the parameters histogramSize (Default: false)

---

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

• ltiKullbackContrast.h