itk::Statistics::MahalanobisDistanceMembershipFunction< TVector > Class Template Reference

#include <itkMahalanobisDistanceMembershipFunction.h>

Inheritance diagram for itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >:

[legend]Collaboration diagram for itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >:

[legend]List of all members.

---

Detailed Description

template<class TVector>
class itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >

MahalanobisDistanceMembershipFunction class represents MahalanobisDistance Density Function.

This class keeps parameter to define MahalanobisDistance Density Function and has method to return the probability density of an instance. MeasurementVectorSize is the dimension of measurement space. double is type of measurement.

Definition at line 44 of file itkMahalanobisDistanceMembershipFunction.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef vnl_matrix< double >	CovarianceMatrixType
typedef TVector	InputType
typedef vnl_vector< double >	MeanVectorType
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef TVector	MeasurementVectorType
typedef double	OutputType
typedef SmartPointer< Self >	Pointer
typedef MahalanobisDistanceMembershipFunction	Self
typedef MembershipFunctionBase< TVector >	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual OutputType	Evaluate (const InputType &input) const =0
virtual double	Evaluate (const TVector &x) const =0
double	Evaluate (const MeasurementVectorType &measurement) const
Command *	GetCommand (unsigned long tag)
virtual const CovarianceMatrixType &	GetCovariance ()
bool	GetDebug () const
virtual const CovarianceMatrixType &	GetInverseCovariance ()
const MeanVectorType &	GetMean () const
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
Strandard macros *virtual const char *	GetNameOfClass () const
virtual double	GetNumberOfSamples ()
virtual int	GetReferenceCount () const
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	SetCovariance (const CovarianceMatrixType &cov)
void	SetDebug (bool debugFlag) const
void	SetInverseCovariance (const CovarianceMatrixType &invcov)
void	SetMean (const Array< double > &mean)
Method to set mean *void	SetMean (const MeanVectorType &mean)
Set Get Macros to set the length of each measurement vector *virtual void	SetMeasurementVectorSize (MeasurementVectorSizeType _arg)
virtual void	SetMeasurementVectorSize (const MeasurementVectorSizeType)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetNumberOfSamples (double _arg)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
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
	FunctionBase ()
	MahalanobisDistanceMembershipFunction (void)
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
virtual	~MahalanobisDistanceMembershipFunction (void)
Protected Attributes
MeasurementVectorSizeType	m_MeasurementVectorSize
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 TVector> typedef SmartPointer<const Self> itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::ConstPointer

Reimplemented from itk::Statistics::MembershipFunctionBase< TVector >. Definition at line 52 of file itkMahalanobisDistanceMembershipFunction.h.

template<class TVector> typedef vnl_matrix<double> itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::CovarianceMatrixType

Type used for representing the covariance matrix Definition at line 69 of file itkMahalanobisDistanceMembershipFunction.h.

typedef TVector itk::FunctionBase< TVector , double >::InputType [inherited]

Input type Definition at line 54 of file itkFunctionBase.h.

template<class TVector> typedef vnl_vector<double> itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::MeanVectorType

Type used for representing the mean vector Definition at line 66 of file itkMahalanobisDistanceMembershipFunction.h.

template<class TVector> typedef Superclass::MeasurementVectorSizeType itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::MeasurementVectorSizeType

Typedef to represent the length of measurement vectors Reimplemented from itk::Statistics::MembershipFunctionBase< TVector >. Definition at line 63 of file itkMahalanobisDistanceMembershipFunction.h.

template<class TVector> typedef TVector itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::MeasurementVectorType

Typedef alias for the measurement vectors Definition at line 56 of file itkMahalanobisDistanceMembershipFunction.h.

typedef double itk::FunctionBase< TVector , double >::OutputType [inherited]

Output type Definition at line 60 of file itkFunctionBase.h.

template<class TVector> typedef SmartPointer<Self> itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::Pointer

Reimplemented from itk::Statistics::MembershipFunctionBase< TVector >. Definition at line 51 of file itkMahalanobisDistanceMembershipFunction.h.

template<class TVector> typedef MahalanobisDistanceMembershipFunction itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::Self

Standard class typedefs Reimplemented from itk::Statistics::MembershipFunctionBase< TVector >. Definition at line 49 of file itkMahalanobisDistanceMembershipFunction.h.

template<class TVector> typedef MembershipFunctionBase< TVector > itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::Superclass

Reimplemented from itk::Statistics::MembershipFunctionBase< TVector >. Definition at line 50 of file itkMahalanobisDistanceMembershipFunction.h.

---

Constructor & Destructor Documentation

template<class TVector> itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::MahalanobisDistanceMembershipFunction (  void   )  [protected]

template<class TVector> virtual itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::~MahalanobisDistanceMembershipFunction (  void   )  [inline, protected, virtual]

Definition at line 113 of file itkMahalanobisDistanceMembershipFunction.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.

virtual OutputType itk::FunctionBase< TVector , double >::Evaluate (  const InputType &  input  )  const [pure virtual, inherited]

Evaluate at the specified input position

template<class TVector> virtual double itk::Statistics::MembershipFunctionBase< TVector >::Evaluate (  const TVector &  x  )  const [pure virtual, inherited]

Method to get membership score (discriminant score) of an entity. Implemented in itk::Statistics::DensityFunction< TMeasurementVector >, itk::Statistics::DistanceMetric< TVector >, itk::Statistics::EuclideanDistance< TVector >, itk::Statistics::DistanceMetric< ParameterType >, and itk::Statistics::EuclideanDistance< ParameterType >.

template<class TVector> double itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::Evaluate (  const MeasurementVectorType &  measurement  )  const

Method to get probability of an instance. The return value is the value of the density function, not probability.

itk::FunctionBase< TVector , double >::FunctionBase (   )  [inline, protected, inherited]

Definition at line 66 of file itkFunctionBase.h.

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 TVector> virtual const CovarianceMatrixType& itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::GetCovariance (   )  [virtual]

Method to get covariance matrix

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

Get the value of the debug flag.

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

template<class TVector> virtual const CovarianceMatrixType& itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::GetInverseCovariance (   )  [virtual]

Method to get covariance matrix

template<class TVector> const MeanVectorType& itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::GetMean (   )  const

Method to get mean

template<class TVector> virtual MeasurementVectorSizeType itk::Statistics::MembershipFunctionBase< TVector >::GetMeasurementVectorSize (   )  const [virtual, inherited]

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 TVector> Strandard macros* virtual const char* itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::GetNameOfClass (   )  const [virtual]

Strandard macros Reimplemented from itk::Statistics::MembershipFunctionBase< TVector >.

template<class TVector> virtual double itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::GetNumberOfSamples (   )  [virtual]

Method to get the number of samples

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

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

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 TVector> static Pointer itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::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 TVector> void itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::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::MembershipFunctionBase< TVector >.

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.

template<class TVector> void itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::SetCovariance (  const CovarianceMatrixType &  cov  )

Method to set covariance matrix Also, this function calculates inverse covariance and pre factor of MahalanobisDistance Distribution to speed up GetProbability

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 TVector> void itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::SetInverseCovariance (  const CovarianceMatrixType &  invcov  )

Method to set covariance matrix Also, this function calculates inverse covariance and pre factor of MahalanobisDistance Distribution to speed up GetProbability

template<class TVector> void itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::SetMean (  const Array< double > &  mean  )

template<class TVector> Method to set mean* void itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::SetMean (  const MeanVectorType &  mean  )

template<class TVector> Set Get Macros to set the length of each measurement vector* virtual void itk::Statistics::MembershipFunctionBase< TVector >::SetMeasurementVectorSize (  MeasurementVectorSizeType  _arg  )  [virtual, inherited]

template<class TVector> virtual void itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::SetMeasurementVectorSize (  const   MeasurementVectorSizeType  )  [virtual]

Set the length of each measurement vector.

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

Returns: Set the MetaDataDictionary

template<class TVector> virtual void itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >::SetNumberOfSamples (  double  _arg  )  [virtual]

Method to set the number of samples

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

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

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

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

---

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 TVector> MeasurementVectorSizeType itk::Statistics::MembershipFunctionBase< TVector >::m_MeasurementVectorSize [protected, inherited]

Definition at line 74 of file itkMembershipFunctionBase.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:

• itkMahalanobisDistanceMembershipFunction.h

---