#include <itkEuclideanDistanceMetric.h>

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 35 of file itkEuclideanDistanceMetric.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = EuclideanDistanceMetric

using	Superclass = DistanceMetric< TVector >

using	ValueType = typename MeasurementVectorTraitsTypes< MeasurementVectorType >::ValueType

Public Types inherited from itk::Statistics::DistanceMetric< TVector >
using	ConstPointer = SmartPointer< const Self >

using	MeasurementVectorSizeType = unsigned int

using	MeasurementVectorType = TVector

using	OriginType = Array< double >

using	Pointer = SmartPointer< Self >

using	Self = DistanceMetric

using	Superclass = FunctionBase< TVector, double >

Public Types inherited from itk::FunctionBase< TVector, double >
using	ConstPointer = SmartPointer< const Self >

using	InputType = TVector

using	OutputType = double

using	Pointer = SmartPointer< Self >

using	Self = FunctionBase

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
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

const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::Statistics::DistanceMetric< TVector >
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const

virtual const OriginType &	GetOrigin () const

void	SetOrigin (const OriginType &x)

virtual void	SetMeasurementVectorSize (MeasurementVectorSizeType s)

Public Member Functions inherited from itk::FunctionBase< TVector, double >
const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
	EuclideanDistanceMetric ()=default

	~EuclideanDistanceMetric () override=default

Protected Member Functions inherited from itk::Statistics::DistanceMetric< TVector >
	DistanceMetric ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~DistanceMetric () override=default

Protected Member Functions inherited from itk::FunctionBase< TVector, double >
	FunctionBase ()=default

	~FunctionBase () override=default

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~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
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TVector>

using itk::Statistics::EuclideanDistanceMetric< TVector >::ConstPointer = SmartPointer<const Self>

Definition at line 43 of file itkEuclideanDistanceMetric.h.

◆ Pointer

template<typename TVector>

using itk::Statistics::EuclideanDistanceMetric< TVector >::Pointer = SmartPointer<Self>

Definition at line 42 of file itkEuclideanDistanceMetric.h.

◆ Self

template<typename TVector>

using itk::Statistics::EuclideanDistanceMetric< TVector >::Self = EuclideanDistanceMetric

Standard "Self" type alias.

Definition at line 40 of file itkEuclideanDistanceMetric.h.

◆ Superclass

template<typename TVector>

using itk::Statistics::EuclideanDistanceMetric< TVector >::Superclass = DistanceMetric<TVector>

Definition at line 41 of file itkEuclideanDistanceMetric.h.

◆ ValueType

template<typename TVector>

using itk::Statistics::EuclideanDistanceMetric< TVector >::ValueType = typename MeasurementVectorTraitsTypes<MeasurementVectorType>::ValueType

Definition at line 46 of file itkEuclideanDistanceMetric.h.

Constructor & Destructor Documentation

◆ EuclideanDistanceMetric()

template<typename TVector>

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

protecteddefault

◆ ~EuclideanDistanceMetric()

template<typename TVector>

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

overrideprotecteddefault

Member Function Documentation

◆ Evaluate() [1/3]

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

◆ Evaluate() [2/3]

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

◆ Evaluate() [3/3]

template<typename TVector>

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

Gets the coordinate 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.

◆ GetNameOfClass()

template<typename TVector>

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

overridevirtual

See also: LightObject::GetNameOfClass()

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

◆ New()

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

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

◆ ValueType

Constructor & Destructor Documentation

◆ EuclideanDistanceMetric()

◆ ~EuclideanDistanceMetric()

Member Function Documentation

◆ Evaluate() [1/3]

◆ Evaluate() [2/3]

◆ Evaluate() [3/3]

◆ GetNameOfClass()

◆ New()

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