ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::Statistics::MahalanobisDistanceMetric< TVector > Class Template Reference

#include <itkMahalanobisDistanceMetric.h>

+ Inheritance diagram for itk::Statistics::MahalanobisDistanceMetric< TVector >:
+ Collaboration diagram for itk::Statistics::MahalanobisDistanceMetric< TVector >:

Detailed Description

template<typename TVector>
class itk::Statistics::MahalanobisDistanceMetric< TVector >

MahalanobisDistanceMetric class computes a Mahalanobis distance given a mean and covariance.

See Also
DistanceMetric
EuclideanDistanceMetric
EuclideanSquareDistanceMetric

Definition at line 46 of file itkMahalanobisDistanceMetric.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef vnl_matrix< double > CovarianceMatrixType
 
typedef Superclass::OriginType MeanVectorType
 
typedef
Superclass::MeasurementVectorSizeType 
MeasurementVectorSizeType
 
typedef
Superclass::MeasurementVectorType 
MeasurementVectorType
 
typedef SmartPointer< SelfPointer
 
typedef MahalanobisDistanceMetric Self
 
typedef DistanceMetric< TVector > Superclass
 
- Public Types inherited from itk::Statistics::DistanceMetric< TVector >
typedef SmartPointer< const SelfConstPointer
 
typedef unsigned int MeasurementVectorSizeType
 
typedef TVector MeasurementVectorType
 
typedef Array< double > OriginType
 
typedef SmartPointer< SelfPointer
 
typedef DistanceMetric Self
 
typedef FunctionBase< TVector,
double > 
Superclass
 
- Public Types inherited from itk::FunctionBase< TVector, double >
typedef SmartPointer< const SelfConstPointer
 
typedef TVector InputType
 
typedef double OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

double Evaluate (const MeasurementVectorType &measurement) const override
 
double Evaluate (const MeasurementVectorType &x1, const MeasurementVectorType &x2) const override
 
virtual const
CovarianceMatrixType
GetCovariance () const
 
virtual double GetDoubleMax () const
 
virtual const
CovarianceMatrixType
GetInverseCovariance () const
 
const MeanVectorTypeGetMean () const
 
void SetCovariance (const CovarianceMatrixType &cov)
 
virtual void SetDoubleMax (double _arg)
 
void SetInverseCovariance (const CovarianceMatrixType &invcov)
 
void SetMean (const MeanVectorType &mean)
 
virtual void SetMeasurementVectorSize (MeasurementVectorSizeType) override
 
virtual void SetEpsilon (double _arg)
 
virtual double GetEpsilon () const
 
- Public Member Functions inherited from itk::Statistics::DistanceMetric< TVector >
virtual MeasurementVectorSizeType GetMeasurementVectorSize () const
 
virtual const OriginTypeGetOrigin () const
 
void SetOrigin (const OriginType &x)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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

 MahalanobisDistanceMetric ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~MahalanobisDistanceMetric (void)
 
- Protected Member Functions inherited from itk::Statistics::DistanceMetric< TVector >
 DistanceMetric ()
 
virtual ~DistanceMetric ()
 
- Protected Member Functions inherited from itk::FunctionBase< TVector, double >
 FunctionBase ()
 
 ~FunctionBase ()
 
- 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 Member Functions

void CalculateInverseCovariance ()
 

Private Attributes

CovarianceMatrixType m_Covariance
 
double m_DoubleMax
 
double m_Epsilon
 
CovarianceMatrixType m_InverseCovariance
 
MeanVectorType m_Mean
 
virtual const char * GetNameOfClass () const
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
static Pointer New ()
 

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 Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TVector >
typedef SmartPointer< const Self > itk::Statistics::MahalanobisDistanceMetric< TVector >::ConstPointer

Definition at line 54 of file itkMahalanobisDistanceMetric.h.

template<typename TVector >
typedef vnl_matrix< double > itk::Statistics::MahalanobisDistanceMetric< TVector >::CovarianceMatrixType

Type used for representing the covariance matrix

Definition at line 71 of file itkMahalanobisDistanceMetric.h.

template<typename TVector >
typedef Superclass::OriginType itk::Statistics::MahalanobisDistanceMetric< TVector >::MeanVectorType

Type used for representing the mean vector

Definition at line 68 of file itkMahalanobisDistanceMetric.h.

template<typename TVector >
typedef Superclass::MeasurementVectorSizeType itk::Statistics::MahalanobisDistanceMetric< TVector >::MeasurementVectorSizeType

Typedef to represent the length of measurement vectors

Definition at line 65 of file itkMahalanobisDistanceMetric.h.

template<typename TVector >
typedef Superclass::MeasurementVectorType itk::Statistics::MahalanobisDistanceMetric< TVector >::MeasurementVectorType

Typedef to represent the measurement vector type

Definition at line 58 of file itkMahalanobisDistanceMetric.h.

template<typename TVector >
typedef SmartPointer< Self > itk::Statistics::MahalanobisDistanceMetric< TVector >::Pointer

Definition at line 53 of file itkMahalanobisDistanceMetric.h.

template<typename TVector >
typedef MahalanobisDistanceMetric itk::Statistics::MahalanobisDistanceMetric< TVector >::Self

Standard class typedefs

Definition at line 51 of file itkMahalanobisDistanceMetric.h.

template<typename TVector >
typedef DistanceMetric< TVector > itk::Statistics::MahalanobisDistanceMetric< TVector >::Superclass

Definition at line 52 of file itkMahalanobisDistanceMetric.h.

Constructor & Destructor Documentation

template<typename TVector >
itk::Statistics::MahalanobisDistanceMetric< TVector >::MahalanobisDistanceMetric ( )
protected
template<typename TVector >
virtual itk::Statistics::MahalanobisDistanceMetric< TVector >::~MahalanobisDistanceMetric ( void  )
inlineprotectedvirtual

Definition at line 116 of file itkMahalanobisDistanceMetric.h.

Member Function Documentation

template<typename TVector >
void itk::Statistics::MahalanobisDistanceMetric< TVector >::CalculateInverseCovariance ( )
private
template<typename TVector >
virtual::itk::LightObject::Pointer itk::Statistics::MahalanobisDistanceMetric< TVector >::CreateAnother ( ) const
virtual

Strandard macros

Reimplemented from itk::Object.

template<typename TVector >
double itk::Statistics::MahalanobisDistanceMetric< TVector >::Evaluate ( const MeasurementVectorType measurement) const
overridevirtual

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

Implements itk::Statistics::DistanceMetric< TVector >.

template<typename TVector >
double itk::Statistics::MahalanobisDistanceMetric< TVector >::Evaluate ( const MeasurementVectorType x1,
const MeasurementVectorType x2 
) const
overridevirtual

Gets the distance between x1 and x2.

Implements itk::Statistics::DistanceMetric< TVector >.

template<typename TVector >
virtual const CovarianceMatrixType& itk::Statistics::MahalanobisDistanceMetric< TVector >::GetCovariance ( ) const
virtual

Method to get covariance matrix

template<typename TVector >
virtual double itk::Statistics::MahalanobisDistanceMetric< TVector >::GetDoubleMax ( ) const
virtual
template<typename TVector >
virtual double itk::Statistics::MahalanobisDistanceMetric< TVector >::GetEpsilon ( ) const
virtual

Set/Get tolerance values

template<typename TVector >
virtual const CovarianceMatrixType& itk::Statistics::MahalanobisDistanceMetric< TVector >::GetInverseCovariance ( ) const
virtual

Method to get covariance matrix

template<typename TVector >
const MeanVectorType& itk::Statistics::MahalanobisDistanceMetric< TVector >::GetMean ( ) const

Method to get mean

template<typename TVector >
virtual const char* itk::Statistics::MahalanobisDistanceMetric< TVector >::GetNameOfClass ( ) const
virtual

Strandard macros

Reimplemented from itk::Statistics::DistanceMetric< TVector >.

template<typename TVector >
static Pointer itk::Statistics::MahalanobisDistanceMetric< TVector >::New ( )
static

Strandard macros

template<typename TVector >
void itk::Statistics::MahalanobisDistanceMetric< TVector >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::DistanceMetric< TVector >.

template<typename TVector >
void itk::Statistics::MahalanobisDistanceMetric< 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

template<typename TVector >
virtual void itk::Statistics::MahalanobisDistanceMetric< TVector >::SetDoubleMax ( double  _arg)
virtual
template<typename TVector >
virtual void itk::Statistics::MahalanobisDistanceMetric< TVector >::SetEpsilon ( double  _arg)
virtual

Set/Get tolerance values

template<typename TVector >
void itk::Statistics::MahalanobisDistanceMetric< TVector >::SetInverseCovariance ( const CovarianceMatrixType invcov)

Method to set inverse covariance matrix

template<typename TVector >
void itk::Statistics::MahalanobisDistanceMetric< TVector >::SetMean ( const MeanVectorType mean)

Method to set mean

template<typename TVector >
virtual void itk::Statistics::MahalanobisDistanceMetric< TVector >::SetMeasurementVectorSize ( MeasurementVectorSizeType  )
overridevirtual

Set the length of each measurement vector.

Reimplemented from itk::Statistics::DistanceMetric< TVector >.

Member Data Documentation

template<typename TVector >
CovarianceMatrixType itk::Statistics::MahalanobisDistanceMetric< TVector >::m_Covariance
private

Definition at line 121 of file itkMahalanobisDistanceMetric.h.

template<typename TVector >
double itk::Statistics::MahalanobisDistanceMetric< TVector >::m_DoubleMax
private

Definition at line 128 of file itkMahalanobisDistanceMetric.h.

template<typename TVector >
double itk::Statistics::MahalanobisDistanceMetric< TVector >::m_Epsilon
private

Definition at line 127 of file itkMahalanobisDistanceMetric.h.

template<typename TVector >
CovarianceMatrixType itk::Statistics::MahalanobisDistanceMetric< TVector >::m_InverseCovariance
private

Definition at line 125 of file itkMahalanobisDistanceMetric.h.

template<typename TVector >
MeanVectorType itk::Statistics::MahalanobisDistanceMetric< TVector >::m_Mean
private

Definition at line 120 of file itkMahalanobisDistanceMetric.h.


The documentation for this class was generated from the following file: