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 Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef TVector::ValueType	ValueType
Public Member Functions
virtual const char *	GetNameOfClass () 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).

The class can be templated over any container that holds data elements. The containter is expected to provide access to its elements with the [] operator. It must also implement a Size() that returns the length of the container. It must also contain a typedef "ValueType" that defines the data-type held by the container. (In other words it will support itk::Vector, FixedArray, Array ).

Recent API changes: The static const macro to get the length of a measurement vector, VectorLength has been removed to allow the length of a measurement vector to be specified at run time. Please use the function GetMeasurementVectorSize() instead.

Definition at line 52 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 60 of file itkEuclideanDistance.h.

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

Typedef for the length of each measurement vector Reimplemented from itk::Statistics::DistanceMetric< TVector >. Definition at line 61 of file itkEuclideanDistance.h.

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

Reimplemented from itk::Statistics::MembershipFunctionBase< TVector >. Definition at line 59 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 57 of file itkEuclideanDistance.h.

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

Reimplemented from itk::Statistics::DistanceMetric< TVector >. Definition at line 58 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 70 of file itkEuclideanDistance.h.

---

Constructor & Destructor Documentation

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

Definition at line 87 of file itkEuclideanDistance.h.

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

Definition at line 88 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 >::GetNameOfClass (   )  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> 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

---