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

Euclidean distance function. More...

#include <itkEuclideanDistance.h>

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

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

[legend]List of all members.

Public Types
typedef EuclideanDistance	Self
typedef DistanceMetric< TVector >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TVector::ValueType	ValueType
Public Member Functions
	itkStaticConstMacro (VectorLength, unsigned int, TVector::Length)
virtual const char *	GetClassName () const
double	Evaluate (const TVector &x) const
double	Evaluate (const TVector &x1, const TVector &x2) const
double	Evaluate (const ValueType &a, const ValueType &b) const
bool	IsWithinRange (const TVector &x, const double radius) const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	EuclideanDistance ()
virtual	~EuclideanDistance ()

---

Detailed Description

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

Euclidean distance function.

This class is derived from DistanceMetric class. In addition to the two Evaluate methods in the base class, this class has a method (Evaluate) to compute the coordinate distance between two vector component (not vectors), and a method to tell if a measurement vector is whithin the range (defined by a radius value) from the origin (set by SetOrigin mehtod).

Definition at line 38 of file itkEuclideanDistance.h.

---

Member Typedef Documentation

template<class TVector> typedef SmartPointer<const Self> itk::Statistics::EuclideanDistance< TVector >::ConstPointer

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

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

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

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

Standard "Self" typedef. Reimplemented from itk::Statistics::DistanceMetric< TVector >. Definition at line 43 of file itkEuclideanDistance.h.

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

Reimplemented from itk::Statistics::DistanceMetric< TVector >. Definition at line 44 of file itkEuclideanDistance.h.

template<class TVector> typedef TVector::ValueType itk::Statistics::EuclideanDistance< TVector >::ValueType

Type of the component of a vector Definition at line 58 of file itkEuclideanDistance.h.

---

Constructor & Destructor Documentation

template<class TVector> itk::Statistics::EuclideanDistance< TVector >::EuclideanDistance (   )  [inline, protected]

Definition at line 75 of file itkEuclideanDistance.h.

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

Definition at line 76 of file itkEuclideanDistance.h.

---

Member Function Documentation

template<class TVector> double itk::Statistics::EuclideanDistance< TVector >::Evaluate (  const ValueType &  a, const ValueType &  b )  const

Gets the cooridnate distance between a and b. NOTE: a and b should be type of component

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

Gets the distance between x1 and x2 Implements itk::Statistics::DistanceMetric< TVector >.

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

Gets the distance between the origin and x Implements itk::Statistics::DistanceMetric< TVector >.

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

Run-time type information (and related methods). Reimplemented from itk::Statistics::DistanceMetric< TVector >.

template<class TVector> bool itk::Statistics::EuclideanDistance< TVector >::IsWithinRange (  const TVector &  x, const double  radius )  const

Returns true if the distance between x and the origin is less than radius

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

Length of the vector Reimplemented from itk::Statistics::DistanceMetric< TVector >.

template<class TVector> Pointer itk::Statistics::EuclideanDistance< TVector >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

---

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

• itkEuclideanDistance.h

---