open_iA  2019.12
A tool for the visual analysis and processing of volumetric datasets, with a focus on industrial computed tomography.
Classes | Public Types | Public Member Functions | Protected Member Functions | List of all members
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage > Class Template Reference

Computes overlap measures between the set same set of labels of pixels of two images. Background is assumed to be 0. Based on LabelOverlapMeasuresImageFilter. In addition, it filters out certain labels for the result. More...

#include <iAMaskingLabelOverlapMeasuresImageFilter.h>

Inheritance diagram for iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >:
Collaboration diagram for iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >:

Classes

class  LabelSetMeasures
 Metrics stored per label. More...
 

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef TLabelImage::IndexType IndexType
 
typedef TLabelImage::ConstPointer LabelImageConstPointer
 
typedef TLabelImage::Pointer LabelImagePointer
 
typedef TLabelImage LabelImageType
 Image related typedefs. More...
 
typedef TLabelImage::PixelType LabelType
 
typedef MapType::const_iterator MapConstIterator
 
typedef MapType::iterator MapIterator
 
typedef itksys::hash_map< LabelType, LabelSetMeasures > MapType
 Type of the map used to store data per label. More...
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::NumericTraits< LabelType >::RealType RealType
 Type to use for computations. More...
 
typedef TLabelImage::RegionType RegionType
 
typedef iAMaskingLabelOverlapMeasuresImageFilter Self
 Standard Self typedef. More...
 
typedef TLabelImage::SizeType SizeType
 
typedef itk::ImageToImageFilter< TLabelImage, TLabelImage > Superclass
 

Public Member Functions

RealType GetDiceCoefficient () const
 
RealType GetDiceCoefficient (LabelType label) const
 
RealType GetFalseNegativeError () const
 
RealType GetFalseNegativeError (LabelType) const
 
RealType GetFalsePositiveError () const
 
RealType GetFalsePositiveError (LabelType) const
 
RealType GetJaccardCoefficient () const
 alternative names More...
 
RealType GetJaccardCoefficient (LabelType label) const
 
MapType GetLabelSetMeasures ()
 Get the label set measures. More...
 
RealType GetMeanOverlap () const
 
RealType GetMeanOverlap (LabelType) const
 
const LabelImageType * GetSourceImage (void)
 Get the source image. More...
 
const LabelImageType * GetTargetImage (void)
 Get the target image. More...
 
RealType GetTargetOverlap (LabelType) const
 measures over individual labels More...
 
RealType GetTotalOverlap () const
 tric overlap measures More...
 
RealType GetUnionOverlap () const
 
RealType GetUnionOverlap (LabelType) const
 
RealType GetVolumeSimilarity () const
 
RealType GetVolumeSimilarity (LabelType) const
 
const std::set< size_t > & IgnoredIndices ()
 
 itkNewMacro (Self)
 Method for creation through the object factory. More...
 
 itkStaticConstMacro (ImageDimension, unsigned int, TLabelImage::ImageDimension)
 Image related typedefs. More...
 
 itkTypeMacro (iAMaskingLabelOverlapMeasuresImageFilter, ImageToImageFilter)
 Runtime information support. More...
 
void SetIgnoredIndices (std::set< size_t > const &v)
 
void SetIgnoredLabel (LabelType label)
 
void SetSourceImage (const LabelImageType *image)
 Set the source image. More...
 
void SetTargetImage (const LabelImageType *image)
 Set the target image. More...
 

Protected Member Functions

void AfterThreadedGenerateData () override
 
void AllocateOutputs () override
 Pass the input through unmodified. More...
 
void BeforeThreadedGenerateData () override
 
void EnlargeOutputRequestedRegion (itk::DataObject *data) override
 
 iAMaskingLabelOverlapMeasuresImageFilter ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void ThreadedGenerateData (const RegionType &, itk::ThreadIdType) override
 Multi-thread version GenerateData. More...
 
 ~iAMaskingLabelOverlapMeasuresImageFilter ()
 

Detailed Description

template<typename TLabelImage>
class iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >

Computes overlap measures between the set same set of labels of pixels of two images. Background is assumed to be 0. Based on LabelOverlapMeasuresImageFilter. In addition, it filters out certain labels for the result.

Author
Nicholas J. Tustison
See also
iAMaskingLabelOverlapMeasuresImageFilter

Member Typedef Documentation

◆ ConstPointer

template<typename TLabelImage>
typedef itk::SmartPointer<const Self> iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::ConstPointer

◆ IndexType

template<typename TLabelImage>
typedef TLabelImage::IndexType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::IndexType

◆ LabelImageConstPointer

template<typename TLabelImage>
typedef TLabelImage::ConstPointer iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::LabelImageConstPointer

◆ LabelImagePointer

template<typename TLabelImage>
typedef TLabelImage::Pointer iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::LabelImagePointer

◆ LabelImageType

template<typename TLabelImage>
typedef TLabelImage iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::LabelImageType

Image related typedefs.

◆ LabelType

template<typename TLabelImage>
typedef TLabelImage::PixelType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::LabelType

◆ MapConstIterator

template<typename TLabelImage>
typedef MapType::const_iterator iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::MapConstIterator

◆ MapIterator

template<typename TLabelImage>
typedef MapType::iterator iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::MapIterator

◆ MapType

template<typename TLabelImage>
typedef itksys::hash_map<LabelType, LabelSetMeasures> iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::MapType

Type of the map used to store data per label.

◆ Pointer

template<typename TLabelImage>
typedef itk::SmartPointer<Self> iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::Pointer

◆ RealType

template<typename TLabelImage>
typedef itk::NumericTraits<LabelType>::RealType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::RealType

Type to use for computations.

◆ RegionType

template<typename TLabelImage>
typedef TLabelImage::RegionType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::RegionType

◆ Self

template<typename TLabelImage>
typedef iAMaskingLabelOverlapMeasuresImageFilter iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::Self

Standard Self typedef.

◆ SizeType

template<typename TLabelImage>
typedef TLabelImage::SizeType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::SizeType

◆ Superclass

template<typename TLabelImage>
typedef itk::ImageToImageFilter<TLabelImage, TLabelImage> iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::Superclass

Constructor & Destructor Documentation

◆ iAMaskingLabelOverlapMeasuresImageFilter()

template<typename TLabelImage >
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::iAMaskingLabelOverlapMeasuresImageFilter ( )
protected

◆ ~iAMaskingLabelOverlapMeasuresImageFilter()

template<typename TLabelImage>
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::~iAMaskingLabelOverlapMeasuresImageFilter ( )
inlineprotected

Member Function Documentation

◆ AfterThreadedGenerateData()

template<typename TLabelImage >
void iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::AfterThreadedGenerateData ( )
overrideprotected

◆ AllocateOutputs()

template<typename TLabelImage >
void iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::AllocateOutputs ( )
overrideprotected

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.

◆ BeforeThreadedGenerateData()

template<typename TLabelImage >
void iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::BeforeThreadedGenerateData ( )
overrideprotected

◆ EnlargeOutputRequestedRegion()

template<typename TLabelImage >
void iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::EnlargeOutputRequestedRegion ( itk::DataObject *  data)
overrideprotected

◆ GetDiceCoefficient() [1/2]

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

◆ GetDiceCoefficient() [2/2]

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

◆ GetFalseNegativeError() [1/2]

template<typename TLabelImage >
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::RealType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::GetFalseNegativeError ( ) const

◆ GetFalseNegativeError() [2/2]

template<typename TLabelImage >
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::RealType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::GetFalseNegativeError ( LabelType  label) const

◆ GetFalsePositiveError() [1/2]

template<typename TLabelImage >
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::RealType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::GetFalsePositiveError ( ) const

◆ GetFalsePositiveError() [2/2]

template<typename TLabelImage >
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::RealType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::GetFalsePositiveError ( LabelType  label) const

◆ GetJaccardCoefficient() [1/2]

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

alternative names

◆ GetJaccardCoefficient() [2/2]

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

◆ GetLabelSetMeasures()

template<typename TLabelImage>
MapType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::GetLabelSetMeasures ( )
inline

Get the label set measures.

◆ GetMeanOverlap() [1/2]

template<typename TLabelImage >
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::RealType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::GetMeanOverlap ( ) const

◆ GetMeanOverlap() [2/2]

template<typename TLabelImage >
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::RealType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::GetMeanOverlap ( LabelType  label) const

◆ GetSourceImage()

template<typename TLabelImage>
const LabelImageType* iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::GetSourceImage ( void  )
inline

Get the source image.

◆ GetTargetImage()

template<typename TLabelImage>
const LabelImageType* iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::GetTargetImage ( void  )
inline

Get the target image.

◆ GetTargetOverlap()

template<typename TLabelImage >
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::RealType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::GetTargetOverlap ( LabelType  label) const

measures over individual labels

◆ GetTotalOverlap()

template<typename TLabelImage >
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::RealType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::GetTotalOverlap ( ) const

tric overlap measures

measures

measures over all labels

◆ GetUnionOverlap() [1/2]

template<typename TLabelImage >
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::RealType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::GetUnionOverlap ( ) const

◆ GetUnionOverlap() [2/2]

template<typename TLabelImage >
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::RealType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::GetUnionOverlap ( LabelType  label) const

◆ GetVolumeSimilarity() [1/2]

template<typename TLabelImage >
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::RealType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::GetVolumeSimilarity ( ) const

◆ GetVolumeSimilarity() [2/2]

template<typename TLabelImage >
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::RealType iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::GetVolumeSimilarity ( LabelType  label) const

◆ IgnoredIndices()

template<typename TLabelImage>
const std::set<size_t>& iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::IgnoredIndices ( )
inline

◆ itkNewMacro()

template<typename TLabelImage>
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::itkNewMacro ( Self  )

Method for creation through the object factory.

◆ itkStaticConstMacro()

template<typename TLabelImage>
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::itkStaticConstMacro ( ImageDimension  ,
unsigned int  ,
TLabelImage::ImageDimension   
)

Image related typedefs.

◆ itkTypeMacro()

template<typename TLabelImage>
iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::itkTypeMacro ( iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >  ,
ImageToImageFilter   
)

Runtime information support.

◆ PrintSelf()

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

◆ SetIgnoredIndices()

template<typename TLabelImage>
void iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::SetIgnoredIndices ( std::set< size_t > const &  v)
inline

◆ SetIgnoredLabel()

template<typename TLabelImage>
void iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::SetIgnoredLabel ( LabelType  label)
inline

◆ SetSourceImage()

template<typename TLabelImage>
void iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::SetSourceImage ( const LabelImageType *  image)
inline

Set the source image.

◆ SetTargetImage()

template<typename TLabelImage>
void iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::SetTargetImage ( const LabelImageType *  image)
inline

Set the target image.

◆ ThreadedGenerateData()

template<typename TLabelImage >
void iAMaskingLabelOverlapMeasuresImageFilter< TLabelImage >::ThreadedGenerateData ( const RegionType &  outputRegionForThread,
itk::ThreadIdType  threadId 
)
overrideprotected

Multi-thread version GenerateData.

The documentation for this class was generated from the following files:
Generated on Tue Dec 31 2019 00:11:52 for open_iA by   doxygen 1.8.16