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

#include <itkExpectationMaximizationMixtureModelEstimator.h>

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

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

[legend]List of all members.

---

Detailed Description

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

This class generates the parameter estimates for a mixture model using expectation maximization strategy.

The first template argument is the type of the target sample data. This estimator expects one or more mixture model component objects of the classes derived from the MixtureModelComponentBase. The actual component (or module) parameters are updated by each component. Users can think this class as a strategy or a integration point for the EM procedure. The initial proportion (SetInitialProportions), the input sample (SetSample), the mixture model components (AddComponent), and the maximum iteration (SetMaximumIteration) are required. The EM procedure terminates when the current iteration reaches the maximum iteration or the model parameters converge.

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, GaussianMixtureModelComponent

Definition at line 53 of file itkExpectationMaximizationMixtureModelEstimator.h.

Public Types
typedef MembershipFunctionBase< MeasurementVectorType >	ComponentMembershipFunctionType
typedef MixtureModelComponentBase< TSample >	ComponentType
typedef std::vector< ComponentType * >	ComponentVectorType
typedef SmartPointer< const Self >	ConstPointer
typedef TSample::MeasurementType	MeasurementType
typedef TSample::MeasurementVectorType	MeasurementVectorType
typedef SmartPointer< Self >	Pointer
typedef Array< double >	ProportionVectorType
typedef ExpectationMaximizationMixtureModelEstimator	Self
typedef Object	Superclass
enum	TERMINATION_CODE {   CONVERGED = 0,   NOT_CONVERGED = 1 }
Public Member Functions
int	AddComponent (ComponentType *component)
Set Gets the initial proportion values The size of proportion *vector should be same as the number of	component (or classes)*/void SetInitialProportions(ProportionVectorType &propotion)
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
ComponentMembershipFunctionType *	GetComponentMembershipFunction (int componentIndex)
int	GetCurrentIteration ()
bool	GetDebug () const
ProportionVectorType *	GetInitialProportions ()
int	GetMaximumIteration ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
Standard macros *virtual const char *	GetNameOfClass () const
unsigned int	GetNumberOfComponents ()
ProportionVectorType *	GetProportions ()
virtual int	GetReferenceCount () const
const TSample *	GetSample () const
TERMINATION_CODE	GetTerminationCode ()
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
Set Gets the maximum number of iterations When the optimization *process reaches the maximum number of even if the *class parameters aren t converged the optimization process *stops *void	SetMaximumIteration (int numberOfIterations)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
void	SetSample (const TSample *sample)
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
Set Gets the maximum number of iterations When the optimization *process reaches the maximum number of	interations
Protected Member Functions
bool	CalculateDensities ()
double	CalculateExpectation ()
	ExpectationMaximizationMixtureModelEstimator ()
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
bool	UpdateComponentParameters ()
bool	UpdateProportions ()
virtual	~ExpectationMaximizationMixtureModelEstimator ()
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 MembershipFunctionBase< MeasurementVectorType > itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::ComponentMembershipFunctionType

Type of the membership function base class Definition at line 80 of file itkExpectationMaximizationMixtureModelEstimator.h.

template<class TSample> typedef MixtureModelComponentBase< TSample > itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::ComponentType

Type of the mixture model component base class Definition at line 73 of file itkExpectationMaximizationMixtureModelEstimator.h.

template<class TSample> typedef std::vector< ComponentType* > itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::ComponentVectorType

Type of the component pointer storage Definition at line 76 of file itkExpectationMaximizationMixtureModelEstimator.h.

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

Reimplemented from itk::Object. Definition at line 60 of file itkExpectationMaximizationMixtureModelEstimator.h.

template<class TSample> typedef TSample::MeasurementType itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::MeasurementType

TSample template argument related typedefs Definition at line 65 of file itkExpectationMaximizationMixtureModelEstimator.h.

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

Definition at line 70 of file itkExpectationMaximizationMixtureModelEstimator.h.

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

Reimplemented from itk::Object. Definition at line 59 of file itkExpectationMaximizationMixtureModelEstimator.h.

template<class TSample> typedef Array< double > itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::ProportionVectorType

Type of the array of the proportion values Definition at line 83 of file itkExpectationMaximizationMixtureModelEstimator.h.

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

Standard class typedef Reimplemented from itk::Object. Definition at line 57 of file itkExpectationMaximizationMixtureModelEstimator.h.

template<class TSample> typedef Object itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::Superclass

Reimplemented from itk::Object. Definition at line 58 of file itkExpectationMaximizationMixtureModelEstimator.h.

---

Member Enumeration Documentation

template<class TSample> enum itk::Statistics::ExpectationMaximizationMixtureModelEstimator::TERMINATION_CODE

Termination status after running optimization Enumeration values: CONVERGED  NOT_CONVERGED  Definition at line 122 of file itkExpectationMaximizationMixtureModelEstimator.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 133 of file itkExpectationMaximizationMixtureModelEstimator.h.

---

Member Function Documentation

template<class TSample> int itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::AddComponent (  ComponentType *  component  )

Adds a new component (or class).

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> bool itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::CalculateDensities (   )  [protected]

template<class TSample> double itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::CalculateExpectation (   )  [protected]

template<class TSample> Set Gets the initial proportion values The size of proportion* vector should be same as the number of itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::component (  or  classes  )

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::ExpectationMaximizationMixtureModelEstimator< TSample >::GenerateData (   )  [protected]

Starts the estimation process

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.

template<class TSample> ComponentMembershipFunctionType* itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::GetComponentMembershipFunction (  int  componentIndex  )

Gets the membership function specified by componentIndex argument.

template<class TSample> int itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::GetCurrentIteration (   )  [inline]

Gets the current iteration. Definition at line 109 of file itkExpectationMaximizationMixtureModelEstimator.h.

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

Get the value of the debug flag.

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

template<class TSample> ProportionVectorType* itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::GetInitialProportions (   )

template<class TSample> int itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::GetMaximumIteration (   )

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

Standard part of all itk objects. Reimplemented from itk::Object.

template<class TSample> unsigned int itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::GetNumberOfComponents (   )

Gets the total number of classes currently plugged in.

template<class TSample> ProportionVectorType* itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::GetProportions (   )

Gets the result proportion values

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::ExpectationMaximizationMixtureModelEstimator< TSample >::GetSample (   )  const

Returns the target data

template<class TSample> TERMINATION_CODE itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::GetTerminationCode (   )

Gets the termination status

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::ExpectationMaximizationMixtureModelEstimator< TSample >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

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::ExpectationMaximizationMixtureModelEstimator< 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::Object.

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> Set Gets the maximum number of iterations When the optimization* process reaches the maximum number of even if the* class parameters aren t converged the optimization process* stops* void itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::SetMaximumIteration (  int  numberOfIterations  )

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::ExpectationMaximizationMixtureModelEstimator< TSample >::SetSample (  const TSample *  sample  )

Sets the target data that will be classified by this

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

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

template<class TSample> void itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::Update (   )

Runs the optimization process.

template<class TSample> bool itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::UpdateComponentParameters (   )  [protected]

template<class TSample> bool itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::UpdateProportions (   )  [protected]

---

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.

template<class TSample> Set Gets the maximum number of iterations When the optimization* process reaches the maximum number of itk::Statistics::ExpectationMaximizationMixtureModelEstimator< TSample >::interations

Definition at line 101 of file itkExpectationMaximizationMixtureModelEstimator.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:

• itkExpectationMaximizationMixtureModelEstimator.h

---