ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::Statistics::DistanceMetric< TVector > Class Template Referenceabstract

#include <itkDistanceMetric.h>

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

Detailed Description

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

this class declares common interfaces for distance functions.

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

To use this function 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.

See Also
EuclideanSquareDistanceMetric
EuclideanDistanceMetric
ManhattanDistanceMetric

Definition at line 47 of file itkDistanceMetric.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef unsigned int MeasurementVectorSizeType
 
typedef TVector MeasurementVectorType
 
typedef Array< double > OriginType
 
typedef SmartPointer< SelfPointer
 
typedef DistanceMetric Self
 
typedef FunctionBase< TVector,
double > 
Superclass
 
- Public Types inherited from itk::FunctionBase< TVector, double >
typedef SmartPointer< const SelfConstPointer
 
typedef TVector InputType
 
typedef double OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual double Evaluate (const MeasurementVectorType &x) const override=0
 
virtual double Evaluate (const MeasurementVectorType &x1, const MeasurementVectorType &x2) const =0
 
virtual MeasurementVectorSizeType GetMeasurementVectorSize () const
 
virtual const char * GetNameOfClass () const
 
virtual const OriginTypeGetOrigin () const
 
virtual void SetMeasurementVectorSize (MeasurementVectorSizeType s)
 
void SetOrigin (const OriginType &x)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 DistanceMetric ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~DistanceMetric ()
 
- Protected Member Functions inherited from itk::FunctionBase< TVector, double >
 FunctionBase ()
 
 ~FunctionBase ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

MeasurementVectorSizeType m_MeasurementVectorSize
 
OriginType m_Origin
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TVector>
typedef SmartPointer< const Self > itk::Statistics::DistanceMetric< TVector >::ConstPointer

Definition at line 54 of file itkDistanceMetric.h.

template<typename TVector>
typedef unsigned int itk::Statistics::DistanceMetric< TVector >::MeasurementVectorSizeType

declare Measurement vector component type Type used to represent the number of components oft he MeasurementVectorType

Definition at line 63 of file itkDistanceMetric.h.

template<typename TVector>
typedef TVector itk::Statistics::DistanceMetric< TVector >::MeasurementVectorType

declare the MeasurementVector type

Definition at line 57 of file itkDistanceMetric.h.

template<typename TVector>
typedef Array< double > itk::Statistics::DistanceMetric< TVector >::OriginType

Definition at line 66 of file itkDistanceMetric.h.

template<typename TVector>
typedef SmartPointer< Self > itk::Statistics::DistanceMetric< TVector >::Pointer

Definition at line 53 of file itkDistanceMetric.h.

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

Standard typedefs

Definition at line 51 of file itkDistanceMetric.h.

template<typename TVector>
typedef FunctionBase< TVector, double > itk::Statistics::DistanceMetric< TVector >::Superclass

Definition at line 52 of file itkDistanceMetric.h.

Constructor & Destructor Documentation

template<typename TVector>
itk::Statistics::DistanceMetric< TVector >::DistanceMetric ( )
protected
template<typename TVector>
virtual itk::Statistics::DistanceMetric< TVector >::~DistanceMetric ( )
inlineprotectedvirtual

Definition at line 135 of file itkDistanceMetric.h.

Member Function Documentation

template<typename TVector>
virtual double itk::Statistics::DistanceMetric< TVector >::Evaluate ( const MeasurementVectorType x) const
overridepure virtual
template<typename TVector>
virtual double itk::Statistics::DistanceMetric< TVector >::Evaluate ( const MeasurementVectorType x1,
const MeasurementVectorType x2 
) const
pure virtual

Gets the distance between x1 and x2. This method is used by KdTreeKMeans estimators. When the estimator is refactored, this method should be removed. Distance between two measurement vectors can be computed by setting one of them as an origin of the distane and using the Evaluate method with a single argument

Implemented in itk::Statistics::MahalanobisDistanceMetric< TVector >, itk::Statistics::ManhattanDistanceMetric< TVector >, itk::Statistics::EuclideanDistanceMetric< TVector >, itk::Statistics::EuclideanDistanceMetric< Array< double > >, and itk::Statistics::EuclideanSquareDistanceMetric< TVector >.

template<typename TVector>
virtual MeasurementVectorSizeType itk::Statistics::DistanceMetric< TVector >::GetMeasurementVectorSize ( ) const
virtual

Get method for the length of the measurement vector

template<typename TVector>
virtual const char* itk::Statistics::DistanceMetric< TVector >::GetNameOfClass ( ) const
virtual
template<typename TVector>
virtual const OriginType& itk::Statistics::DistanceMetric< TVector >::GetOrigin ( ) const
virtual
template<typename TVector>
void itk::Statistics::DistanceMetric< TVector >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::Object.

Reimplemented in itk::Statistics::MahalanobisDistanceMetric< TVector >.

template<typename TVector>
virtual void itk::Statistics::DistanceMetric< TVector >::SetMeasurementVectorSize ( MeasurementVectorSizeType  s)
inlinevirtual

Set method for the length of the measurement vector

Reimplemented in itk::Statistics::MahalanobisDistanceMetric< TVector >.

Definition at line 93 of file itkDistanceMetric.h.

template<typename 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 the Evaluate() interface. The argument of SetOrigin() must be of type DistanceMetric::OriginType, which in most cases will be different from the TVector type. This is necessary because often times the origin would be a mean, or a vector representative of a collection of vectors.

Member Data Documentation

template<typename TVector>
MeasurementVectorSizeType itk::Statistics::DistanceMetric< TVector >::m_MeasurementVectorSize
private

Number of components in the MeasurementVectorType

Definition at line 143 of file itkDistanceMetric.h.

Referenced by itk::Statistics::DistanceMetric< Array< double > >::SetMeasurementVectorSize().

template<typename TVector>
OriginType itk::Statistics::DistanceMetric< TVector >::m_Origin
private

Definition at line 140 of file itkDistanceMetric.h.


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