geodesic gray scale dilation of an image More...

#include <sitkGrayscaleGeodesicDilateImageFilter.h>

Inheritance diagram for itk::simple::GrayscaleGeodesicDilateImageFilter:

Collaboration diagram for itk::simple::GrayscaleGeodesicDilateImageFilter:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList

typedef GrayscaleGeodesicDilateImageFilter	Self

Public Types inherited from itk::simple::ImageFilter< 2 >
typedef ImageFilter	Self

Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Image	Execute (const Image &image1, const Image &image2)

Image	Execute (const Image &image1, const Image &image2, bool runOneIteration, bool fullyConnected)

Self &	FullyConnectedOff ()

Self &	FullyConnectedOn ()

bool	GetFullyConnected () const

std::string	GetName () const

bool	GetRunOneIteration () const

	GrayscaleGeodesicDilateImageFilter ()

Self &	RunOneIterationOff ()

Self &	RunOneIterationOn ()

Self &	SetFullyConnected (bool FullyConnected)

Self &	SetRunOneIteration (bool RunOneIteration)

std::string	ToString () const

	~GrayscaleGeodesicDilateImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter< 2 >
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...

virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands. More...

virtual	~ProcessObject ()

virtual void	DebugOn ()

virtual void	DebugOff ()

virtual bool	GetDebug () const

virtual void	SetDebug (bool debugFlag)

virtual void	SetNumberOfThreads (unsigned int n)

virtual unsigned int	GetNumberOfThreads () const

Private Types
typedef Image(Self::*	MemberFunctionType) (const Image &image1, const Image &image2)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1, const Image &image2)

Private Attributes
bool	m_FullyConnected

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

bool	m_RunOneIteration

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()

static void	GlobalDefaultDebugOff ()

static void	GlobalDefaultDebugOn ()

static void	SetGlobalDefaultDebug (bool debugFlag)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static void	SetGlobalWarningDisplay (bool flag)

static bool	GetGlobalWarningDisplay ()

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()

static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)

virtual itk::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) throw ()

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()

Static Protected Member Functions inherited from itk::simple::ImageFilter< 2 >
static void	FixNonZeroIndex (TImageType *img)

Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)

template<class TImageType >
static Image	CastITKToImage (TImageType *img)

template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

static const itk::EventObject &	GetITKEventObject (EventEnum e)

template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)

static std::ostream &	ToStringHelper (std::ostream &os, const char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

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; itk::simple::GrayscaleGeodesicDilate for the procedural interface; itk::GrayscaleGeodesicDilateImageFilter for the Doxygen on the original ITK class.

Definition at line 52 of file sitkGrayscaleGeodesicDilateImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::GrayscaleGeodesicDilateImageFilter::MemberFunctionType) (const Image &image1, const Image &image2)

private

Setup for member function dispatching

Definition at line 114 of file sitkGrayscaleGeodesicDilateImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::GrayscaleGeodesicDilateImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 64 of file sitkGrayscaleGeodesicDilateImageFilter.h.

typedef GrayscaleGeodesicDilateImageFilter itk::simple::GrayscaleGeodesicDilateImageFilter::Self

Definition at line 54 of file sitkGrayscaleGeodesicDilateImageFilter.h.

Constructor & Destructor Documentation

itk::simple::GrayscaleGeodesicDilateImageFilter::GrayscaleGeodesicDilateImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

itk::simple::GrayscaleGeodesicDilateImageFilter::~GrayscaleGeodesicDilateImageFilter ( )

Destructor

Member Function Documentation

Image itk::simple::GrayscaleGeodesicDilateImageFilter::Execute	(	const Image &	image1,
		const Image &	image2
	)

Execute the filter on the input images

Image itk::simple::GrayscaleGeodesicDilateImageFilter::Execute	(	const Image &	image1,
		const Image &	image2,
		bool	runOneIteration,
		bool	fullyConnected
	)

Execute the filter on the input images with the given parameters

template<class TImageType >

Image itk::simple::GrayscaleGeodesicDilateImageFilter::ExecuteInternal	(	const Image &	image1,
		const Image &	image2
	)

private

Self& itk::simple::GrayscaleGeodesicDilateImageFilter::FullyConnectedOff ( )

inline

Definition at line 89 of file sitkGrayscaleGeodesicDilateImageFilter.h.

Self& itk::simple::GrayscaleGeodesicDilateImageFilter::FullyConnectedOn ( )

inline

Set the value of FullyConnected to true or false respectfully.

Definition at line 88 of file sitkGrayscaleGeodesicDilateImageFilter.h.

bool itk::simple::GrayscaleGeodesicDilateImageFilter::GetFullyConnected ( ) const

inline

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.

Definition at line 94 of file sitkGrayscaleGeodesicDilateImageFilter.h.

std::string itk::simple::GrayscaleGeodesicDilateImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 96 of file sitkGrayscaleGeodesicDilateImageFilter.h.

bool itk::simple::GrayscaleGeodesicDilateImageFilter::GetRunOneIteration ( ) const

inline

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.

Definition at line 80 of file sitkGrayscaleGeodesicDilateImageFilter.h.

Self& itk::simple::GrayscaleGeodesicDilateImageFilter::RunOneIterationOff ( )

inline

Definition at line 75 of file sitkGrayscaleGeodesicDilateImageFilter.h.

Self& itk::simple::GrayscaleGeodesicDilateImageFilter::RunOneIterationOn ( )

inline

Set the value of RunOneIteration to true or false respectfully.

Definition at line 74 of file sitkGrayscaleGeodesicDilateImageFilter.h.

Self& itk::simple::GrayscaleGeodesicDilateImageFilter::SetFullyConnected ( bool FullyConnected )

inline

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.

Definition at line 85 of file sitkGrayscaleGeodesicDilateImageFilter.h.

Self& itk::simple::GrayscaleGeodesicDilateImageFilter::SetRunOneIteration ( bool RunOneIteration )

inline

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.

Definition at line 71 of file sitkGrayscaleGeodesicDilateImageFilter.h.

std::string itk::simple::GrayscaleGeodesicDilateImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.