SimpleITK  2.2.0.dev41
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::ReconstructionByDilationImageFilter Class Reference

grayscale reconstruction by dilation of an image More...

#include <sitkReconstructionByDilationImageFilter.h>

+ Inheritance diagram for itk::simple::ReconstructionByDilationImageFilter:
+ Collaboration diagram for itk::simple::ReconstructionByDilationImageFilter:

Public Types

using PixelIDTypeList = BasicPixelIDTypeList
using Self = ReconstructionByDilationImageFilter
- 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 &markerImage, const Image &maskImage)
SelfFullyConnectedOff ()
SelfFullyConnectedOn ()
bool GetFullyConnected () const
std::string GetName () const
bool GetUseInternalCopy () const
 ReconstructionByDilationImageFilter ()
SelfSetFullyConnected (bool FullyConnected)
SelfSetUseInternalCopy (bool UseInternalCopy)
std::string ToString () const
SelfUseInternalCopyOff ()
SelfUseInternalCopyOn ()
virtual ~ReconstructionByDilationImageFilter ()
- 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 *markerImage, const Image *maskImage)

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image *markerImage, const Image *maskImage)

Private Attributes

bool m_FullyConnected {false}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
bool m_UseInternalCopy {true}


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

grayscale reconstruction by dilation of an image

Reconstruction by dilation operates on a "marker" image and a "mask" image, and is defined as the dilation of the marker image with respect to the mask image iterated until stability.

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.2 of Pierre Soille's book "Morphological Image Analysis: Principles and Applications", Second Edition, Springer, 2003.

Algorithm implemented in this filter is based on algorithm described by Kevin Robinson and Paul F. Whelan in "Efficient Morphological Reconstruction: A Downhill Filter", Pattern Recognition Letters, Volume 25, Issue 15, November 2004, Pages 1759-1767.

The algorithm, a description of the transform and some applications can be found in "Morphological Grayscale Reconstruction in Image Analysis: Applications and Efficient Algorithms", Luc Vincent, IEEE Transactions on image processing, Vol. 2, April 1993.

Richard Beare. Department of Medicine, Monash University, Melbourne, Australia.
See also
MorphologyImageFilter , GrayscaleDilateImageFilter , GrayscaleFunctionDilateImageFilter , BinaryDilateImageFilter , ReconstructionByErosionImageFilter , OpeningByReconstructionImageFilter , ClosingByReconstructionImageFilter , ReconstructionImageFilter
itk::simple::ReconstructionByDilation for the procedural interface
itk::ReconstructionByDilationImageFilter for the Doxygen on the original ITK class.

Definition at line 57 of file sitkReconstructionByDilationImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::ReconstructionByDilationImageFilter::MemberFunctionType = Image (Self::*)( const Image * markerImage, const Image * maskImage )

Setup for member function dispatching

Definition at line 111 of file sitkReconstructionByDilationImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 69 of file sitkReconstructionByDilationImageFilter.h.

◆ Self

Definition at line 59 of file sitkReconstructionByDilationImageFilter.h.

Constructor & Destructor Documentation

◆ ~ReconstructionByDilationImageFilter()

virtual itk::simple::ReconstructionByDilationImageFilter::~ReconstructionByDilationImageFilter ( )


◆ ReconstructionByDilationImageFilter()

itk::simple::ReconstructionByDilationImageFilter::ReconstructionByDilationImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::ReconstructionByDilationImageFilter::Execute ( const Image markerImage,
const Image maskImage 

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::ReconstructionByDilationImageFilter::ExecuteInternal ( const Image markerImage,
const Image maskImage 

◆ FullyConnectedOff()

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

Definition at line 78 of file sitkReconstructionByDilationImageFilter.h.

◆ FullyConnectedOn()

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

Set the value of FullyConnected to true or false respectfully.

Definition at line 77 of file sitkReconstructionByDilationImageFilter.h.

◆ GetFullyConnected()

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

Definition at line 82 of file sitkReconstructionByDilationImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 97 of file sitkReconstructionByDilationImageFilter.h.

◆ GetUseInternalCopy()

bool itk::simple::ReconstructionByDilationImageFilter::GetUseInternalCopy ( ) const

Definition at line 94 of file sitkReconstructionByDilationImageFilter.h.

◆ SetFullyConnected()

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

Definition at line 74 of file sitkReconstructionByDilationImageFilter.h.

◆ SetUseInternalCopy()

Self& itk::simple::ReconstructionByDilationImageFilter::SetUseInternalCopy ( bool  UseInternalCopy)

Definition at line 86 of file sitkReconstructionByDilationImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

◆ UseInternalCopyOff()

Self& itk::simple::ReconstructionByDilationImageFilter::UseInternalCopyOff ( )

Definition at line 90 of file sitkReconstructionByDilationImageFilter.h.

◆ UseInternalCopyOn()

Self& itk::simple::ReconstructionByDilationImageFilter::UseInternalCopyOn ( )

Set the value of UseInternalCopy to true or false respectfully.

Definition at line 89 of file sitkReconstructionByDilationImageFilter.h.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 115 of file sitkReconstructionByDilationImageFilter.h.

Member Data Documentation

◆ m_FullyConnected

bool itk::simple::ReconstructionByDilationImageFilter::m_FullyConnected {false}

Definition at line 121 of file sitkReconstructionByDilationImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ReconstructionByDilationImageFilter::m_MemberFactory

Definition at line 117 of file sitkReconstructionByDilationImageFilter.h.

◆ m_UseInternalCopy

bool itk::simple::ReconstructionByDilationImageFilter::m_UseInternalCopy {true}

Definition at line 123 of file sitkReconstructionByDilationImageFilter.h.

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