lti::histogramEqualization::parameters Class Reference

the parameters for the class histogramEqualization More...

#include <ltiHistogramEqualization.h>

Inheritance diagram for lti::histogramEqualization::parameters:

[legend]

Collaboration diagram for lti::histogramEqualization::parameters:

[legend]

List of all members.

Public Member Functions
	parameters (const float upperLimit=1.0f)
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (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
float	lowerInputLimit
float	lowerOutputLimit
int	cells
float	upperInputLimit
float	upperOutputLimit

---

Detailed Description

the parameters for the class histogramEqualization

---

Constructor & Destructor Documentation

lti::histogramEqualization::parameters::parameters

(

const float

upperLimit = 1.0f

)

default constructor

Parameters:

upperLimit

upper value used for the input and output upper limits. It is 1.0f as default, but if you plan to equalize channel8 objects, you should use 255

lti::histogramEqualization::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::modifier::parameters.

lti::histogramEqualization::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::histogramEqualization::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::modifier::parameters.

parameters& lti::histogramEqualization::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::modifier::parameters.

const char* lti::histogramEqualization::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::modifier::parameters.

virtual bool lti::histogramEqualization::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::modifier::parameters.

virtual bool lti::histogramEqualization::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::modifier::parameters.

---

Member Data Documentation

int lti::histogramEqualization::parameters::cells

the number of cells, the histogram uses for equalization

Default 256

float lti::histogramEqualization::parameters::lowerInputLimit

the least value equalized.

Use values in the same input range as the input parameter, i.e. values between 0.0 and 1.0 for channel equalization or values between 0 and 255 for channel8 equalization. Default 0.0

float lti::histogramEqualization::parameters::lowerOutputLimit

the least value the equalized values are mapped to.

Use values in the same input range as the input parameter, i.e. values between 0.0 and 1.0 for channel equalization or values between 0 and 255 for channel8 equalization. Default 0.0

float lti::histogramEqualization::parameters::upperInputLimit

the highest value equalized

Use values in the same input range as the input parameter, i.e. values between 0.0 and 1.0 for channel equalization or values between 0 and 255 for channel8 equalization Default 1.0

float lti::histogramEqualization::parameters::upperOutputLimit

the highest value the equalized values are mapped to

Use values in the same input range as the input parameter, i.e. values between 0.0 and 1.0 for channel equalization or values between 0 and 255 for channel8 equalization Default 1.0

---

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

• ltiHistogramEqualization.h