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

#include <itkEuclideanDistanceMetric.h>

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

Collaboration diagram for itk::Statistics::EuclideanDistanceMetric< TVector >:

Detailed Description

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

Euclidean distance function.

Examples:

Examples/Statistics/EuclideanDistanceMetric.cxx, and Examples/Statistics/KdTree.cxx.

Definition at line 34 of file itkEuclideanDistanceMetric.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef Superclass::OriginType	OriginType
typedef SmartPointer< Self >	Pointer
typedef EuclideanDistanceMetric	Self
typedef DistanceMetric< TVector >	Superclass
typedef MeasurementVectorTraitsTypes < MeasurementVectorType > ::ValueType	ValueType
Public Types inherited from itk::Statistics::DistanceMetric< TVector >
typedef SmartPointer< const Self >	ConstPointer
typedef unsigned int	MeasurementVectorSizeType
typedef TVector	MeasurementVectorType
typedef Array< double >	OriginType
typedef SmartPointer< Self >	Pointer
typedef DistanceMetric	Self
typedef FunctionBase< TVector, double >	Superclass
Public Types inherited from itk::FunctionBase< TVector, double >
typedef SmartPointer< const Self >	ConstPointer
typedef TVector	InputType
typedef double	OutputType
typedef SmartPointer< Self >	Pointer
typedef FunctionBase	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
double	Evaluate (const MeasurementVectorType &x) const override
double	Evaluate (const MeasurementVectorType &x1, const MeasurementVectorType &x2) const override
double	Evaluate (const ValueType &a, const ValueType &b) const
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::Statistics::DistanceMetric< TVector >
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
virtual const OriginType &	GetOrigin () 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 void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () 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

Static Public Member Functions
static Pointer	New ()
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 Member Functions
	EuclideanDistanceMetric ()
virtual	~EuclideanDistanceMetric () override
Protected Member Functions inherited from itk::Statistics::DistanceMetric< TVector >
	DistanceMetric ()
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual	~DistanceMetric () override
Protected Member Functions inherited from itk::FunctionBase< TVector, double >
	FunctionBase ()
	~FunctionBase () override
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object () override
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 ()

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TVector>

typedef SmartPointer< const Self > itk::Statistics::EuclideanDistanceMetric< TVector >::ConstPointer

Definition at line 42 of file itkEuclideanDistanceMetric.h.

template<typename TVector>

typedef Superclass::MeasurementVectorSizeType itk::Statistics::EuclideanDistanceMetric< TVector >::MeasurementVectorSizeType

Definition at line 46 of file itkEuclideanDistanceMetric.h.

template<typename TVector>

typedef Superclass::MeasurementVectorType itk::Statistics::EuclideanDistanceMetric< TVector >::MeasurementVectorType

Definition at line 44 of file itkEuclideanDistanceMetric.h.

template<typename TVector>

typedef Superclass::OriginType itk::Statistics::EuclideanDistanceMetric< TVector >::OriginType

Definition at line 48 of file itkEuclideanDistanceMetric.h.

template<typename TVector>

typedef SmartPointer< Self > itk::Statistics::EuclideanDistanceMetric< TVector >::Pointer

Definition at line 41 of file itkEuclideanDistanceMetric.h.

template<typename TVector>

typedef EuclideanDistanceMetric itk::Statistics::EuclideanDistanceMetric< TVector >::Self

Standard "Self" typedef.

Definition at line 39 of file itkEuclideanDistanceMetric.h.

template<typename TVector>

typedef DistanceMetric< TVector > itk::Statistics::EuclideanDistanceMetric< TVector >::Superclass

Definition at line 40 of file itkEuclideanDistanceMetric.h.

template<typename TVector>

typedef MeasurementVectorTraitsTypes< MeasurementVectorType >::ValueType itk::Statistics::EuclideanDistanceMetric< TVector >::ValueType

Definition at line 45 of file itkEuclideanDistanceMetric.h.

Constructor & Destructor Documentation

template<typename TVector>

itk::Statistics::EuclideanDistanceMetric< TVector >::EuclideanDistanceMetric ( )

inlineprotected

Definition at line 69 of file itkEuclideanDistanceMetric.h.

template<typename TVector>

virtual itk::Statistics::EuclideanDistanceMetric< TVector >::~EuclideanDistanceMetric ( )

inlineoverrideprotectedvirtual

Definition at line 70 of file itkEuclideanDistanceMetric.h.

Member Function Documentation

template<typename TVector>

virtual::itk::LightObject::Pointer itk::Statistics::EuclideanDistanceMetric< TVector >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<typename TVector>

double itk::Statistics::EuclideanDistanceMetric< TVector >::Evaluate ( const MeasurementVectorType &  x ) const

overridevirtual

Gets the distance between the origin and x

Implements itk::Statistics::DistanceMetric< TVector >.

template<typename TVector>

double itk::Statistics::EuclideanDistanceMetric< TVector >::Evaluate ( const MeasurementVectorType &  x1, const MeasurementVectorType &  x2  ) const

overridevirtual

Gets the distance between x1 and x2

Implements itk::Statistics::DistanceMetric< TVector >.

template<typename TVector>

double itk::Statistics::EuclideanDistanceMetric< 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. This method is used by KdTreeKMeans estimators. When the estimator is refactored, this method should be removed.

template<typename TVector>

virtual const char* itk::Statistics::EuclideanDistanceMetric< TVector >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Statistics::DistanceMetric< TVector >.

template<typename TVector>

static Pointer itk::Statistics::EuclideanDistanceMetric< TVector >::New ( )

static

Method for creation through the object factory.

---

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

• itkEuclideanDistanceMetric.h