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

#include <itkGaussianMixtureModelComponent.h>

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

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

[legend]List of all members.

---

Detailed Description

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

is a component (derived from MixtureModelComponentBase) for Gaussian class. This class is used in ExpectationMaximizationMixtureModelEstimator.

On every iteration of EM estimation, this class's GenerateData method is called to compute the new distribution parameters.

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 at run time from the sample set as input. Please use the function GetMeasurementVectorSize() to get the length.

See also:

MixtureModelComponentBase, ExpectationMaximizationMixtureModelEstimator

Definition at line 48 of file itkGaussianMixtureModelComponent.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef WeightedCovarianceCalculator< TSample >	CovarianceEstimatorType
typedef CovarianceEstimatorType::OutputType	CovarianceType
typedef WeightedMeanCalculator< TSample >	MeanEstimatorType
typedef MeanEstimatorType::OutputType	MeanType
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef Superclass::MembershipFunctionType	MembershipFunctionType
typedef GaussianDensityFunction< MeasurementVectorType >	NativeMembershipFunctionType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef GaussianMixtureModelComponent	Self
typedef MixtureModelComponentBase< TSample >	Superclass
typedef Superclass::WeightArrayType	WeightArrayType
Public Member Functions
bool	AreParametersModified ()
void	AreParametersModified (bool flag)
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
double	Evaluate (MeasurementVectorType &measurements)
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual ParametersType	GetFullParameters ()
MembershipFunctionType *	GetMembershipFunction ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
double	GetMinimalParametersChange ()
virtual unsigned long	GetMTime () const
Standard Macros *virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
const TSample *	GetSample () const
double	GetWeight (int index)
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
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMinimalParametersChange (double change)
void	SetParameters (const ParametersType &parameters)
virtual void	SetReferenceCount (int)
void	SetSample (const TSample *sample)
void	SetWeight (int index, double value)
virtual void	UnRegister () const
virtual 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
double	CalculateParametersChange ()
void	CreateWeightArray ()
void	DeleteWeightArray ()
	GaussianMixtureModelComponent ()
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
void	SetMembershipFunction (MembershipFunctionType *function)
virtual	~GaussianMixtureModelComponent ()
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::GaussianMixtureModelComponent< TSample >::ConstPointer

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

template<class TSample> typedef WeightedCovarianceCalculator< TSample > itk::Statistics::GaussianMixtureModelComponent< TSample >::CovarianceEstimatorType

Definition at line 78 of file itkGaussianMixtureModelComponent.h.

template<class TSample> typedef CovarianceEstimatorType::OutputType itk::Statistics::GaussianMixtureModelComponent< TSample >::CovarianceType

Type of the covariance matrix Definition at line 84 of file itkGaussianMixtureModelComponent.h.

template<class TSample> typedef WeightedMeanCalculator< TSample > itk::Statistics::GaussianMixtureModelComponent< TSample >::MeanEstimatorType

Types of the mean and the covariance calculator that will update this component's distribution parameters Definition at line 77 of file itkGaussianMixtureModelComponent.h.

template<class TSample> typedef MeanEstimatorType::OutputType itk::Statistics::GaussianMixtureModelComponent< TSample >::MeanType

Type of the mean vector Definition at line 81 of file itkGaussianMixtureModelComponent.h.

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

Reimplemented from itk::Statistics::MixtureModelComponentBase< TSample >. Definition at line 66 of file itkGaussianMixtureModelComponent.h.

template<class TSample> typedef Superclass::MeasurementVectorType itk::Statistics::GaussianMixtureModelComponent< TSample >::MeasurementVectorType

Typedefs from the superclass Reimplemented from itk::Statistics::MixtureModelComponentBase< TSample >. Definition at line 60 of file itkGaussianMixtureModelComponent.h.

template<class TSample> typedef Superclass::MembershipFunctionType itk::Statistics::GaussianMixtureModelComponent< TSample >::MembershipFunctionType

typedef for the MembershipFunctionBase Reimplemented from itk::Statistics::MixtureModelComponentBase< TSample >. Definition at line 67 of file itkGaussianMixtureModelComponent.h.

template<class TSample> typedef GaussianDensityFunction< MeasurementVectorType > itk::Statistics::GaussianMixtureModelComponent< TSample >::NativeMembershipFunctionType

Type of the membership function. Gaussian density function Definition at line 73 of file itkGaussianMixtureModelComponent.h.

template<class TSample> typedef Superclass::ParametersType itk::Statistics::GaussianMixtureModelComponent< TSample >::ParametersType

Reimplemented from itk::Statistics::MixtureModelComponentBase< TSample >. Definition at line 69 of file itkGaussianMixtureModelComponent.h.

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

Reimplemented from itk::Statistics::MixtureModelComponentBase< TSample >. Definition at line 55 of file itkGaussianMixtureModelComponent.h.

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

Standard class typedefs. Reimplemented from itk::Statistics::MixtureModelComponentBase< TSample >. Definition at line 53 of file itkGaussianMixtureModelComponent.h.

template<class TSample> typedef MixtureModelComponentBase< TSample > itk::Statistics::GaussianMixtureModelComponent< TSample >::Superclass

Reimplemented from itk::Statistics::MixtureModelComponentBase< TSample >. Definition at line 54 of file itkGaussianMixtureModelComponent.h.

template<class TSample> typedef Superclass::WeightArrayType itk::Statistics::GaussianMixtureModelComponent< TSample >::WeightArrayType

typedef of strorage for the weights Reimplemented from itk::Statistics::MixtureModelComponentBase< TSample >. Definition at line 68 of file itkGaussianMixtureModelComponent.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 94 of file itkGaussianMixtureModelComponent.h.

---

Member Function Documentation

template<class TSample> bool itk::Statistics::MixtureModelComponentBase< TSample >::AreParametersModified (   )  [inherited]

returns the value of parameter modified tag

template<class TSample> void itk::Statistics::MixtureModelComponentBase< TSample >::AreParametersModified (  bool  flag  )  [inherited]

sets the parameters modified tag. if one or more of the membership funtion's parameters are changed, then flag should be true

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

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

template<class TSample> double itk::Statistics::GaussianMixtureModelComponent< TSample >::CalculateParametersChange (   )  [protected]

Returns the sum of squared changes in parameters between iterations

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.

template<class TSample> void itk::Statistics::MixtureModelComponentBase< TSample >::CreateWeightArray (   )  [protected, inherited]

allocates the weights array

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::MixtureModelComponentBase< TSample >::DeleteWeightArray (   )  [protected, inherited]

deallocates the weights array

template<class TSample> double itk::Statistics::MixtureModelComponentBase< TSample >::Evaluate (  MeasurementVectorType &  measurements  )  [inherited]

returns the membership score of the "measurements" vector

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

Computes the new distribution parameters Reimplemented from itk::Statistics::MixtureModelComponentBase< 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.

template<class TSample> virtual ParametersType itk::Statistics::MixtureModelComponentBase< TSample >::GetFullParameters (   )  [inline, virtual, inherited]

Definition at line 100 of file itkMixtureModelComponentBase.h.

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

template<class TSample> MembershipFunctionType* itk::Statistics::MixtureModelComponentBase< TSample >::GetMembershipFunction (   )  [inherited]

returns the pointer to the membership function object. Subclasses of this class are responsible for creating the actual membership function objects and cast them to MembershipFunctionBase objects

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.

template<class TSample> double itk::Statistics::MixtureModelComponentBase< TSample >::GetMinimalParametersChange (   )  [inline, inherited]

Definition at line 95 of file itkMixtureModelComponentBase.h.

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::GaussianMixtureModelComponent< TSample >::GetNameOfClass (   )  const [virtual]

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

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> const TSample* itk::Statistics::MixtureModelComponentBase< TSample >::GetSample (   )  const [inherited]

returns the sample pointer

template<class TSample> double itk::Statistics::MixtureModelComponentBase< TSample >::GetWeight (  int  index  )  [inherited]

returns the index-th weight

template<class TSample> WeightArrayType* itk::Statistics::MixtureModelComponentBase< TSample >::GetWeights (   )  [inherited]

returns the pointer to 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::GaussianMixtureModelComponent< TSample >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Statistics::MixtureModelComponentBase< 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::GaussianMixtureModelComponent< 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::MixtureModelComponentBase< 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.

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

template<class TSample> void itk::Statistics::MixtureModelComponentBase< TSample >::SetMembershipFunction (  MembershipFunctionType *  function  )  [protected, inherited]

stores the pointer to the membership function. subclasses use this funtion to store their membership function object after dynamic creation

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

Returns: Set the MetaDataDictionary

template<class TSample> void itk::Statistics::MixtureModelComponentBase< TSample >::SetMinimalParametersChange (  double  change  )  [inline, inherited]

Definition at line 92 of file itkMixtureModelComponentBase.h.

template<class TSample> void itk::Statistics::GaussianMixtureModelComponent< TSample >::SetParameters (  const ParametersType &  parameters  )  [virtual]

Sets the component's distribution parameters. Reimplemented from itk::Statistics::MixtureModelComponentBase< TSample >.

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::GaussianMixtureModelComponent< TSample >::SetSample (  const TSample *  sample  )  [virtual]

Sets the input sample Reimplemented from itk::Statistics::MixtureModelComponentBase< TSample >.

template<class TSample> void itk::Statistics::MixtureModelComponentBase< TSample >::SetWeight (  int  index, double  value )  [inherited]

sets the index-th weight with the "value"

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

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

template<class TSample> virtual void itk::Statistics::MixtureModelComponentBase< TSample >::Update (   )  [virtual, inherited]

---

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:

• itkGaussianMixtureModelComponent.h

---