itk::LabelStatisticsImageFilter< TInputImage, TLabelImage > Class Template Reference

#include <itkLabelStatisticsImageFilter.h>

Detailed Description

template<typename TInputImage, typename TLabelImage>
class itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >

Given an intensity image and a label map, compute min, max, variance and mean of the pixels associated with each label or segment.

LabelStatisticsImageFilter computes the minimum, maximum, sum, mean, median, variance and sigma of regions of an intensity image, where the regions are defined via a label map (a second input). The label image should be integral type. The filter needs all of its input image. It behaves as a filter with an input and output. Thus it can be inserted in a pipeline with other filters and the statistics will only be recomputed if a downstream filter changes.

Optionally, the filter also computes intensity histograms on each object. If histograms are enabled, a median intensity value can also be computed, although its accuracy is limited to the bin width of the histogram. If histograms are not enabled, the median returns zero.

This filter is automatically multi-threaded and can stream its input when NumberOfStreamDivisions is set to more than

1. Statistics are independently computed for each streamed and threaded region then merged.

ITK Sphinx Examples:

• All ITK Sphinx Examples

• Statistical Properties Of Labeled Regions

Definition at line 62 of file itkLabelStatisticsImageFilter.h.

Inheritance diagram for itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >:

Collaboration diagram for itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >:

Classes
class	LabelStatistics

Public Types
using	BoundingBoxType = std::vector<IndexValueType>
using	ConstPointer = SmartPointer<const Self>
using	DataObjectPointer = DataObject::Pointer
using	HistogramPointer = typename HistogramType::Pointer
using	HistogramType = itk::Statistics::Histogram<RealType>
using	IndexType = typename TInputImage::IndexType
using	InputImagePointer = typename TInputImage::Pointer
using	LabelImagePointer = typename TLabelImage::Pointer
using	LabelImageType = TLabelImage
using	LabelIndexType = typename TLabelImage::IndexType
using	LabelPixelType = typename TLabelImage::PixelType
using	LabelRegionType = typename TLabelImage::RegionType
using	LabelSizeType = typename TLabelImage::SizeType
using	MapConstIterator = typename MapType::const_iterator
using	MapIterator = typename MapType::iterator
using	MapSizeType = IdentifierType
using	MapType = std::unordered_map<LabelPixelType, LabelStatistics>
using	PixelType = typename TInputImage::PixelType
using	Pointer = SmartPointer<Self>
using	RealObjectType = SimpleDataObjectDecorator<RealType>
using	RealType = typename NumericTraits<PixelType>::RealType
using	RegionType = typename TInputImage::RegionType
using	Self = LabelStatisticsImageFilter
using	SizeType = typename TInputImage::SizeType
using	Superclass = ImageSink<TInputImage>
using	ValidLabelValuesContainerType = std::vector<LabelPixelType>
Public Types inherited from itk::ImageSink< TInputImage >
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 = TInputImage
using	Pointer = SmartPointer<Self>
using	RegionSplitterPointer = 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	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
virtual::itk::LightObject::Pointer	CreateAnother () const
BoundingBoxType	GetBoundingBox (LabelPixelType label) const
MapSizeType	GetCount (LabelPixelType label) const
HistogramPointer	GetHistogram (LabelPixelType label) const
RealType	GetMaximum (LabelPixelType label) const
RealType	GetMean (LabelPixelType label) const
RealType	GetMedian (LabelPixelType label) const
RealType	GetMinimum (LabelPixelType label) const
virtual const char *	GetNameOfClass () const
MapSizeType	GetNumberOfLabels () const
MapSizeType	GetNumberOfObjects () const
unsigned int	GetNumberOfStreamDivisions () const override
RegionType	GetRegion (LabelPixelType label) const
RealType	GetSigma (LabelPixelType label) const
RealType	GetSum (LabelPixelType label) const
virtual bool	GetUseHistograms () const
virtual const ValidLabelValuesContainerType &	GetValidLabelValues () const
RealType	GetVariance (LabelPixelType label) const
bool	HasLabel (LabelPixelType label) const
void	SetHistogramParameters (const int numBins, RealType lowerBound, RealType upperBound)
void	SetNumberOfStreamDivisions (const unsigned int n) override
virtual void	SetUseHistograms (bool _arg)
virtual void	UseHistogramsOff ()
virtual void	UseHistogramsOn ()
	itkSetInputMacro (LabelInput, TLabelImage)
	itkGetInputMacro (LabelInput, TLabelImage)
Public Member Functions inherited from itk::ImageSink< TInputImage >
virtual const InputImageType *	GetInput () const
virtual const InputImageType *	GetInput (const DataObjectIdentifierType &key) const
virtual const InputImageType *	GetInput (unsigned int idx) const
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	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *output)
virtual const bool &	GetAbortGenerateData () const
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
NameArray	GetInputNames () const
DataObjectPointerArray	GetInputs ()
MultiThreaderBase *	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 (MultiThreaderBase *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	ReleaseDataBeforeUpdateFlagOff ()
	itkVirtualSetClampMacro (NumberOfWorkUnits, ThreadIdType, 1, ITK_MAX_THREADS)
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< TInputImage >
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 = TInputImage::ImageDimension
Static Public Attributes inherited from itk::ImageSink< TInputImage >
static constexpr unsigned int	InputImageDimension = InputImageType::ImageDimension

Protected Member Functions
void	AfterStreamedGenerateData () override
void	BeforeStreamedGenerateData () override
	LabelStatisticsImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const override
void	ThreadedStreamedGenerateData (const RegionType &) override
	~LabelStatisticsImageFilter () override=default
Protected Member Functions inherited from itk::ImageSink< TInputImage >
virtual void	AllocateOutputs ()
void	GenerateNthInputRequestedRegion (unsigned int inputRequestedRegionNumber) override
unsigned int	GetNumberOfInputRequestedRegions () override
	ImageSink ()
	itkVirtualGetConstMacro (NumberOfStreamDivisions, unsigned int)
	itkVirtualSetMacro (NumberOfStreamDivisions, unsigned int)
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 ()
virtual const SplitterType *	GetRegionSplitter () const
Protected Member Functions inherited from itk::StreamingProcessObject
void	PrintSelf (std::ostream &os, Indent indent) const override
	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	ThreaderUpdateProgressOff ()
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 Member Functions
void	MergeMap (MapType &, MapType &) const

Private Attributes
MapType	m_LabelStatistics {}
RealType	m_LowerBound {}
std::mutex	m_Mutex {}
HistogramType::SizeType	m_NumBins {}
RealType	m_UpperBound {}
bool	m_UseHistograms {}
ValidLabelValuesContainerType	m_ValidLabelValues {}

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 {}

Member Typedef Documentation

BoundingBoxType

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::BoundingBoxType = std::vector<IndexValueType>

Bounding Box-related type alias

Definition at line 107 of file itkLabelStatisticsImageFilter.h.

ConstPointer

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::ConstPointer = SmartPointer<const Self>

Definition at line 71 of file itkLabelStatisticsImageFilter.h.

DataObjectPointer

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::DataObjectPointer = DataObject::Pointer

Smart Pointer type to a DataObject.

Definition at line 101 of file itkLabelStatisticsImageFilter.h.

HistogramPointer

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::HistogramPointer = typename HistogramType::Pointer

Definition at line 111 of file itkLabelStatisticsImageFilter.h.

HistogramType

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::HistogramType = itk::Statistics::Histogram<RealType>

Histogram-related type alias

Definition at line 110 of file itkLabelStatisticsImageFilter.h.

IndexType

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::IndexType = typename TInputImage::IndexType

Definition at line 83 of file itkLabelStatisticsImageFilter.h.

InputImagePointer

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::InputImagePointer = typename TInputImage::Pointer

Image related type alias.

Definition at line 80 of file itkLabelStatisticsImageFilter.h.

LabelImagePointer

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelImagePointer = typename TLabelImage::Pointer

Definition at line 88 of file itkLabelStatisticsImageFilter.h.

LabelImageType

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelImageType = TLabelImage

Label image related type alias.

Definition at line 87 of file itkLabelStatisticsImageFilter.h.

LabelIndexType

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelIndexType = typename TLabelImage::IndexType

Definition at line 91 of file itkLabelStatisticsImageFilter.h.

LabelPixelType

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelPixelType = typename TLabelImage::PixelType

Definition at line 92 of file itkLabelStatisticsImageFilter.h.

LabelRegionType

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelRegionType = typename TLabelImage::RegionType

Definition at line 89 of file itkLabelStatisticsImageFilter.h.

LabelSizeType

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelSizeType = typename TLabelImage::SizeType

Definition at line 90 of file itkLabelStatisticsImageFilter.h.

MapConstIterator

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::MapConstIterator = typename MapType::const_iterator

Definition at line 262 of file itkLabelStatisticsImageFilter.h.

MapIterator

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::MapIterator = typename MapType::iterator

Definition at line 261 of file itkLabelStatisticsImageFilter.h.

MapSizeType

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::MapSizeType = IdentifierType

Definition at line 263 of file itkLabelStatisticsImageFilter.h.

MapType

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::MapType = std::unordered_map<LabelPixelType, LabelStatistics>

Type of the map used to store data per label

Definition at line 260 of file itkLabelStatisticsImageFilter.h.

PixelType

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::PixelType = typename TInputImage::PixelType

Definition at line 84 of file itkLabelStatisticsImageFilter.h.

Pointer

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::Pointer = SmartPointer<Self>

Definition at line 70 of file itkLabelStatisticsImageFilter.h.

RealObjectType

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::RealObjectType = SimpleDataObjectDecorator<RealType>

Type of DataObjects used for scalar outputs

Definition at line 104 of file itkLabelStatisticsImageFilter.h.

RealType

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::RealType = typename NumericTraits<PixelType>::RealType

Type to use for computations.

Definition at line 98 of file itkLabelStatisticsImageFilter.h.

RegionType

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::RegionType = typename TInputImage::RegionType

Definition at line 81 of file itkLabelStatisticsImageFilter.h.

Self

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::Self = LabelStatisticsImageFilter

Standard Self type alias

Definition at line 68 of file itkLabelStatisticsImageFilter.h.

SizeType

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::SizeType = typename TInputImage::SizeType

Definition at line 82 of file itkLabelStatisticsImageFilter.h.

Superclass

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::Superclass = ImageSink<TInputImage>

Definition at line 69 of file itkLabelStatisticsImageFilter.h.

ValidLabelValuesContainerType

template<typename TInputImage, typename TLabelImage>

using itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::ValidLabelValuesContainerType = std::vector<LabelPixelType>

Type of the container used to store valid label values

Definition at line 266 of file itkLabelStatisticsImageFilter.h.

Constructor & Destructor Documentation

LabelStatisticsImageFilter()

template<typename TInputImage, typename TLabelImage>

itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelStatisticsImageFilter ( )

protected

Referenced by GetNameOfClass().

~LabelStatisticsImageFilter()

template<typename TInputImage, typename TLabelImage>

itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::~LabelStatisticsImageFilter ( )

overrideprotecteddefault

Member Function Documentation

AfterStreamedGenerateData()

template<typename TInputImage, typename TLabelImage>

void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::AfterStreamedGenerateData ( )

overrideprotectedvirtual

Do final mean and variance computation from data accumulated in threads.

Reimplemented from itk::StreamingProcessObject.

BeforeStreamedGenerateData()

template<typename TInputImage, typename TLabelImage>

void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::BeforeStreamedGenerateData ( )

inlineoverrideprotectedvirtual

Called before the input's first requested region is set or updated.

Reimplemented from itk::ImageSink< TInputImage >.

Definition at line 379 of file itkLabelStatisticsImageFilter.h.

References itk::ImageSink< TInputImage >::AllocateOutputs(), and m_LabelStatistics.

CreateAnother()

template<typename TInputImage, typename TLabelImage>

virtual::itk::LightObject::Pointer itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

GetBoundingBox()

template<typename TInputImage, typename TLabelImage>

BoundingBoxType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetBoundingBox

(

LabelPixelType

label

)

const

Return the computed bounding box for a label. A vector of minIndex, maxIndex pairs for each axis. The intervals include the endpoints.

GetCount()

template<typename TInputImage, typename TLabelImage>

MapSizeType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetCount

(

LabelPixelType

label

)

const

Return the number of pixels for a label.

GetHistogram()

template<typename TInputImage, typename TLabelImage>

HistogramPointer itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetHistogram

(

LabelPixelType

label

)

const

Return the histogram for a label

GetMaximum()

template<typename TInputImage, typename TLabelImage>

RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetMaximum

(

LabelPixelType

label

)

const

Return the computed Maximum for a label.

GetMean()

template<typename TInputImage, typename TLabelImage>

RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetMean

(

LabelPixelType

label

)

const

Return the computed Mean for a label.

GetMedian()

template<typename TInputImage, typename TLabelImage>

RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetMedian

(

LabelPixelType

label

)

const

Return the computed Median for a label. Requires histograms to be enabled!

GetMinimum()

template<typename TInputImage, typename TLabelImage>

RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetMinimum

(

LabelPixelType

label

)

const

Return the computed Minimum for a label.

GetNameOfClass()

template<typename TInputImage, typename TLabelImage>

virtual const char * itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetNameOfClass ( ) const

virtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::ImageSink< TInputImage >.

References LabelStatisticsImageFilter().

GetNumberOfLabels()

template<typename TInputImage, typename TLabelImage>

MapSizeType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetNumberOfLabels ( ) const

inlinenodiscard

Definition at line 301 of file itkLabelStatisticsImageFilter.h.

References GetNumberOfObjects().

GetNumberOfObjects()

template<typename TInputImage, typename TLabelImage>

MapSizeType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetNumberOfObjects ( ) const

inlinenodiscard

Get the number of labels used

Definition at line 295 of file itkLabelStatisticsImageFilter.h.

References m_LabelStatistics.

Referenced by GetNumberOfLabels().

GetNumberOfStreamDivisions()

template<typename TInputImage, typename TLabelImage>

unsigned int itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetNumberOfStreamDivisions ( ) const

inlinenodiscardoverride

Definition at line 365 of file itkLabelStatisticsImageFilter.h.

GetRegion()

template<typename TInputImage, typename TLabelImage>

RegionType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetRegion

(

LabelPixelType

label

)

const

Return the computed region.

GetSigma()

template<typename TInputImage, typename TLabelImage>

RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetSigma

(

LabelPixelType

label

)

const

Return the computed Standard Deviation for a label.

GetSum()

template<typename TInputImage, typename TLabelImage>

RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetSum

(

LabelPixelType

label

)

const

Return the compute Sum for a label.

GetUseHistograms()

template<typename TInputImage, typename TLabelImage>

virtual bool itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetUseHistograms ( ) const

virtual

GetValidLabelValues()

template<typename TInputImage, typename TLabelImage>

virtual const ValidLabelValuesContainerType & itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetValidLabelValues ( ) const

inlinevirtual

Definition at line 275 of file itkLabelStatisticsImageFilter.h.

References m_ValidLabelValues.

GetVariance()

template<typename TInputImage, typename TLabelImage>

RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetVariance

(

LabelPixelType

label

)

const

Return the computed Variance for a label.

HasLabel()

template<typename TInputImage, typename TLabelImage>

bool itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::HasLabel ( LabelPixelType label ) const

inline

Does the specified label exist? Can only be called after a call a call to Update().

Definition at line 288 of file itkLabelStatisticsImageFilter.h.

References m_LabelStatistics.

itkGetInputMacro()

template<typename TInputImage, typename TLabelImage>

itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::itkGetInputMacro	(	LabelInput	,
		TLabelImage	)

Set the label image

itkSetInputMacro()

template<typename TInputImage, typename TLabelImage>

itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::itkSetInputMacro	(	LabelInput	,
		TLabelImage	)

Set the label image

MergeMap()

template<typename TInputImage, typename TLabelImage>

void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::MergeMap ( MapType & , MapType &  ) const

private

New()

template<typename TInputImage, typename TLabelImage>

static Pointer itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::New ( )

static

Method for creation through the object factory.

PrintSelf()

template<typename TInputImage, typename TLabelImage>

void itk::LabelStatisticsImageFilter< TInputImage, 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::ImageSink< TInputImage >.

SetHistogramParameters()

template<typename TInputImage, typename TLabelImage>

void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::SetHistogramParameters	(	const int	numBins,
		RealType	lowerBound,
		RealType	upperBound )

specify Histogram parameters

SetNumberOfStreamDivisions()

template<typename TInputImage, typename TLabelImage>

void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::SetNumberOfStreamDivisions ( const unsigned int n )

inlineoverride

Definition at line 360 of file itkLabelStatisticsImageFilter.h.

SetUseHistograms()

template<typename TInputImage, typename TLabelImage>

virtual void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::SetUseHistograms ( bool _arg )

virtual

ThreadedStreamedGenerateData()

template<typename TInputImage, typename TLabelImage>

void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::ThreadedStreamedGenerateData ( const RegionType & )

overrideprotected

UseHistogramsOff()

template<typename TInputImage, typename TLabelImage>

virtual void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::UseHistogramsOff ( )

virtual

UseHistogramsOn()

template<typename TInputImage, typename TLabelImage>

virtual void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::UseHistogramsOn ( )

virtual

Member Data Documentation

ImageDimension

template<typename TInputImage, typename TLabelImage>

unsigned int itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::ImageDimension = TInputImage::ImageDimension

staticconstexpr

Image related type alias.

Definition at line 95 of file itkLabelStatisticsImageFilter.h.

Referenced by itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelStatistics::LabelStatistics(), and itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelStatistics::LabelStatistics().

m_LabelStatistics

template<typename TInputImage, typename TLabelImage>

MapType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::m_LabelStatistics {}

private

Definition at line 397 of file itkLabelStatisticsImageFilter.h.

Referenced by BeforeStreamedGenerateData(), GetNumberOfObjects(), and HasLabel().

m_LowerBound

template<typename TInputImage, typename TLabelImage>

RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::m_LowerBound {}

private

Definition at line 404 of file itkLabelStatisticsImageFilter.h.

m_Mutex

template<typename TInputImage, typename TLabelImage>

std::mutex itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::m_Mutex {}

private

Definition at line 407 of file itkLabelStatisticsImageFilter.h.

m_NumBins

template<typename TInputImage, typename TLabelImage>

HistogramType::SizeType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::m_NumBins {}

private

Definition at line 402 of file itkLabelStatisticsImageFilter.h.

m_UpperBound

template<typename TInputImage, typename TLabelImage>

RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::m_UpperBound {}

private

Definition at line 405 of file itkLabelStatisticsImageFilter.h.

m_UseHistograms

template<typename TInputImage, typename TLabelImage>

bool itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::m_UseHistograms {}

private

Definition at line 400 of file itkLabelStatisticsImageFilter.h.

m_ValidLabelValues

template<typename TInputImage, typename TLabelImage>

ValidLabelValuesContainerType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::m_ValidLabelValues {}

private

Definition at line 398 of file itkLabelStatisticsImageFilter.h.

Referenced by GetValidLabelValues().

---

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

• itkLabelStatisticsImageFilter.h