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

#include <itkMixtureModelComponentBase.h>

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

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

[legend]List of all members.

---

Detailed Description

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

base class for distribution modules that supports analytical way to update the distribution parameters

This class expects that its subclasses (distribution components) should have analytical expressions for updating its paraters using only the measurement vectors and their associated weights.

This class can be considered as a macro class that encapsulates the storage for the weights, model (subclasses of MembershipFunctionBase), and model parameter estimators (implemenation of analytical expressions).

Subclasses of this class should define their own distribution specific membership function. For example, GaussianMixtureModelComponent class defines and creates a GaussianDensityFunction object for that matter. Subclasses should also cast such membership function object to MembershipFunctionBase object. By doing that, users can get pointers to membership functions from different distributional model

See also:

ExpectationMaximizationMixtureModelEstimator

Definition at line 53 of file itkMixtureModelComponentBase.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TSample::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef TSample::MeasurementVectorType	MeasurementVectorType
typedef MembershipFunctionBase< MeasurementVectorType >	MembershipFunctionType
typedef Array< double >	ParametersType
typedef SmartPointer< Self >	Pointer
typedef MixtureModelComponentBase	Self
typedef Object	Superclass
typedef Array< double >	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)
virtual void	SetParameters (const ParametersType &parameters)
virtual void	SetReferenceCount (int)
virtual 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
void	CreateWeightArray ()
void	DeleteWeightArray ()
virtual void	GenerateData ()
	MixtureModelComponentBase ()
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	~MixtureModelComponentBase ()
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::MixtureModelComponentBase< TSample >::ConstPointer

Reimplemented from itk::Object. Reimplemented in itk::Statistics::GaussianMixtureModelComponent< TSample >. Definition at line 61 of file itkMixtureModelComponentBase.h.

template<class TSample> typedef TSample::MeasurementVectorSizeType itk::Statistics::MixtureModelComponentBase< TSample >::MeasurementVectorSizeType

Reimplemented in itk::Statistics::GaussianMixtureModelComponent< TSample >. Definition at line 69 of file itkMixtureModelComponentBase.h.

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

Reimplemented in itk::Statistics::GaussianMixtureModelComponent< TSample >. Definition at line 65 of file itkMixtureModelComponentBase.h.

template<class TSample> typedef MembershipFunctionBase< MeasurementVectorType > itk::Statistics::MixtureModelComponentBase< TSample >::MembershipFunctionType

typedef for the MembershipFunctionBase Reimplemented in itk::Statistics::GaussianMixtureModelComponent< TSample >. Definition at line 73 of file itkMixtureModelComponentBase.h.

template<class TSample> typedef Array< double > itk::Statistics::MixtureModelComponentBase< TSample >::ParametersType

Reimplemented in itk::Statistics::GaussianMixtureModelComponent< TSample >. Definition at line 78 of file itkMixtureModelComponentBase.h.

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

Reimplemented from itk::Object. Reimplemented in itk::Statistics::GaussianMixtureModelComponent< TSample >. Definition at line 60 of file itkMixtureModelComponentBase.h.

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

Standard class typedefs. Reimplemented from itk::Object. Reimplemented in itk::Statistics::GaussianMixtureModelComponent< TSample >. Definition at line 58 of file itkMixtureModelComponentBase.h.

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

Reimplemented from itk::Object. Reimplemented in itk::Statistics::GaussianMixtureModelComponent< TSample >. Definition at line 59 of file itkMixtureModelComponentBase.h.

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

typedef of strorage for the weights Reimplemented in itk::Statistics::GaussianMixtureModelComponent< TSample >. Definition at line 76 of file itkMixtureModelComponentBase.h.

---

Constructor & Destructor Documentation

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

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

---

Member Function Documentation

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

returns the value of parameter modified tag

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

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.

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]

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]

deallocates the weights array

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

returns the membership score of the "measurements" vector

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

Reimplemented in itk::Statistics::GaussianMixtureModelComponent< 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]

Definition at line 100 of file itkMixtureModelComponentBase.h.

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

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

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]

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

Standard part of all itk objects. Reimplemented from itk::Object. Reimplemented in itk::Statistics::GaussianMixtureModelComponent< 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

returns the sample pointer

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

returns the index-th weight

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

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

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

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]

Definition at line 92 of file itkMixtureModelComponentBase.h.

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

Reimplemented in itk::Statistics::GaussianMixtureModelComponent< TSample >.

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

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

template<class TSample> virtual void itk::Statistics::MixtureModelComponentBase< TSample >::SetSample (  const TSample *  sample  )  [virtual]

stores the sample pointer Reimplemented in itk::Statistics::GaussianMixtureModelComponent< TSample >.

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

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]

---

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:

• itkMixtureModelComponentBase.h

---