iptk::NeighbourhoodStatisticsFilter Class Reference

#include <neighbourhoodStatisticsFilter.h>

Inheritance diagram for iptk::NeighbourhoodStatisticsFilter:

[legend]Collaboration diagram for iptk::NeighbourhoodStatisticsFilter:

[legend]List of all members.

---

Detailed Description

An abstract base class to encapsulate a neighbourhood statistics filtering operation.

Any class derived from this class has to overide the process member function to enable object initialisation.

Public Member Functions
	NeighbourhoodStatisticsFilter (void)
	Default Constructor. An object created using the default constructor should set the image by using the setImage member function.
	NeighbourhoodStatisticsFilter (const iptk::Image &im)
	Image registering constructor. The image is autmatically registered at the construction stage.
	NeighbourhoodStatisticsFilter (const NeighbourhoodStatisticsFilter &nsf)
	Copy constructor. The image data is shared between the passed object(i.e the parameter to the copy constructor) and the new object.
virtual	~NeighbourhoodStatisticsFilter ()
	Destructor.
virtual void	process (void)=0
	A pure virtual function.
virtual void	setParams (double params[])
	Sets the value of the protected member NEIGHBOURHOOD.
virtual iptk::Image	getResult (void)
	Returns the protected member RESULT.
Protected Attributes
int	NEIGHBOURHOOD
	This variable holds the size of the neighbourhood the function should look into.
iptk::Image	RESULT
	This iptk::Image object holds the result of the filtering operation.

---

Member Function Documentation

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

Returns the protected member RESULT. The derived classes need to have to re-implement this function. Reimplemented from iptk::IP_Function.

virtual void iptk::NeighbourhoodStatisticsFilter::process (  void   )  [pure virtual]

A pure virtual function. See iptk::IP_Function for more information on this. This function is inherited iptk::IP_Function from. Implements iptk::IP_Function. Implemented in iptk::ImExtrema, iptk::MeanImage, iptk::MedianFilter, iptk::RangeImage, and iptk::SdImage.

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

Sets the value of the protected member NEIGHBOURHOOD. The derived classes need not have to re-implment this function. Reimplemented from iptk::IP_Function.

---

Member Data Documentation

int iptk::NeighbourhoodStatisticsFilter::NEIGHBOURHOOD [protected]

This variable holds the size of the neighbourhood the function should look into. For example, if it is initialised by a value of 5, then a neighbourhood of size 5 with 2 pixels on all sides of the current pixel, are used to extract the statistics. Classes derived from this class have to make use of this variable to know the neighbourhood size.

iptk::Image iptk::NeighbourhoodStatisticsFilter::RESULT [protected]

This iptk::Image object holds the result of the filtering operation. Classes derived from this class should store the resulting image in this iptk::Image object.

---

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

• neighbourhoodStatisticsFilter.h

---