SimpleITK  
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::StatisticsImageFilter Class Reference

Compute min, max, variance and mean of an Image . More...

#include <sitkStatisticsImageFilter.h>

+ Inheritance diagram for itk::simple::StatisticsImageFilter:
+ Collaboration diagram for itk::simple::StatisticsImageFilter:

Detailed Description

Compute min, max, variance and mean of an Image .

StatisticsImageFilter computes the minimum, maximum, sum, sum of squares, mean, variance sigma of an image. 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.

This filter is automatically multi-threaded and can stream its input when NumberOfStreamDivisions is set to more than one. Statistics are independently computed for each streamed and threaded region then merged.

Internally a compensated summation algorithm is used for the accumulation of intensities to improve accuracy for large images.

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

Definition at line 45 of file sitkStatisticsImageFilter.h.

Public Types

using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = StatisticsImageFilter
 
- 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)
 
double GetMaximum () const
 
double GetMean () const
 
double GetMinimum () const
 
std::string GetName () const
 
double GetSigma () const
 
double GetSum () const
 
double GetVariance () const
 
 StatisticsImageFilter ()
 
std::string ToString () const
 
virtual ~StatisticsImageFilter ()
 
- 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. More...
 
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
 
virtual void SetNumberOfWorkUnits (unsigned int n)
 
virtual unsigned int GetNumberOfWorkUnits () const
 

Private Types

using MemberFunctionType = void(Self::*)(const Image *image)
 

Private Member Functions

template<class TImageType >
void ExecuteInternal (const Image *image)
 

Private Attributes

double m_Maximum {0.0}
 
double m_Mean {0.0}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
double m_Minimum {0.0}
 
double m_Sigma {0.0}
 
double m_Sum {0.0}
 
double m_Variance {0.0}
 

Friends

struct detail::MemberFunctionAddressor< 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. 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...
 
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
 
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
 
- 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::ProcessObjectGetActiveProcess ()
 
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
 
NonCopyableoperator= (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::EventObjectGetITKEventObject (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::StatisticsImageFilter::MemberFunctionType = void (Self::*)( const Image * image )
private

Setup for member function dispatching

Definition at line 123 of file sitkStatisticsImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 57 of file sitkStatisticsImageFilter.h.

◆ Self

Definition at line 47 of file sitkStatisticsImageFilter.h.

Constructor & Destructor Documentation

◆ ~StatisticsImageFilter()

virtual itk::simple::StatisticsImageFilter::~StatisticsImageFilter ( )
virtual

Destructor

◆ StatisticsImageFilter()

itk::simple::StatisticsImageFilter::StatisticsImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

void itk::simple::StatisticsImageFilter::Execute ( const Image image)

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
void itk::simple::StatisticsImageFilter::ExecuteInternal ( const Image image)
private

◆ GetMaximum()

double itk::simple::StatisticsImageFilter::GetMaximum ( ) const
inline

Return the computed Maximum.

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 73 of file sitkStatisticsImageFilter.h.

◆ GetMean()

double itk::simple::StatisticsImageFilter::GetMean ( ) const
inline

Return the computed Mean.

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 81 of file sitkStatisticsImageFilter.h.

◆ GetMinimum()

double itk::simple::StatisticsImageFilter::GetMinimum ( ) const
inline

Return the computed Minimum.

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 65 of file sitkStatisticsImageFilter.h.

◆ GetName()

std::string itk::simple::StatisticsImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 109 of file sitkStatisticsImageFilter.h.

◆ GetSigma()

double itk::simple::StatisticsImageFilter::GetSigma ( ) const
inline

Return the computed Standard Deviation.

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 89 of file sitkStatisticsImageFilter.h.

◆ GetSum()

double itk::simple::StatisticsImageFilter::GetSum ( ) const
inline

Return the compute Sum.

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

◆ GetVariance()

double itk::simple::StatisticsImageFilter::GetVariance ( ) const
inline

Return the computed Variance.

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 97 of file sitkStatisticsImageFilter.h.

◆ ToString()

std::string itk::simple::StatisticsImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 127 of file sitkStatisticsImageFilter.h.

Member Data Documentation

◆ m_Maximum

double itk::simple::StatisticsImageFilter::m_Maximum {0.0}
private

Definition at line 135 of file sitkStatisticsImageFilter.h.

◆ m_Mean

double itk::simple::StatisticsImageFilter::m_Mean {0.0}
private

Definition at line 137 of file sitkStatisticsImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::StatisticsImageFilter::m_MemberFactory
private

Definition at line 129 of file sitkStatisticsImageFilter.h.

◆ m_Minimum

double itk::simple::StatisticsImageFilter::m_Minimum {0.0}
private

Definition at line 133 of file sitkStatisticsImageFilter.h.

◆ m_Sigma

double itk::simple::StatisticsImageFilter::m_Sigma {0.0}
private

Definition at line 139 of file sitkStatisticsImageFilter.h.

◆ m_Sum

double itk::simple::StatisticsImageFilter::m_Sum {0.0}
private

Definition at line 143 of file sitkStatisticsImageFilter.h.

◆ m_Variance

double itk::simple::StatisticsImageFilter::m_Variance {0.0}
private

Definition at line 141 of file sitkStatisticsImageFilter.h.


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