cvr::contrastEnhancement Class Reference
[Contrast Enhancement Algorithms]

Class contrastEnhancement. More...

#include <cvrContrastEnhancement.h>

Inheritance diagram for cvr::contrastEnhancement:

[legend]

Collaboration diagram for cvr::contrastEnhancement:

[legend]

List of all members.

Classes
class	parameters
	The parameters for the class contrastEnhancement. More...
Public Member Functions
	contrastEnhancement ()
	contrastEnhancement (const contrastEnhancement &other)
virtual	~contrastEnhancement ()
virtual bool	apply (channel &srcdest) const =0
virtual bool	apply (channel8 &srcdest) const =0
virtual bool	apply (const channel &src, channel &dest) const =0
virtual bool	apply (const channel8 &src, channel8 &dest) const =0
contrastEnhancement &	copy (const contrastEnhancement &other)
contrastEnhancement &	operator= (const contrastEnhancement &other)
virtual const std::string &	name () const
virtual contrastEnhancement *	clone () const =0
virtual contrastEnhancement *	newInstance () const =0
const parameters &	getParameters () const

---

Detailed Description

Class contrastEnhancement.

This is an abstract class used to define the common interface for all functors that achieve contrast enhancement (e.g. histogram equalization).

See also:

contrastEnhancement::parameters.

---

Constructor & Destructor Documentation

cvr::contrastEnhancement::contrastEnhancement

(

)

Default constructor.

cvr::contrastEnhancement::contrastEnhancement

(

const contrastEnhancement &

other

)

Copy constructor.

Parameters:

other

the object to be copied

virtual cvr::contrastEnhancement::~contrastEnhancement

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual bool cvr::contrastEnhancement::apply	(	const channel8 &	src,
		channel8 &	dest
	)			const [pure virtual]

Operates on a copy of the given arguments.

Parameters:

	src	channel8 with the source data.
	dest	channel8 where the result will be left.

Returns:

true if apply successful or false otherwise.

Implemented in cvr::histogramEqualization.

virtual bool cvr::contrastEnhancement::apply	(	const channel &	src,
		channel &	dest
	)			const [pure virtual]

Operates on a copy of the given arguments.

Parameters:

	src	channel with the source data.
	dest	channel where the result will be left.

Returns:

true if apply successful or false otherwise.

Implemented in cvr::histogramEqualization.

virtual bool cvr::contrastEnhancement::apply

(

channel8 &

srcdest

)

const [pure virtual]

Operates on the given argument.

Parameters:

srcdest

channel8 with the source data. The result will be left here too.

Returns:

true if apply successful or false otherwise.

Implemented in cvr::histogramEqualization.

virtual bool cvr::contrastEnhancement::apply

(

channel &

srcdest

)

const [pure virtual]

Operates on the given argument.

Parameters:

srcdest

channel with the source data. The result will be left here too.

Returns:

true if apply successful or false otherwise.

Implemented in cvr::histogramEqualization.

virtual contrastEnhancement* cvr::contrastEnhancement::clone

(

)

const [pure virtual]

Returns a pointer to a clone of this functor.

Implements cvr::functor.

Implemented in cvr::histogramEqualization.

contrastEnhancement& cvr::contrastEnhancement::copy

(

const contrastEnhancement &

other

)

Copy data of "other" functor.

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

const parameters& cvr::contrastEnhancement::getParameters

(

)

const

Returns used parameters.

Reimplemented from cvr::parametersManager.

Reimplemented in cvr::histogramEqualization.

virtual const std::string& cvr::contrastEnhancement::name

(

)

const [virtual]

Returns the complete name of the functor class.

Implements cvr::functor.

Reimplemented in cvr::histogramEqualization.

virtual contrastEnhancement* cvr::contrastEnhancement::newInstance

(

)

const [pure virtual]

Returns a pointer to a new instance of this functor.

Implements cvr::functor.

Implemented in cvr::histogramEqualization.

contrastEnhancement& cvr::contrastEnhancement::operator=

(

const contrastEnhancement &

other

)

Alias for copy member.

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

---

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

• cvrContrastEnhancement.h