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

geodesic gray scale erosion of an image More...

#include <itkGrayscaleGeodesicErodeImageFilter.h>

Inheritance diagram for itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >:

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

[legend]List of all members.

Public Types
typedef GrayscaleGeodesicErodeImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	MarkerImageType
typedef TInputImage	MaskImageType
typedef TOutputImage	OutputImageType
typedef MarkerImageType::Pointer	MarkerImagePointer
typedef MarkerImageType::ConstPointer	MarkerImageConstPointer
typedef MarkerImageType::RegionType	MarkerImageRegionType
typedef MarkerImageType::PixelType	MarkerImagePixelType
typedef MaskImageType::Pointer	MaskImagePointer
typedef MaskImageType::ConstPointer	MaskImageConstPointer
typedef MaskImageType::RegionType	MaskImageRegionType
typedef MaskImageType::PixelType	MaskImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::ConstPointer	OutputImageConstPointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef OutputImageType::PixelType	OutputImagePixelType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual unsigned long	GetNumberOfIterationsUsed ()
	itkStaticConstMacro (MarkerImageDimension, unsigned int, TInputImage::ImageDimension)
	itkStaticConstMacro (MaskImageDimension, unsigned int, TInputImage::ImageDimension)
	itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
void	SetMarkerImage (const MarkerImageType *)
const MarkerImageType *	GetMarkerImage ()
void	SetMaskImage (const MaskImageType *)
const MaskImageType *	GetMaskImage ()
virtual void	SetRunOneIteration (bool _arg)
virtual bool	GetRunOneIteration ()
virtual void	RunOneIterationOn ()
virtual void	RunOneIterationOff ()
virtual void	SetFullyConnected (bool _arg)
virtual const bool &	GetFullyConnected ()
virtual void	FullyConnectedOn ()
virtual void	FullyConnectedOff ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	GrayscaleGeodesicErodeImageFilter ()
	~GrayscaleGeodesicErodeImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateInputRequestedRegion ()
void	EnlargeOutputRequestedRegion (DataObject *)
void	GenerateData ()
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

---

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >

geodesic gray scale erosion of an image

Geodesic erosion operates on a "marker" image and a "mask" image. The marker image is eroded using an elementary structuring element (neighborhood of radius one using only the face connected neighbors). The resulting image is then compared with the mask image. The output image is the pixelwise maximum of the eroded marker image and the mask image.

Geodesic erosion is run either one iteration or until convergence. In the convergence case, the filter is equivalent to "reconstruction by erosion". This filter is implemented to handle both scenarios. The one iteration case is multi-threaded. The convergence case is delegated to another instance of the same filter (but configured to run a single iteration).

The marker image must be greater than or equal to the mask image (on a pixel by pixel basis).

Geodesic morphology is described in Chapter 6 of Pierre Soille's book "Morphological Image Analysis: Principles and Applications", Second Edition, Springer, 2003.

A noniterative version of this algorithm can be found in the ReconstructionByErosionImageFilter. This noniterative solution is much faster than the implementation provided here. All ITK filters that previously used GrayscaleGeodesicErodeImageFilter as part of their implementation have been converted to use the ReconstructionByErosionImageFilter. The GrayscaleGeodesicErodeImageFilter is maintained for backward compatibility.

See also:

MorphologyImageFilter, GrayscaleErodeImageFilter, GrayscaleFunctionErodeImageFilter, BinaryErodeImageFilter, ReconstructionByErosionImageFilter

Definition at line 63 of file itkGrayscaleGeodesicErodeImageFilter.h.

---

Member Typedef Documentation

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 72 of file itkGrayscaleGeodesicErodeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef MarkerImageType::ConstPointer itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::MarkerImageConstPointer

Definition at line 79 of file itkGrayscaleGeodesicErodeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef MarkerImageType::PixelType itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::MarkerImagePixelType

Definition at line 81 of file itkGrayscaleGeodesicErodeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef MarkerImageType::Pointer itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::MarkerImagePointer

Definition at line 78 of file itkGrayscaleGeodesicErodeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef MarkerImageType::RegionType itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::MarkerImageRegionType

Definition at line 80 of file itkGrayscaleGeodesicErodeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::MarkerImageType

Some convenient typedefs. Definition at line 75 of file itkGrayscaleGeodesicErodeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef MaskImageType::ConstPointer itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::MaskImageConstPointer

Definition at line 83 of file itkGrayscaleGeodesicErodeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef MaskImageType::PixelType itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::MaskImagePixelType

Definition at line 85 of file itkGrayscaleGeodesicErodeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef MaskImageType::Pointer itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::MaskImagePointer

Definition at line 82 of file itkGrayscaleGeodesicErodeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef MaskImageType::RegionType itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::MaskImageRegionType

Definition at line 84 of file itkGrayscaleGeodesicErodeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::MaskImageType

Definition at line 76 of file itkGrayscaleGeodesicErodeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef OutputImageType::ConstPointer itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::OutputImageConstPointer

Definition at line 87 of file itkGrayscaleGeodesicErodeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef OutputImageType::PixelType itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 89 of file itkGrayscaleGeodesicErodeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef OutputImageType::Pointer itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 86 of file itkGrayscaleGeodesicErodeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef OutputImageType::RegionType itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

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

template<class TInputImage, class TOutputImage> typedef TOutputImage itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::OutputImageType

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

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 71 of file itkGrayscaleGeodesicErodeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef GrayscaleGeodesicErodeImageFilter itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 68 of file itkGrayscaleGeodesicErodeImageFilter.h.

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 70 of file itkGrayscaleGeodesicErodeImageFilter.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 146 of file itkGrayscaleGeodesicErodeImageFilter.h.

---

Member Function Documentation

template<class TInputImage, class TOutputImage> void itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion (  DataObject *   )  [protected, virtual]

This filter will enlarge the output requested region to produce all of the output if the filter is configured to run to convergence. See also: ProcessObject::EnlargeOutputRequestedRegion() Reimplemented from itk::ProcessObject.

template<class TInputImage, class TOutputImage> virtual void itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::FullyConnectedOff (   )  [virtual]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

template<class TInputImage, class TOutputImage> virtual void itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::FullyConnectedOn (   )  [virtual]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

template<class TInputImage, class TOutputImage> void itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::GenerateData (   )  [protected, virtual]

Single-threaded version of GenerateData. This version is used when the filter is configured to run to convergence. This method may delegate to the multithreaded version if the filter is configured to run a single iteration. Otherwise, it will delegate to a separate instance to run each iteration until the filter converges. Reimplemented from itk::ImageSource< TOutputImage >.

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

GrayscaleGeodesicErodeImageFilter needs to request enough of the marker image to account for the elementary structuring element. The mask image does not need to be padded. Depending on whether the filter is configured to run a single iteration or until convergence, this method may request all of the marker and mask image be provided. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual const bool& itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::GetFullyConnected (   )  [virtual]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

template<class TInputImage, class TOutputImage> const MarkerImageType* itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::GetMarkerImage (   )

Set/Get the marker image. The marker image must be pixelwise greater than or equal to the mask image. The marker image the image that is eroded by this filter.

template<class TInputImage, class TOutputImage> const MaskImageType* itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::GetMaskImage (   )

Set/Get the mask image. The mask image is used to "mask" the eroded marker image. The mask operation is a pixelwise maximum.

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

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

template<class TInputImage, class TOutputImage> virtual unsigned long itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::GetNumberOfIterationsUsed (   )  [virtual]

Get the number of iterations used to produce the current output.

template<class TInputImage, class TOutputImage> virtual bool itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::GetRunOneIteration (   )  [virtual]

Set/Get whether the filter should run one iteration or until convergence. When run to convergence, this filter is equivalent to "reconstruction by erosion". Default is off.

template<class TInputImage, class TOutputImage> itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  OutputImageDimension  , unsigned  int, TOutputImage::ImageDimension  )

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

template<class TInputImage, class TOutputImage> itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  MaskImageDimension  , unsigned  int, TInputImage::ImageDimension  )

ImageDimension constants

template<class TInputImage, class TOutputImage> itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  MarkerImageDimension  , unsigned  int, TInputImage::ImageDimension  )

ImageDimension constants

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

Standard New method. Reimplemented from itk::Object.

template<class TInputImage, class TOutputImage> void itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::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> virtual void itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::RunOneIterationOff (   )  [virtual]

Set/Get whether the filter should run one iteration or until convergence. When run to convergence, this filter is equivalent to "reconstruction by erosion". Default is off.

template<class TInputImage, class TOutputImage> virtual void itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::RunOneIterationOn (   )  [virtual]

Set/Get whether the filter should run one iteration or until convergence. When run to convergence, this filter is equivalent to "reconstruction by erosion". Default is off.

template<class TInputImage, class TOutputImage> virtual void itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::SetFullyConnected (  bool  _arg  )  [virtual]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

template<class TInputImage, class TOutputImage> void itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::SetMarkerImage (  const MarkerImageType *   )

Set/Get the marker image. The marker image must be pixelwise greater than or equal to the mask image. The marker image the image that is eroded by this filter.

template<class TInputImage, class TOutputImage> void itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::SetMaskImage (  const MaskImageType *   )

Set/Get the mask image. The mask image is used to "mask" the eroded marker image. The mask operation is a pixelwise maximum.

template<class TInputImage, class TOutputImage> virtual void itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::SetRunOneIteration (  bool  _arg  )  [virtual]

Set/Get whether the filter should run one iteration or until convergence. When run to convergence, this filter is equivalent to "reconstruction by erosion". Default is off.

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

Multi-thread version GenerateData. This version is used when the filter is configured to run a single iteration. When the filter is configured to run to convergence, the GenerateData() method is called. Reimplemented from itk::ImageSource< TOutputImage >.

---

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

• itkGrayscaleGeodesicErodeImageFilter.h

---