SimpleITK  1.3.0.dev466
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::ApproximateSignedDistanceMapImageFilter Class Reference

Create a map of the approximate signed distance from the boundaries of a binary image. More...

#include <sitkApproximateSignedDistanceMapImageFilter.h>

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

Public Types

typedef IntegerPixelIDTypeList PixelIDTypeList
 
typedef ApproximateSignedDistanceMapImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

 ApproximateSignedDistanceMapImageFilter ()
 
Image Execute (const Image &image1)
 
Image Execute (const Image &image1, double insideValue, double outsideValue)
 
double GetInsideValue () const
 
std::string GetName () const
 
double GetOutsideValue () const
 
SelfSetInsideValue (double InsideValue)
 
SelfSetOutsideValue (double OutsideValue)
 
std::string ToString () const
 
virtual ~ApproximateSignedDistanceMapImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 1 >
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
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
 

Private Types

typedef Image(Self::* MemberFunctionType) (const Image &image1)
 

Private Member Functions

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

Private Attributes

double m_InsideValue
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
double m_OutsideValue
 

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 void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 
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...
 
- 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) SITK_NOEXCEPT
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
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 TImageType >
static Image CastITKToImage (TImageType *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)
 
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

Create a map of the approximate signed distance from the boundaries of a binary image.

The ApproximateSignedDistanceMapImageFilter takes as input a binary image and produces a signed distance map. Each pixel value in the output contains the approximate distance from that pixel to the nearest "object" in the binary image. This filter differs from the DanielssonDistanceMapImageFilter in that it calculates the distance to the "object edge" for pixels within the object.

Negative values in the output indicate that the pixel at that position is within an object in the input image. The absolute value of a negative pixel represents the approximate distance to the nearest object boundary pixel.

WARNING: This filter requires that the output type be floating-point. Otherwise internal calculations will not be performed to the appropriate precision, resulting in completely incorrect (read: zero-valued) output.

The distances computed by this filter are Chamfer distances, which are only an approximation to Euclidian distances, and are not as exact approximations as those calculated by the DanielssonDistanceMapImageFilter . On the other hand, this filter is faster.

This filter requires that an "inside value" and "outside value" be set as parameters. The "inside value" is the intensity value of the binary image which corresponds to objects, and the "outside value" is the intensity of the background. (A typical binary image often represents objects as black (0) and background as white (usually 255), or vice-versa.) Note that this filter is slightly faster if the inside value is less than the outside value. Otherwise an extra iteration through the image is required.

This filter uses the FastChamferDistanceImageFilter and the IsoContourDistanceImageFilter internally to perform the distance calculations.

See also
DanielssonDistanceMapImageFilter
SignedDanielssonDistanceMapImageFilter
SignedMaurerDistanceMapImageFilter
FastChamferDistanceImageFilter
IsoContourDistanceImageFilter
Author
Zach Pincus
See also
itk::simple::ApproximateSignedDistanceMap for the procedural interface
itk::ApproximateSignedDistanceMapImageFilter for the Doxygen on the original ITK class.

Definition at line 64 of file sitkApproximateSignedDistanceMapImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::ApproximateSignedDistanceMapImageFilter::MemberFunctionType) (const Image &image1)
private

Setup for member function dispatching

Definition at line 117 of file sitkApproximateSignedDistanceMapImageFilter.h.

Define the pixels types supported by this filter

Definition at line 76 of file sitkApproximateSignedDistanceMapImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::ApproximateSignedDistanceMapImageFilter::~ApproximateSignedDistanceMapImageFilter ( )
virtual

Destructor

itk::simple::ApproximateSignedDistanceMapImageFilter::ApproximateSignedDistanceMapImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::ApproximateSignedDistanceMapImageFilter::Execute ( const Image image1,
double  insideValue,
double  outsideValue 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::ApproximateSignedDistanceMapImageFilter::ExecuteInternal ( const Image image1)
private
double itk::simple::ApproximateSignedDistanceMapImageFilter::GetInsideValue ( ) const
inline

Set/Get intensity value representing the interior of objects in the mask.

Definition at line 88 of file sitkApproximateSignedDistanceMapImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 100 of file sitkApproximateSignedDistanceMapImageFilter.h.

double itk::simple::ApproximateSignedDistanceMapImageFilter::GetOutsideValue ( ) const
inline

Set/Get intensity value representing non-objects in the mask.

Definition at line 98 of file sitkApproximateSignedDistanceMapImageFilter.h.

Self& itk::simple::ApproximateSignedDistanceMapImageFilter::SetInsideValue ( double  InsideValue)
inline

Set/Get intensity value representing the interior of objects in the mask.

Definition at line 83 of file sitkApproximateSignedDistanceMapImageFilter.h.

Self& itk::simple::ApproximateSignedDistanceMapImageFilter::SetOutsideValue ( double  OutsideValue)
inline

Set/Get intensity value representing non-objects in the mask.

Definition at line 93 of file sitkApproximateSignedDistanceMapImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Member Data Documentation

double itk::simple::ApproximateSignedDistanceMapImageFilter::m_InsideValue
private
nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ApproximateSignedDistanceMapImageFilter::m_MemberFactory
private
double itk::simple::ApproximateSignedDistanceMapImageFilter::m_OutsideValue
private

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