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

#include <sitkSignedDanielssonDistanceMapImageFilter.h>

Inheritance diagram for itk::simple::SignedDanielssonDistanceMapImageFilter:

Collaboration diagram for itk::simple::SignedDanielssonDistanceMapImageFilter:

Detailed Description

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

This class is parameterized over the type of the input image and the type of the output image.

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

A signed distance map with the approximation to the euclidean distance.

A voronoi partition. (See itkDanielssonDistanceMapImageFilter)

A vector map containing the component of the vector relating the current pixel with the closest point of the closest object to this pixel. Given that the components of the distance are computed in "pixels", the vector is represented by an itk::Offset . That is, physical coordinates are not used. (See itkDanielssonDistanceMapImageFilter)

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 62 of file sitkSignedDanielssonDistanceMapImageFilter.h.

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	GetVectorDistanceMap () const

Image	GetVoronoiMap () const

Self &	InsideIsPositiveOff ()

Self &	InsideIsPositiveOn ()

Self &	SetInsideIsPositive (bool InsideIsPositive)

Self &	SetSquaredDistance (bool SquaredDistance)

Self &	SetUseImageSpacing (bool UseImageSpacing)

	SignedDanielssonDistanceMapImageFilter ()

Self &	SquaredDistanceOff ()

Self &	SquaredDistanceOn ()

std::string	ToString () const

Self &	UseImageSpacingOff ()

Self &	UseImageSpacingOn ()

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_VectorDistanceMap {Image()}

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::ProcessObject *	GetActiveProcess ()

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

NonCopyable &	operator= (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<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)

template<class TImageType >
static Image	CastITKToImage (TImageType *img)

static const itk::EventObject &	GetITKEventObject (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)

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::SignedDanielssonDistanceMapImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 150 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ PixelIDTypeList

using itk::simple::SignedDanielssonDistanceMapImageFilter::PixelIDTypeList = IntegerPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 74 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ Self

using itk::simple::SignedDanielssonDistanceMapImageFilter::Self = SignedDanielssonDistanceMapImageFilter

Definition at line 64 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 89 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 136 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ GetSquaredDistance()

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

inline

Get the distance squared.

Definition at line 103 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ GetUseImageSpacing()

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

inline

Get whether spacing is used.

Definition at line 117 of file sitkSignedDanielssonDistanceMapImageFilter.h.

◆ GetVectorDistanceMap()

Image itk::simple::SignedDanielssonDistanceMapImageFilter::GetVectorDistanceMap ( ) const

inline

Get vector field of distances.

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 132 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 124 of file sitkSignedDanielssonDistanceMapImageFilter.h.