SimpleITK  2.0.0rc2.post23
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::GrayscaleGeodesicDilateImageFilter Class Reference

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

using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = GrayscaleGeodesicDilateImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

Image Execute (const Image &image1, const Image &image2)
 
SelfFullyConnectedOff ()
 
SelfFullyConnectedOn ()
 
bool GetFullyConnected () const
 
std::string GetName () const
 
bool GetRunOneIteration () const
 
 GrayscaleGeodesicDilateImageFilter ()
 
SelfRunOneIterationOff ()
 
SelfRunOneIterationOn ()
 
SelfSetFullyConnected (bool FullyConnected)
 
SelfSetRunOneIteration (bool RunOneIteration)
 
std::string ToString () const
 
virtual ~GrayscaleGeodesicDilateImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
 
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
 
virtual void SetNumberOfWorkUnits (unsigned int n)
 
virtual unsigned int GetNumberOfWorkUnits () const
 

Private Types

using MemberFunctionType = Image(Self::*)(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 {false}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
bool m_RunOneIteration {false}
 

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 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...
 
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
 
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
 
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
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 TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *img)
 
static const itk::EventObjectGetITKEventObject (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

◆ MemberFunctionType

using itk::simple::GrayscaleGeodesicDilateImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1, const Image& image2 )
private

Setup for member function dispatching

Definition at line 110 of file sitkGrayscaleGeodesicDilateImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 64 of file sitkGrayscaleGeodesicDilateImageFilter.h.

◆ Self

Definition at line 54 of file sitkGrayscaleGeodesicDilateImageFilter.h.

Constructor & Destructor Documentation

◆ ~GrayscaleGeodesicDilateImageFilter()

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

Destructor

◆ GrayscaleGeodesicDilateImageFilter()

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input images

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::GrayscaleGeodesicDilateImageFilter::ExecuteInternal ( const Image image1,
const Image image2 
)
private

◆ FullyConnectedOff()

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

Definition at line 88 of file sitkGrayscaleGeodesicDilateImageFilter.h.

◆ FullyConnectedOn()

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

Set the value of FullyConnected to true or false respectfully.

Definition at line 87 of file sitkGrayscaleGeodesicDilateImageFilter.h.

◆ GetFullyConnected()

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 93 of file sitkGrayscaleGeodesicDilateImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 96 of file sitkGrayscaleGeodesicDilateImageFilter.h.

◆ GetRunOneIteration()

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 79 of file sitkGrayscaleGeodesicDilateImageFilter.h.

◆ RunOneIterationOff()

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

Definition at line 74 of file sitkGrayscaleGeodesicDilateImageFilter.h.

◆ RunOneIterationOn()

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

Set the value of RunOneIteration to true or false respectfully.

Definition at line 73 of file sitkGrayscaleGeodesicDilateImageFilter.h.

◆ SetFullyConnected()

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 84 of file sitkGrayscaleGeodesicDilateImageFilter.h.

◆ SetRunOneIteration()

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 70 of file sitkGrayscaleGeodesicDilateImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 114 of file sitkGrayscaleGeodesicDilateImageFilter.h.

Member Data Documentation

◆ m_FullyConnected

bool itk::simple::GrayscaleGeodesicDilateImageFilter::m_FullyConnected {false}
private

Definition at line 123 of file sitkGrayscaleGeodesicDilateImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::GrayscaleGeodesicDilateImageFilter::m_MemberFactory
private

Definition at line 116 of file sitkGrayscaleGeodesicDilateImageFilter.h.

◆ m_RunOneIteration

bool itk::simple::GrayscaleGeodesicDilateImageFilter::m_RunOneIteration {false}
private

Definition at line 120 of file sitkGrayscaleGeodesicDilateImageFilter.h.


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