Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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

Euclidean distance function. More...

#include <itkEuclideanDistance.h>

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

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

Collaboration graph
[legend]
List of all members.

Public Types

typedef EuclideanDistance Self
typedef DistanceMetric< TVector > Superclass
typedef SmartPointer< SelfPointer
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 ()
virtual void PrintSelf (std::ostream &os, Indent indent) const

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< 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 57 of file itkEuclideanDistance.h.


Constructor & Destructor Documentation

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

Definition at line 74 of file itkEuclideanDistance.h.

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

Definition at line 75 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.

template<class TVector>
virtual void itk::Statistics::EuclideanDistance< TVector >::PrintSelf std::ostream &  os,
Indent  indent
const [inline, protected, virtual]
 

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

Definition at line 76 of file itkEuclideanDistance.h.


The documentation for this class was generated from the following file:
Generated at Sat Mar 31 03:13:14 2007 for ITK by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2000