SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::DanielssonDistanceMapImageFilter Class Reference

This filter computes the distance map of the input image as an approximation with pixel accuracy to the Euclidean distance. More...

#include <sitkDanielssonDistanceMapImageFilter.h>

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

Public Types

using PixelIDTypeList = IntegerPixelIDTypeList
 
using Self = DanielssonDistanceMapImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

 DanielssonDistanceMapImageFilter ()
 
Image Execute (const Image &image1)
 
bool GetInputIsBinary () const
 
std::string GetName () const
 
bool GetSquaredDistance () const
 
bool GetUseImageSpacing () const
 
SelfInputIsBinaryOff ()
 
SelfInputIsBinaryOn ()
 
SelfSetInputIsBinary (bool InputIsBinary)
 
SelfSetSquaredDistance (bool SquaredDistance)
 
SelfSetUseImageSpacing (bool UseImageSpacing)
 
SelfSquaredDistanceOff ()
 
SelfSquaredDistanceOn ()
 
std::string ToString () const
 
SelfUseImageSpacingOff ()
 
SelfUseImageSpacingOn ()
 
virtual ~DanielssonDistanceMapImageFilter ()
 
- 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)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image &image1)
 

Private Attributes

bool m_InputIsBinary {false}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
bool m_SquaredDistance {false}
 
bool m_UseImageSpacing {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

This filter computes the distance map of the input image as an approximation with pixel accuracy to the Euclidean distance.

TInputImage

Input Image Type

TOutputImage

Output Image Type

TVoronoiImage

Voronoi Image Type. Note the default value is TInputImage.

The input is assumed to contain numeric codes defining objects. The filter will produce as output the following images:

This filter is N-dimensional and known to be efficient in computational time. The algorithm is the N-dimensional version of the 4SED algorithm given for two dimensions in:

Danielsson, Per-Erik. Euclidean Distance Mapping. Computer Graphics and Image Processing 14, 227-248 (1980).

See also
itk::simple::DanielssonDistanceMap for the procedural interface
itk::DanielssonDistanceMapImageFilter for the Doxygen on the original ITK class.

Definition at line 78 of file sitkDanielssonDistanceMapImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 150 of file sitkDanielssonDistanceMapImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 90 of file sitkDanielssonDistanceMapImageFilter.h.

◆ Self

Definition at line 80 of file sitkDanielssonDistanceMapImageFilter.h.

Constructor & Destructor Documentation

◆ ~DanielssonDistanceMapImageFilter()

virtual itk::simple::DanielssonDistanceMapImageFilter::~DanielssonDistanceMapImageFilter ( )
virtual

Destructor

◆ DanielssonDistanceMapImageFilter()

itk::simple::DanielssonDistanceMapImageFilter::DanielssonDistanceMapImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::DanielssonDistanceMapImageFilter::Execute ( const Image image1)

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::DanielssonDistanceMapImageFilter::ExecuteInternal ( const Image image1)
private

◆ GetInputIsBinary()

bool itk::simple::DanielssonDistanceMapImageFilter::GetInputIsBinary ( ) const
inline

Get if the input is binary. See SetInputIsBinary() .

Definition at line 105 of file sitkDanielssonDistanceMapImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 136 of file sitkDanielssonDistanceMapImageFilter.h.

◆ GetSquaredDistance()

bool itk::simple::DanielssonDistanceMapImageFilter::GetSquaredDistance ( ) const
inline

Get the distance squared.

Definition at line 119 of file sitkDanielssonDistanceMapImageFilter.h.

◆ GetUseImageSpacing()

bool itk::simple::DanielssonDistanceMapImageFilter::GetUseImageSpacing ( ) const
inline

Get whether spacing is used.

Definition at line 133 of file sitkDanielssonDistanceMapImageFilter.h.

◆ InputIsBinaryOff()

Self& itk::simple::DanielssonDistanceMapImageFilter::InputIsBinaryOff ( )
inline

Definition at line 100 of file sitkDanielssonDistanceMapImageFilter.h.

◆ InputIsBinaryOn()

Self& itk::simple::DanielssonDistanceMapImageFilter::InputIsBinaryOn ( )
inline

Set the value of InputIsBinary to true or false respectfully.

Definition at line 99 of file sitkDanielssonDistanceMapImageFilter.h.

◆ SetInputIsBinary()

Self& itk::simple::DanielssonDistanceMapImageFilter::SetInputIsBinary ( bool  InputIsBinary)
inline

Set if the input is binary. If this variable is set, each nonzero pixel in the input image will be given a unique numeric code to be used by the Voronoi partition. If the image is binary but you are not interested in the Voronoi regions of the different nonzero pixels, then you need not set this.

Definition at line 96 of file sitkDanielssonDistanceMapImageFilter.h.

◆ SetSquaredDistance()

Self& itk::simple::DanielssonDistanceMapImageFilter::SetSquaredDistance ( bool  SquaredDistance)
inline

Set if the distance should be squared.

Definition at line 110 of file sitkDanielssonDistanceMapImageFilter.h.

◆ SetUseImageSpacing()

Self& itk::simple::DanielssonDistanceMapImageFilter::SetUseImageSpacing ( bool  UseImageSpacing)
inline

Set if image spacing should be used in computing distances.

Definition at line 124 of file sitkDanielssonDistanceMapImageFilter.h.

◆ SquaredDistanceOff()

Self& itk::simple::DanielssonDistanceMapImageFilter::SquaredDistanceOff ( )
inline

Definition at line 114 of file sitkDanielssonDistanceMapImageFilter.h.

◆ SquaredDistanceOn()

Self& itk::simple::DanielssonDistanceMapImageFilter::SquaredDistanceOn ( )
inline

Set the value of SquaredDistance to true or false respectfully.

Definition at line 113 of file sitkDanielssonDistanceMapImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

◆ UseImageSpacingOff()

Self& itk::simple::DanielssonDistanceMapImageFilter::UseImageSpacingOff ( )
inline

Definition at line 128 of file sitkDanielssonDistanceMapImageFilter.h.

◆ UseImageSpacingOn()

Self& itk::simple::DanielssonDistanceMapImageFilter::UseImageSpacingOn ( )
inline

Set the value of UseImageSpacing to true or false respectfully.

Definition at line 127 of file sitkDanielssonDistanceMapImageFilter.h.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 154 of file sitkDanielssonDistanceMapImageFilter.h.

Member Data Documentation

◆ m_InputIsBinary

bool itk::simple::DanielssonDistanceMapImageFilter::m_InputIsBinary {false}
private

Definition at line 159 of file sitkDanielssonDistanceMapImageFilter.h.

◆ m_MemberFactory

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

Definition at line 156 of file sitkDanielssonDistanceMapImageFilter.h.

◆ m_SquaredDistance

bool itk::simple::DanielssonDistanceMapImageFilter::m_SquaredDistance {false}
private

Definition at line 161 of file sitkDanielssonDistanceMapImageFilter.h.

◆ m_UseImageSpacing

bool itk::simple::DanielssonDistanceMapImageFilter::m_UseImageSpacing {false}
private

Definition at line 163 of file sitkDanielssonDistanceMapImageFilter.h.


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