otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector > Class Template Reference

#include <otbEuclideanDistanceMetricWithMissingValue.h>

Inheritance diagram for otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >:

Collaboration diagram for otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef itk::SmartPointer< Self >	Pointer
typedef EuclideanDistanceMetricWithMissingValue	Self
typedef otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >	Superclass
typedef TVector::ValueType	ValueType
Public Types inherited from otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >
typedef itk::SmartPointer< const Self >	ConstPointer
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef itk::SmartPointer< Self >	Pointer
typedef EuclideanDistanceMetricWithMissingValuePow2	Self
typedef itk::Statistics::EuclideanDistanceMetric< TVector >	Superclass
typedef TVector::ValueType	ValueType

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
double	Evaluate (const TVector &x) const override
double	Evaluate (const TVector &x1, const TVector &x2) const override
double	Evaluate (const ValueType &a, const ValueType &b) const
virtual const char *	GetNameOfClass () const
bool	IsWithinRange (const TVector &x, const double radius) const
Public Member Functions inherited from otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
double	Evaluate (const TVector &x) const override
double	Evaluate (const TVector &x1, const TVector &x2) const override
double	Evaluate (const ValueType &a, const ValueType &b) const
bool	IsWithinRange (const TVector &x, const double radius) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >
static bool	IsMissingValue (const ValueType &v)
static Pointer	New ()
static void	SetToMissingValue (ValueType &v)

Protected Member Functions
	EuclideanDistanceMetricWithMissingValue ()
	~EuclideanDistanceMetricWithMissingValue () override
Protected Member Functions inherited from otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >
	EuclideanDistanceMetricWithMissingValuePow2 ()
	~EuclideanDistanceMetricWithMissingValuePow2 () override

Detailed Description

template<class TVector>
class otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >

Euclidean distance function facing missing value.

This class is derived from EuclideanDistanceMetricWithMissingValuePow2 class that handle the missing value functonnalities. Here, the square root is included in the evaluation...

The class can be templated over any container that holds data elements, as for template of EuclideanDistanceMetric.

The only restriction is that elements have to support NaN values.

See also

EuclideanDistanceMetric

EuclideanDistanceMetricWithMissingValuePow2

Definition at line 51 of file otbEuclideanDistanceMetricWithMissingValue.h.

Member Typedef Documentation

ConstPointer

template<class TVector >

typedef itk::SmartPointer<const Self> otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >::ConstPointer

Definition at line 58 of file otbEuclideanDistanceMetricWithMissingValue.h.

MeasurementVectorSizeType

template<class TVector >

typedef Superclass::MeasurementVectorSizeType otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >::MeasurementVectorSizeType

Definition at line 60 of file otbEuclideanDistanceMetricWithMissingValue.h.

Pointer

template<class TVector >

typedef itk::SmartPointer<Self> otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >::Pointer

Definition at line 57 of file otbEuclideanDistanceMetricWithMissingValue.h.

Self

template<class TVector >

typedef EuclideanDistanceMetricWithMissingValue otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >::Self

Standard "Self" typedef.

Definition at line 55 of file otbEuclideanDistanceMetricWithMissingValue.h.

Superclass

template<class TVector >

typedef otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2<TVector> otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >::Superclass

Definition at line 56 of file otbEuclideanDistanceMetricWithMissingValue.h.

ValueType

template<class TVector >

typedef TVector::ValueType otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >::ValueType

Type of the component of a vector

Definition at line 66 of file otbEuclideanDistanceMetricWithMissingValue.h.

Constructor & Destructor Documentation

EuclideanDistanceMetricWithMissingValue()

template<class TVector >

otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >::EuclideanDistanceMetricWithMissingValue ( )

inlineprotected

Definition at line 98 of file otbEuclideanDistanceMetricWithMissingValue.h.

~EuclideanDistanceMetricWithMissingValue()

template<class TVector >

otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >::~EuclideanDistanceMetricWithMissingValue ( )

inlineoverrideprotected

Definition at line 101 of file otbEuclideanDistanceMetricWithMissingValue.h.

Member Function Documentation

CreateAnother()

template<class TVector >

virtual::itk::LightObject::Pointer otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >::CreateAnother

(

void

)

const

Evaluate() [1/3]

template<class TVector >

double otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >::Evaluate ( const TVector &  x ) const

inlineoverride

Gets the distance between the origin and x

Definition at line 72 of file otbEuclideanDistanceMetricWithMissingValue.h.

Evaluate() [2/3]

template<class TVector >

double otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >::Evaluate ( const TVector &  x1, const TVector &  x2  ) const

inlineoverride

Gets the distance between x1 and x2

Definition at line 78 of file otbEuclideanDistanceMetricWithMissingValue.h.

Evaluate() [3/3]

template<class TVector >

double otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >::Evaluate ( const ValueType &  a, const ValueType &  b  ) const

inline

Gets the coordinate distance between a and b. NOTE: a and b should be type of component

Definition at line 85 of file otbEuclideanDistanceMetricWithMissingValue.h.

GetNameOfClass()

template<class TVector >

virtual const char* otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >.

IsWithinRange()

template<class TVector >

bool otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >::IsWithinRange ( const TVector &  x, const double  radius  ) const

inline

Returns true if the distance between x and the origin is less than radius

Definition at line 92 of file otbEuclideanDistanceMetricWithMissingValue.h.

New()

template<class TVector >

static Pointer otb::Statistics::EuclideanDistanceMetricWithMissingValue< TVector >::New ( )

static

Method for creation through the object factory.

---

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

• otbEuclideanDistanceMetricWithMissingValue.h