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

Binary erosion of an image. More...

#include <itkBinaryErodeImageFilter.h>

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

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

[legend]List of all members.

Public Types
typedef BinaryErodeImageFilter	Self
typedef MorphologyImageFilter< TInputImage, TOutputImage, TKernel >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::PixelType	PixelType
typedef ConstNeighborhoodIterator< TInputImage >	NeighborhoodIteratorType
typedef TKernel	KernelType
typedef KernelType::ConstIterator	KernelIteratorType
Public Member Functions
virtual const char *	GetClassName () const
virtual void	SetErodeValue (PixelType _arg)
virtual PixelType	GetErodeValue ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	BinaryErodeImageFilter ()
	~BinaryErodeImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
PixelType	Evaluate (const NeighborhoodIteratorType &nit, const KernelIteratorType kernelBegin, const KernelIteratorType kernelEnd)
virtual void	BeforeThreadedGenerateData ()

---

Detailed Description

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

Binary erosion of an image.

Erode an image using binary morphology. Gray scale images can be processed as binary images by selecting an "ErodeValue". Pixel values matching the erode value are considered the "foreground" and all other pixels are "background". This is useful in processing segmented images where all pixels in segment #1 have value 1 and pixels in segment #2 have value 2, etc. A particular "segment number" can be processed. ErodeValue defaults to the maximum possible value of the PixelType.

Binary erosion will set a pixel as the "ErodeValue" if all of the pixels in the image for "on" structuring element pixels have a value of "ErodeValue". Otherwise, the center pixel is set to an appropriate "background" value. For lack of something better, the background value used will be the minimum of the pixels that were not the ErodeValue.

The structuring element is assumed to be composed of binary values (zero or one). Only elements of the structuring element having values > 0 ("on" values) are candidates for affecting the center pixel. A reasonable choice of structuring element is itk::BinaryBallStructuringElement.

For the each input image pixel,

• NeighborhoodIterator gives neighbors of the pixel.
• Evaluate() member function returns either the original pixel value or the ErodeValue.
• Replace the original value with the specified value

See also:

MorphologyImageFilter, BinaryDilateImageFilter

Definition at line 60 of file itkBinaryErodeImageFilter.h.

---

Member Typedef Documentation

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

Reimplemented from itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 70 of file itkBinaryErodeImageFilter.h.

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

Kernel (structuring element) iterator. Reimplemented from itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 88 of file itkBinaryErodeImageFilter.h. Referenced by itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::~BinaryErodeImageFilter().

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

Kernel typedef. Reimplemented from itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 85 of file itkBinaryErodeImageFilter.h.

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

Neighborhood iterator type. Reimplemented from itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 82 of file itkBinaryErodeImageFilter.h. Referenced by itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::~BinaryErodeImageFilter().

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

Declaration of pixel type. Reimplemented from itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 79 of file itkBinaryErodeImageFilter.h. Referenced by itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::~BinaryErodeImageFilter().

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

Reimplemented from itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 69 of file itkBinaryErodeImageFilter.h.

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

Standard class typedefs. Reimplemented from itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 66 of file itkBinaryErodeImageFilter.h. Referenced by itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::~BinaryErodeImageFilter().

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

Reimplemented from itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >. Definition at line 68 of file itkBinaryErodeImageFilter.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 100 of file itkBinaryErodeImageFilter.h. References itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::KernelIteratorType, itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::NeighborhoodIteratorType, itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::PixelType, and itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::Self.

---

Member Function Documentation

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

Cache some information that can be used to by each thread and each call to Evaluate() Reimplemented from itk::ImageSource< TOutputImage >.

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

Evaluate image neighborhood with kernel to find the new value for the center pixel value It will return the ErodeValue if all of the image pixels in the neighborhood have the ErodeValue and that pixel's corresponding element in the structuring element is positive. This version of Evaluate is used for non-boundary pixels. Implements itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

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

Runtime information support. Reimplemented from itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

template<class TInputImage, class TOutputImage, class TKernel> virtual PixelType itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::GetErodeValue (   )  [virtual]

Get the value in the image considered as "foreground". Defaults to maximum value of PixelType.

template<class TInputImage, class TOutputImage, class TKernel> Pointer itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::New (   )  [static]

Standard New method. Reimplemented from itk::Object.

template<class TInputImage, class TOutputImage, class TKernel> void itk::BinaryErodeImageFilter< 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::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

template<class TInputImage, class TOutputImage, class TKernel> virtual void itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::SetErodeValue (  PixelType  _arg  )  [virtual]

Set the value in the image to consider as "foreground". Defaults to maximum value of PixelType.

---

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

• itkBinaryErodeImageFilter.h

---