iptk::Threshold Class Reference

#include <threshold.h>

Inheritance diagram for iptk::Threshold:

[legend]Collaboration diagram for iptk::Threshold:

[legend]List of all members.

---

Detailed Description

Class to perform a thresholding operation.

The threshold has to be set using the setParams member function. The registered image is modified after a call to this function.

Public Member Functions
	Threshold (void)
	Default Constructor.
	Threshold (const iptk::Image &im)
	Image registering constructor.
	Threshold (const Threshold &t)
	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	~Threshold ()
	Destructor.
virtual void	process (void)
	The function which actually performs the thresholding operation.
virtual void	setParams (double params[])
	Set the threshold value by calling this function.
virtual iptk::Image	getResult (void)
	Returns the result of the thresholding operation.

---

Constructor & Destructor Documentation

iptk::Threshold::Threshold (  void   )

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

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

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

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

Destructor. Does nothing.

---

Member Function Documentation

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

Returns the result of the thresholding operation. The returned image and the thresholded image share the same space in memory. Reimplemented from iptk::IP_Function.

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

The function which actually performs the thresholding operation. Call this function after the threshold is set by a call to setParams member functions. If the threshold is not set explicitly by the setParams function, then a default value of zero will be used for the threshold. Note that the registered image is modified after a call to this function. Implements iptk::IP_Function.

virtual void iptk::Threshold::setParams (  double  params[]  )  [virtual]

Set the threshold value by calling this function. The first element of the array params should have the threshold value. Reimplemented from iptk::IP_Function.

---

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

• threshold.h

---