ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkMixtureModelComponentBase.h>
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
Definition at line 56 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 Types inherited from itk::Object | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef Object | Self |
typedef LightObject | Superclass |
Public Types inherited from itk::LightObject | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
Public Member Functions | |
void | AreParametersModified (bool flag) |
bool | AreParametersModified () |
double | Evaluate (MeasurementVectorType &measurements) |
virtual ParametersType | GetFullParameters () |
MembershipFunctionType * | GetMembershipFunction () |
double | GetMinimalParametersChange () |
virtual const char * | GetNameOfClass () const |
const TSample * | GetSample () const |
double | GetWeight (unsigned int index) const |
virtual const WeightArrayType & | GetWeights () const |
void | SetMinimalParametersChange (double change) |
virtual void | SetParameters (const ParametersType ¶meters) |
virtual void | SetSample (const TSample *sample) |
void | SetWeight (unsigned int index, double value) |
virtual void | Update () |
Public Member Functions inherited from itk::Object | |
unsigned long | AddObserver (const EventObject &event, Command *) |
unsigned long | AddObserver (const EventObject &event, Command *) const |
virtual LightObject::Pointer | CreateAnother () const ITK_OVERRIDE |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
Command * | GetCommand (unsigned long tag) |
bool | GetDebug () const |
MetaDataDictionary & | GetMetaDataDictionary (void) |
const MetaDataDictionary & | GetMetaDataDictionary (void) 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 |
virtual void | Register () const ITK_OVERRIDE |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) ITK_OVERRIDE |
virtual void | UnRegister () const ITK_OVERRIDE |
virtual void | SetObjectName (std::string _arg) |
virtual const std::string & | GetObjectName () const |
Public Member Functions inherited from itk::LightObject | |
virtual void | Delete () |
virtual int | GetReferenceCount () const |
itkCloneMacro (Self) | |
void | Print (std::ostream &os, Indent indent=0) const |
Protected Member Functions | |
virtual void | GenerateData ()=0 |
MixtureModelComponentBase () | |
virtual void | PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE |
void | SetMembershipFunction (MembershipFunctionType *function) |
virtual | ~MixtureModelComponentBase () |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | SetTimeStamp (const TimeStamp &time) |
virtual | ~Object () |
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 () |
Private Attributes | |
MembershipFunctionType * | m_MembershipFunction |
double | m_MinimalParametersChange |
ParametersType | m_Parameters |
bool | m_ParametersModified |
const TSample * | m_Sample |
WeightArrayType | m_Weights |
Additional Inherited Members | |
Static Public Member Functions inherited from itk::Object | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Protected Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
Protected Attributes inherited from itk::LightObject | |
InternalReferenceCountType | m_ReferenceCount |
SimpleFastMutexLock | m_ReferenceCountLock |
typedef SmartPointer< const Self > itk::Statistics::MixtureModelComponentBase< TSample >::ConstPointer |
Definition at line 64 of file itkMixtureModelComponentBase.h.
typedef TSample::MeasurementVectorSizeType itk::Statistics::MixtureModelComponentBase< TSample >::MeasurementVectorSizeType |
Definition at line 70 of file itkMixtureModelComponentBase.h.
typedef TSample::MeasurementVectorType itk::Statistics::MixtureModelComponentBase< TSample >::MeasurementVectorType |
Definition at line 67 of file itkMixtureModelComponentBase.h.
typedef MembershipFunctionBase< MeasurementVectorType > itk::Statistics::MixtureModelComponentBase< TSample >::MembershipFunctionType |
typedef for the MembershipFunctionBase
Definition at line 74 of file itkMixtureModelComponentBase.h.
typedef Array< double > itk::Statistics::MixtureModelComponentBase< TSample >::ParametersType |
Definition at line 79 of file itkMixtureModelComponentBase.h.
typedef SmartPointer< Self > itk::Statistics::MixtureModelComponentBase< TSample >::Pointer |
Definition at line 63 of file itkMixtureModelComponentBase.h.
typedef MixtureModelComponentBase itk::Statistics::MixtureModelComponentBase< TSample >::Self |
Standard class typedefs.
Definition at line 61 of file itkMixtureModelComponentBase.h.
typedef Object itk::Statistics::MixtureModelComponentBase< TSample >::Superclass |
Definition at line 62 of file itkMixtureModelComponentBase.h.
typedef Array< double > itk::Statistics::MixtureModelComponentBase< TSample >::WeightArrayType |
typedef of strorage for the weights
Definition at line 77 of file itkMixtureModelComponentBase.h.
|
protected |
|
protectedvirtual |
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
bool itk::Statistics::MixtureModelComponentBase< TSample >::AreParametersModified | ( | ) |
returns the value of parameter modified tag
double itk::Statistics::MixtureModelComponentBase< TSample >::Evaluate | ( | MeasurementVectorType & | measurements | ) |
returns the membership score of the "measurements" vector
|
protectedpure virtual |
Implemented in itk::Statistics::GaussianMixtureModelComponent< TSample >.
|
inlinevirtual |
Definition at line 105 of file itkMixtureModelComponentBase.h.
References itk::Statistics::MixtureModelComponentBase< TSample >::m_Parameters.
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
|
inline |
Definition at line 98 of file itkMixtureModelComponentBase.h.
References itk::Statistics::MixtureModelComponentBase< TSample >::m_MinimalParametersChange.
|
virtual |
Standard Macros
Reimplemented from itk::Object.
Reimplemented in itk::Statistics::GaussianMixtureModelComponent< TSample >.
const TSample* itk::Statistics::MixtureModelComponentBase< TSample >::GetSample | ( | ) | const |
returns the sample pointer
double itk::Statistics::MixtureModelComponentBase< TSample >::GetWeight | ( | unsigned int | index | ) | const |
returns the index-th weight
|
virtual |
returns the pointer to the weights array
|
protectedvirtual |
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 >.
|
protected |
stores the pointer to the membership function. subclasses use this function to store their membership function object after dynamic creation
|
inline |
Definition at line 93 of file itkMixtureModelComponentBase.h.
References itk::Statistics::MixtureModelComponentBase< TSample >::m_MinimalParametersChange.
|
virtual |
|
virtual |
stores the sample pointer
Reimplemented in itk::Statistics::GaussianMixtureModelComponent< TSample >.
void itk::Statistics::MixtureModelComponentBase< TSample >::SetWeight | ( | unsigned int | index, |
double | value | ||
) |
sets the index-th weight with the "value"
|
virtual |
|
private |
SmartPointer to the memberhip function - usually density function
Definition at line 152 of file itkMixtureModelComponentBase.h.
|
private |
Definition at line 147 of file itkMixtureModelComponentBase.h.
Referenced by itk::Statistics::MixtureModelComponentBase< TSample >::GetMinimalParametersChange(), and itk::Statistics::MixtureModelComponentBase< TSample >::SetMinimalParametersChange().
|
private |
Definition at line 149 of file itkMixtureModelComponentBase.h.
Referenced by itk::Statistics::MixtureModelComponentBase< TSample >::GetFullParameters().
|
private |
indicative flag of membership function's parameter changes
Definition at line 158 of file itkMixtureModelComponentBase.h.
|
private |
target sample data pointer
Definition at line 145 of file itkMixtureModelComponentBase.h.
|
private |
weights array
Definition at line 155 of file itkMixtureModelComponentBase.h.