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

#include <sitkSignedDanielssonDistanceMapImageFilter.h>

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

Public Types

using PixelIDTypeList = IntegerPixelIDTypeList
 
using Self = SignedDanielssonDistanceMapImageFilter
 
- 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)
 
bool GetInsideIsPositive () const
 
std::string GetName () const
 
bool GetSquaredDistance () const
 
bool GetUseImageSpacing () const
 
Image GetVoronoiMap () const
 
SelfInsideIsPositiveOff ()
 
SelfInsideIsPositiveOn ()
 
SelfSetInsideIsPositive (bool InsideIsPositive)
 
SelfSetSquaredDistance (bool SquaredDistance)
 
SelfSetUseImageSpacing (bool UseImageSpacing)
 
 SignedDanielssonDistanceMapImageFilter ()
 
SelfSquaredDistanceOff ()
 
SelfSquaredDistanceOn ()
 
std::string ToString () const
 
SelfUseImageSpacingOff ()
 
SelfUseImageSpacingOn ()
 
virtual ~SignedDanielssonDistanceMapImageFilter ()
 
- 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_InsideIsPositive {false}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
bool m_SquaredDistance {false}
 
bool m_UseImageSpacing {false}
 
Image m_VoronoiMap {Image()}
 

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 class is parameterized over the type of the input image and the type of the output image.

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

For purposes of evaluating the signed distance map, the input is assumed to be binary composed of pixels with value 0 and non-zero.

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

As a convention, the distance is evaluated from the boundary of the ON pixels.

The filter returns

This filter internally uses the DanielssonDistanceMap filter. This filter is N-dimensional.

See also
itkDanielssonDistanceMapImageFilter
itk::simple::SignedDanielssonDistanceMap for the procedural interface
itk::SignedDanielssonDistanceMapImageFilter for the Doxygen on the original ITK class.

Definition at line 65 of file sitkSignedDanielssonDistanceMapImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 145 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 77 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ Self

Definition at line 67 of file sitkSignedDanielssonDistanceMapImageFilter.h.

Constructor & Destructor Documentation

◆ ~SignedDanielssonDistanceMapImageFilter()

virtual itk::simple::SignedDanielssonDistanceMapImageFilter::~SignedDanielssonDistanceMapImageFilter ( )
virtual

Destructor

◆ SignedDanielssonDistanceMapImageFilter()

itk::simple::SignedDanielssonDistanceMapImageFilter::SignedDanielssonDistanceMapImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetInsideIsPositive()

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

Get if the inside represents positive values in the signed distance map. See GetInsideIsPositive()

Definition at line 92 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 131 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ GetSquaredDistance()

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

Get the distance squared.

Definition at line 106 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ GetUseImageSpacing()

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

Get whether spacing is used.

Definition at line 120 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ GetVoronoiMap()

Image itk::simple::SignedDanielssonDistanceMapImageFilter::GetVoronoiMap ( ) const
inline

Get Voronoi Map This map shows for each pixel what object is closest to it. Each object should be labeled by a number (larger than 0), so the map has a value for each pixel corresponding to the label of the closest object.

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 127 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ InsideIsPositiveOff()

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

Definition at line 87 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ InsideIsPositiveOn()

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

Set the value of InsideIsPositive to true or false respectfully.

Definition at line 86 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ SetInsideIsPositive()

Self& itk::simple::SignedDanielssonDistanceMapImageFilter::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 83 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ SetSquaredDistance()

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

Set if the distance should be squared.

Definition at line 97 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ SetUseImageSpacing()

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

Set if image spacing should be used in computing distances.

Definition at line 111 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ SquaredDistanceOff()

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

◆ SquaredDistanceOn()

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

Set the value of SquaredDistance to true or false respectfully.

Definition at line 100 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

◆ UseImageSpacingOff()

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

◆ UseImageSpacingOn()

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

Set the value of UseImageSpacing to true or false respectfully.

Definition at line 114 of file sitkSignedDanielssonDistanceMapImageFilter.h.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_InsideIsPositive

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

◆ m_MemberFactory

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

◆ m_SquaredDistance

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

◆ m_UseImageSpacing

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

◆ m_VoronoiMap

Image itk::simple::SignedDanielssonDistanceMapImageFilter::m_VoronoiMap {Image()}
private

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