iptk::HistogramEqualisation Class Reference

#include <histogramEqualisation.h>

Inheritance diagram for iptk::HistogramEqualisation:

[legend]Collaboration diagram for iptk::HistogramEqualisation:

[legend]List of all members.

---

Detailed Description

Class to perform a histogram equalisation.

This process modifies the image in place. Meaning that, after the call to the process member function, the image which has been registered is modified.

Public Member Functions
	HistogramEqualisation (void)
	Default Constructor.
	HistogramEqualisation (const iptk::Image &im)
	Image registering constructor.
	HistogramEqualisation (const HistogramEqualisation &he)
	Copy constructor Though this constructor does not look like a reference copier, the image data is shared between the passed object(i.e the parameter to the copy constructor) and the new object.
virtual	~HistogramEqualisation ()
	Do nothing destructor.
virtual void	process (void)
	The function which actaually does the equalisation.
virtual iptk::Image	getResult (void)
	The function which returns the processed image.
mutk::Vector	getHistogram (void)
	Returns the histogram of the image.

---

Constructor & Destructor Documentation

iptk::HistogramEqualisation::HistogramEqualisation (  void   )

Default Constructor. An object created using the default constructor should set the image by using the setImage member function.

iptk::HistogramEqualisation::HistogramEqualisation (  const iptk::Image &  im  )

Image registering constructor. The image is autmatically registered at the construction stage.

virtual iptk::HistogramEqualisation::~HistogramEqualisation (   )  [virtual]

Do nothing destructor. Destructor does nothing at all as the default destructor would have been sufficient.

---

Member Function Documentation

mutk::Vector iptk::HistogramEqualisation::getHistogram (  void   )

Returns the histogram of the image. Returns a valid histogram only after a call to the process member function. The returned Vector object holds the histogram of the image before the equalisation process. iptk::Image::getHistogram() might be a more appropriate function for you.

virtual iptk::Image iptk::HistogramEqualisation::getResult (  void   )  [virtual]

The function which returns the processed image. The returned image is same as the registered image. i.e., the image returned and the image registered share the same space in memory. Reimplemented from iptk::IP_Function.

virtual void iptk::HistogramEqualisation::process (  void   )  [virtual]

The function which actaually does the equalisation. The image is processed in place. Implements iptk::IP_Function.

---

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

• histogramEqualisation.h

---