SimpleITK  1.0.1
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::SimilarityIndexImageFilter Class Reference

Measures the similarity between the set of non-zero pixels of two images. More...

#include <sitkSimilarityIndexImageFilter.h>

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

Public Types

typedef BasicPixelIDTypeList PixelIDTypeList
typedef SimilarityIndexImageFilter Self
- Public Types inherited from itk::simple::ImageFilter< 2 >
typedef ImageFilter Self
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self

Public Member Functions

void Execute (const Image &image1, const Image &image2)
std::string GetName () const
double GetSimilarityIndex () const
 SimilarityIndexImageFilter ()
std::string ToString () const
 ~SimilarityIndexImageFilter ()
- Public Member Functions inherited from itk::simple::ImageFilter< 2 >
 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 void(Self::* MemberFunctionType) (const Image &image1, const Image &image2)

Private Member Functions

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

Private Attributes

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
double m_SimilarityIndex


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) throw ()
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< 2 >
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

Measures the similarity between the set of non-zero pixels of two images.

SimilarityIndexImageFilter measures the similarity between the set non-zero pixels of two images using the following formula:

\[ S = \frac{2 | A \cap B |}{|A| + |B|} \]

where $A$ and $B$ are respectively the set of non-zero pixels in the first and second input images. Operator $|\cdot|$ represents the size of a set and $\cap$ represents the intersection of two sets.

The measure is derived from a reliability measure known as the kappa statistic. $S$ is sensitive to both differences in size and in location and have been in the literature for comparing two segmentation masks. For more information see: "Morphometric Analysis of White Matter Lesions in MR Images: Method and Validation", A. P. Zijdenbos, B. M. Dawant, R. A. Margolin and A. C. Palmer, IEEE Trans. on Medical Imaging, 13(4) pp 716-724,1994

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 input 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 type. It assume both image have the same number of dimensions.

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

Definition at line 49 of file sitkSimilarityIndexImageFilter.h.

Member Typedef Documentation

typedef void(Self::* itk::simple::SimilarityIndexImageFilter::MemberFunctionType) (const Image &image1, const Image &image2)

Setup for member function dispatching

Definition at line 88 of file sitkSimilarityIndexImageFilter.h.

Define the pixels types supported by this filter

Definition at line 61 of file sitkSimilarityIndexImageFilter.h.

Definition at line 51 of file sitkSimilarityIndexImageFilter.h.

Constructor & Destructor Documentation

itk::simple::SimilarityIndexImageFilter::SimilarityIndexImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

itk::simple::SimilarityIndexImageFilter::~SimilarityIndexImageFilter ( )


Member Function Documentation

void itk::simple::SimilarityIndexImageFilter::Execute ( const Image image1,
const Image image2 

Execute the filter on the input images

template<class TImageType >
void itk::simple::SimilarityIndexImageFilter::ExecuteInternal ( const Image image1,
const Image image2 
std::string itk::simple::SimilarityIndexImageFilter::GetName ( ) const

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 73 of file sitkSimilarityIndexImageFilter.h.

double itk::simple::SimilarityIndexImageFilter::GetSimilarityIndex ( ) const

Return the computed similarity index.

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 70 of file sitkSimilarityIndexImageFilter.h.

std::string itk::simple::SimilarityIndexImageFilter::ToString ( ) const

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 93 of file sitkSimilarityIndexImageFilter.h.

Member Data Documentation

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::SimilarityIndexImageFilter::m_MemberFactory

Definition at line 95 of file sitkSimilarityIndexImageFilter.h.

double itk::simple::SimilarityIndexImageFilter::m_SimilarityIndex

Definition at line 99 of file sitkSimilarityIndexImageFilter.h.

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