Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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

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

#include <itkMorphologyImageFilter.h>

Inheritance diagram for itk::MorphologyImageFilter:

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

Collaboration graph
[legend]
List of all members.

Public Types

typedef MorphologyImageFilter Self
typedef ImageToImageFilter<
TInputImage, TOutputImage > 
Superclass
typedef SmartPointer< SelfPointer
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 ConstNeighborhoodIterator<
TInputImage > 
NeighborhoodIteratorType
typedef TKernel KernelType
typedef KernelType::ConstIterator KernelIteratorType
typedef KernelType::SizeType RadiusType

Public Methods

virtual const char * GetClassName () const
 itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
virtual void SetKernel (KernelType _arg)
virtual const KernelTypeGetKernel ()
void GenerateInputRequestedRegion ()

Protected Methods

 MorphologyImageFilter ()
 ~MorphologyImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
virtual PixelType Evaluate (const NeighborhoodIteratorType &nit, const KernelType &kernel)=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 71 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::BinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >, 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 TInputImage::IndexType itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::IndexType
 

Definition at line 89 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 85 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::BinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 105 of file itkMorphologyImageFilter.h.

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

Kernel typedef.

Reimplemented in itk::BinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 102 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::BinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 99 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 91 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 86 of file itkMorphologyImageFilter.h.

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

Reimplemented in itk::BinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 90 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::BinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >, 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.

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

n-dimensional Kernel radius.

Definition at line 108 of file itkMorphologyImageFilter.h.

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

Definition at line 87 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::BinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 76 of file itkMorphologyImageFilter.h.

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

Definition at line 88 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::BinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >, 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.


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 125 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 KernelType   kernel
[protected, pure virtual]
 

Evaluate image neighborhood with kernel to find the new value for the center pixel value.

Implemented in itk::BinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >, 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 const char* itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetClassName   const [virtual]
 

Runtime information support.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::BinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >, 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>
virtual const KernelType& itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetKernel   [virtual]
 

Get the kernel (structuring element).

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

Image related typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

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 >.

Reimplemented in itk::BinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >, and itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >.

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:
Generated at Fri May 21 01:34:15 2004 for ITK by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2000