itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel > Class Template Reference
[Image Enhancement Filters, Mathematical Morphology Image Filters]

Base class for the morphological operations such as erosion and dialation. More...

#include <itkMorphologyImageFilter.h>

Inheritance diagram for itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >:

[legend]Collaboration diagram for itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >:

[legend]List of all members.

Public Types
typedef MorphologyImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef TOutputImage	OutputImageType
typedef TInputImage::RegionType	RegionType
typedef TInputImage::SizeType	SizeType
typedef TInputImage::IndexType	IndexType
typedef TInputImage::PixelType	PixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef ImageBoundaryCondition< InputImageType > *	ImageBoundaryConditionPointerType
typedef ImageBoundaryCondition< InputImageType > const *	ImageBoundaryConditionConstPointerType
typedef ConstantBoundaryCondition< InputImageType >	DefaultBoundaryConditionType
typedef ConstNeighborhoodIterator< TInputImage >	NeighborhoodIteratorType
typedef TKernel	KernelType
typedef KernelType::ConstIterator	KernelIteratorType
typedef KernelType::SizeType	RadiusType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
virtual void	SetKernel (KernelType _arg)
virtual const KernelType &	GetKernel ()
void	GenerateInputRequestedRegion ()
void	OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)
void	ResetBoundaryCondition ()
virtual ImageBoundaryConditionPointerType	GetBoundaryCondition ()
Protected Member Functions
	MorphologyImageFilter ()
	~MorphologyImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
virtual PixelType	Evaluate (const NeighborhoodIteratorType &nit, const KernelIteratorType kernelBegin, const KernelIteratorType kernelEnd)=0

---

Detailed Description

template<class TInputImage, class TOutputImage, class TKernel>
class itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >

Base class for the morphological operations such as erosion and dialation.

This class provides the infrastructure to support most morphological operations. Subclasses of MorphologyImageFilter implement specific "binary" and "grayscale" operations. The "binary" subclasses can operate on gray level data, where a specified a pixel value is consider the "foreground" and every other pixel value is considered the background. This is useful for operating on segment masks where all pixels assigned to segment #1 have value 1, all pixels assigned to segment #2 have value 2, etc. Here, a given segment can be dilated (expanded) while treating all other segment identifiers are background.

The "kernel" specified represents a morphology structuring element. The structuring element is a small Neighborhood with values indicating an element is "on" (value > 0) or "off" (value <=0). Morphological operations are defined by placing the structuring element over a pixel, and calculating a nonlinear function (min, max) over the pixels of the image that are under pixels in the structuring element that are "on". The result of this calculation is the value of the pixel in the output image. Under most circumstances, the "center pixel" of the structuring element -- or structuring element pixel over the input pixel under consideration -- is prescribed to be "on". This is not a strict requirement but the subclasses of this filter are not guarenteed to produce the correct result if the "center pixel" is not part of the structuring element.

Subclasses of this class can define their own operations by simply providing their own Evaluate() protected member function.

See also:

BinaryErodeImageFilter

BinaryDilateImageFilter

GrayScaleErodeImageFilter

GrayScaleDilateImageFilter

NeighborhoodIterator

Neighborhood

Definition at line 72 of file itkMorphologyImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TOutputImage, class TKernel> typedef SmartPointer<const Self> itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 80 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> typedef ConstantBoundaryCondition<InputImageType> itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::DefaultBoundaryConditionType

Reimplemented in itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 101 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> typedef ImageBoundaryCondition<InputImageType> const* itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ImageBoundaryConditionConstPointerType

Definition at line 100 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> typedef ImageBoundaryCondition<InputImageType>* itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ImageBoundaryConditionPointerType

Typedef for boundary conditions. Definition at line 99 of file itkMorphologyImageFilter.h. Referenced by itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::OverrideBoundaryCondition().

template<class TInputImage, class TOutputImage, class TKernel> typedef TInputImage::IndexType itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::IndexType

Definition at line 90 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> typedef TInputImage itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::InputImageType

Image related typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 86 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> typedef KernelType::ConstIterator itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::KernelIteratorType

Kernel (structuring element) iterator. Reimplemented in itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 112 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> typedef TKernel itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::KernelType

Kernel typedef. Reimplemented in itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 109 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> typedef ConstNeighborhoodIterator<TInputImage> itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::NeighborhoodIteratorType

Neighborhood iterator type. Reimplemented in itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 106 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> typedef Superclass::OutputImageRegionType itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::OutputImageRegionType

Superclass typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 92 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> typedef TOutputImage itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::OutputImageType

Some convenient typedefs. Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 87 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> typedef TInputImage::PixelType itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::PixelType

Reimplemented in itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 91 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> typedef SmartPointer<Self> itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::Pointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 79 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> typedef KernelType::SizeType itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::RadiusType

n-dimensional Kernel radius. Definition at line 115 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> typedef TInputImage::RegionType itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::RegionType

Definition at line 88 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> typedef MorphologyImageFilter itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::Self

Standard Self typedef Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 77 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> typedef TInputImage::SizeType itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::SizeType

Definition at line 89 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> typedef ImageToImageFilter<TInputImage,TOutputImage> itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::Superclass

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 78 of file itkMorphologyImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage, class TKernel> itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::MorphologyImageFilter (   )  [protected]

template<class TInputImage, class TOutputImage, class TKernel> itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::~MorphologyImageFilter (   )  [inline, protected]

Definition at line 147 of file itkMorphologyImageFilter.h.

---

Member Function Documentation

template<class TInputImage, class TOutputImage, class TKernel> virtual PixelType itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::Evaluate (  const NeighborhoodIteratorType &  nit, const KernelIteratorType  kernelBegin, const KernelIteratorType  kernelEnd )  [protected, pure virtual]

Evaluate image neighborhood with kernel to find the new value for the center pixel value. Implemented in itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >.

template<class TInputImage, class TOutputImage, class TKernel> void itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GenerateInputRequestedRegion (   )  [virtual]

MorphologyImageFilters need to make sure they request enough of an input image to account for the structuring element size. The input requested region is expanded by the radius of the structuring element. If the request extends past the LargestPossibleRegion for the input, the request is cropped by the LargestPossibleRegion. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TKernel> virtual ImageBoundaryConditionPointerType itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetBoundaryCondition (   )  [virtual]

Get the current boundary condition.

template<class TInputImage, class TOutputImage, class TKernel> virtual const KernelType& itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetKernel (   )  [virtual]

Get the kernel (structuring element).

template<class TInputImage, class TOutputImage, class TKernel> virtual const char* itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetNameOfClass (   )  const [virtual]

Runtime information support. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >.

template<class TInputImage, class TOutputImage, class TKernel> itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::itkStaticConstMacro (  ImageDimension  , unsigned  int, TInputImage::ImageDimension  )

Image related typedefs.

template<class TInputImage, class TOutputImage, class TKernel> void itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::OverrideBoundaryCondition (  const ImageBoundaryConditionPointerType  i  )  [inline]

Allows a user to override the internal boundary condition. Care should be be taken to ensure that the overriding boundary condition is a persistent object during the time it is referenced. The overriding condition can be of a different type than the default type as long as it is a subclass of ImageBoundaryCondition. Definition at line 135 of file itkMorphologyImageFilter.h. References itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ImageBoundaryConditionPointerType.

template<class TInputImage, class TOutputImage, class TKernel> void itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TKernel> void itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ResetBoundaryCondition (   )  [inline]

Rest the boundary condition to the default Definition at line 139 of file itkMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel> virtual void itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::SetKernel (  KernelType  _arg  )  [virtual]

Set kernel (structuring element).

template<class TInputImage, class TOutputImage, class TKernel> void itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ThreadedGenerateData (  const OutputImageRegionType &  outputRegionForThread, int  threadId )  [protected, virtual]

Multi-thread version GenerateData. Reimplemented from itk::ImageSource< TOutputImage >.

---

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

• itkMorphologyImageFilter.h

---