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

this class declares common interfaces for distance functions. More...

#include <itkDistanceMetric.h>

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

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

[legend]List of all members.

Public Types
typedef DistanceMetric	Self
typedef MembershipFunctionBase< TVector >	Superclass
typedef Vector< double, itkGetStaticConstMacro(VectorLength)	OriginType )
Public Member Functions
	itkStaticConstMacro (VectorLength, unsigned int, TVector::Length)
virtual const char *	GetClassName () const
void	SetOrigin (const OriginType &x)
virtual double	Evaluate (const TVector &x) const =0
virtual double	Evaluate (const TVector &x1, const TVector &x2) const =0
Protected Attributes
OriginType	m_Origin

---

Detailed Description

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

this class declares common interfaces for distance functions.

As a function derived from MembershipFunctionBase, users use Evaluate method to get result.

To use this function in the context of MembershipFunction, users should first set the origin by calling SetOrigin() function, then call Evaluate() method with a point to get the distance between the origin point and the evaluation point.

If users want to the distance between two points without setting the origin point. Use two argument version of Evaluate() function.

Definition at line 43 of file itkDistanceMetric.h.

---

Member Typedef Documentation

template<class TVector> typedef Vector< double, itkGetStaticConstMacro(VectorLength) itk::Statistics::DistanceMetric< TVector >::OriginType)

Definition at line 56 of file itkDistanceMetric.h.

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

Standard typedefs Reimplemented from itk::Statistics::MembershipFunctionBase< TVector >. Reimplemented in itk::Statistics::EuclideanDistance< TVector >, and itk::Statistics::EuclideanDistance< ParameterType >. Definition at line 47 of file itkDistanceMetric.h.

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

Reimplemented from itk::Statistics::MembershipFunctionBase< TVector >. Reimplemented in itk::Statistics::EuclideanDistance< TVector >, and itk::Statistics::EuclideanDistance< ParameterType >. Definition at line 48 of file itkDistanceMetric.h.

---

Member Function Documentation

template<class TVector> virtual double itk::Statistics::DistanceMetric< TVector >::Evaluate (  const TVector &  x1, const TVector &  x2 )  const [pure virtual]

Gets the distance between x1 and x2 points Implemented in itk::Statistics::EuclideanDistance< TVector >, and itk::Statistics::EuclideanDistance< ParameterType >.

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

Gets the distance between the origin point and x. This function work with SetOrigin() function Implements itk::Statistics::MembershipFunctionBase< TVector >. Implemented in itk::Statistics::EuclideanDistance< TVector >, and itk::Statistics::EuclideanDistance< ParameterType >.

template<class TVector> virtual const char* itk::Statistics::DistanceMetric< TVector >::GetClassName (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Statistics::MembershipFunctionBase< TVector >. Reimplemented in itk::Statistics::EuclideanDistance< TVector >, and itk::Statistics::EuclideanDistance< ParameterType >.

template<class TVector> itk::Statistics::DistanceMetric< TVector >::itkStaticConstMacro (  VectorLength  , unsigned  int, TVector::Length  )

Length constant Reimplemented in itk::Statistics::EuclideanDistance< TVector >, and itk::Statistics::EuclideanDistance< ParameterType >.

template<class TVector> void itk::Statistics::DistanceMetric< TVector >::SetOrigin (  const OriginType &  x  )

Sets the origin point that will be used for the single point version Evaluate() function. This function is necessary part of implementing MembershipFunctionBase's Evaluate() interface

---

Member Data Documentation

template<class TVector> OriginType itk::Statistics::DistanceMetric< TVector >::m_Origin [protected]

Definition at line 71 of file itkDistanceMetric.h.

---

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

• itkDistanceMetric.h

---