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
typedef IntegerPixelIDTypeList	PixelIDTypeList

typedef LabelOverlapMeasuresImageFilter	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)

double	GetDiceCoefficient () const

double	GetFalseNegativeError () const

double	GetFalsePositiveError () const

double	GetJaccardCoefficient () const

double	GetMeanOverlap () const

std::string	GetName () const

double	GetUnionOverlap () const

double	GetVolumeSimilarity () const

	LabelOverlapMeasuresImageFilter ()

std::string	ToString () const

virtual	~LabelOverlapMeasuresImageFilter ()

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
double	m_DiceCoefficient

double	m_FalseNegativeError

double	m_FalsePositiveError

double	m_JaccardCoefficient

double	m_MeanOverlap

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

double	m_UnionOverlap

double	m_VolumeSimilarity

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::ProcessObject *	GetActiveProcess ()

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< 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::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)

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://hdl.handle.net/10380/3141 http://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 46 of file sitkLabelOverlapMeasuresImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 132 of file sitkLabelOverlapMeasuresImageFilter.h.

typedef IntegerPixelIDTypeList itk::simple::LabelOverlapMeasuresImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 58 of file sitkLabelOverlapMeasuresImageFilter.h.

typedef LabelOverlapMeasuresImageFilter itk::simple::LabelOverlapMeasuresImageFilter::Self

Definition at line 48 of file sitkLabelOverlapMeasuresImageFilter.h.

Constructor & Destructor Documentation

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

virtual

Destructor

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input images

template<class TImageType >

void itk::simple::LabelOverlapMeasuresImageFilter::ExecuteInternal	(	const Image &	image1,
		const Image &	image2
	)

private

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

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.

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

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

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

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 118 of file sitkLabelOverlapMeasuresImageFilter.h.

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

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

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 136 of file sitkLabelOverlapMeasuresImageFilter.h.

Member Data Documentation

double itk::simple::LabelOverlapMeasuresImageFilter::m_DiceCoefficient

private

Definition at line 154 of file sitkLabelOverlapMeasuresImageFilter.h.

double itk::simple::LabelOverlapMeasuresImageFilter::m_FalseNegativeError

private

Definition at line 142 of file sitkLabelOverlapMeasuresImageFilter.h.

double itk::simple::LabelOverlapMeasuresImageFilter::m_FalsePositiveError

private

Definition at line 144 of file sitkLabelOverlapMeasuresImageFilter.h.

double itk::simple::LabelOverlapMeasuresImageFilter::m_JaccardCoefficient

private

Definition at line 152 of file sitkLabelOverlapMeasuresImageFilter.h.

double itk::simple::LabelOverlapMeasuresImageFilter::m_MeanOverlap

private

Definition at line 146 of file sitkLabelOverlapMeasuresImageFilter.h.

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

private

Definition at line 138 of file sitkLabelOverlapMeasuresImageFilter.h.

double itk::simple::LabelOverlapMeasuresImageFilter::m_UnionOverlap

private

Definition at line 148 of file sitkLabelOverlapMeasuresImageFilter.h.

double itk::simple::LabelOverlapMeasuresImageFilter::m_VolumeSimilarity

private

Definition at line 150 of file sitkLabelOverlapMeasuresImageFilter.h.

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

sitkLabelOverlapMeasuresImageFilter.h

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation