#include <itkLabelOverlapMeasuresImageFilter.h>

Detailed Description

template<typename TLabelImage>
class itk::LabelOverlapMeasuresImageFilter< TLabelImage >

Computes overlap measures between the 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://doi.org/10.54294/1vixgg

Author: Nicholas J. Tustison

See also: LabelOverlapMeasuresImageFilter

Definition at line 45 of file itkLabelOverlapMeasuresImageFilter.h.

Inheritance diagram for itk::LabelOverlapMeasuresImageFilter< TLabelImage >:

Collaboration diagram for itk::LabelOverlapMeasuresImageFilter< TLabelImage >:

Classes
class	LabelSetMeasures

Public Types
using	ConstPointer = SmartPointer< const Self >

using	IndexType = typename TLabelImage::IndexType

using	LabelImageConstPointer = typename TLabelImage::ConstPointer

using	LabelImagePointer = typename TLabelImage::Pointer

using	LabelImageType = TLabelImage

using	LabelType = typename TLabelImage::PixelType

using	MapConstIterator = typename MapType::const_iterator

using	MapIterator = typename MapType::iterator

using	MapType = std::unordered_map< LabelType, LabelSetMeasures >

using	Pointer = SmartPointer< Self >

using	RealType = typename NumericTraits< LabelType >::RealType

using	RegionType = typename TLabelImage::RegionType

using	Self = LabelOverlapMeasuresImageFilter

using	SizeType = typename TLabelImage::SizeType

using	Superclass = ImageSink< TLabelImage >

Public Types inherited from itk::ImageSink< TLabelImage >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectPointer = DataObject::Pointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TLabelImage

using	Pointer = SmartPointer< Self >

using	RegionSplitterPointer = typename SplitterType::Pointer

using	Self = ImageSink

using	SplitterType = ImageRegionSplitterBase

using	Superclass = StreamingProcessObject

Public Types inherited from itk::StreamingProcessObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = StreamingProcessObject

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
RealType	GetFalseDiscoveryRate () const

RealType	GetFalseDiscoveryRate (LabelType) const

RealType	GetFalseNegativeError () const

RealType	GetFalseNegativeError (LabelType) const

RealType	GetFalsePositiveError () const

RealType	GetFalsePositiveError (LabelType) const

MapType	GetLabelSetMeasures ()

const char *	GetNameOfClass () const override

RealType	GetTargetOverlap (LabelType) const

RealType	GetTotalOverlap () const

RealType	GetVolumeSimilarity () const

RealType	GetVolumeSimilarity (LabelType) const


virtual void	SetTargetImage (const LabelImageType *input)

virtual const LabelImageType *	GetTargetImage () const

virtual void	SetSourceImage (const LabelImageType *input)

virtual const LabelImageType *	GetSourceImage () const


RealType	GetUnionOverlap () const

RealType	GetJaccardCoefficient () const


RealType	GetUnionOverlap (LabelType) const

RealType	GetJaccardCoefficient (LabelType label) const


RealType	GetMeanOverlap () const

RealType	GetDiceCoefficient () const


RealType	GetMeanOverlap (LabelType) const

RealType	GetDiceCoefficient (LabelType label) const

Public Member Functions inherited from itk::ImageSink< TLabelImage >
virtual const InputImageType *	GetInput () const

virtual const InputImageType *	GetInput (const DataObjectIdentifierType &key) const

virtual const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

virtual void	SetInput (const InputImageType *input)

void	Update () override

void	UpdateLargestPossibleRegion () override

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::StreamingProcessObject
void	GenerateData () override

virtual int	GetCurrentRequestNumber () const

void	PropagateRequestedRegion (DataObject *output) override

void	ResetPipeline () override

void	UpdateOutputData (DataObject *output) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageSink< TLabelImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TLabelImage::ImageDimension

Static Public Attributes inherited from itk::ImageSink< TLabelImage >
static constexpr unsigned int	InputImageDimension

Protected Types
using	PrintType = typename NumericTraits< LabelType >::PrintType

Protected Member Functions
void	BeforeStreamedGenerateData () override

	LabelOverlapMeasuresImageFilter ()

void	MergeMap (MapType &m1, MapType &m2) const

void	PrintSelf (std::ostream &os, Indent indent) const override

void	ThreadedStreamedGenerateData (const RegionType &) override

	~LabelOverlapMeasuresImageFilter () override=default

Protected Member Functions inherited from itk::ImageSink< TLabelImage >
virtual void	AllocateOutputs ()

void	BeforeStreamedGenerateData () override

void	GenerateNthInputRequestedRegion (unsigned int inputRequestedRegionNumber) override

unsigned int	GetNumberOfInputRequestedRegions () override

virtual unsigned int	GetNumberOfStreamDivisions () const

	ImageSink ()

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetNumberOfStreamDivisions (unsigned int _arg)

void	StreamedGenerateData (unsigned int inputRequestedRegionNumber) override

virtual void	ThreadedStreamedGenerateData (const InputImageRegionType &inputRegionForChunk)=0

void	VerifyInputInformation () const override

	~ImageSink () override=default

virtual void	SetRegionSplitter (SplitterType *_arg)

virtual SplitterType *	GetModifiableRegionSplitter ()

Protected Member Functions inherited from itk::StreamingProcessObject
virtual void	AfterStreamedGenerateData ()

	StreamingProcessObject ()

	~StreamingProcessObject () override

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
MapType	m_LabelSetMeasures {}

std::mutex	m_Mutex {}

Additional Inherited Members
Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}