#include <itkWeightedMeanSampleFilter.h>

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

See also: MeanSampleFilter

Examples: Examples/Statistics/WeightedSampleStatistics.cxx.

Definition at line 43 of file itkWeightedMeanSampleFilter.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	InputWeightArrayObjectType = SimpleDataObjectDecorator< WeightArrayType >

using	InputWeightingFunctionObjectType = DataObjectDecorator< WeightingFunctionType >

using	Pointer = SmartPointer< Self >

using	Self = WeightedMeanSampleFilter

using	Superclass = MeanSampleFilter< TSample >

using	WeightArrayType = Array< WeightValueType >

using	WeightingFunctionType = FunctionBase< MeasurementVectorType, WeightValueType >

using	WeightValueType = double

Public Types inherited from itk::Statistics::MeanSampleFilter< TSample >
using	ConstPointer = SmartPointer< const Self >

using	MeasurementRealType = typename NumericTraits< MeasurementType >::RealType

using	MeasurementType = typename SampleType::MeasurementType

using	MeasurementVectorDecoratedType = SimpleDataObjectDecorator< MeasurementVectorRealType >

using	MeasurementVectorRealType = typename NumericTraits< MeasurementVectorType >::RealType

using	MeasurementVectorSizeType = typename SampleType::MeasurementVectorSizeType

using	MeasurementVectorType = typename SampleType::MeasurementVectorType

using	OutputType = MeasurementVectorDecoratedType

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

Public Member Functions
virtual void	SetWeightingFunctionInput (const DataObjectDecorator< WeightingFunctionType > *_arg)

virtual void	SetWeightsInput (const SimpleDataObjectDecorator< WeightArrayType > *_arg)

Public Member Functions inherited from itk::Statistics::MeanSampleFilter< TSample >
const SampleType *	GetInput () 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	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 (const DataObjectIdentifierType &)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

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	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) 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) const

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

Protected Member Functions
void	ComputeMeanWithWeightingFunction ()

void	ComputeMeanWithWeights ()

void	GenerateData () override

	WeightedMeanSampleFilter ()

	~WeightedMeanSampleFilter () override=default

Protected Member Functions inherited from itk::Statistics::MeanSampleFilter< TSample >
DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx) override

	MeanSampleFilter ()

	~MeanSampleFilter () override=default

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 ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	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	VerifyInputInformation () const

virtual void	VerifyPreconditions () 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 ()

const char *	GetNameOfClass () const override

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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Types inherited from itk::Statistics::MeanSampleFilter< TSample >
using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

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 TSample >

using itk::Statistics::WeightedMeanSampleFilter< TSample >::ConstPointer = SmartPointer<const Self>

Definition at line 52 of file itkWeightedMeanSampleFilter.h.

◆ InputWeightArrayObjectType

template<typename TSample >

using itk::Statistics::WeightedMeanSampleFilter< TSample >::InputWeightArrayObjectType = SimpleDataObjectDecorator<WeightArrayType>

Type of DataObjects to use for the weight array type

Definition at line 78 of file itkWeightedMeanSampleFilter.h.

◆ InputWeightingFunctionObjectType

template<typename TSample >

using itk::Statistics::WeightedMeanSampleFilter< TSample >::InputWeightingFunctionObjectType = DataObjectDecorator<WeightingFunctionType>

Type of DataObjects to use for Weight function

Definition at line 88 of file itkWeightedMeanSampleFilter.h.

◆ Pointer

template<typename TSample >

using itk::Statistics::WeightedMeanSampleFilter< TSample >::Pointer = SmartPointer<Self>

Definition at line 51 of file itkWeightedMeanSampleFilter.h.

◆ Self

template<typename TSample >

using itk::Statistics::WeightedMeanSampleFilter< TSample >::Self = WeightedMeanSampleFilter

Standard class type aliases.

Definition at line 49 of file itkWeightedMeanSampleFilter.h.

◆ Superclass

template<typename TSample >

using itk::Statistics::WeightedMeanSampleFilter< TSample >::Superclass = MeanSampleFilter<TSample>

Definition at line 50 of file itkWeightedMeanSampleFilter.h.

◆ WeightArrayType

template<typename TSample >

using itk::Statistics::WeightedMeanSampleFilter< TSample >::WeightArrayType = Array<WeightValueType>

Array type for weights

Definition at line 75 of file itkWeightedMeanSampleFilter.h.

◆ WeightingFunctionType

template<typename TSample >

using itk::Statistics::WeightedMeanSampleFilter< TSample >::WeightingFunctionType = FunctionBase<MeasurementVectorType, WeightValueType>

Weight calculation function type

Definition at line 85 of file itkWeightedMeanSampleFilter.h.

◆ WeightValueType

template<typename TSample >

using itk::Statistics::WeightedMeanSampleFilter< TSample >::WeightValueType = double

Type of weight values

Definition at line 71 of file itkWeightedMeanSampleFilter.h.

Constructor & Destructor Documentation

◆ WeightedMeanSampleFilter()

template<typename TSample >

itk::Statistics::WeightedMeanSampleFilter< TSample >::WeightedMeanSampleFilter ( )

protected

◆ ~WeightedMeanSampleFilter()

template<typename TSample >

itk::Statistics::WeightedMeanSampleFilter< TSample >::~WeightedMeanSampleFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ ComputeMeanWithWeightingFunction()

template<typename TSample >

void itk::Statistics::WeightedMeanSampleFilter< TSample >::ComputeMeanWithWeightingFunction ( )

protected

◆ ComputeMeanWithWeights()

template<typename TSample >

void itk::Statistics::WeightedMeanSampleFilter< TSample >::ComputeMeanWithWeights ( )

protected

◆ GenerateData()

template<typename TSample >

void itk::Statistics::WeightedMeanSampleFilter< TSample >::GenerateData ( )

overrideprotectedvirtual

This method causes the filter to generate its output.

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

◆ GetNameOfClass()

template<typename TSample >

const char* itk::Statistics::WeightedMeanSampleFilter< TSample >::GetNameOfClass ( ) const

overridevirtual

Standard Macros

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

◆ New()

template<typename TSample >

static Pointer itk::Statistics::WeightedMeanSampleFilter< TSample >::New ( )

static

Standard Macros

◆ SetWeightingFunctionInput()

template<typename TSample >

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

virtual

Method to set/get the weighting function

◆ SetWeightsInput()

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:

itkWeightedMeanSampleFilter.h

Detailed Description

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

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ InputWeightArrayObjectType

◆ InputWeightingFunctionObjectType

◆ Pointer

◆ Self

◆ Superclass

◆ WeightArrayType

◆ WeightingFunctionType

◆ WeightValueType

Constructor & Destructor Documentation

◆ WeightedMeanSampleFilter()

◆ ~WeightedMeanSampleFilter()

Member Function Documentation

◆ ComputeMeanWithWeightingFunction()

◆ ComputeMeanWithWeights()

◆ GenerateData()

◆ GetNameOfClass()

◆ New()

◆ SetWeightingFunctionInput()

◆ SetWeightsInput()

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