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

This filter calculates the Euclidean distance transform of a binary image in linear time for arbitrary dimensions. More...

#include <sitkSignedMaurerDistanceMapImageFilter.h>

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

Public Types

using PixelIDTypeList = IntegerPixelIDTypeList
 
using Self = SignedMaurerDistanceMapImageFilter
 
- 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)
 
double GetBackgroundValue () const
 
bool GetInsideIsPositive () const
 
std::string GetName () const
 
bool GetSquaredDistance () const
 
bool GetUseImageSpacing () const
 
SelfInsideIsPositiveOff ()
 
SelfInsideIsPositiveOn ()
 
SelfSetBackgroundValue (double BackgroundValue)
 
SelfSetInsideIsPositive (bool InsideIsPositive)
 
SelfSetSquaredDistance (bool SquaredDistance)
 
SelfSetUseImageSpacing (bool UseImageSpacing)
 
 SignedMaurerDistanceMapImageFilter ()
 
SelfSquaredDistanceOff ()
 
SelfSquaredDistanceOn ()
 
std::string ToString () const
 
SelfUseImageSpacingOff ()
 
SelfUseImageSpacingOn ()
 
virtual ~SignedMaurerDistanceMapImageFilter ()
 
- 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

double m_BackgroundValue {0.0}
 
bool m_InsideIsPositive {false}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
bool m_SquaredDistance {true}
 
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 calculates the Euclidean distance transform of a binary image in linear time for arbitrary dimensions.

Inputs and Outputs
This is an image-to-image filter. The dimensionality is arbitrary. The only dimensionality constraint is that the input and output images be of the same dimensions and size. To maintain integer arithmetic within the filter, the default output is the signed squared distance. This implies that the input image should be of type "unsigned int" or "int" whereas the output image is of type "int". Obviously, if the user wishes to utilize the image spacing or to have a filter with the Euclidean distance (as opposed to the squared distance), output image types of float or double should be used.

The inside is considered as having negative distances. Outside is treated as having positive distances. To change the convention, use the InsideIsPositive(bool) function.

Parameters
Set/GetBackgroundValue specifies the background of the value of the input binary image. Normally this is zero and, as such, zero is the default value. Other than that, the usage is completely analogous to the itk::DanielssonDistanceImageFilter class except it does not return the Voronoi map.

Reference: C. R. Maurer, Jr., R. Qi, and V. Raghavan, "A Linear Time Algorithm for Computing Exact Euclidean Distance Transforms of Binary Images in Arbitrary Dimensions", IEEE - Transactions on Pattern Analysis and Machine Intelligence, 25(2): 265-270, 2003.

See also
itk::simple::SignedMaurerDistanceMap for the procedural interface
itk::SignedMaurerDistanceMapImageFilter for the Doxygen on the original ITK class.

Definition at line 52 of file sitkSignedMaurerDistanceMapImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 134 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 64 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ Self

Definition at line 54 of file sitkSignedMaurerDistanceMapImageFilter.h.

Constructor & Destructor Documentation

◆ ~SignedMaurerDistanceMapImageFilter()

virtual itk::simple::SignedMaurerDistanceMapImageFilter::~SignedMaurerDistanceMapImageFilter ( )
virtual

Destructor

◆ SignedMaurerDistanceMapImageFilter()

itk::simple::SignedMaurerDistanceMapImageFilter::SignedMaurerDistanceMapImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetBackgroundValue()

double itk::simple::SignedMaurerDistanceMapImageFilter::GetBackgroundValue ( ) const
inline

Set the background value which defines the object. Usually this value is = 0.

Definition at line 117 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ GetInsideIsPositive()

bool itk::simple::SignedMaurerDistanceMapImageFilter::GetInsideIsPositive ( ) const
inline

Get if the inside represents positive values in the signed distance map.

See also
GetInsideIsPositive()

Definition at line 79 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 120 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ GetSquaredDistance()

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

Get the distance squared.

Definition at line 93 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ GetUseImageSpacing()

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

Get whether spacing is used.

Definition at line 107 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ InsideIsPositiveOff()

Self& itk::simple::SignedMaurerDistanceMapImageFilter::InsideIsPositiveOff ( )
inline

Definition at line 74 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ InsideIsPositiveOn()

Self& itk::simple::SignedMaurerDistanceMapImageFilter::InsideIsPositiveOn ( )
inline

Set the value of InsideIsPositive to true or false respectfully.

Definition at line 73 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ SetBackgroundValue()

Self& itk::simple::SignedMaurerDistanceMapImageFilter::SetBackgroundValue ( double  BackgroundValue)
inline

Set the background value which defines the object. Usually this value is = 0.

Definition at line 112 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ SetInsideIsPositive()

Self& itk::simple::SignedMaurerDistanceMapImageFilter::SetInsideIsPositive ( bool  InsideIsPositive)
inline

Set if the inside represents positive values in the signed distance map. By convention ON pixels are treated as inside pixels.

Definition at line 70 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ SetSquaredDistance()

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

Set if the distance should be squared.

Definition at line 84 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ SetUseImageSpacing()

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

Set if image spacing should be used in computing distances.

Definition at line 98 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ SquaredDistanceOff()

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

Definition at line 88 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ SquaredDistanceOn()

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

Set the value of SquaredDistance to true or false respectfully.

Definition at line 87 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

◆ UseImageSpacingOff()

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

Definition at line 102 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ UseImageSpacingOn()

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

Set the value of UseImageSpacing to true or false respectfully.

Definition at line 101 of file sitkSignedMaurerDistanceMapImageFilter.h.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 138 of file sitkSignedMaurerDistanceMapImageFilter.h.

Member Data Documentation

◆ m_BackgroundValue

double itk::simple::SignedMaurerDistanceMapImageFilter::m_BackgroundValue {0.0}
private

Definition at line 149 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ m_InsideIsPositive

bool itk::simple::SignedMaurerDistanceMapImageFilter::m_InsideIsPositive {false}
private

Definition at line 143 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ m_MemberFactory

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

Definition at line 140 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ m_SquaredDistance

bool itk::simple::SignedMaurerDistanceMapImageFilter::m_SquaredDistance {true}
private

Definition at line 145 of file sitkSignedMaurerDistanceMapImageFilter.h.

◆ m_UseImageSpacing

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

Definition at line 147 of file sitkSignedMaurerDistanceMapImageFilter.h.


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