itk::simple::LabelStatisticsImageFilter Class Reference

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

#include <sitkLabelStatisticsImageFilter.h>

Inheritance diagram for itk::simple::LabelStatisticsImageFilter:

Collaboration diagram for itk::simple::LabelStatisticsImageFilter:

Detailed Description

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

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

  See also

  itk::LabelStatisticsImageFilter for the Doxygen on the original ITK class.

Definition at line 53 of file sitkLabelStatisticsImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList
using	Self = LabelStatisticsImageFilter
Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter
Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
void	Execute (const Image &image, const Image &labelImage)
std::vector< int >	GetBoundingBox (int64_t label) const
uint64_t	GetCount (int64_t label) const
std::vector< int64_t >	GetLabels () const
double	GetMaximum (int64_t label) const
double	GetMean (int64_t label) const
double	GetMedian (int64_t label) const
double	GetMinimum (int64_t label) const
std::string	GetName () const
uint64_t	GetNumberOfLabels ()
std::vector< unsigned int >	GetRegion (int64_t label) const
double	GetSigma (int64_t label) const
double	GetSum (int64_t label) const
bool	GetUseHistograms () const
double	GetVariance (int64_t label) const
bool	HasLabel (int64_t label)
	LabelStatisticsImageFilter ()
void	SetUseHistograms (bool UseHistograms)
std::string	ToString () const
void	UseHistogramsOff ()
void	UseHistogramsOn ()
virtual	~LabelStatisticsImageFilter ()
Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()
virtual	~ImageFilter ()=0
Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()
virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event.
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event.
virtual float	GetProgress () const
	An Active Measurement of the progress of execution.
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event.
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands.
virtual	~ProcessObject ()
virtual void	DebugOn ()
virtual void	DebugOff ()
virtual bool	GetDebug () const
virtual void	SetDebug (bool debugFlag)
virtual void	SetNumberOfThreads (unsigned int n)
virtual unsigned int	GetNumberOfThreads () const
virtual void	SetNumberOfWorkUnits (unsigned int n)
virtual unsigned int	GetNumberOfWorkUnits () const

Private Types
using	MemberFunctionType

Private Member Functions
template<class TImageType1, class TImageType2>
void	DualExecuteInternal (const Image *image, const Image *labelImage)

Static Private Member Functions
static const detail::DualMemberFunctionFactory< MemberFunctionType > &	GetMemberFunctionFactory ()

Private Attributes
std::unique_ptr< itk::ProcessObject, ProcessObjectDeleter >	m_Filter {nullptr}
std::vector< int64_t >	m_Labels { std::vector<int64_t>() }
std::function< std::vector< int >(int64_t)>	m_pfGetBoundingBox
std::function< uint64_t(int64_t)>	m_pfGetCount
std::function< double(int64_t)>	m_pfGetMaximum
std::function< double(int64_t)>	m_pfGetMean
std::function< double(int64_t)>	m_pfGetMedian
std::function< double(int64_t)>	m_pfGetMinimum
std::function< std::vector< unsigned int >(int64_t)>	m_pfGetRegion
std::function< double(int64_t)>	m_pfGetSigma
std::function< double(int64_t)>	m_pfGetSum
std::function< double(int64_t)>	m_pfGetVariance
bool	m_UseHistograms { true }

Friends
struct	detail::DualExecuteInternalAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()
static void	GlobalDefaultDebugOff ()
static void	GlobalDefaultDebugOn ()
static void	SetGlobalDefaultDebug (bool debugFlag)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces.
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces.
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces.
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces.
static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.
static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.
Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)
virtual itk::ProcessObject *	GetActiveProcess ()
virtual void	OnActiveProcessDelete ()
virtual void	onCommandDelete (const itk::simple::Command *cmd) noexcept
virtual void	PreUpdate (itk::ProcessObject *p)
virtual void	RemoveITKObserver (EventCommand &e)
Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default
	NonCopyable (const NonCopyable &)=delete
NonCopyable &	operator= (const NonCopyable &)=delete
Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType>
static void	FixNonZeroIndex (TImageType *img)
Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType>
static TImageType::ConstPointer	CastImageToITK (const Image &img)
template<class TPixelType, unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)
template<class TImageType>
static Image	CastITKToImage (TImageType *img)
static const itk::EventObject &	GetITKEventObject (EventEnum e)
template<typename T>
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)
static std::ostream &	ToStringHelper (std::ostream &os, const char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Member Typedef Documentation

MemberFunctionType

using itk::simple::LabelStatisticsImageFilter::MemberFunctionType

private

Initial value:

 void (Self::*)(const Image *
    image, const Image *
    labelImage)

Setup for member function dispatching

Definition at line 206 of file sitkLabelStatisticsImageFilter.h.

PixelIDTypeList

using itk::simple::LabelStatisticsImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 65 of file sitkLabelStatisticsImageFilter.h.

Self

using itk::simple::LabelStatisticsImageFilter::Self = LabelStatisticsImageFilter

Definition at line 55 of file sitkLabelStatisticsImageFilter.h.

Constructor & Destructor Documentation

~LabelStatisticsImageFilter()

virtual itk::simple::LabelStatisticsImageFilter::~LabelStatisticsImageFilter ( )

virtual

Destructor

LabelStatisticsImageFilter()

itk::simple::LabelStatisticsImageFilter::LabelStatisticsImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

DualExecuteInternal()

template<class TImageType1, class TImageType2>

void itk::simple::LabelStatisticsImageFilter::DualExecuteInternal ( const Image * image, const Image * labelImage )

private

Execute()

void itk::simple::LabelStatisticsImageFilter::Execute	(	const Image &	image,
		const Image &	labelImage )

Execute the filter on the input image

GetBoundingBox()

std::vector< int > itk::simple::LabelStatisticsImageFilter::GetBoundingBox ( int64_t label ) const

inline

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

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 166 of file sitkLabelStatisticsImageFilter.h.

References m_pfGetBoundingBox.

GetCount()

uint64_t itk::simple::LabelStatisticsImageFilter::GetCount ( int64_t label ) const

inline

Return the number of pixels for a label.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 157 of file sitkLabelStatisticsImageFilter.h.

References m_pfGetCount.

GetLabels()

std::vector< int64_t > itk::simple::LabelStatisticsImageFilter::GetLabels ( ) const

inline

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 182 of file sitkLabelStatisticsImageFilter.h.

References m_Labels.

GetMaximum()

double itk::simple::LabelStatisticsImageFilter::GetMaximum ( int64_t label ) const

inline

Return the computed Maximum for a label.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 103 of file sitkLabelStatisticsImageFilter.h.

References m_pfGetMaximum.

GetMean()

double itk::simple::LabelStatisticsImageFilter::GetMean ( int64_t label ) const

inline

Return the computed Mean for a label.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 112 of file sitkLabelStatisticsImageFilter.h.

References m_pfGetMean.

GetMedian()

double itk::simple::LabelStatisticsImageFilter::GetMedian ( int64_t label ) const

inline

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

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 121 of file sitkLabelStatisticsImageFilter.h.

References m_pfGetMedian.

GetMemberFunctionFactory()

static const detail::DualMemberFunctionFactory< MemberFunctionType > & itk::simple::LabelStatisticsImageFilter::GetMemberFunctionFactory ( )

staticprivate

GetMinimum()

double itk::simple::LabelStatisticsImageFilter::GetMinimum ( int64_t label ) const

inline

Return the computed Minimum for a label.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 94 of file sitkLabelStatisticsImageFilter.h.

References m_pfGetMinimum.

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 185 of file sitkLabelStatisticsImageFilter.h.

GetNumberOfLabels()

uint64_t itk::simple::LabelStatisticsImageFilter::GetNumberOfLabels

(

)

Return the number of labels after execution .

Referenced by detail::DualExecuteInternalAddressor< MemberFunctionType >.

GetRegion()

std::vector< unsigned int > itk::simple::LabelStatisticsImageFilter::GetRegion ( int64_t label ) const

inline

Return the computed region.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 175 of file sitkLabelStatisticsImageFilter.h.

References m_pfGetRegion.

GetSigma()

double itk::simple::LabelStatisticsImageFilter::GetSigma ( int64_t label ) const

inline

Return the computed Standard Deviation for a label.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 130 of file sitkLabelStatisticsImageFilter.h.

References m_pfGetSigma.

GetSum()

double itk::simple::LabelStatisticsImageFilter::GetSum ( int64_t label ) const

inline

Return the compute Sum for a label.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 148 of file sitkLabelStatisticsImageFilter.h.

References m_pfGetSum.

GetUseHistograms()

bool itk::simple::LabelStatisticsImageFilter::GetUseHistograms ( ) const

inline

Definition at line 84 of file sitkLabelStatisticsImageFilter.h.

References m_UseHistograms.

GetVariance()

double itk::simple::LabelStatisticsImageFilter::GetVariance ( int64_t label ) const

inline

Return the computed Variance for a label.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 139 of file sitkLabelStatisticsImageFilter.h.

References m_pfGetVariance.

HasLabel()

bool itk::simple::LabelStatisticsImageFilter::HasLabel

(

int64_t

label

)

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

SetUseHistograms()

void itk::simple::LabelStatisticsImageFilter::SetUseHistograms ( bool UseHistograms )

inline

Definition at line 73 of file sitkLabelStatisticsImageFilter.h.

References m_UseHistograms.

Referenced by UseHistogramsOff(), and UseHistogramsOn().

ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

UseHistogramsOff()

void itk::simple::LabelStatisticsImageFilter::UseHistogramsOff ( )

inline

Definition at line 80 of file sitkLabelStatisticsImageFilter.h.

References SetUseHistograms().

UseHistogramsOn()

void itk::simple::LabelStatisticsImageFilter::UseHistogramsOn ( )

inline

Set the value of UseHistograms to true or false respectfully.

Definition at line 78 of file sitkLabelStatisticsImageFilter.h.

References SetUseHistograms().

Friends And Related Symbol Documentation

detail::DualExecuteInternalAddressor< MemberFunctionType >

friend struct detail::DualExecuteInternalAddressor< MemberFunctionType >

friend

Definition at line 199 of file sitkLabelStatisticsImageFilter.h.

References GetNumberOfLabels().

Member Data Documentation

m_Filter

std::unique_ptr<itk::ProcessObject, ProcessObjectDeleter> itk::simple::LabelStatisticsImageFilter::m_Filter {nullptr}

private

Definition at line 238 of file sitkLabelStatisticsImageFilter.h.

m_Labels

std::vector<int64_t> itk::simple::LabelStatisticsImageFilter::m_Labels { std::vector<int64_t>() }

private

Definition at line 234 of file sitkLabelStatisticsImageFilter.h.

Referenced by GetLabels().

m_pfGetBoundingBox

std::function<std::vector<int>(int64_t)> itk::simple::LabelStatisticsImageFilter::m_pfGetBoundingBox

private

Definition at line 232 of file sitkLabelStatisticsImageFilter.h.

Referenced by GetBoundingBox().

m_pfGetCount

std::function<uint64_t(int64_t)> itk::simple::LabelStatisticsImageFilter::m_pfGetCount

private

Definition at line 231 of file sitkLabelStatisticsImageFilter.h.

Referenced by GetCount().

m_pfGetMaximum

std::function<double(int64_t)> itk::simple::LabelStatisticsImageFilter::m_pfGetMaximum

private

Definition at line 225 of file sitkLabelStatisticsImageFilter.h.

Referenced by GetMaximum().

m_pfGetMean

std::function<double(int64_t)> itk::simple::LabelStatisticsImageFilter::m_pfGetMean

private

Definition at line 226 of file sitkLabelStatisticsImageFilter.h.

Referenced by GetMean().

m_pfGetMedian

std::function<double(int64_t)> itk::simple::LabelStatisticsImageFilter::m_pfGetMedian

private

Definition at line 227 of file sitkLabelStatisticsImageFilter.h.

Referenced by GetMedian().

m_pfGetMinimum

std::function<double(int64_t)> itk::simple::LabelStatisticsImageFilter::m_pfGetMinimum

private

Definition at line 224 of file sitkLabelStatisticsImageFilter.h.

Referenced by GetMinimum().

m_pfGetRegion

std::function<std::vector<unsigned int>(int64_t)> itk::simple::LabelStatisticsImageFilter::m_pfGetRegion

private

Definition at line 233 of file sitkLabelStatisticsImageFilter.h.

Referenced by GetRegion().

m_pfGetSigma

std::function<double(int64_t)> itk::simple::LabelStatisticsImageFilter::m_pfGetSigma

private

Definition at line 228 of file sitkLabelStatisticsImageFilter.h.

Referenced by GetSigma().

m_pfGetSum

std::function<double(int64_t)> itk::simple::LabelStatisticsImageFilter::m_pfGetSum

private

Definition at line 230 of file sitkLabelStatisticsImageFilter.h.

Referenced by GetSum().

m_pfGetVariance

std::function<double(int64_t)> itk::simple::LabelStatisticsImageFilter::m_pfGetVariance

private

Definition at line 229 of file sitkLabelStatisticsImageFilter.h.

Referenced by GetVariance().

m_UseHistograms

bool itk::simple::LabelStatisticsImageFilter::m_UseHistograms { true }

private

Definition at line 220 of file sitkLabelStatisticsImageFilter.h.

Referenced by GetUseHistograms(), and SetUseHistograms().

---

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

• sitkLabelStatisticsImageFilter.h