SimpleITK
2.0.0
|
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>
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 &image1, const Image &image2) |
double | GetDiceCoefficient () const |
double | GetDiceCoefficient (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 &image1, const Image &image2) |
Private Member Functions | |
template<class TImageType > | |
void | ExecuteInternal (const Image &image1, const Image &image2) |
Private Attributes | |
double | m_DiceCoefficient {0.0} |
double | m_FalseNegativeError {0.0} |
double | m_FalsePositiveError {0.0} |
itk::ProcessObject * | m_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_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::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<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) |
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://hdl.handle.net/10380/3141 http://www.insight-journal.org/browse/publication/707
Definition at line 47 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Setup for member function dispatching
Definition at line 196 of file sitkLabelOverlapMeasuresImageFilter.h.
Define the pixels types supported by this filter
Definition at line 59 of file sitkLabelOverlapMeasuresImageFilter.h.
Definition at line 49 of file sitkLabelOverlapMeasuresImageFilter.h.
|
virtual |
Destructor
itk::simple::LabelOverlapMeasuresImageFilter::LabelOverlapMeasuresImageFilter | ( | ) |
Default Constructor that takes no arguments and initializes default parameters
void itk::simple::LabelOverlapMeasuresImageFilter::Execute | ( | const Image & | image1, |
const Image & | image2 | ||
) |
Execute the filter on the input images
|
private |
|
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.
|
inline |
Get the mean overlap (Dice coefficient) over all labels.
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.
|
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.
|
inline |
Get the false negative error over all labels.
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.
|
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.
|
inline |
Get the false positive error over all labels.
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.
|
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.
|
inline |
Get the union overlap (Jaccard coefficient) over all labels.
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.
|
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.
|
inline |
Get the mean overlap (Dice coefficient) over all labels.
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.
|
inlinevirtual |
Name of this class
Implements itk::simple::ProcessObject.
Definition at line 182 of file sitkLabelOverlapMeasuresImageFilter.h.
|
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.
|
inline |
Get the union overlap (Jaccard coefficient) over all labels.
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.
|
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.
|
inline |
Get the volume similarity over all labels.
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.
|
virtual |
Print ourselves out
Reimplemented from itk::simple::ProcessObject.
|
friend |
Definition at line 200 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Definition at line 230 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Definition at line 206 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Definition at line 210 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Definition at line 235 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Definition at line 226 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Definition at line 214 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Definition at line 202 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Definition at line 232 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Definition at line 208 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Definition at line 212 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Definition at line 228 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Definition at line 216 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Definition at line 220 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Definition at line 224 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Definition at line 218 of file sitkLabelOverlapMeasuresImageFilter.h.
|
private |
Definition at line 222 of file sitkLabelOverlapMeasuresImageFilter.h.