cvr::histogramEqualization::histogramEqualization::parameters Class Reference

The parameters for the class cvr::histogramEqualization. More...

#include <cvrHistogramEqualization.h>

Inheritance diagram for cvr::histogramEqualization::histogramEqualization::parameters:

[legend]

Collaboration diagram for cvr::histogramEqualization::histogramEqualization::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
virtual const std::string &	name () const
virtual parameters *	clone () const
virtual parameters *	newInstance () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
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 cvr::histogramEqualization.

---

Constructor & Destructor Documentation

cvr::histogramEqualization::histogramEqualization::parameters::parameters

(

)

Default constructor.

Reimplemented from cvr::contrastEnhancement::contrastEnhancement::parameters.

cvr::histogramEqualization::histogramEqualization::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from cvr::contrastEnhancement::contrastEnhancement::parameters.

cvr::histogramEqualization::histogramEqualization::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from cvr::contrastEnhancement::contrastEnhancement::parameters.

---

Member Function Documentation

virtual parameters* cvr::histogramEqualization::histogramEqualization::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Reimplemented from cvr::contrastEnhancement::contrastEnhancement::parameters.

parameters& cvr::histogramEqualization::histogramEqualization::parameters::copy

(

const parameters &

other

)

Copy the other instance.here.

Reimplemented from cvr::contrastEnhancement::contrastEnhancement::parameters.

virtual const std::string& cvr::histogramEqualization::histogramEqualization::parameters::name

(

)

const [virtual]

Returns the name of this type.

Reimplemented from cvr::contrastEnhancement::contrastEnhancement::parameters.

virtual parameters* cvr::histogramEqualization::histogramEqualization::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a new instance of the parameters.

Reimplemented from cvr::contrastEnhancement::contrastEnhancement::parameters.

parameters& cvr::histogramEqualization::histogramEqualization::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 cvr::contrastEnhancement::contrastEnhancement::parameters.

virtual bool cvr::histogramEqualization::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 cvr::contrastEnhancement::contrastEnhancement::parameters.

virtual bool cvr::histogramEqualization::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 cvr::contrastEnhancement::contrastEnhancement::parameters.

---

Member Data Documentation

int cvr::histogramEqualization::histogramEqualization::parameters::cells

The number of cells, the histogram uses for equalization.

Default 256

float cvr::histogramEqualization::histogramEqualization::parameters::lowerInputLimit

The least normalized value equalized.

Use always values in the range between 0.0 and 1.0.

Depending on the matrix type used, the values will be de-normalized using the typeInfo<T>::suggestedNorm().

Default 0.0

float cvr::histogramEqualization::histogramEqualization::parameters::lowerOutputLimit

The least value the equalized values are mapped to.

Use always values in the range between 0.0 and 1.0.

Depending on the matrix type used, the values will be de-normalized using the typeInfo<T>::suggestedNorm().

Default 0.0

float cvr::histogramEqualization::histogramEqualization::parameters::upperInputLimit

The highest value equalized.

Use always values in the range between 0.0 and 1.0.

Depending on the matrix type used, the values will be de-normalized using the typeInfo<T>::suggestedNorm().

Default 1.0

float cvr::histogramEqualization::histogramEqualization::parameters::upperOutputLimit

The highest value the equalized values are mapped to.

Use always values in the range between 0.0 and 1.0.

Depending on the matrix type used, the values will be de-normalized using the typeInfo<T>::suggestedNorm().

Default 1.0

---

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

• cvrHistogramEqualization.h