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

#include <itkMahalanobisDistanceMetric.h>

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

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

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef vnl_matrix< double >	CovarianceMatrixType
typedef Superclass::OriginType	MeanVectorType
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef SmartPointer< Self >	Pointer
typedef MahalanobisDistanceMetric	Self
typedef DistanceMetric< TVector >	Superclass
Public Member Functions
double	Evaluate (const MeasurementVectorType &measurement) const
double	Evaluate (const MeasurementVectorType &x1, const MeasurementVectorType &x2) const
virtual const CovarianceMatrixType &	GetCovariance ()
virtual double	GetDoubleMax () const
virtual const CovarianceMatrixType &	GetInverseCovariance ()
const MeanVectorType &	GetMean () 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)

virtual void	SetEpsilon (double _arg)
virtual double	GetEpsilon () const
Protected Member Functions
	MahalanobisDistanceMetric (void)
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~MahalanobisDistanceMetric (void)
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 (void) const
static Pointer	New ()

Detailed Description

template<class 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.

Member Typedef Documentation

template<class TVector >

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

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

Definition at line 54 of file itkMahalanobisDistanceMetric.h.

template<class 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<class 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<class TVector >

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

Typedef to represent the length of measurement vectors

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

Definition at line 65 of file itkMahalanobisDistanceMetric.h.

template<class TVector >

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

Typedef to represent the measurement vector type

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

Definition at line 58 of file itkMahalanobisDistanceMetric.h.

template<class TVector >

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

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

Definition at line 53 of file itkMahalanobisDistanceMetric.h.

template<class TVector >

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

Standard class typedefs

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

Definition at line 51 of file itkMahalanobisDistanceMetric.h.

template<class TVector >

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

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

Definition at line 52 of file itkMahalanobisDistanceMetric.h.

Constructor & Destructor Documentation

template<class TVector >

itk::Statistics::MahalanobisDistanceMetric< TVector >::MahalanobisDistanceMetric ( void ) [protected]

template<class TVector >

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

Definition at line 115 of file itkMahalanobisDistanceMetric.h.

Member Function Documentation

template<class TVector >

void itk::Statistics::MahalanobisDistanceMetric< TVector >::CalculateInverseCovariance ( ) [private]

template<class TVector >

virtual::itk::LightObject::Pointer itk::Statistics::MahalanobisDistanceMetric< TVector >::CreateAnother ( void ) const [virtual]

Strandard macros

Reimplemented from itk::Object.

template<class TVector >

double itk::Statistics::MahalanobisDistanceMetric< TVector >::Evaluate ( const MeasurementVectorType & measurement ) const [virtual]

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<class TVector >

double itk::Statistics::MahalanobisDistanceMetric< TVector >::Evaluate	(	const MeasurementVectorType &	x1,
		const MeasurementVectorType &	x2
	)		const `[virtual]`

Gets the distance between x1 and x2.

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

template<class TVector >

virtual const CovarianceMatrixType& itk::Statistics::MahalanobisDistanceMetric< TVector >::GetCovariance ( ) [virtual]

Method to get covariance matrix

template<class TVector >

virtual double itk::Statistics::MahalanobisDistanceMetric< TVector >::GetDoubleMax ( ) const [virtual]

template<class TVector >

virtual double itk::Statistics::MahalanobisDistanceMetric< TVector >::GetEpsilon ( ) const [virtual]

Set/Get tolerance values

template<class TVector >

virtual const CovarianceMatrixType& itk::Statistics::MahalanobisDistanceMetric< TVector >::GetInverseCovariance ( ) [virtual]

Method to get covariance matrix

template<class TVector >

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

Method to get mean

template<class TVector >

virtual const char* itk::Statistics::MahalanobisDistanceMetric< TVector >::GetNameOfClass ( ) const [virtual]

Strandard macros

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

template<class TVector >

static Pointer itk::Statistics::MahalanobisDistanceMetric< TVector >::New ( ) [static]

Strandard macros

Reimplemented from itk::Object.

template<class TVector >

void itk::Statistics::MahalanobisDistanceMetric< TVector >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const `[protected, virtual]`

Get method for the length of the measurement vector

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

template<class 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<class TVector >

virtual void itk::Statistics::MahalanobisDistanceMetric< TVector >::SetDoubleMax ( double _arg ) [virtual]

template<class TVector >

virtual void itk::Statistics::MahalanobisDistanceMetric< TVector >::SetEpsilon ( double _arg ) [virtual]

Set/Get tolerance values

template<class TVector >

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

Method to set inverse covariance matrix

template<class TVector >

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

Method to set mean

template<class TVector >

virtual void itk::Statistics::MahalanobisDistanceMetric< TVector >::SetMeasurementVectorSize ( MeasurementVectorSizeType ) [virtual]

Set the length of each measurement vector.

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

Member Data Documentation

template<class TVector >

CovarianceMatrixType itk::Statistics::MahalanobisDistanceMetric< TVector >::m_Covariance [private]

Definition at line 120 of file itkMahalanobisDistanceMetric.h.

template<class TVector >

double itk::Statistics::MahalanobisDistanceMetric< TVector >::m_DoubleMax [private]

Definition at line 127 of file itkMahalanobisDistanceMetric.h.

template<class TVector >

double itk::Statistics::MahalanobisDistanceMetric< TVector >::m_Epsilon [private]

Definition at line 126 of file itkMahalanobisDistanceMetric.h.

template<class TVector >

CovarianceMatrixType itk::Statistics::MahalanobisDistanceMetric< TVector >::m_InverseCovariance [private]

Definition at line 124 of file itkMahalanobisDistanceMetric.h.

template<class TVector >

MeanVectorType itk::Statistics::MahalanobisDistanceMetric< TVector >::m_Mean [private]

Definition at line 119 of file itkMahalanobisDistanceMetric.h.

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

itkMahalanobisDistanceMetric.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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