itk::StatisticsImageFilterWithMask< TInputImage > Class Template Reference

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

#include <itkStatisticsImageFilterWithMask.h>

Inheritance diagram for itk::StatisticsImageFilterWithMask< TInputImage >:

Public Types
typedef StatisticsImageFilterWithMask	Self
typedef ImageToImageFilter< TInputImage, TInputImage >	Superclass
typedef SmartPointer< Self >	Pointer
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 TInputImage::PointType	PointType
typedef NumericTraits< PixelType >::RealType	RealType
typedef DataObject::Pointer	DataObjectPointer
typedef SimpleDataObjectDecorator< RealType >	RealObjectType
typedef SimpleDataObjectDecorator< PixelType >	PixelObjectType
typedef SpatialObject< TInputImage::ImageDimension >	ImageMaskType
typedef ImageMaskType::Pointer	ImageMaskPointer

Public Member Functions
	itkNewMacro (Self)
	itkTypeMacro (StatisticsImageFilterWithMask, ImageToImageFilter)
	itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
	itkSetObjectMacro (ImageMask, ImageMaskType)
	itkGetConstObjectMacro (ImageMask, ImageMaskType)
PixelType	GetMinimum () const
PixelObjectType *	GetMinimumOutput ()
const PixelObjectType *	GetMinimumOutput () const
PixelType	GetMaximum () const
PixelObjectType *	GetMaximumOutput ()
const PixelObjectType *	GetMaximumOutput () const
RealType	GetMean () const
RealObjectType *	GetMeanOutput ()
const RealObjectType *	GetMeanOutput () const
RealType	GetSigma () const
RealObjectType *	GetSigmaOutput ()
const RealObjectType *	GetSigmaOutput () const
RealType	GetVariance () const
RealObjectType *	GetVarianceOutput ()
const RealObjectType *	GetVarianceOutput () const
RealType	GetSum () const
RealObjectType *	GetSumOutput ()
const RealObjectType *	GetSumOutput () const
virtual DataObjectPointer	MakeOutput (unsigned int idx)

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
void	AllocateOutputs ()
void	BeforeThreadedGenerateData ()
void	AfterThreadedGenerateData ()
void	ThreadedGenerateData (const RegionType &outputRegionForThread, ThreadIdType threadId)
void	GenerateInputRequestedRegion ()
void	EnlargeOutputRequestedRegion (DataObject *data)

Detailed Description

template<class TInputImage>
class itk::StatisticsImageFilterWithMask< TInputImage >

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

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

Member Typedef Documentation

template<class TInputImage>

typedef DataObject::Pointer itk::StatisticsImageFilterWithMask< TInputImage >::DataObjectPointer

Smart Pointer type to a DataObject.

template<class TInputImage>

typedef SpatialObject<TInputImage::ImageDimension> itk::StatisticsImageFilterWithMask< TInputImage >::ImageMaskType

Type for the mask of the fixed image. Only pixels that are "inside" this mask will be considered for the computation of the metric

template<class TInputImage>

typedef TInputImage::Pointer itk::StatisticsImageFilterWithMask< TInputImage >::InputImagePointer

Image related typedefs.

template<class TInputImage>

typedef SimpleDataObjectDecorator<RealType> itk::StatisticsImageFilterWithMask< TInputImage >::RealObjectType

Type of DataObjects used for scalar outputs

template<class TInputImage>

typedef NumericTraits<PixelType>::RealType itk::StatisticsImageFilterWithMask< TInputImage >::RealType

Type to use for computations.

template<class TInputImage>

typedef StatisticsImageFilterWithMask itk::StatisticsImageFilterWithMask< TInputImage >::Self

Standard Self typedef

Member Function Documentation

template<class TInputImage>

void itk::StatisticsImageFilterWithMask< TInputImage >::AfterThreadedGenerateData ( )

protected

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

template<class TInputImage>

void itk::StatisticsImageFilterWithMask< TInputImage >::AllocateOutputs ( )

protected

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

template<class TInputImage>

void itk::StatisticsImageFilterWithMask< TInputImage >::BeforeThreadedGenerateData ( )

protected

Initialize some accumulators before the threads run.

template<class TInputImage>

PixelType itk::StatisticsImageFilterWithMask< TInputImage >::GetMaximum ( ) const

inline

Return the computed Maximum.

template<class TInputImage>

RealType itk::StatisticsImageFilterWithMask< TInputImage >::GetMean ( ) const

inline

Return the computed Mean.

template<class TInputImage>

PixelType itk::StatisticsImageFilterWithMask< TInputImage >::GetMinimum ( ) const

inline

Return the computed Minimum.

template<class TInputImage>

RealType itk::StatisticsImageFilterWithMask< TInputImage >::GetSigma ( ) const

inline

Return the computed Standard Deviation.

template<class TInputImage>

RealType itk::StatisticsImageFilterWithMask< TInputImage >::GetSum ( ) const

inline

Return the compute Sum.

template<class TInputImage>

RealType itk::StatisticsImageFilterWithMask< TInputImage >::GetVariance ( ) const

inline

Return the computed Variance.

template<class TInputImage>

itk::StatisticsImageFilterWithMask< TInputImage >::itkNewMacro

(

Self

)

Method for creation through the object factory.

template<class TInputImage>

itk::StatisticsImageFilterWithMask< TInputImage >::itkSetObjectMacro	(	ImageMask	,
		ImageMaskType
	)

Set/Get the image mask.

template<class TInputImage>

itk::StatisticsImageFilterWithMask< TInputImage >::itkStaticConstMacro	(	ImageDimension	,
		unsigned	int,
		TInputImage::ImageDimension
	)

Image related typedefs.

template<class TInputImage>

itk::StatisticsImageFilterWithMask< TInputImage >::itkTypeMacro	(	StatisticsImageFilterWithMask< TInputImage >	,
		ImageToImageFilter
	)

Runtime information support.

template<class TInputImage>

virtual DataObjectPointer itk::StatisticsImageFilterWithMask< TInputImage >::MakeOutput ( unsigned int  idx )

virtual

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

template<class TInputImage>

void itk::StatisticsImageFilterWithMask< TInputImage >::ThreadedGenerateData ( const RegionType &  outputRegionForThread, ThreadIdType  threadId  )

protected

Multi-thread version GenerateData.

---

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

• Core/ITKCommon/Filtering/itkStatisticsImageFilterWithMask.h