SimpleITK  1.3.0.dev245
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:

Public Types

typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef StatisticsImageFilter 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)
 
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< 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)
 

Private Member Functions

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

Private Attributes

double m_Maximum
 
double m_Mean
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
double m_Minimum
 
double m_Sigma
 
double m_Sum
 
double m_Variance
 

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 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::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT
 
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::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)
 

Detailed Description

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

StatisticsImageFilter computes the minimum, maximum, sum, 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 pipline with other filters and the statistics will only be recomputed if a downstream filter changes.

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

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

Definition at line 44 of file sitkStatisticsImageFilter.h.

Member Typedef Documentation

typedef void(Self::* itk::simple::StatisticsImageFilter::MemberFunctionType) (const Image *image)
private

Setup for member function dispatching

Definition at line 122 of file sitkStatisticsImageFilter.h.

Define the pixels types supported by this filter

Definition at line 56 of file sitkStatisticsImageFilter.h.

Definition at line 46 of file sitkStatisticsImageFilter.h.

Constructor & Destructor Documentation

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

Destructor

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

template<class TImageType >
void itk::simple::StatisticsImageFilter::ExecuteInternal ( const Image image)
private
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.

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.

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.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 108 of file sitkStatisticsImageFilter.h.

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.

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.

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.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 126 of file sitkStatisticsImageFilter.h.

Member Data Documentation

double itk::simple::StatisticsImageFilter::m_Maximum
private

Definition at line 134 of file sitkStatisticsImageFilter.h.

double itk::simple::StatisticsImageFilter::m_Mean
private

Definition at line 136 of file sitkStatisticsImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::StatisticsImageFilter::m_MemberFactory
private

Definition at line 128 of file sitkStatisticsImageFilter.h.

double itk::simple::StatisticsImageFilter::m_Minimum
private

Definition at line 132 of file sitkStatisticsImageFilter.h.

double itk::simple::StatisticsImageFilter::m_Sigma
private

Definition at line 138 of file sitkStatisticsImageFilter.h.

double itk::simple::StatisticsImageFilter::m_Sum
private

Definition at line 142 of file sitkStatisticsImageFilter.h.

double itk::simple::StatisticsImageFilter::m_Variance
private

Definition at line 140 of file sitkStatisticsImageFilter.h.


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