ITK  5.2.0
Insight Toolkit
Public Types | List of all members
itk::Statistics::MeanSampleFilter< TSample > Class Template Reference
Group Numerics » Module ITKStatistics

#include <itkMeanSampleFilter.h>

+ Inheritance diagram for itk::Statistics::MeanSampleFilter< TSample >:
+ Collaboration diagram for itk::Statistics::MeanSampleFilter< TSample >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using SampleType = TSample
 
using Self = MeanSampleFilter
 
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
 
using MeasurementVectorType = typename SampleType::MeasurementVectorType
 
using MeasurementVectorSizeType = typename SampleType::MeasurementVectorSizeType
 
using MeasurementType = typename SampleType::MeasurementType
 
using MeasurementVectorRealType = typename NumericTraits< MeasurementVectorType >::RealType
 
using MeasurementRealType = typename NumericTraits< MeasurementType >::RealType
 
using MeasurementVectorDecoratedType = SimpleDataObjectDecorator< MeasurementVectorRealType >
 
using OutputType = MeasurementVectorDecoratedType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
virtual const char * GetNameOfClass () const
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
void SetInput (const SampleType *sample)
 
const SampleType * GetInput () const
 
const MeasurementVectorRealType GetMean () const
 
const MeasurementVectorDecoratedType * GetOutput () const
 
MeasurementVectorSizeType GetMeasurementVectorSize () const
 
static Pointer New ()
 
 MeanSampleFilter ()
 
 ~MeanSampleFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
void GenerateData () override
 

Additional Inherited Members

- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
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 (const DataObjectIdentifierType &)
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
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 ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
MultiThreaderType * GetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- 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
 
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 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 ()
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (const DataObjectIdentifierType &key) const
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *object)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
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
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *object)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void GenerateOutputInformation ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
- 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 ()
 
- 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
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TSample>
class itk::Statistics::MeanSampleFilter< TSample >

Given a sample, this filter computes the sample mean.

The sample is plugged in using SetSample method. Then invoke update() method to compute the sample mean.

The sample mean is computed as follows $ = \frac{1}{n}\sum^{n}_{i=1}x_{i}$ where $n$ is the number of measurement vectors in the target

Recent API changes: The static const macro to get the length of a measurement vector, 'MeasurementVectorSize' has been removed to allow the length of a measurement vector to be specified at run time. It is now obtained from the input sample. Please use the function GetMeasurementVectorSize() to obtain the length.

Examples
Examples/Statistics/SampleStatistics.cxx.

Definition at line 49 of file itkMeanSampleFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TSample >
using itk::Statistics::MeanSampleFilter< TSample >::ConstPointer = SmartPointer<const Self>

Definition at line 58 of file itkMeanSampleFilter.h.

◆ DataObjectPointer

template<typename TSample >
using itk::Statistics::MeanSampleFilter< TSample >::DataObjectPointer = DataObject::Pointer
protected

DataObject pointer

Definition at line 114 of file itkMeanSampleFilter.h.

◆ DataObjectPointerArraySizeType

template<typename TSample >
using itk::Statistics::MeanSampleFilter< TSample >::DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
protected

Type of each measurement vector in sample

Definition at line 116 of file itkMeanSampleFilter.h.

◆ MeasurementRealType

template<typename TSample >
using itk::Statistics::MeanSampleFilter< TSample >::MeasurementRealType = typename NumericTraits<MeasurementType>::RealType

Type of a floating point measurement component value

Definition at line 79 of file itkMeanSampleFilter.h.

◆ MeasurementType

template<typename TSample >
using itk::Statistics::MeanSampleFilter< TSample >::MeasurementType = typename SampleType::MeasurementType

Type of measurement vector component value

Definition at line 73 of file itkMeanSampleFilter.h.

◆ MeasurementVectorDecoratedType

template<typename TSample >
using itk::Statistics::MeanSampleFilter< TSample >::MeasurementVectorDecoratedType = SimpleDataObjectDecorator<MeasurementVectorRealType>

MeasurementVector is not a DataObject, we need to decorate it to push it down a ProcessObject's pipeline

Definition at line 98 of file itkMeanSampleFilter.h.

◆ MeasurementVectorRealType

template<typename TSample >
using itk::Statistics::MeanSampleFilter< TSample >::MeasurementVectorRealType = typename NumericTraits<MeasurementVectorType>::RealType

Type of a measurement vector, holding floating point values

Definition at line 76 of file itkMeanSampleFilter.h.

◆ MeasurementVectorSizeType

template<typename TSample >
using itk::Statistics::MeanSampleFilter< TSample >::MeasurementVectorSizeType = typename SampleType::MeasurementVectorSizeType

Type of the length of each measurement vector

Definition at line 70 of file itkMeanSampleFilter.h.

◆ MeasurementVectorType

template<typename TSample >
using itk::Statistics::MeanSampleFilter< TSample >::MeasurementVectorType = typename SampleType::MeasurementVectorType

Type of each measurement vector in sample

Definition at line 67 of file itkMeanSampleFilter.h.

◆ OutputType

template<typename TSample >
using itk::Statistics::MeanSampleFilter< TSample >::OutputType = MeasurementVectorDecoratedType

Type of each measurement vector in sample

Definition at line 101 of file itkMeanSampleFilter.h.

◆ Pointer

template<typename TSample >
using itk::Statistics::MeanSampleFilter< TSample >::Pointer = SmartPointer<Self>

Definition at line 57 of file itkMeanSampleFilter.h.

◆ SampleType

template<typename TSample >
using itk::Statistics::MeanSampleFilter< TSample >::SampleType = TSample

Definition at line 59 of file itkMeanSampleFilter.h.

◆ Self

template<typename TSample >
using itk::Statistics::MeanSampleFilter< TSample >::Self = MeanSampleFilter

Standard class type aliases.

Definition at line 55 of file itkMeanSampleFilter.h.

◆ Superclass

template<typename TSample >
using itk::Statistics::MeanSampleFilter< TSample >::Superclass = ProcessObject

Definition at line 56 of file itkMeanSampleFilter.h.

Constructor & Destructor Documentation

◆ MeanSampleFilter()

template<typename TSample >
itk::Statistics::MeanSampleFilter< TSample >::MeanSampleFilter ( )
protected

Type of each measurement vector in sample

◆ ~MeanSampleFilter()

template<typename TSample >
itk::Statistics::MeanSampleFilter< TSample >::~MeanSampleFilter ( )
overrideprotecteddefault

Type of each measurement vector in sample

Member Function Documentation

◆ CreateAnother()

template<typename TSample >
virtual::itk::LightObject::Pointer itk::Statistics::MeanSampleFilter< TSample >::CreateAnother ( ) const
virtual

Type of each measurement vector in sample

Reimplemented from itk::Object.

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

◆ GenerateData()

template<typename TSample >
void itk::Statistics::MeanSampleFilter< TSample >::GenerateData ( )
overrideprotectedvirtual

Type of each measurement vector in sample

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

◆ GetInput()

template<typename TSample >
const SampleType* itk::Statistics::MeanSampleFilter< TSample >::GetInput ( ) const

Method to get the sample

◆ GetMean()

template<typename TSample >
const MeasurementVectorRealType itk::Statistics::MeanSampleFilter< TSample >::GetMean ( ) const

Get the mean measurement vector

◆ GetMeasurementVectorSize()

template<typename TSample >
MeasurementVectorSizeType itk::Statistics::MeanSampleFilter< TSample >::GetMeasurementVectorSize ( ) const

Type of each measurement vector in sample

◆ GetNameOfClass()

template<typename TSample >
virtual const char* itk::Statistics::MeanSampleFilter< TSample >::GetNameOfClass ( ) const
virtual

Standard Macros

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

◆ GetOutput()

template<typename TSample >
const MeasurementVectorDecoratedType* itk::Statistics::MeanSampleFilter< TSample >::GetOutput ( ) const

Type of each measurement vector in sample

◆ MakeOutput()

template<typename TSample >
DataObjectPointer itk::Statistics::MeanSampleFilter< TSample >::MakeOutput ( DataObjectPointerArraySizeType  idx)
overrideprotectedvirtual

Type of each measurement vector in sample

Reimplemented from itk::ProcessObject.

◆ New()

template<typename TSample >
static Pointer itk::Statistics::MeanSampleFilter< TSample >::New ( )
static

Type of each measurement vector in sample

◆ PrintSelf()

template<typename TSample >
void itk::Statistics::MeanSampleFilter< TSample >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Type of each measurement vector in sample

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

◆ SetInput()

template<typename TSample >
void itk::Statistics::MeanSampleFilter< TSample >::SetInput ( const SampleType *  sample)

Type of each measurement vector in sample

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.
Generated on Thu Apr 1 2021 02:37:29 for ITK by   doxygen 1.8.16