ITK  5.3.0
Insight Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::LabelOverlapMeasuresImageFilter< TLabelImage > Class Template Reference

#include <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 = ImageToImageFilter< TLabelImage, TLabelImage >
 
- Public Types inherited from itk::ImageToImageFilter< TLabelImage, TLabelImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TLabelImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TLabelImage >
 
- Public Types inherited from itk::ImageSource< TLabelImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TLabelImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
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 GetFalseNegativeError () const
 
RealType GetFalseNegativeError (LabelType) const
 
RealType GetFalsePositiveError () const
 
RealType GetFalsePositiveError (LabelType) const
 
MapType GetLabelSetMeasures ()
 
virtual const char * GetNameOfClass () const
 
const LabelImageTypeGetSourceImage ()
 
const LabelImageTypeGetTargetImage ()
 
RealType GetTargetOverlap (LabelType) const
 
RealType GetTotalOverlap () const
 
RealType GetVolumeSimilarity () const
 
RealType GetVolumeSimilarity (LabelType) const
 
void SetSourceImage (const LabelImageType *image)
 
void SetTargetImage (const LabelImageType *image)
 
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::ImageToImageFilter< TLabelImage, TLabelImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *input)
 
virtual void PushFrontInput (const InputImageType *input)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *input)
 
virtual void SetInput (unsigned int, const TLabelImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TLabelImage >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () 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 void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
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 ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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)
 
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::ImageToImageFilter< TLabelImage, 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::ImageToImageFilter< TLabelImage, TLabelImage >
static constexpr unsigned int InputImageDimension
 
static constexpr unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TLabelImage >
static constexpr unsigned int OutputImageDimension
 

Protected Member Functions

void AfterThreadedGenerateData () override
 
void AllocateOutputs () override
 
void BeforeThreadedGenerateData () override
 
void DynamicThreadedGenerateData (const RegionType &) override
 
void EnlargeOutputRequestedRegion (DataObject *data) override
 
 LabelOverlapMeasuresImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ThreadedGenerateData (const RegionType &, ThreadIdType) override
 
 ~LabelOverlapMeasuresImageFilter () override=default
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TLabelImage, TLabelImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
void GenerateInputRequestedRegion () override
 
 ImageToImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void VerifyInputInformation () ITKv5_CONST override
 
 ~ImageToImageFilter () override=default
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TLabelImage >
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- 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 GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () 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
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
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 () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () 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::vector< MapTypem_LabelSetMeasuresPerThread
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TLabelImage, TLabelImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Static Protected Member Functions inherited from itk::ImageSource< TLabelImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageSource< TLabelImage >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

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

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

Definition at line 45 of file itkLabelOverlapMeasuresImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TLabelImage >
using itk::LabelOverlapMeasuresImageFilter< TLabelImage >::ConstPointer = SmartPointer<const Self>

Definition at line 54 of file itkLabelOverlapMeasuresImageFilter.h.

◆ IndexType

template<typename TLabelImage >
using itk::LabelOverlapMeasuresImageFilter< TLabelImage >::IndexType = typename TLabelImage::IndexType

Definition at line 69 of file itkLabelOverlapMeasuresImageFilter.h.

◆ LabelImageConstPointer

template<typename TLabelImage >
using itk::LabelOverlapMeasuresImageFilter< TLabelImage >::LabelImageConstPointer = typename TLabelImage::ConstPointer

Definition at line 65 of file itkLabelOverlapMeasuresImageFilter.h.

◆ LabelImagePointer

template<typename TLabelImage >
using itk::LabelOverlapMeasuresImageFilter< TLabelImage >::LabelImagePointer = typename TLabelImage::Pointer

Definition at line 64 of file itkLabelOverlapMeasuresImageFilter.h.

◆ LabelImageType

template<typename TLabelImage >
using itk::LabelOverlapMeasuresImageFilter< TLabelImage >::LabelImageType = TLabelImage

Image related type alias.

Definition at line 63 of file itkLabelOverlapMeasuresImageFilter.h.

◆ LabelType

template<typename TLabelImage >
using itk::LabelOverlapMeasuresImageFilter< TLabelImage >::LabelType = typename TLabelImage::PixelType

Definition at line 71 of file itkLabelOverlapMeasuresImageFilter.h.

◆ MapConstIterator

template<typename TLabelImage >
using itk::LabelOverlapMeasuresImageFilter< TLabelImage >::MapConstIterator = typename MapType::const_iterator

Definition at line 121 of file itkLabelOverlapMeasuresImageFilter.h.

◆ MapIterator

template<typename TLabelImage >
using itk::LabelOverlapMeasuresImageFilter< TLabelImage >::MapIterator = typename MapType::iterator

Definition at line 120 of file itkLabelOverlapMeasuresImageFilter.h.

◆ MapType

template<typename TLabelImage >
using itk::LabelOverlapMeasuresImageFilter< TLabelImage >::MapType = std::unordered_map<LabelType, LabelSetMeasures>

Type of the map used to store data per label

Definition at line 119 of file itkLabelOverlapMeasuresImageFilter.h.

◆ Pointer

template<typename TLabelImage >
using itk::LabelOverlapMeasuresImageFilter< TLabelImage >::Pointer = SmartPointer<Self>

Definition at line 53 of file itkLabelOverlapMeasuresImageFilter.h.

◆ RealType

template<typename TLabelImage >
using itk::LabelOverlapMeasuresImageFilter< TLabelImage >::RealType = typename NumericTraits<LabelType>::RealType

Type to use for computations.

Definition at line 74 of file itkLabelOverlapMeasuresImageFilter.h.

◆ RegionType

template<typename TLabelImage >
using itk::LabelOverlapMeasuresImageFilter< TLabelImage >::RegionType = typename TLabelImage::RegionType

Definition at line 67 of file itkLabelOverlapMeasuresImageFilter.h.

◆ Self

template<typename TLabelImage >
using itk::LabelOverlapMeasuresImageFilter< TLabelImage >::Self = LabelOverlapMeasuresImageFilter

Standard Self type alias

Definition at line 51 of file itkLabelOverlapMeasuresImageFilter.h.

◆ SizeType

template<typename TLabelImage >
using itk::LabelOverlapMeasuresImageFilter< TLabelImage >::SizeType = typename TLabelImage::SizeType

Definition at line 68 of file itkLabelOverlapMeasuresImageFilter.h.

◆ Superclass

template<typename TLabelImage >
using itk::LabelOverlapMeasuresImageFilter< TLabelImage >::Superclass = ImageToImageFilter<TLabelImage, TLabelImage>

Definition at line 52 of file itkLabelOverlapMeasuresImageFilter.h.

Constructor & Destructor Documentation

◆ LabelOverlapMeasuresImageFilter()

template<typename TLabelImage >
itk::LabelOverlapMeasuresImageFilter< TLabelImage >::LabelOverlapMeasuresImageFilter ( )
protected

◆ ~LabelOverlapMeasuresImageFilter()

template<typename TLabelImage >
itk::LabelOverlapMeasuresImageFilter< TLabelImage >::~LabelOverlapMeasuresImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ AfterThreadedGenerateData()

template<typename TLabelImage >
void itk::LabelOverlapMeasuresImageFilter< TLabelImage >::AfterThreadedGenerateData ( )
overrideprotectedvirtual

If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TLabelImage >.

◆ AllocateOutputs()

template<typename TLabelImage >
void itk::LabelOverlapMeasuresImageFilter< TLabelImage >::AllocateOutputs ( )
overrideprotectedvirtual

Pass the input through unmodified. Do this by setting the output to the source this by setting the output to the source image in the AllocateOutputs() method.

Reimplemented from itk::ImageSource< TLabelImage >.

◆ BeforeThreadedGenerateData()

template<typename TLabelImage >
void itk::LabelOverlapMeasuresImageFilter< TLabelImage >::BeforeThreadedGenerateData ( )
overrideprotectedvirtual

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TLabelImage >.

◆ DynamicThreadedGenerateData()

template<typename TLabelImage >
void itk::LabelOverlapMeasuresImageFilter< TLabelImage >::DynamicThreadedGenerateData ( const RegionType )
inlineoverrideprotected

Definition at line 264 of file itkLabelOverlapMeasuresImageFilter.h.

◆ EnlargeOutputRequestedRegion()

template<typename TLabelImage >
void itk::LabelOverlapMeasuresImageFilter< TLabelImage >::EnlargeOutputRequestedRegion ( DataObject )
overrideprotectedvirtual

Give the process object a chance to indicate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Reimplemented from itk::ProcessObject.

◆ GetDiceCoefficient() [1/2]

template<typename TLabelImage >
RealType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetDiceCoefficient ( ) const
inline

Get the mean overlap (Dice coefficient) over all labels.

Definition at line 194 of file itkLabelOverlapMeasuresImageFilter.h.

◆ GetDiceCoefficient() [2/2]

template<typename TLabelImage >
RealType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetDiceCoefficient ( LabelType  label) const
inline

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

Definition at line 204 of file itkLabelOverlapMeasuresImageFilter.h.

◆ GetFalseNegativeError() [1/2]

template<typename TLabelImage >
RealType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetFalseNegativeError ( ) const

Get the false negative error over all labels.

◆ GetFalseNegativeError() [2/2]

template<typename TLabelImage >
RealType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetFalseNegativeError ( LabelType  ) const

Get the false negative error for the specified individual label.

◆ GetFalsePositiveError() [1/2]

template<typename TLabelImage >
RealType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetFalsePositiveError ( ) const

Get the false positive error over all labels.

◆ GetFalsePositiveError() [2/2]

template<typename TLabelImage >
RealType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetFalsePositiveError ( LabelType  ) const

Get the false positive error for the specified individual label.

◆ GetJaccardCoefficient() [1/2]

template<typename TLabelImage >
RealType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetJaccardCoefficient ( ) const
inline

Get the union overlap (Jaccard coefficient) over all labels.

Definition at line 174 of file itkLabelOverlapMeasuresImageFilter.h.

◆ GetJaccardCoefficient() [2/2]

template<typename TLabelImage >
RealType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetJaccardCoefficient ( LabelType  label) const
inline

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

Definition at line 184 of file itkLabelOverlapMeasuresImageFilter.h.

◆ GetLabelSetMeasures()

template<typename TLabelImage >
MapType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetLabelSetMeasures ( )
inline

Get the label set measures.

Definition at line 156 of file itkLabelOverlapMeasuresImageFilter.h.

◆ GetMeanOverlap() [1/2]

template<typename TLabelImage >
RealType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetMeanOverlap ( ) const

Get the mean overlap (Dice coefficient) over all labels.

◆ GetMeanOverlap() [2/2]

template<typename TLabelImage >
RealType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetMeanOverlap ( LabelType  ) const

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

◆ GetNameOfClass()

template<typename TLabelImage >
virtual const char* itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetNameOfClass ( ) const
virtual

Runtime information support.

Reimplemented from itk::ImageToImageFilter< TLabelImage, TLabelImage >.

◆ GetSourceImage()

template<typename TLabelImage >
const LabelImageType* itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetSourceImage ( )
inline

Get the source image.

Definition at line 142 of file itkLabelOverlapMeasuresImageFilter.h.

◆ GetTargetImage()

template<typename TLabelImage >
const LabelImageType* itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetTargetImage ( )
inline

Get the target image.

Definition at line 149 of file itkLabelOverlapMeasuresImageFilter.h.

◆ GetTargetOverlap()

template<typename TLabelImage >
RealType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetTargetOverlap ( LabelType  ) const

Get the target overlap for the specified individual label.

◆ GetTotalOverlap()

template<typename TLabelImage >
RealType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetTotalOverlap ( ) const

Get the total overlap over all labels.

◆ GetUnionOverlap() [1/2]

template<typename TLabelImage >
RealType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetUnionOverlap ( ) const

Get the union overlap (Jaccard coefficient) over all labels.

◆ GetUnionOverlap() [2/2]

template<typename TLabelImage >
RealType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetUnionOverlap ( LabelType  ) const

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

◆ GetVolumeSimilarity() [1/2]

template<typename TLabelImage >
RealType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetVolumeSimilarity ( ) const

Get the volume similarity over all labels.

◆ GetVolumeSimilarity() [2/2]

template<typename TLabelImage >
RealType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::GetVolumeSimilarity ( LabelType  ) const

Get the volume similarity for the specified individual label.

◆ New()

template<typename TLabelImage >
static Pointer itk::LabelOverlapMeasuresImageFilter< TLabelImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TLabelImage >
void itk::LabelOverlapMeasuresImageFilter< TLabelImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ProcessObject.

◆ SetSourceImage()

template<typename TLabelImage >
void itk::LabelOverlapMeasuresImageFilter< TLabelImage >::SetSourceImage ( const LabelImageType image)
inline

Set the source image.

Definition at line 128 of file itkLabelOverlapMeasuresImageFilter.h.

◆ SetTargetImage()

template<typename TLabelImage >
void itk::LabelOverlapMeasuresImageFilter< TLabelImage >::SetTargetImage ( const LabelImageType image)
inline

Set the target image.

Definition at line 135 of file itkLabelOverlapMeasuresImageFilter.h.

◆ ThreadedGenerateData()

template<typename TLabelImage >
void itk::LabelOverlapMeasuresImageFilter< TLabelImage >::ThreadedGenerateData ( const RegionType ,
ThreadIdType   
)
overrideprotected

Multi-thread version GenerateData.

Member Data Documentation

◆ ImageDimension

template<typename TLabelImage >
constexpr unsigned int itk::LabelOverlapMeasuresImageFilter< TLabelImage >::ImageDimension = TLabelImage::ImageDimension
staticconstexpr

Image related type alias.

Definition at line 124 of file itkLabelOverlapMeasuresImageFilter.h.

◆ m_LabelSetMeasures

template<typename TLabelImage >
MapType itk::LabelOverlapMeasuresImageFilter< TLabelImage >::m_LabelSetMeasures
private

Definition at line 275 of file itkLabelOverlapMeasuresImageFilter.h.

◆ m_LabelSetMeasuresPerThread

template<typename TLabelImage >
std::vector<MapType> itk::LabelOverlapMeasuresImageFilter< TLabelImage >::m_LabelSetMeasuresPerThread
private

Definition at line 274 of file itkLabelOverlapMeasuresImageFilter.h.


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