Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::StatisticsImageFilter< TInputImage > Class Template Reference

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

#include <itkStatisticsImageFilter.h>

Inheritance diagram for itk::StatisticsImageFilter< TInputImage >:

Inheritance graph
[legend]
Collaboration diagram for itk::StatisticsImageFilter< TInputImage >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef StatisticsImageFilter Self
typedef ImageToImageFilter<
TInputImage, TInputImage > 
Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef TInputImage::Pointer InputImagePointer
typedef TInputImage::RegionType RegionType
typedef TInputImage::SizeType SizeType
typedef TInputImage::IndexType IndexType
typedef TInputImage::PixelType PixelType
typedef NumericTraits< PixelType
>::RealType 
RealType
typedef DataObject::Pointer DataObjectPointer
typedef SimpleDataObjectDecorator<
RealType
RealObjectType
typedef SimpleDataObjectDecorator<
PixelType
PixelObjectType

Public Member Functions

virtual const char * GetNameOfClass () const
 itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
virtual DataObjectPointer MakeOutput (unsigned int idx)
PixelType GetMinimum () const
PixelObjectTypeGetMinimumOutput ()
const PixelObjectTypeGetMinimumOutput () const
PixelType GetMaximum () const
PixelObjectTypeGetMaximumOutput ()
const PixelObjectTypeGetMaximumOutput () const
RealType GetMean () const
RealObjectTypeGetMeanOutput ()
const RealObjectTypeGetMeanOutput () const
RealType GetSigma () const
RealObjectTypeGetSigmaOutput ()
const RealObjectTypeGetSigmaOutput () const
RealType GetVariance () const
RealObjectTypeGetVarianceOutput ()
const RealObjectTypeGetVarianceOutput () const
RealType GetSum () const
RealObjectTypeGetSumOutput ()
const RealObjectTypeGetSumOutput () const

Static Public Member Functions

Pointer New ()

Protected Member Functions

 StatisticsImageFilter ()
 ~StatisticsImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
void AllocateOutputs ()
void BeforeThreadedGenerateData ()
void AfterThreadedGenerateData ()
void ThreadedGenerateData (const RegionType &outputRegionForThread, int threadId)
void GenerateInputRequestedRegion ()
void EnlargeOutputRequestedRegion (DataObject *data)

Detailed Description

template<class TInputImage>
class itk::StatisticsImageFilter< TInputImage >

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.

Definition at line 44 of file itkStatisticsImageFilter.h.


Member Typedef Documentation

template<class TInputImage>
typedef SmartPointer<const Self> itk::StatisticsImageFilter< TInputImage >::ConstPointer
 

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

Definition at line 52 of file itkStatisticsImageFilter.h.

template<class TInputImage>
typedef DataObject::Pointer itk::StatisticsImageFilter< TInputImage >::DataObjectPointer
 

Smart Pointer type to a DataObject.

Reimplemented from itk::ImageSource< TInputImage >.

Definition at line 76 of file itkStatisticsImageFilter.h.

template<class TInputImage>
typedef TInputImage::IndexType itk::StatisticsImageFilter< TInputImage >::IndexType
 

Definition at line 65 of file itkStatisticsImageFilter.h.

template<class TInputImage>
typedef TInputImage::Pointer itk::StatisticsImageFilter< TInputImage >::InputImagePointer
 

Image related typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

Definition at line 61 of file itkStatisticsImageFilter.h.

template<class TInputImage>
typedef SimpleDataObjectDecorator<PixelType> itk::StatisticsImageFilter< TInputImage >::PixelObjectType
 

Definition at line 80 of file itkStatisticsImageFilter.h.

template<class TInputImage>
typedef TInputImage::PixelType itk::StatisticsImageFilter< TInputImage >::PixelType
 

Definition at line 66 of file itkStatisticsImageFilter.h.

Referenced by itk::StatisticsImageFilter< TInputImage >::GetMinimum().

template<class TInputImage>
typedef SmartPointer<Self> itk::StatisticsImageFilter< TInputImage >::Pointer
 

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

Definition at line 51 of file itkStatisticsImageFilter.h.

template<class TInputImage>
typedef SimpleDataObjectDecorator<RealType> itk::StatisticsImageFilter< TInputImage >::RealObjectType
 

Type of DataObjects used for scalar outputs

Definition at line 79 of file itkStatisticsImageFilter.h.

Referenced by itk::StatisticsImageFilter< TInputImage >::GetMean(), and itk::StatisticsImageFilter< TInputImage >::GetSigma().

template<class TInputImage>
typedef NumericTraits<PixelType>::RealType itk::StatisticsImageFilter< TInputImage >::RealType
 

Type to use for computations.

Definition at line 73 of file itkStatisticsImageFilter.h.

Referenced by itk::StatisticsImageFilter< TInputImage >::GetMean(), itk::StatisticsImageFilter< TInputImage >::GetSigma(), and itk::StatisticsImageFilter< TInputImage >::GetVariance().

template<class TInputImage>
typedef TInputImage::RegionType itk::StatisticsImageFilter< TInputImage >::RegionType
 

Definition at line 63 of file itkStatisticsImageFilter.h.

template<class TInputImage>
typedef StatisticsImageFilter itk::StatisticsImageFilter< TInputImage >::Self
 

Standard Self typedef

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

Definition at line 49 of file itkStatisticsImageFilter.h.

template<class TInputImage>
typedef TInputImage::SizeType itk::StatisticsImageFilter< TInputImage >::SizeType
 

Definition at line 64 of file itkStatisticsImageFilter.h.

template<class TInputImage>
typedef ImageToImageFilter<TInputImage,TInputImage> itk::StatisticsImageFilter< TInputImage >::Superclass
 

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

Definition at line 50 of file itkStatisticsImageFilter.h.


Constructor & Destructor Documentation

template<class TInputImage>
itk::StatisticsImageFilter< TInputImage >::StatisticsImageFilter  )  [protected]
 

template<class TInputImage>
itk::StatisticsImageFilter< TInputImage >::~StatisticsImageFilter  )  [inline, protected]
 

Definition at line 130 of file itkStatisticsImageFilter.h.


Member Function Documentation

template<class TInputImage>
void itk::StatisticsImageFilter< TInputImage >::AfterThreadedGenerateData  )  [protected, virtual]
 

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

Reimplemented from itk::ImageSource< TInputImage >.

template<class TInputImage>
void itk::StatisticsImageFilter< TInputImage >::AllocateOutputs  )  [protected, virtual]
 

Pass the input through unmodified. Do this by Grafting in the AllocateOutputs method.

Reimplemented from itk::ImageSource< TInputImage >.

template<class TInputImage>
void itk::StatisticsImageFilter< TInputImage >::BeforeThreadedGenerateData  )  [protected, virtual]
 

Initialize some accumulators before the threads run.

Reimplemented from itk::ImageSource< TInputImage >.

template<class TInputImage>
void itk::StatisticsImageFilter< TInputImage >::EnlargeOutputRequestedRegion DataObject data  )  [protected, virtual]
 

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Reimplemented from itk::ProcessObject.

template<class TInputImage>
void itk::StatisticsImageFilter< TInputImage >::GenerateInputRequestedRegion  )  [protected, virtual]
 

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierachy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See also:
ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

template<class TInputImage>
PixelType itk::StatisticsImageFilter< TInputImage >::GetMaximum  )  const [inline]
 

Return the computed Maximum.

Definition at line 90 of file itkStatisticsImageFilter.h.

template<class TInputImage>
const PixelObjectType* itk::StatisticsImageFilter< TInputImage >::GetMaximumOutput  )  const
 

Return the computed Maximum.

template<class TInputImage>
PixelObjectType* itk::StatisticsImageFilter< TInputImage >::GetMaximumOutput  ) 
 

Return the computed Maximum.

template<class TInputImage>
RealType itk::StatisticsImageFilter< TInputImage >::GetMean  )  const [inline]
 

Return the computed Mean.

Definition at line 97 of file itkStatisticsImageFilter.h.

References itk::StatisticsImageFilter< TInputImage >::RealObjectType, and itk::StatisticsImageFilter< TInputImage >::RealType.

template<class TInputImage>
const RealObjectType* itk::StatisticsImageFilter< TInputImage >::GetMeanOutput  )  const
 

Return the computed Mean.

template<class TInputImage>
RealObjectType* itk::StatisticsImageFilter< TInputImage >::GetMeanOutput  ) 
 

Return the computed Mean.

template<class TInputImage>
PixelType itk::StatisticsImageFilter< TInputImage >::GetMinimum  )  const [inline]
 

Return the computed Minimum.

Definition at line 83 of file itkStatisticsImageFilter.h.

References itk::StatisticsImageFilter< TInputImage >::PixelType.

template<class TInputImage>
const PixelObjectType* itk::StatisticsImageFilter< TInputImage >::GetMinimumOutput  )  const
 

Return the computed Minimum.

template<class TInputImage>
PixelObjectType* itk::StatisticsImageFilter< TInputImage >::GetMinimumOutput  ) 
 

Return the computed Minimum.

template<class TInputImage>
virtual const char* itk::StatisticsImageFilter< TInputImage >::GetNameOfClass  )  const [virtual]
 

Runtime information support.

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

template<class TInputImage>
RealType itk::StatisticsImageFilter< TInputImage >::GetSigma  )  const [inline]
 

Return the computed Standard Deviation.

Definition at line 104 of file itkStatisticsImageFilter.h.

References itk::StatisticsImageFilter< TInputImage >::RealObjectType, and itk::StatisticsImageFilter< TInputImage >::RealType.

template<class TInputImage>
const RealObjectType* itk::StatisticsImageFilter< TInputImage >::GetSigmaOutput  )  const
 

Return the computed Standard Deviation.

template<class TInputImage>
RealObjectType* itk::StatisticsImageFilter< TInputImage >::GetSigmaOutput  ) 
 

Return the computed Standard Deviation.

template<class TInputImage>
RealType itk::StatisticsImageFilter< TInputImage >::GetSum  )  const [inline]
 

Return the compute Sum.

Definition at line 118 of file itkStatisticsImageFilter.h.

template<class TInputImage>
const RealObjectType* itk::StatisticsImageFilter< TInputImage >::GetSumOutput  )  const
 

Return the compute Sum.

template<class TInputImage>
RealObjectType* itk::StatisticsImageFilter< TInputImage >::GetSumOutput  ) 
 

Return the compute Sum.

template<class TInputImage>
RealType itk::StatisticsImageFilter< TInputImage >::GetVariance void   )  const [inline]
 

Return the computed Variance.

Definition at line 111 of file itkStatisticsImageFilter.h.

References itk::StatisticsImageFilter< TInputImage >::RealType.

template<class TInputImage>
const RealObjectType* itk::StatisticsImageFilter< TInputImage >::GetVarianceOutput  )  const
 

Return the computed Variance.

template<class TInputImage>
RealObjectType* itk::StatisticsImageFilter< TInputImage >::GetVarianceOutput  ) 
 

Return the computed Variance.

template<class TInputImage>
itk::StatisticsImageFilter< TInputImage >::itkStaticConstMacro ImageDimension  ,
unsigned  int,
TInputImage::ImageDimension 
 

Image related typedefs.

template<class TInputImage>
virtual DataObjectPointer itk::StatisticsImageFilter< TInputImage >::MakeOutput unsigned int  idx  )  [virtual]
 

Make a DataObject of the correct type to be used as the specified output.

Reimplemented from itk::ImageSource< TInputImage >.

template<class TInputImage>
Pointer itk::StatisticsImageFilter< TInputImage >::New  )  [static]
 

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage>
void itk::StatisticsImageFilter< TInputImage >::PrintSelf std::ostream &  os,
Indent  indent
const [protected, virtual]
 

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::ImageToImageFilter< TInputImage, TInputImage >.

template<class TInputImage>
void itk::StatisticsImageFilter< TInputImage >::ThreadedGenerateData const RegionType outputRegionForThread,
int  threadId
[protected]
 

Multi-thread version GenerateData.


The documentation for this class was generated from the following file:
Generated at Thu May 25 02:26:24 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000