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

Computes the Hausdorff distance between the set of non-zero pixels of two images. More...

#include <sitkHausdorffDistanceImageFilter.h>

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

Public Types

using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = HausdorffDistanceImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

void Execute (const Image &image1, const Image &image2)
 
double GetAverageHausdorffDistance () const
 
double GetHausdorffDistance () const
 
std::string GetName () const
 
 HausdorffDistanceImageFilter ()
 
std::string ToString () const
 
virtual ~HausdorffDistanceImageFilter ()
 
- 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 = void(Self::*)(const Image &image1, const Image &image2)
 

Private Member Functions

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

Private Attributes

double m_AverageHausdorffDistance {0.0}
 
double m_HausdorffDistance {0.0}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 

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

Computes the Hausdorff distance between the set of non-zero pixels of two images.

HausdorffDistanceImageFilter computes the distance between the set non-zero pixels of two images using the following formula:

\[ H(A,B) = \max(h(A,B),h(B,A)) \]

where

\[ h(A,B) = \max_{a \in A} \min_{b \in B} \| a - b\| \]

is the directed Hausdorff distance and \(A\) and \(B\) are respectively the set of non-zero pixels in the first and second input images.

In particular, this filter uses the DirectedHausdorffImageFilter inside to compute the two directed distances and then select the largest of the two.

The Hausdorff distance measures the degree of mismatch between two sets and behaves like a metric over the set of all closed bounded sets - with properties of identity, symmetry and triangle inequality.

This filter requires the largest possible region of the first image and the same corresponding region in the second image. It behaves as filter with two inputs and one output. Thus it can be inserted in a pipeline with other filters. The filter passes the first input through unmodified.

This filter is templated over the two input image types. It assume both images have the same number of dimensions.

See also
DirectedHausdorffDistanceImageFilter
itk::HausdorffDistanceImageFilter for the Doxygen on the original ITK class.

Definition at line 52 of file sitkHausdorffDistanceImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::HausdorffDistanceImageFilter::MemberFunctionType = void (Self::*)( const Image& image1, const Image& image2 )
private

Setup for member function dispatching

Definition at line 98 of file sitkHausdorffDistanceImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 64 of file sitkHausdorffDistanceImageFilter.h.

◆ Self

Definition at line 54 of file sitkHausdorffDistanceImageFilter.h.

Constructor & Destructor Documentation

◆ ~HausdorffDistanceImageFilter()

virtual itk::simple::HausdorffDistanceImageFilter::~HausdorffDistanceImageFilter ( )
virtual

Destructor

◆ HausdorffDistanceImageFilter()

itk::simple::HausdorffDistanceImageFilter::HausdorffDistanceImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

void itk::simple::HausdorffDistanceImageFilter::Execute ( const Image image1,
const Image image2 
)

Execute the filter on the input images

◆ ExecuteInternal()

template<class TImageType >
void itk::simple::HausdorffDistanceImageFilter::ExecuteInternal ( const Image image1,
const Image image2 
)
private

◆ GetAverageHausdorffDistance()

double itk::simple::HausdorffDistanceImageFilter::GetAverageHausdorffDistance ( ) const
inline

Return the computed Hausdorff distance.

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 80 of file sitkHausdorffDistanceImageFilter.h.

◆ GetHausdorffDistance()

double itk::simple::HausdorffDistanceImageFilter::GetHausdorffDistance ( ) const
inline

Return the computed Hausdorff distance.

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 72 of file sitkHausdorffDistanceImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 84 of file sitkHausdorffDistanceImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 102 of file sitkHausdorffDistanceImageFilter.h.

Member Data Documentation

◆ m_AverageHausdorffDistance

double itk::simple::HausdorffDistanceImageFilter::m_AverageHausdorffDistance {0.0}
private

Definition at line 110 of file sitkHausdorffDistanceImageFilter.h.

◆ m_HausdorffDistance

double itk::simple::HausdorffDistanceImageFilter::m_HausdorffDistance {0.0}
private

Definition at line 108 of file sitkHausdorffDistanceImageFilter.h.

◆ m_MemberFactory

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

Definition at line 104 of file sitkHausdorffDistanceImageFilter.h.


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