iptk::RectangularMaskFilter Class Reference

#include <rectangularMaskFilter.h>

Inheritance diagram for iptk::RectangularMaskFilter:

[legend]Collaboration diagram for iptk::RectangularMaskFilter:

[legend]List of all members.

---

Detailed Description

A class to perform mask based filtering operation using a rectangular mask.

It is inherited from iptk::MaskFilter. The user can vary the size (as in width and height) of the mask using the setParams function.

Public Member Functions
	RectangularMaskFilter (void)
	Default constructor.
	RectangularMaskFilter (const iptk::Image &im)
	Image registration Constructor.
	RectangularMaskFilter (const RectangularMaskFilter &mf)
	Copy constructor.
virtual	~RectangularMaskFilter ()
	Do nothing destructor.
virtual void	setParams (double params[])
	Sets the size of the mask to be used.

---

Constructor & Destructor Documentation

iptk::RectangularMaskFilter::RectangularMaskFilter (  void   )

Default constructor. Initialises the private member image to a null image. You will have to follow the initialisation by a defualt constructor by a call to the inherited setImage function.

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

Image registration Constructor. Initialises the member image with the parameter im and hence registers it as the image.

iptk::RectangularMaskFilter::RectangularMaskFilter (  const RectangularMaskFilter &  mf  )

Copy constructor. The image data is shared between the passed object(i.e the parameter to the copy constructor) and the new object.

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

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

---

Member Function Documentation

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

Sets the size of the mask to be used. The first element of the parameter params should specify the width of the mask and the second element should specify the height of the mask. Reimplemented from iptk::IP_Function.

---

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

• rectangularMaskFilter.h

---