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

Computes overlap measures between the set same set of labels of pixels of two images. Background is assumed to be 0. More...

#include <sitkLabelOverlapMeasuresImageFilter.h>

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

Public Types

using PixelIDTypeList = IntegerPixelIDTypeList
 
using Self = LabelOverlapMeasuresImageFilter
 
- 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 &sourceImage, const Image &targetImage)
 
double GetDiceCoefficient () const
 
double GetDiceCoefficient (int64_t label) const
 
double GetFalseDiscoveryRate () const
 
double GetFalseDiscoveryRate (int64_t label) const
 
double GetFalseNegativeError () const
 
double GetFalseNegativeError (int64_t label) const
 
double GetFalsePositiveError () const
 
double GetFalsePositiveError (int64_t label) const
 
double GetJaccardCoefficient () const
 
double GetJaccardCoefficient (int64_t label) const
 
double GetMeanOverlap () const
 
double GetMeanOverlap (int64_t label) const
 
std::string GetName () const
 
double GetUnionOverlap () const
 
double GetUnionOverlap (int64_t label) const
 
double GetVolumeSimilarity () const
 
double GetVolumeSimilarity (int64_t label) const
 
 LabelOverlapMeasuresImageFilter ()
 
std::string ToString () const
 
virtual ~LabelOverlapMeasuresImageFilter ()
 
- 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 *sourceImage, const Image *targetImage)
 

Private Member Functions

template<class TImageType >
void ExecuteInternal (const Image *sourceImage, const Image *targetImage)
 

Private Attributes

double m_DiceCoefficient {0.0}
 
double m_FalseDiscoveryRate {0.0}
 
double m_FalseNegativeError {0.0}
 
double m_FalsePositiveError {0.0}
 
itk::ProcessObjectm_Filter {nullptr}
 
double m_JaccardCoefficient {0.0}
 
double m_MeanOverlap {0.0}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::function< double(int64_t)> m_pfGetDiceCoefficient
 
std::function< double(int64_t)> m_pfGetFalseDiscoveryRate
 
std::function< double(int64_t)> m_pfGetFalseNegativeError
 
std::function< double(int64_t)> m_pfGetFalsePositiveError
 
std::function< double(int64_t)> m_pfGetJaccardCoefficient
 
std::function< double(int64_t)> m_pfGetMeanOverlap
 
std::function< double(int64_t)> m_pfGetUnionOverlap
 
std::function< double(int64_t)> m_pfGetVolumeSimilarity
 
double m_UnionOverlap {0.0}
 
double m_VolumeSimilarity {0.0}
 

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<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::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 overlap measures between the set same set of labels of pixels of two images. Background is assumed to be 0.

This code was contributed in the Insight Journal paper: "Introducing Dice, Jaccard, and Other Label Overlap Measures To ITK" by Nicholas J. Tustison, James C. Gee https://www.insight-journal.org/browse/publication/707

Author
Nicholas J. Tustison
See also
LabelOverlapMeasuresImageFilter
itk::LabelOverlapMeasuresImageFilter for the Doxygen on the original ITK class.

Definition at line 47 of file sitkLabelOverlapMeasuresImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::LabelOverlapMeasuresImageFilter::MemberFunctionType = void (Self::*)( const Image * sourceImage, const Image * targetImage )
private

Setup for member function dispatching

Definition at line 213 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 59 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ Self

Definition at line 49 of file sitkLabelOverlapMeasuresImageFilter.h.

Constructor & Destructor Documentation

◆ ~LabelOverlapMeasuresImageFilter()

virtual itk::simple::LabelOverlapMeasuresImageFilter::~LabelOverlapMeasuresImageFilter ( )
virtual

Destructor

◆ LabelOverlapMeasuresImageFilter()

itk::simple::LabelOverlapMeasuresImageFilter::LabelOverlapMeasuresImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

void itk::simple::LabelOverlapMeasuresImageFilter::Execute ( const Image sourceImage,
const Image targetImage 
)

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
void itk::simple::LabelOverlapMeasuresImageFilter::ExecuteInternal ( const Image sourceImage,
const Image targetImage 
)
private

◆ GetDiceCoefficient() [1/2]

double itk::simple::LabelOverlapMeasuresImageFilter::GetDiceCoefficient ( ) const
inline

Get the mean overlap (Dice coefficient) for the specified individual label.

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 169 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ GetDiceCoefficient() [2/2]

double itk::simple::LabelOverlapMeasuresImageFilter::GetDiceCoefficient ( int64_t  label) const
inline

Get the mean overlap (Dice coefficient) for the specified individual label.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 178 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ GetFalseDiscoveryRate() [1/2]

double itk::simple::LabelOverlapMeasuresImageFilter::GetFalseDiscoveryRate ( ) const
inline

Get the false discovery rate for the specified individual label.

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 186 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ GetFalseDiscoveryRate() [2/2]

double itk::simple::LabelOverlapMeasuresImageFilter::GetFalseDiscoveryRate ( int64_t  label) const
inline

Get the false discovery rate for the specified individual label.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 195 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ GetFalseNegativeError() [1/2]

double itk::simple::LabelOverlapMeasuresImageFilter::GetFalseNegativeError ( ) const
inline

Get the false negative error for the specified individual label.

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 67 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ GetFalseNegativeError() [2/2]

double itk::simple::LabelOverlapMeasuresImageFilter::GetFalseNegativeError ( int64_t  label) const
inline

Get the false negative error for the specified individual label.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 76 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ GetFalsePositiveError() [1/2]

double itk::simple::LabelOverlapMeasuresImageFilter::GetFalsePositiveError ( ) const
inline

Get the false positive error for the specified individual label.

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 84 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ GetFalsePositiveError() [2/2]

double itk::simple::LabelOverlapMeasuresImageFilter::GetFalsePositiveError ( int64_t  label) const
inline

Get the false positive error for the specified individual label.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 93 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ GetJaccardCoefficient() [1/2]

double itk::simple::LabelOverlapMeasuresImageFilter::GetJaccardCoefficient ( ) const
inline

Get the union overlap (Jaccard coefficient) for the specified individual label.

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 152 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ GetJaccardCoefficient() [2/2]

double itk::simple::LabelOverlapMeasuresImageFilter::GetJaccardCoefficient ( int64_t  label) const
inline

Get the union overlap (Jaccard coefficient) for the specified individual label.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 161 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ GetMeanOverlap() [1/2]

double itk::simple::LabelOverlapMeasuresImageFilter::GetMeanOverlap ( ) const
inline

Get the mean overlap (Dice coefficient) for the specified individual label.

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 101 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ GetMeanOverlap() [2/2]

double itk::simple::LabelOverlapMeasuresImageFilter::GetMeanOverlap ( int64_t  label) const
inline

Get the mean overlap (Dice coefficient) for the specified individual label.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 110 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 199 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ GetUnionOverlap() [1/2]

double itk::simple::LabelOverlapMeasuresImageFilter::GetUnionOverlap ( ) const
inline

Get the union overlap (Jaccard coefficient) for the specified individual label.

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 118 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ GetUnionOverlap() [2/2]

double itk::simple::LabelOverlapMeasuresImageFilter::GetUnionOverlap ( int64_t  label) const
inline

Get the union overlap (Jaccard coefficient) for the specified individual label.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 127 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ GetVolumeSimilarity() [1/2]

double itk::simple::LabelOverlapMeasuresImageFilter::GetVolumeSimilarity ( ) const
inline

Get the volume similarity for the specified individual label.

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 135 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ GetVolumeSimilarity() [2/2]

double itk::simple::LabelOverlapMeasuresImageFilter::GetVolumeSimilarity ( int64_t  label) const
inline

Get the volume similarity for the specified individual label.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 144 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 217 of file sitkLabelOverlapMeasuresImageFilter.h.

Member Data Documentation

◆ m_DiceCoefficient

double itk::simple::LabelOverlapMeasuresImageFilter::m_DiceCoefficient {0.0}
private

Definition at line 247 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_FalseDiscoveryRate

double itk::simple::LabelOverlapMeasuresImageFilter::m_FalseDiscoveryRate {0.0}
private

Definition at line 251 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_FalseNegativeError

double itk::simple::LabelOverlapMeasuresImageFilter::m_FalseNegativeError {0.0}
private

Definition at line 223 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_FalsePositiveError

double itk::simple::LabelOverlapMeasuresImageFilter::m_FalsePositiveError {0.0}
private

Definition at line 227 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_Filter

itk::ProcessObject* itk::simple::LabelOverlapMeasuresImageFilter::m_Filter {nullptr}
private

Definition at line 256 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_JaccardCoefficient

double itk::simple::LabelOverlapMeasuresImageFilter::m_JaccardCoefficient {0.0}
private

Definition at line 243 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_MeanOverlap

double itk::simple::LabelOverlapMeasuresImageFilter::m_MeanOverlap {0.0}
private

Definition at line 231 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_MemberFactory

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

Definition at line 219 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_pfGetDiceCoefficient

std::function<double(int64_t)> itk::simple::LabelOverlapMeasuresImageFilter::m_pfGetDiceCoefficient
private

Definition at line 249 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_pfGetFalseDiscoveryRate

std::function<double(int64_t)> itk::simple::LabelOverlapMeasuresImageFilter::m_pfGetFalseDiscoveryRate
private

Definition at line 253 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_pfGetFalseNegativeError

std::function<double(int64_t)> itk::simple::LabelOverlapMeasuresImageFilter::m_pfGetFalseNegativeError
private

Definition at line 225 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_pfGetFalsePositiveError

std::function<double(int64_t)> itk::simple::LabelOverlapMeasuresImageFilter::m_pfGetFalsePositiveError
private

Definition at line 229 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_pfGetJaccardCoefficient

std::function<double(int64_t)> itk::simple::LabelOverlapMeasuresImageFilter::m_pfGetJaccardCoefficient
private

Definition at line 245 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_pfGetMeanOverlap

std::function<double(int64_t)> itk::simple::LabelOverlapMeasuresImageFilter::m_pfGetMeanOverlap
private

Definition at line 233 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_pfGetUnionOverlap

std::function<double(int64_t)> itk::simple::LabelOverlapMeasuresImageFilter::m_pfGetUnionOverlap
private

Definition at line 237 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_pfGetVolumeSimilarity

std::function<double(int64_t)> itk::simple::LabelOverlapMeasuresImageFilter::m_pfGetVolumeSimilarity
private

Definition at line 241 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_UnionOverlap

double itk::simple::LabelOverlapMeasuresImageFilter::m_UnionOverlap {0.0}
private

Definition at line 235 of file sitkLabelOverlapMeasuresImageFilter.h.

◆ m_VolumeSimilarity

double itk::simple::LabelOverlapMeasuresImageFilter::m_VolumeSimilarity {0.0}
private

Definition at line 239 of file sitkLabelOverlapMeasuresImageFilter.h.


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