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

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

Base class for the morphological operations being applied to isolated objects in an image. More...

#include <itkObjectMorphologyImageFilter.h>

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

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

Collaboration graph
[legend]
List of all members.

Public Types

typedef ObjectMorphologyImageFilter 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 ImageBoundaryCondition<
InputImageType > * 
ImageBoundaryConditionPointerType
typedef ImageBoundaryCondition<
InputImageType > const * 
ImageBoundaryConditionConstPointerType
typedef ConstantBoundaryCondition<
InputImageType
DefaultBoundaryConditionType
typedef ConstNeighborhoodIterator<
TInputImage > 
InputNeighborhoodIteratorType
typedef NeighborhoodIterator<
TOutputImage > 
OutputNeighborhoodIteratorType
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 KernelTypeGetKernel ()
virtual PixelType GetObjectValue ()
virtual void SetObjectValue (PixelType _arg)
void GenerateInputRequestedRegion ()
void OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)
void ResetBoundaryCondition ()
virtual ImageBoundaryConditionPointerType GetBoundaryCondition ()
virtual void SetUseBoundaryCondition (bool _arg)
virtual bool GetUseBoundaryCondition ()

Protected Member Functions

 ObjectMorphologyImageFilter ()
 ~ObjectMorphologyImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
virtual void Evaluate (OutputNeighborhoodIteratorType &nit, const KernelType &kernel)=0
bool IsObjectPixelOnBoundary (const InputNeighborhoodIteratorType &nit)
void BeforeThreadedGenerateData ()

Protected Attributes

ImageBoundaryConditionPointerType m_BoundaryCondition
DefaultBoundaryConditionType m_DefaultBoundaryCondition
bool m_UseBoundaryCondition
KernelType m_Kernel
PixelType m_ObjectValue

Detailed Description

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

Base class for the morphological operations being applied to isolated objects in an image.

This class provides the infrastructure to support of morphological operations being applied to images in which the foreground and background intensities are fixed. This filter operates significantly faster than itkBinaryMorhologicalImageFilters; however itkBinaryMorhologicalImageFilters preserve background pixels based on values of neighboring background pixels - potentially important during erosion.

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 functions - one that operates using a smart neighborhood operator for edge faces and one that operates using a standard neighboorhood operator..

See also:
ErodeObjectMorphologicalImageFilter

DilateObjectMorphologicalImageFilter

BinaryErodeImageFilter

BinaryDilateImageFilter

GrayScaleErodeImageFilter

GrayScaleDilateImageFilter

NeighborhoodIterator

Neighborhood

Definition at line 73 of file itkObjectMorphologyImageFilter.h.


Member Typedef Documentation

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

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

Reimplemented in itk::DilateObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, and itk::ErodeObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 81 of file itkObjectMorphologyImageFilter.h.

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

Reimplemented in itk::DilateObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, and itk::ErodeObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 100 of file itkObjectMorphologyImageFilter.h.

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

Definition at line 98 of file itkObjectMorphologyImageFilter.h.

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

Definition at line 96 of file itkObjectMorphologyImageFilter.h.

Referenced by itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::OverrideBoundaryCondition().

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

Definition at line 91 of file itkObjectMorphologyImageFilter.h.

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

Image related typedefs.

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

Definition at line 87 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel>
typedef ConstNeighborhoodIterator<TInputImage> itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::InputNeighborhoodIteratorType
 

Neighborhood iterator type.

Definition at line 108 of file itkObjectMorphologyImageFilter.h.

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

Kernel (structuring element) iterator.

Reimplemented in itk::DilateObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, and itk::ErodeObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 117 of file itkObjectMorphologyImageFilter.h.

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

Kernel typedef.

Reimplemented in itk::DilateObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, and itk::ErodeObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 114 of file itkObjectMorphologyImageFilter.h.

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

Superclass typedefs.

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

Definition at line 93 of file itkObjectMorphologyImageFilter.h.

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

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 88 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel>
typedef NeighborhoodIterator<TOutputImage> itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::OutputNeighborhoodIteratorType
 

Reimplemented in itk::DilateObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, and itk::ErodeObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 111 of file itkObjectMorphologyImageFilter.h.

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

Reimplemented in itk::DilateObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, and itk::ErodeObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 92 of file itkObjectMorphologyImageFilter.h.

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

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

Reimplemented in itk::DilateObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, and itk::ErodeObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 80 of file itkObjectMorphologyImageFilter.h.

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

n-dimensional Kernel radius.

Definition at line 120 of file itkObjectMorphologyImageFilter.h.

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

Definition at line 89 of file itkObjectMorphologyImageFilter.h.

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

Standard Self typedef

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

Reimplemented in itk::DilateObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, and itk::ErodeObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 78 of file itkObjectMorphologyImageFilter.h.

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

Definition at line 90 of file itkObjectMorphologyImageFilter.h.

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

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

Reimplemented in itk::DilateObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, and itk::ErodeObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 79 of file itkObjectMorphologyImageFilter.h.


Constructor & Destructor Documentation

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

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

Definition at line 171 of file itkObjectMorphologyImageFilter.h.


Member Function Documentation

template<class TInputImage, class TOutputImage, class TKernel>
void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::BeforeThreadedGenerateData void   )  [protected, virtual]
 

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage, class TKernel>
virtual void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::Evaluate OutputNeighborhoodIteratorType 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::DilateObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, and itk::ErodeObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

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

ObjectMorphologyImageFilters 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::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetBoundaryCondition  )  [virtual]
 

Get the current boundary condition.

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

Get the kernel (structuring element).

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

Runtime information support.

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

Reimplemented in itk::DilateObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, and itk::ErodeObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

template<class TInputImage, class TOutputImage, class TKernel>
virtual PixelType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetObjectValue  )  [virtual]
 

Get the pixel value being used to identify the object of interest

template<class TInputImage, class TOutputImage, class TKernel>
virtual bool itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetUseBoundaryCondition  )  [virtual]
 

Enable/disable the use of boundary condition. Defaults to false. if false, a neighborhood operator extends outside an image, it does not consider that outside extent when determining if a pixel is on an object's boundary.

template<class TInputImage, class TOutputImage, class TKernel>
bool itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::IsObjectPixelOnBoundary const InputNeighborhoodIteratorType nit  )  [protected]
 

Evaluate a pixel (assumed to have a value of ObjectValue) to determine if one of its neighboring pixels (8-neigh in 2d, etc) is a non-ObjectValue pixel.

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

Image related typedefs.

template<class TInputImage, class TOutputImage, class TKernel>
void itk::ObjectMorphologyImageFilter< 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. NOTE: Don't foget to set UseBoundaryCondition to true!

Definition at line 147 of file itkObjectMorphologyImageFilter.h.

References itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ImageBoundaryConditionPointerType.

template<class TInputImage, class TOutputImage, class TKernel>
void itk::ObjectMorphologyImageFilter< 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::DilateObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, and itk::ErodeObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

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

Rest the boundary condition to the default

Definition at line 151 of file itkObjectMorphologyImageFilter.h.

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

Set kernel (structuring element).

template<class TInputImage, class TOutputImage, class TKernel>
virtual void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::SetObjectValue PixelType  _arg  )  [virtual]
 

Set the pixel value being used to identify the object of interest

template<class TInputImage, class TOutputImage, class TKernel>
virtual void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::SetUseBoundaryCondition bool  _arg  )  [virtual]
 

Enable/disable the use of boundary condition. Defaults to false. if false, a neighborhood operator extends outside an image, it does not consider that outside extent when determining if a pixel is on an object's boundary.

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

Multi-thread version GenerateData.

Reimplemented from itk::ImageSource< TOutputImage >.


Member Data Documentation

template<class TInputImage, class TOutputImage, class TKernel>
ImageBoundaryConditionPointerType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_BoundaryCondition [protected]
 

Pointer to a persistent boundary condition object used for the image iterator.

Definition at line 191 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel>
DefaultBoundaryConditionType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_DefaultBoundaryCondition [protected]
 

Default boundary condition

Definition at line 194 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel>
KernelType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_Kernel [protected]
 

kernel or structuring element to use.

Definition at line 200 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel>
PixelType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_ObjectValue [protected]
 

Pixel value that indicates the object be operated upon

Definition at line 203 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel>
bool itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_UseBoundaryCondition [protected]
 

Defaults to false

Definition at line 197 of file itkObjectMorphologyImageFilter.h.


The documentation for this class was generated from the following file:
Generated at Thu May 25 01:59:28 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000