ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | List of all members
itk::Statistics::WeightedMeanSampleFilter< TSample > Class Template Reference

#include <itkWeightedMeanSampleFilter.h>

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

Detailed Description

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

Given a sample where each measurement vector has associated weight value, this filter computes the sample mean.

To run this algorithm, you have plug in the target sample data using SetInput method and provides weight by an array or function. . Then call the Update method to run the alogithm.

See Also
MeanSampleFilter
Examples:
Examples/Statistics/WeightedSampleStatistics.cxx.

Definition at line 42 of file itkWeightedMeanSampleFilter.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
SimpleDataObjectDecorator
< WeightArrayType
InputWeightArrayObjectType
 
typedef DataObjectDecorator
< WeightingFunctionType
InputWeightingFunctionObjectType
 
typedef
Superclass::MeasurementRealType 
MeasurementRealType
 
typedef Superclass::MeasurementType MeasurementType
 
typedef
Superclass::MeasurementVectorDecoratedType 
MeasurementVectorDecoratedType
 
typedef
Superclass::MeasurementVectorRealType 
MeasurementVectorRealType
 
typedef
Superclass::MeasurementVectorSizeType 
MeasurementVectorSizeType
 
typedef
Superclass::MeasurementVectorType 
MeasurementVectorType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::SampleType SampleType
 
typedef WeightedMeanSampleFilter Self
 
typedef MeanSampleFilter< TSample > Superclass
 
typedef Array< WeightValueTypeWeightArrayType
 
typedef FunctionBase
< MeasurementVectorType,
WeightValueType
WeightingFunctionType
 
typedef double WeightValueType
 
- Public Types inherited from itk::Statistics::MeanSampleFilter< TSample >
typedef SmartPointer< const SelfConstPointer
 
typedef NumericTraits
< MeasurementType >::RealType 
MeasurementRealType
 
typedef SampleType::MeasurementType MeasurementType
 
typedef
SimpleDataObjectDecorator
< MeasurementVectorRealType
MeasurementVectorDecoratedType
 
typedef NumericTraits
< MeasurementVectorType >
::RealType 
MeasurementVectorRealType
 
typedef
SampleType::MeasurementVectorSizeType 
MeasurementVectorSizeType
 
typedef
SampleType::MeasurementVectorType 
MeasurementVectorType
 
typedef
MeasurementVectorDecoratedType 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef TSample SampleType
 
typedef MeanSampleFilter Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef MultiThreader MultiThreaderType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual const
DataObjectDecorator
< WeightingFunctionType > * 
GetInputnumber () const
 
virtual const
WeightingFunctionType
GetWeightingFunction () const
 
virtual const
DataObjectDecorator
< WeightingFunctionType > * 
GetWeightingFunctionInput () const
 
virtual const
DataObjectDecorator
< WeightingFunctionType > * 
GetWeightingFunctionInput () const
 
virtual const WeightArrayTypeGetWeights () const
 
virtual const
SimpleDataObjectDecorator
< WeightArrayType > * 
GetWeightsInput () const
 
virtual void SetInputnumber (const DataObjectDecorator< WeightingFunctionType > *_arg)
 
virtual void SetWeightingFunction (const WeightingFunctionType *_arg)
 
virtual void SetWeightingFunctionInput (const DataObjectDecorator< WeightingFunctionType > *_arg)
 
virtual void SetWeights (const WeightArrayType &_arg)
 
virtual void SetWeights (const SimpleDataObjectDecorator< WeightArrayType > *_arg)
 
virtual void SetWeightsInput (const SimpleDataObjectDecorator< WeightArrayType > *_arg)
 
- Public Member Functions inherited from itk::Statistics::MeanSampleFilter< TSample >
const SampleTypeGetInput () const
 
const MeasurementVectorRealType GetMean () const
 
MeasurementVectorSizeType GetMeasurementVectorSize () const
 
const
MeasurementVectorDecoratedType
GetOutput () const
 
void SetInput (const SampleType *sample)
 
- 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 ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
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)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
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 SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

void ComputeMeanWithWeightingFunction ()
 
void ComputeMeanWithWeights ()
 
void GenerateData () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 WeightedMeanSampleFilter ()
 
virtual ~WeightedMeanSampleFilter () override
 
- Protected Member Functions inherited from itk::Statistics::MeanSampleFilter< TSample >
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
 MeanSampleFilter ()
 
virtual ~MeanSampleFilter () 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)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (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
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
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 num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~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 ()
 
virtual const char * GetNameOfClass () const
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
static Pointer New ()
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Statistics::MeanSampleFilter< TSample >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Types inherited from itk::Statistics::MeanSampleFilter< TSample >
typedef DataObject::Pointer DataObjectPointer
 
typedef
ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TSample >
typedef SmartPointer< const Self > itk::Statistics::WeightedMeanSampleFilter< TSample >::ConstPointer

Definition at line 49 of file itkWeightedMeanSampleFilter.h.

Type of DataObjects to use for the weight array type

Definition at line 75 of file itkWeightedMeanSampleFilter.h.

Type of DataObjects to use for Weight function

Definition at line 85 of file itkWeightedMeanSampleFilter.h.

template<typename TSample >
typedef Superclass::MeasurementRealType itk::Statistics::WeightedMeanSampleFilter< TSample >::MeasurementRealType

Definition at line 64 of file itkWeightedMeanSampleFilter.h.

template<typename TSample >
typedef Superclass::MeasurementType itk::Statistics::WeightedMeanSampleFilter< TSample >::MeasurementType

Definition at line 60 of file itkWeightedMeanSampleFilter.h.

template<typename TSample >
typedef Superclass::MeasurementVectorDecoratedType itk::Statistics::WeightedMeanSampleFilter< TSample >::MeasurementVectorDecoratedType

Types derived from the base class

Definition at line 88 of file itkWeightedMeanSampleFilter.h.

template<typename TSample >
typedef Superclass::MeasurementVectorRealType itk::Statistics::WeightedMeanSampleFilter< TSample >::MeasurementVectorRealType

Types derived from the base class

Definition at line 63 of file itkWeightedMeanSampleFilter.h.

template<typename TSample >
typedef Superclass::MeasurementVectorSizeType itk::Statistics::WeightedMeanSampleFilter< TSample >::MeasurementVectorSizeType

Definition at line 59 of file itkWeightedMeanSampleFilter.h.

template<typename TSample >
typedef Superclass::MeasurementVectorType itk::Statistics::WeightedMeanSampleFilter< TSample >::MeasurementVectorType

Definition at line 58 of file itkWeightedMeanSampleFilter.h.

template<typename TSample >
typedef Superclass::OutputType itk::Statistics::WeightedMeanSampleFilter< TSample >::OutputType

Definition at line 93 of file itkWeightedMeanSampleFilter.h.

template<typename TSample >
typedef SmartPointer< Self > itk::Statistics::WeightedMeanSampleFilter< TSample >::Pointer

Definition at line 48 of file itkWeightedMeanSampleFilter.h.

template<typename TSample >
typedef Superclass::SampleType itk::Statistics::WeightedMeanSampleFilter< TSample >::SampleType

Types derived from the base class

Definition at line 53 of file itkWeightedMeanSampleFilter.h.

template<typename TSample >
typedef WeightedMeanSampleFilter itk::Statistics::WeightedMeanSampleFilter< TSample >::Self

Standard class typedefs.

Definition at line 46 of file itkWeightedMeanSampleFilter.h.

template<typename TSample >
typedef MeanSampleFilter< TSample > itk::Statistics::WeightedMeanSampleFilter< TSample >::Superclass

Definition at line 47 of file itkWeightedMeanSampleFilter.h.

template<typename TSample >
typedef Array< WeightValueType > itk::Statistics::WeightedMeanSampleFilter< TSample >::WeightArrayType

Array type for weights

Definition at line 72 of file itkWeightedMeanSampleFilter.h.

Weight calculation function type

Definition at line 78 of file itkWeightedMeanSampleFilter.h.

template<typename TSample >
typedef double itk::Statistics::WeightedMeanSampleFilter< TSample >::WeightValueType

Type of weight values

Definition at line 68 of file itkWeightedMeanSampleFilter.h.

Constructor & Destructor Documentation

template<typename TSample >
itk::Statistics::WeightedMeanSampleFilter< TSample >::WeightedMeanSampleFilter ( )
protected
template<typename TSample >
virtual itk::Statistics::WeightedMeanSampleFilter< TSample >::~WeightedMeanSampleFilter ( )
overrideprotectedvirtual

Member Function Documentation

template<typename TSample >
void itk::Statistics::WeightedMeanSampleFilter< TSample >::ComputeMeanWithWeightingFunction ( )
protected
template<typename TSample >
void itk::Statistics::WeightedMeanSampleFilter< TSample >::ComputeMeanWithWeights ( )
protected
template<typename TSample >
virtual::itk::LightObject::Pointer itk::Statistics::WeightedMeanSampleFilter< TSample >::CreateAnother ( ) const
virtual

Standard Macros

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

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

This method causes the filter to generate its output.

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

template<typename TSample >
virtual const DataObjectDecorator< WeightingFunctionType >* itk::Statistics::WeightedMeanSampleFilter< TSample >::GetInputnumber ( ) const
virtual
template<typename TSample >
virtual const char* itk::Statistics::WeightedMeanSampleFilter< TSample >::GetNameOfClass ( ) const
virtual

Standard Macros

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

template<typename TSample >
virtual const WeightingFunctionType* itk::Statistics::WeightedMeanSampleFilter< TSample >::GetWeightingFunction ( ) const
virtual
template<typename TSample >
virtual const DataObjectDecorator< WeightingFunctionType >* itk::Statistics::WeightedMeanSampleFilter< TSample >::GetWeightingFunctionInput ( ) const
virtual
template<typename TSample >
virtual const DataObjectDecorator< WeightingFunctionType >* itk::Statistics::WeightedMeanSampleFilter< TSample >::GetWeightingFunctionInput ( ) const
virtual
template<typename TSample >
virtual const WeightArrayType& itk::Statistics::WeightedMeanSampleFilter< TSample >::GetWeights ( ) const
virtual
template<typename TSample >
virtual const SimpleDataObjectDecorator< WeightArrayType >* itk::Statistics::WeightedMeanSampleFilter< TSample >::GetWeightsInput ( ) const
virtual
template<typename TSample >
static Pointer itk::Statistics::WeightedMeanSampleFilter< TSample >::New ( )
static

Standard Macros

template<typename TSample >
void itk::Statistics::WeightedMeanSampleFilter< TSample >::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::Statistics::MeanSampleFilter< TSample >.

template<typename TSample >
virtual void itk::Statistics::WeightedMeanSampleFilter< TSample >::SetInputnumber ( const DataObjectDecorator< WeightingFunctionType > *  _arg)
virtual
template<typename TSample >
virtual void itk::Statistics::WeightedMeanSampleFilter< TSample >::SetWeightingFunction ( const WeightingFunctionType _arg)
virtual
template<typename TSample >
virtual void itk::Statistics::WeightedMeanSampleFilter< TSample >::SetWeightingFunctionInput ( const DataObjectDecorator< WeightingFunctionType > *  _arg)
virtual

Method to set/get the weighting function

template<typename TSample >
virtual void itk::Statistics::WeightedMeanSampleFilter< TSample >::SetWeights ( const SimpleDataObjectDecorator< WeightArrayType > *  _arg)
virtual
template<typename TSample >
virtual void itk::Statistics::WeightedMeanSampleFilter< TSample >::SetWeights ( const WeightArrayType _arg)
virtual
template<typename TSample >
virtual void itk::Statistics::WeightedMeanSampleFilter< TSample >::SetWeightsInput ( const SimpleDataObjectDecorator< WeightArrayType > *  _arg)
virtual

Method to set/get the input value of the weight array


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