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:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList

typedef LabelStatisticsImageFilter	Self

Public Types inherited from itk::simple::ImageFilter< 0 >
typedef ImageFilter	Self

Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
void	Execute (const Image &image, const Image &labelImage)

void	Execute (const Image &image, const Image &labelImage, bool useHistograms)

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 ()

double	GetSigma (int64_t label) const

double	GetSum (int64_t label) const

bool	GetUseHistograms () const

double	GetVariance (int64_t label) const

double	HasLabel (int64_t label)

	LabelStatisticsImageFilter ()

Self &	SetUseHistograms (bool UseHistograms)

std::string	ToString () const

Self &	UseHistogramsOff ()

Self &	UseHistogramsOn ()

	~LabelStatisticsImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter< 0 >
	ImageFilter ()

virtual	~ImageFilter ()=0

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

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...

virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands. More...

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

Private Types
typedef void(Self::*	MemberFunctionType) (const Image image, const Image labelImage)

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

Private Attributes
nsstd::auto_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > >	m_DualMemberFactory

itk::ProcessObject *	m_Filter

std::vector< int64_t >	m_Labels

nsstd::function< std::vector< int >int64_t)>	m_pfGetBoundingBox

nsstd::function< uint64_t(int64_t)>	m_pfGetCount

nsstd::function< double(int64_t)>	m_pfGetMaximum

nsstd::function< double(int64_t)>	m_pfGetMean

nsstd::function< double(int64_t)>	m_pfGetMedian

nsstd::function< double(int64_t)>	m_pfGetMinimum

nsstd::function< double(int64_t)>	m_pfGetSigma

nsstd::function< double(int64_t)>	m_pfGetSum

nsstd::function< double(int64_t)>	m_pfGetVariance

bool	m_UseHistograms

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 void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()

static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

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) throw ()

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()

Static Protected Member Functions inherited from itk::simple::ImageFilter< 0 >
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 TImageType >
static Image	CastITKToImage (TImageType *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)

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)

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 pipline 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.

The filter passes its intensity input through unmodified. The filter is threaded. It computes statistics in each thread then combines them in its AfterThreadedGenerate method.

Wiki Examples:

All Examples

Get statistical properties of labeled regions in an image

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

Definition at line 53 of file sitkLabelStatisticsImageFilter.h.

Member Typedef Documentation

typedef void(Self::* itk::simple::LabelStatisticsImageFilter::MemberFunctionType) (const Image *image, const Image *labelImage)

private

Setup for member function dispatching

Definition at line 193 of file sitkLabelStatisticsImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::LabelStatisticsImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 65 of file sitkLabelStatisticsImageFilter.h.

typedef LabelStatisticsImageFilter itk::simple::LabelStatisticsImageFilter::Self

Definition at line 55 of file sitkLabelStatisticsImageFilter.h.

Constructor & Destructor Documentation

itk::simple::LabelStatisticsImageFilter::LabelStatisticsImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

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

Destructor

Member Function Documentation

template<class TImageType1 , class TImageType2 >

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

private

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

Execute the filter on the input image

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

Execute the filter on the input image with the given parameters

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

inline

Return the computed bounding box 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 159 of file sitkLabelStatisticsImageFilter.h.

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 150 of file sitkLabelStatisticsImageFilter.h.

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 167 of file sitkLabelStatisticsImageFilter.h.

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 96 of file sitkLabelStatisticsImageFilter.h.

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 105 of file sitkLabelStatisticsImageFilter.h.

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 114 of file sitkLabelStatisticsImageFilter.h.

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 87 of file sitkLabelStatisticsImageFilter.h.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 170 of file sitkLabelStatisticsImageFilter.h.

uint64_t itk::simple::LabelStatisticsImageFilter::GetNumberOfLabels ( )

Return the number of labels after execution .

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 123 of file sitkLabelStatisticsImageFilter.h.

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 141 of file sitkLabelStatisticsImageFilter.h.

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

inline

Definition at line 79 of file sitkLabelStatisticsImageFilter.h.

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 132 of file sitkLabelStatisticsImageFilter.h.

double itk::simple::LabelStatisticsImageFilter::HasLabel ( int64_t label )

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

Self& itk::simple::LabelStatisticsImageFilter::SetUseHistograms ( bool UseHistograms )

inline

Definition at line 71 of file sitkLabelStatisticsImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Self& itk::simple::LabelStatisticsImageFilter::UseHistogramsOff ( )

inline

Definition at line 75 of file sitkLabelStatisticsImageFilter.h.

Self& itk::simple::LabelStatisticsImageFilter::UseHistogramsOn ( )

inline

Set the value of UseHistograms to true or false respectfully.

Definition at line 74 of file sitkLabelStatisticsImageFilter.h.

Friends And Related Function Documentation

friend struct detail::DualExecuteInternalAddressor< MemberFunctionType >

friend

Definition at line 195 of file sitkLabelStatisticsImageFilter.h.

Member Data Documentation

nsstd::auto_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > itk::simple::LabelStatisticsImageFilter::m_DualMemberFactory

private

Definition at line 199 of file sitkLabelStatisticsImageFilter.h.

itk::ProcessObject* itk::simple::LabelStatisticsImageFilter::m_Filter

private

Definition at line 226 of file sitkLabelStatisticsImageFilter.h.

std::vector<int64_t> itk::simple::LabelStatisticsImageFilter::m_Labels

private

Definition at line 223 of file sitkLabelStatisticsImageFilter.h.

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

private

Definition at line 221 of file sitkLabelStatisticsImageFilter.h.

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

private

Definition at line 219 of file sitkLabelStatisticsImageFilter.h.

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

private

Definition at line 207 of file sitkLabelStatisticsImageFilter.h.

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

private

Definition at line 209 of file sitkLabelStatisticsImageFilter.h.

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

private

Definition at line 211 of file sitkLabelStatisticsImageFilter.h.

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

private

Definition at line 205 of file sitkLabelStatisticsImageFilter.h.

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

private

Definition at line 213 of file sitkLabelStatisticsImageFilter.h.

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

private

Definition at line 217 of file sitkLabelStatisticsImageFilter.h.

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

private

Definition at line 215 of file sitkLabelStatisticsImageFilter.h.

bool itk::simple::LabelStatisticsImageFilter::m_UseHistograms

private

Definition at line 203 of file sitkLabelStatisticsImageFilter.h.

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

sitkLabelStatisticsImageFilter.h

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation