ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkGrayscaleGeodesicDilateImageFilter.h>

+ Inheritance diagram for itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
MarkerImageType::ConstPointer 
MarkerImageConstPointer
typedef MarkerImageType::PixelType MarkerImagePixelType
typedef MarkerImageType::Pointer MarkerImagePointer
typedef MarkerImageType::RegionType MarkerImageRegionType
typedef TInputImage MarkerImageType
typedef MaskImageType::ConstPointer MaskImageConstPointer
typedef MaskImageType::PixelType MaskImagePixelType
typedef MaskImageType::Pointer MaskImagePointer
typedef MaskImageType::RegionType MaskImageRegionType
typedef TInputImage MaskImageType
typedef
OutputImageType::ConstPointer 
OutputImageConstPointer
typedef OutputImageType::PixelType OutputImagePixelType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef TOutputImage OutputImageType
typedef SmartPointer< SelfPointer
typedef
GrayscaleGeodesicDilateImageFilter 
Self
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
const MarkerImageTypeGetMarkerImage ()
const MaskImageTypeGetMaskImage ()
virtual const char * GetNameOfClass () const
virtual unsigned long GetNumberOfIterationsUsed () const
void SetMarkerImage (const MarkerImageType *)
void SetMaskImage (const MaskImageType *)
 typedef (Concept::SameDimension< MarkerImageDimension, OutputImageDimension >) SameDimensionCheck
 typedef (Concept::Comparable< MarkerImagePixelType >) InputComparableCheck
 typedef (Concept::Convertible< MarkerImagePixelType, OutputImagePixelType >) InputConvertibleToOutputCheck
virtual void SetRunOneIteration (bool _arg)
virtual bool GetRunOneIteration () const
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

static Pointer New ()

Static Public Attributes

static const unsigned int MarkerImageDimension = TInputImage::ImageDimension
static const unsigned int MaskImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions

void EnlargeOutputRequestedRegion (DataObject *)
void GenerateData ()
void GenerateInputRequestedRegion ()
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 GrayscaleGeodesicDilateImageFilter ()
 ~GrayscaleGeodesicDilateImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const

Private Member Functions

 GrayscaleGeodesicDilateImageFilter (const Self &)
void operator= (const Self &)

Private Attributes

bool m_FullyConnected
unsigned long m_NumberOfIterationsUsed
bool m_RunOneIteration

Detailed Description

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

geodesic gray scale dilation of an image

Geodesic dilation operates on a "marker" image and a "mask" image. The marker image is dilated 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 minimum of the dilated marker image and the mask image.

Geodesic dilation is run either one iteration or until convergence. In the convergence case, the filter is equivalent to "reconstruction by dilation". 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 less 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 ReconstructionByDilationImageFilter. This noniterative solution is much faster than the implementation provided here. All ITK filters that previously used GrayscaleGeodesicDiliateImageFilter as part of their implementation have been converted to use the ReconstructionByDilationImageFilter. The GrayscaleGeodesicDilateImageFilter is maintained for backward compatibility.

See also:
MorphologyImageFilter, GrayscaleDilateImageFilter, GrayscaleFunctionDilateImageFilter, BinaryDilateImageFilter, ReconstructionByDilationImageFilter

Definition at line 64 of file itkGrayscaleGeodesicDilateImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef SmartPointer< const Self > itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage >
typedef MarkerImageType::ConstPointer itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::MarkerImageConstPointer

Definition at line 77 of file itkGrayscaleGeodesicDilateImageFilter.h.

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

Definition at line 79 of file itkGrayscaleGeodesicDilateImageFilter.h.

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

Definition at line 76 of file itkGrayscaleGeodesicDilateImageFilter.h.

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

Definition at line 78 of file itkGrayscaleGeodesicDilateImageFilter.h.

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

Some convenient typedefs.

Definition at line 75 of file itkGrayscaleGeodesicDilateImageFilter.h.

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

Definition at line 82 of file itkGrayscaleGeodesicDilateImageFilter.h.

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

Definition at line 84 of file itkGrayscaleGeodesicDilateImageFilter.h.

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

Definition at line 81 of file itkGrayscaleGeodesicDilateImageFilter.h.

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

Definition at line 83 of file itkGrayscaleGeodesicDilateImageFilter.h.

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

Definition at line 80 of file itkGrayscaleGeodesicDilateImageFilter.h.

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

Definition at line 87 of file itkGrayscaleGeodesicDilateImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef OutputImageType::PixelType itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::OutputImagePixelType
template<class TInputImage , class TOutputImage >
typedef OutputImageType::Pointer itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 86 of file itkGrayscaleGeodesicDilateImageFilter.h.

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

Superclass typedefs.

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

Definition at line 88 of file itkGrayscaleGeodesicDilateImageFilter.h.

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

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 85 of file itkGrayscaleGeodesicDilateImageFilter.h.

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

Standard class typedefs.

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

Definition at line 69 of file itkGrayscaleGeodesicDilateImageFilter.h.

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

Constructor & Destructor Documentation

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

End concept checking

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

End concept checking

Definition at line 157 of file itkGrayscaleGeodesicDilateImageFilter.h.

template<class TInputImage , class TOutputImage >
itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::GrayscaleGeodesicDilateImageFilter ( const Self ) [private]

Member Function Documentation

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

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

GrayscaleGeodesicDilateImageFilter 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::GrayscaleGeodesicDilateImageFilter< 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::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::GetMarkerImage ( )
template<class TInputImage , class TOutputImage >
const MaskImageType* itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::GetMaskImage ( )
template<class TInputImage , class TOutputImage >
virtual const char* itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]

Runtime information support.

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

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

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

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

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

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

Standard New method.

Reimplemented from itk::Object.

template<class TInputImage , class TOutputImage >
void itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::operator= ( const Self ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

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

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

End concept checking

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

template<class TInputImage , class TOutputImage >
virtual void itk::GrayscaleGeodesicDilateImageFilter< 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 dilation". Default is off.

template<class TInputImage , class TOutputImage >
virtual void itk::GrayscaleGeodesicDilateImageFilter< 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 dilation". Default is off.

template<class TInputImage , class TOutputImage >
virtual void itk::GrayscaleGeodesicDilateImageFilter< 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::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::SetMarkerImage ( const MarkerImageType )

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

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

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

template<class TInputImage , class TOutputImage >
virtual void itk::GrayscaleGeodesicDilateImageFilter< 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 dilation". Default is off.

template<class TInputImage , class TOutputImage >
void itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  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 >.

template<class TInputImage , class TOutputImage >
itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::typedef ( Concept::SameDimension< MarkerImageDimension, OutputImageDimension )

Begin concept checking This class requires SameDimensionCheck in the form of ( Concept::SameDimension< MarkerImageDimension, OutputImageDimension > )

template<class TInputImage , class TOutputImage >
itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Comparable< MarkerImagePixelType )

This class requires InputComparableCheck in the form of ( Concept::Comparable< MarkerImagePixelType > )

template<class TInputImage , class TOutputImage >
itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Convertible< MarkerImagePixelType, OutputImagePixelType )

This class requires InputConvertibleToOutputCheck in the form of ( Concept::Convertible< MarkerImagePixelType, OutputImagePixelType > )


Member Data Documentation

template<class TInputImage , class TOutputImage >
bool itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::m_FullyConnected [private]

Definition at line 197 of file itkGrayscaleGeodesicDilateImageFilter.h.

template<class TInputImage , class TOutputImage >
unsigned long itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::m_NumberOfIterationsUsed [private]

Definition at line 196 of file itkGrayscaleGeodesicDilateImageFilter.h.

template<class TInputImage , class TOutputImage >
bool itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::m_RunOneIteration [private]

Definition at line 195 of file itkGrayscaleGeodesicDilateImageFilter.h.

template<class TInputImage , class TOutputImage >
const unsigned int itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::MarkerImageDimension = TInputImage::ImageDimension [static]

ImageDimension constants

Definition at line 93 of file itkGrayscaleGeodesicDilateImageFilter.h.

template<class TInputImage , class TOutputImage >
const unsigned int itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::MaskImageDimension = TInputImage::ImageDimension [static]

ImageDimension constants

Definition at line 95 of file itkGrayscaleGeodesicDilateImageFilter.h.

template<class TInputImage , class TOutputImage >
const unsigned int itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension [static]

ImageDimension constants

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

Definition at line 97 of file itkGrayscaleGeodesicDilateImageFilter.h.


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