ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::StatisticsImageFilter< TInputImage > Class Template Reference
Group Filtering » Module ITKImageStatistics

#include <itkStatisticsImageFilter.h>

Detailed Description

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

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.

ITK Sphinx Examples:
Examples
SphinxExamples/src/Filtering/ImageIntensity/NormalizeImage/Code.cxx, and SphinxExamples/src/Filtering/ImageStatistics/ComputeMinMaxVarianceMeanOfImage/Code.cxx.

Definition at line 55 of file itkStatisticsImageFilter.h.

+ Inheritance diagram for itk::StatisticsImageFilter< TInputImage >:
+ Collaboration diagram for itk::StatisticsImageFilter< TInputImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = ProcessObject::DataObjectIdentifierType
 
using DataObjectPointer = typename DataObject::Pointer
 
using IndexType = typename TInputImage::IndexType
 
using InputImagePointer = typename TInputImage::Pointer
 
using PixelObjectType = SimpleDataObjectDecorator< PixelType >
 
using PixelType = typename TInputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using RealObjectType = SimpleDataObjectDecorator< RealType >
 
using RealType = typename NumericTraits< PixelType >::RealType
 
using RegionType = typename TInputImage::RegionType
 
using Self = StatisticsImageFilter
 
using SizeType = typename TInputImage::SizeType
 
using Superclass = ImageSink< TInputImage >
 
- Public Types inherited from itk::ImageSink< TInputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectPointer = DataObject::Pointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using Pointer = SmartPointer< Self >
 
using RegionSplitterPointer = typename SplitterType::Pointer
 
using Self = ImageSink
 
using SplitterType = ImageRegionSplitterBase
 
using Superclass = StreamingProcessObject
 
- Public Types inherited from itk::StreamingProcessObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = StreamingProcessObject
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual const SimpleDataObjectDecorator< PixelType > * GetMaximumOutput () const
 
virtual const SimpleDataObjectDecorator< RealType > * GetMeanOutput () const
 
virtual const SimpleDataObjectDecorator< PixelType > * GetMinimumOutput () const
 
const char * GetNameOfClass () const override
 
unsigned int GetNumberOfStreamDivisions () const override
 
virtual const SimpleDataObjectDecorator< RealType > * GetSigmaOutput () const
 
virtual const SimpleDataObjectDecorator< RealType > * GetSumOfSquaresOutput () const
 
virtual const SimpleDataObjectDecorator< RealType > * GetSumOutput () const
 
virtual const SimpleDataObjectDecorator< RealType > * GetVarianceOutput () const
 
DataObjectPointer MakeOutput (const DataObjectIdentifierType &name) override
 
void SetNumberOfStreamDivisions (const unsigned int n) override
 
- Public Member Functions inherited from itk::ImageSink< TInputImage >
virtual const InputImageType * GetInput () const
 
virtual const InputImageType * GetInput (const DataObjectIdentifierType &key) const
 
virtual const InputImageType * GetInput (unsigned int idx) const
 
virtual void SetInput (const InputImageType *input)
 
void Update () override
 
void UpdateLargestPossibleRegion () override
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::StreamingProcessObject
void GenerateData () override
 
virtual int GetCurrentRequestNumber () const
 
void PropagateRequestedRegion (DataObject *output) override
 
void ResetPipeline () override
 
void UpdateOutputData (DataObject *output) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderType * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageSink< TInputImage >
static double GetGlobalDefaultCoordinateTolerance ()
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static void SetGlobalDefaultDirectionTolerance (double)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSink< TInputImage >
static constexpr unsigned int InputImageDimension = InputImageType::ImageDimension
 

Protected Member Functions

void AfterStreamedGenerateData () override
 
void BeforeStreamedGenerateData () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetMaximumOutput (const SimpleDataObjectDecorator< PixelType > *_arg)
 
virtual void SetMeanOutput (const SimpleDataObjectDecorator< RealType > *_arg)
 
virtual void SetMinimumOutput (const SimpleDataObjectDecorator< PixelType > *_arg)
 
virtual void SetSigmaOutput (const SimpleDataObjectDecorator< RealType > *_arg)
 
virtual void SetSumOfSquaresOutput (const SimpleDataObjectDecorator< RealType > *_arg)
 
virtual void SetSumOutput (const SimpleDataObjectDecorator< RealType > *_arg)
 
virtual void SetVarianceOutput (const SimpleDataObjectDecorator< RealType > *_arg)
 
 StatisticsImageFilter ()
 
void ThreadedStreamedGenerateData (const RegionType &) override
 
 ~StatisticsImageFilter () override=default
 
- Protected Member Functions inherited from itk::ImageSink< TInputImage >
virtual void AllocateOutputs ()
 
void GenerateNthInputRequestedRegion (unsigned int inputRequestedRegionNumber) override
 
unsigned int GetNumberOfInputRequestedRegions () override
 
 ImageSink ()
 
void StreamedGenerateData (unsigned int inputRequestedRegionNumber) override
 
virtual void ThreadedStreamedGenerateData (const InputImageRegionType &inputRegionForChunk)=0
 
void VerifyInputInformation () ITKv5_CONST override
 
 ~ImageSink () override=default
 
virtual void SetRegionSplitter (SplitterType *_arg)
 
virtual SplitterType * GetModifiableRegionSplitter ()
 
- Protected Member Functions inherited from itk::StreamingProcessObject
 StreamingProcessObject ()
 
 ~StreamingProcessObject () override
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObject * GetOutput (const DataObjectIdentifierType &key)
 
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObject * GetOutput (DataObjectPointerArraySizeType i)
 
const DataObject * GetOutput (DataObjectPointerArraySizeType i) const
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

SizeValueType m_Count { 1 }
 
std::mutex m_Mutex {}
 
CompensatedSummation< RealType > m_SumOfSquares { 1 }
 
PixelType m_ThreadMax { 1 }
 
PixelType m_ThreadMin { 1 }
 
CompensatedSummation< RealType > m_ThreadSum { 1 }
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage>
using itk::StatisticsImageFilter< TInputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 64 of file itkStatisticsImageFilter.h.

◆ DataObjectIdentifierType

template<typename TInputImage>
using itk::StatisticsImageFilter< TInputImage >::DataObjectIdentifierType = ProcessObject::DataObjectIdentifierType

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

Definition at line 129 of file itkStatisticsImageFilter.h.

◆ DataObjectPointer

template<typename TInputImage>
using itk::StatisticsImageFilter< TInputImage >::DataObjectPointer = typename DataObject::Pointer

Smart Pointer type to a DataObject.

Definition at line 87 of file itkStatisticsImageFilter.h.

◆ IndexType

template<typename TInputImage>
using itk::StatisticsImageFilter< TInputImage >::IndexType = typename TInputImage::IndexType

Definition at line 77 of file itkStatisticsImageFilter.h.

◆ InputImagePointer

template<typename TInputImage>
using itk::StatisticsImageFilter< TInputImage >::InputImagePointer = typename TInputImage::Pointer

Image related type alias.

Definition at line 73 of file itkStatisticsImageFilter.h.

◆ PixelObjectType

template<typename TInputImage>
using itk::StatisticsImageFilter< TInputImage >::PixelObjectType = SimpleDataObjectDecorator<PixelType>

Definition at line 91 of file itkStatisticsImageFilter.h.

◆ PixelType

template<typename TInputImage>
using itk::StatisticsImageFilter< TInputImage >::PixelType = typename TInputImage::PixelType

Definition at line 78 of file itkStatisticsImageFilter.h.

◆ Pointer

template<typename TInputImage>
using itk::StatisticsImageFilter< TInputImage >::Pointer = SmartPointer<Self>

Definition at line 63 of file itkStatisticsImageFilter.h.

◆ RealObjectType

template<typename TInputImage>
using itk::StatisticsImageFilter< TInputImage >::RealObjectType = SimpleDataObjectDecorator<RealType>

Type of DataObjects used for scalar outputs

Definition at line 90 of file itkStatisticsImageFilter.h.

◆ RealType

template<typename TInputImage>
using itk::StatisticsImageFilter< TInputImage >::RealType = typename NumericTraits<PixelType>::RealType

Type to use for computations.

Definition at line 84 of file itkStatisticsImageFilter.h.

◆ RegionType

template<typename TInputImage>
using itk::StatisticsImageFilter< TInputImage >::RegionType = typename TInputImage::RegionType

Definition at line 75 of file itkStatisticsImageFilter.h.

◆ Self

template<typename TInputImage>
using itk::StatisticsImageFilter< TInputImage >::Self = StatisticsImageFilter

Standard Self type alias

Definition at line 61 of file itkStatisticsImageFilter.h.

◆ SizeType

template<typename TInputImage>
using itk::StatisticsImageFilter< TInputImage >::SizeType = typename TInputImage::SizeType

Definition at line 76 of file itkStatisticsImageFilter.h.

◆ Superclass

template<typename TInputImage>
using itk::StatisticsImageFilter< TInputImage >::Superclass = ImageSink<TInputImage>

Definition at line 62 of file itkStatisticsImageFilter.h.

Constructor & Destructor Documentation

◆ StatisticsImageFilter()

template<typename TInputImage>
itk::StatisticsImageFilter< TInputImage >::StatisticsImageFilter ( )
protected

◆ ~StatisticsImageFilter()

template<typename TInputImage>
itk::StatisticsImageFilter< TInputImage >::~StatisticsImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ AfterStreamedGenerateData()

template<typename TInputImage>
void itk::StatisticsImageFilter< TInputImage >::AfterStreamedGenerateData ( )
overrideprotectedvirtual

Set outputs to computed values from all regions

Reimplemented from itk::StreamingProcessObject.

◆ BeforeStreamedGenerateData()

template<typename TInputImage>
void itk::StatisticsImageFilter< TInputImage >::BeforeStreamedGenerateData ( )
overrideprotectedvirtual

Initialize some accumulators before the threads run.

Reimplemented from itk::ImageSink< TInputImage >.

◆ GetMaximumOutput()

template<typename TInputImage>
virtual const SimpleDataObjectDecorator< PixelType >* itk::StatisticsImageFilter< TInputImage >::GetMaximumOutput ( ) const
virtual

Return the computed Maximum.

◆ GetMeanOutput()

template<typename TInputImage>
virtual const SimpleDataObjectDecorator< RealType >* itk::StatisticsImageFilter< TInputImage >::GetMeanOutput ( ) const
virtual

Return the computed Mean.

◆ GetMinimumOutput()

template<typename TInputImage>
virtual const SimpleDataObjectDecorator< PixelType >* itk::StatisticsImageFilter< TInputImage >::GetMinimumOutput ( ) const
virtual

Return the computed Minimum.

◆ GetNameOfClass()

template<typename TInputImage>
const char* itk::StatisticsImageFilter< TInputImage >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::ImageSink< TInputImage >.

◆ GetNumberOfStreamDivisions()

template<typename TInputImage>
unsigned int itk::StatisticsImageFilter< TInputImage >::GetNumberOfStreamDivisions ( ) const
inlineoverridevirtual

Get the number of pieces to divide the input. The upstream pipeline will be executed this many times.

Reimplemented from itk::ImageSink< TInputImage >.

Definition at line 122 of file itkStatisticsImageFilter.h.

◆ GetSigmaOutput()

template<typename TInputImage>
virtual const SimpleDataObjectDecorator< RealType >* itk::StatisticsImageFilter< TInputImage >::GetSigmaOutput ( ) const
virtual

Return the computed Standard Deviation.

◆ GetSumOfSquaresOutput()

template<typename TInputImage>
virtual const SimpleDataObjectDecorator< RealType >* itk::StatisticsImageFilter< TInputImage >::GetSumOfSquaresOutput ( ) const
virtual

Return the compute Sum of Squares.

◆ GetSumOutput()

template<typename TInputImage>
virtual const SimpleDataObjectDecorator< RealType >* itk::StatisticsImageFilter< TInputImage >::GetSumOutput ( ) const
virtual

Return the compute Sum.

◆ GetVarianceOutput()

template<typename TInputImage>
virtual const SimpleDataObjectDecorator< RealType >* itk::StatisticsImageFilter< TInputImage >::GetVarianceOutput ( ) const
virtual

Return the computed Variance.

◆ MakeOutput()

template<typename TInputImage>
DataObjectPointer itk::StatisticsImageFilter< TInputImage >::MakeOutput ( const DataObjectIdentifierType &  )
overridevirtual

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

Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

◆ New()

template<typename TInputImage>
static Pointer itk::StatisticsImageFilter< TInputImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage>
void itk::StatisticsImageFilter< TInputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::ImageSink< TInputImage >.

◆ SetMaximumOutput()

template<typename TInputImage>
virtual void itk::StatisticsImageFilter< TInputImage >::SetMaximumOutput ( const SimpleDataObjectDecorator< PixelType > *  _arg)
protectedvirtual

◆ SetMeanOutput()

template<typename TInputImage>
virtual void itk::StatisticsImageFilter< TInputImage >::SetMeanOutput ( const SimpleDataObjectDecorator< RealType > *  _arg)
protectedvirtual

◆ SetMinimumOutput()

template<typename TInputImage>
virtual void itk::StatisticsImageFilter< TInputImage >::SetMinimumOutput ( const SimpleDataObjectDecorator< PixelType > *  _arg)
protectedvirtual

◆ SetNumberOfStreamDivisions()

template<typename TInputImage>
void itk::StatisticsImageFilter< TInputImage >::SetNumberOfStreamDivisions ( const unsigned int  _arg)
inlineoverridevirtual

Set the number of pieces to divide the input. The upstream pipeline will be executed this many times.

Reimplemented from itk::ImageSink< TInputImage >.

Definition at line 117 of file itkStatisticsImageFilter.h.

◆ SetSigmaOutput()

template<typename TInputImage>
virtual void itk::StatisticsImageFilter< TInputImage >::SetSigmaOutput ( const SimpleDataObjectDecorator< RealType > *  _arg)
protectedvirtual

◆ SetSumOfSquaresOutput()

template<typename TInputImage>
virtual void itk::StatisticsImageFilter< TInputImage >::SetSumOfSquaresOutput ( const SimpleDataObjectDecorator< RealType > *  _arg)
protectedvirtual

◆ SetSumOutput()

template<typename TInputImage>
virtual void itk::StatisticsImageFilter< TInputImage >::SetSumOutput ( const SimpleDataObjectDecorator< RealType > *  _arg)
protectedvirtual

◆ SetVarianceOutput()

template<typename TInputImage>
virtual void itk::StatisticsImageFilter< TInputImage >::SetVarianceOutput ( const SimpleDataObjectDecorator< RealType > *  _arg)
protectedvirtual

◆ ThreadedStreamedGenerateData()

template<typename TInputImage>
void itk::StatisticsImageFilter< TInputImage >::ThreadedStreamedGenerateData ( const RegionType &  )
overrideprotected

Member Data Documentation

◆ ImageDimension

template<typename TInputImage>
constexpr unsigned int itk::StatisticsImageFilter< TInputImage >::ImageDimension = TInputImage::ImageDimension
staticconstexpr

Image related type alias.

Definition at line 81 of file itkStatisticsImageFilter.h.

◆ m_Count

template<typename TInputImage>
SizeValueType itk::StatisticsImageFilter< TInputImage >::m_Count { 1 }
private

Definition at line 170 of file itkStatisticsImageFilter.h.

◆ m_Mutex

template<typename TInputImage>
std::mutex itk::StatisticsImageFilter< TInputImage >::m_Mutex {}
private

Definition at line 174 of file itkStatisticsImageFilter.h.

◆ m_SumOfSquares

template<typename TInputImage>
CompensatedSummation<RealType> itk::StatisticsImageFilter< TInputImage >::m_SumOfSquares { 1 }
private

Definition at line 168 of file itkStatisticsImageFilter.h.

◆ m_ThreadMax

template<typename TInputImage>
PixelType itk::StatisticsImageFilter< TInputImage >::m_ThreadMax { 1 }
private

Definition at line 172 of file itkStatisticsImageFilter.h.

◆ m_ThreadMin

template<typename TInputImage>
PixelType itk::StatisticsImageFilter< TInputImage >::m_ThreadMin { 1 }
private

Definition at line 171 of file itkStatisticsImageFilter.h.

◆ m_ThreadSum

template<typename TInputImage>
CompensatedSummation<RealType> itk::StatisticsImageFilter< TInputImage >::m_ThreadSum { 1 }
private

Definition at line 167 of file itkStatisticsImageFilter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16