itk::Statistics::WeightedMeanCalculator< TSample > Class Template Reference

#include <itkWeightedMeanCalculator.h>

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

[legend]Collaboration diagram for itk::Statistics::WeightedMeanCalculator< TSample >:

[legend]List of all members.

---

Detailed Description

template<class TSample>
class itk::Statistics::WeightedMeanCalculator< TSample >

calculates sample mean where each measurement vector has associated weight value

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

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. The mean output is an Array rather than a Vector.

See also:

MeanCalculator SampleAlgorithmBase

Definition at line 50 of file itkWeightedMeanCalculator.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TSample	InputSampleType
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef TSample::MeasurementVectorType	MeasurementVectorType
typedef Array< double >	OutputType
typedef SmartPointer< Self >	Pointer
typedef WeightedMeanCalculator	Self
typedef SampleAlgorithmBase< TSample >	Superclass
typedef Array< double >	WeightArrayType
typedef FunctionBase< MeasurementVectorType, double >	WeightFunctionType
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
const TSample *	GetInputSample () const
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
Standard Macros *virtual const char *	GetNameOfClass () const
OutputType *	GetOutput ()
virtual int	GetReferenceCount () const
WeightFunctionType *	GetWeightFunction ()
WeightArrayType *	GetWeights ()
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
Stores the sample pointer *void	SetInputSample (const TSample *sample)
virtual void	SetMeasurementVectorSize (MeasurementVectorSizeType _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
void	SetWeightFunction (WeightFunctionType *func)
void	SetWeights (WeightArrayType *array)
virtual void	UnRegister () const
void	Update ()
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
void	GenerateData ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	SampleAlgorithmBase ()
	WeightedMeanCalculator ()
virtual	~WeightedMeanCalculator ()
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

template<class TSample> typedef SmartPointer<const Self> itk::Statistics::WeightedMeanCalculator< TSample >::ConstPointer

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 58 of file itkWeightedMeanCalculator.h.

typedef TSample itk::Statistics::SampleAlgorithmBase< TSample >::InputSampleType [inherited]

Sample typedefs alias Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >, and itk::Statistics::SampleMeanShiftBlurringFilter< TSample >. Definition at line 59 of file itkSampleAlgorithmBase.h.

template<class TSample> typedef Superclass::MeasurementVectorSizeType itk::Statistics::WeightedMeanCalculator< TSample >::MeasurementVectorSizeType

Length of a measurement vector Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 62 of file itkWeightedMeanCalculator.h.

template<class TSample> typedef TSample::MeasurementVectorType itk::Statistics::WeightedMeanCalculator< TSample >::MeasurementVectorType

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 68 of file itkWeightedMeanCalculator.h.

template<class TSample> typedef Array< double > itk::Statistics::WeightedMeanCalculator< TSample >::OutputType

Typedef for the mean output Definition at line 71 of file itkWeightedMeanCalculator.h.

template<class TSample> typedef SmartPointer<Self> itk::Statistics::WeightedMeanCalculator< TSample >::Pointer

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 57 of file itkWeightedMeanCalculator.h.

template<class TSample> typedef WeightedMeanCalculator itk::Statistics::WeightedMeanCalculator< TSample >::Self

Standard class typedefs. Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 55 of file itkWeightedMeanCalculator.h.

template<class TSample> typedef SampleAlgorithmBase< TSample > itk::Statistics::WeightedMeanCalculator< TSample >::Superclass

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 56 of file itkWeightedMeanCalculator.h.

template<class TSample> typedef Array< double > itk::Statistics::WeightedMeanCalculator< TSample >::WeightArrayType

Array typedef for weights Definition at line 74 of file itkWeightedMeanCalculator.h.

template<class TSample> typedef FunctionBase< MeasurementVectorType, double > itk::Statistics::WeightedMeanCalculator< TSample >::WeightFunctionType

Weight calculation function typedef Definition at line 83 of file itkWeightedMeanCalculator.h.

---

Constructor & Destructor Documentation

template<class TSample> itk::Statistics::WeightedMeanCalculator< TSample >::WeightedMeanCalculator (   )  [protected]

template<class TSample> virtual itk::Statistics::WeightedMeanCalculator< TSample >::~WeightedMeanCalculator (   )  [inline, protected, virtual]

Definition at line 98 of file itkWeightedMeanCalculator.h.

---

Member Function Documentation

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class. Reimplemented from itk::LightObject.

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

template<class TSample> void itk::Statistics::WeightedMeanCalculator< TSample >::GenerateData (   )  [protected, virtual]

Calculates the mean and save it Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

const TSample * itk::Statistics::SampleAlgorithmBase< TSample >::GetInputSample (   )  const [inline, inherited]

Definition at line 82 of file itkSampleAlgorithmBase.h.

virtual MeasurementVectorSizeType itk::Statistics::SampleAlgorithmBase< TSample >::GetMeasurementVectorSize (   )  const [virtual, inherited]

Get Macro to get the length of a measurement vector. This is equal to the length of each measurement vector contained in the samples that are plugged in as input to this class. GetMeasurementVectorSize() will return zero until the SetInputSample() method has been called

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

template<class TSample> Standard Macros* virtual const char* itk::Statistics::WeightedMeanCalculator< TSample >::GetNameOfClass (   )  const [virtual]

Standard part of all itk objects. Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

template<class TSample> OutputType* itk::Statistics::WeightedMeanCalculator< TSample >::GetOutput (   )

Returns the mean vector as the result

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

template<class TSample> WeightFunctionType* itk::Statistics::WeightedMeanCalculator< TSample >::GetWeightFunction (   )

Gets the weight function

template<class TSample> WeightArrayType* itk::Statistics::WeightedMeanCalculator< TSample >::GetWeights (   )

Gets the weights array

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TSample> static Pointer itk::Statistics::WeightedMeanCalculator< TSample >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

template<class TSample> void itk::Statistics::WeightedMeanCalculator< TSample >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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::SampleAlgorithmBase< TSample >.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

itk::Statistics::SampleAlgorithmBase< TSample >::SampleAlgorithmBase (   )  [protected, inherited]

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

Stores the sample pointer* void itk::Statistics::SampleAlgorithmBase< TSample >::SetInputSample (  const TSample *  sample  )  [inline, inherited]

Definition at line 63 of file itkSampleAlgorithmBase.h.

virtual void itk::Statistics::SampleAlgorithmBase< TSample >::SetMeasurementVectorSize (  MeasurementVectorSizeType  _arg  )  [virtual, inherited]

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

template<class TSample> void itk::Statistics::WeightedMeanCalculator< TSample >::SetWeightFunction (  WeightFunctionType *  func  )

Sets the wiehts using an function the function should have a method, Evaluate(MeasurementVectorType&)

template<class TSample> void itk::Statistics::WeightedMeanCalculator< TSample >::SetWeights (  WeightArrayType *  array  )

Sets the weights using an array

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

void itk::Statistics::SampleAlgorithmBase< TSample >::Update (  void   )  [inline, inherited]

dummy function that calls the GenerateData() function to generate output. It exists for future compatibility with ProcessObject without streaming Definition at line 88 of file itkSampleAlgorithmBase.h.

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkWeightedMeanCalculator.h

---