OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector > Class Template Reference

#include <otbEuclideanDistanceMetricWithMissingValuePow2.h>

+ Inheritance diagram for otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >:
+ Collaboration diagram for otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::MeasurementVectorSizeType MeasurementVectorSizeType
 
typedef itk::SmartPointer< SelfPointer
 
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
 

Static Public Member Functions

static bool IsMissingValue (const ValueType &v)
 
static Pointer New ()
 
static void SetToMissingValue (ValueType &v)
 

Protected Member Functions

 EuclideanDistanceMetricWithMissingValuePow2 ()
 
 ~EuclideanDistanceMetricWithMissingValuePow2 () override
 

Detailed Description

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

Euclidean comparison distance function facing missing value. The square root is not performed in this class.

This class is derived from EuclideanDistanceMetric class. In addition to the initial Evaluate method, the class does not perform calculation when a component does not contain any data. The 'no data' case is perform through the

which performs a

Nan

affectation.

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
EuclideanDistanceMetricWithMissingValue

Definition at line 53 of file otbEuclideanDistanceMetricWithMissingValuePow2.h.

Member Typedef Documentation

◆ ConstPointer

template<class TVector >
typedef itk::SmartPointer<const Self> otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >::ConstPointer

◆ MeasurementVectorSizeType

template<class TVector >
typedef Superclass::MeasurementVectorSizeType otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >::MeasurementVectorSizeType

◆ Pointer

template<class TVector >
typedef itk::SmartPointer<Self> otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >::Pointer

◆ Self

Standard "Self" typedef.

Definition at line 57 of file otbEuclideanDistanceMetricWithMissingValuePow2.h.

◆ Superclass

template<class TVector >
typedef itk::Statistics::EuclideanDistanceMetric<TVector> otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >::Superclass

◆ ValueType

template<class TVector >
typedef TVector::ValueType otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >::ValueType

Type of the component of a vector

Definition at line 67 of file otbEuclideanDistanceMetricWithMissingValuePow2.h.

Constructor & Destructor Documentation

◆ EuclideanDistanceMetricWithMissingValuePow2()

◆ ~EuclideanDistanceMetricWithMissingValuePow2()

template<class TVector >
otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >::~EuclideanDistanceMetricWithMissingValuePow2 ( )
inlineoverrideprotected

Member Function Documentation

◆ CreateAnother()

template<class TVector >
virtual::itk::LightObject::Pointer otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >::CreateAnother ( void  ) const

◆ Evaluate() [1/3]

template<class TVector >
double otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >::Evaluate ( const TVector &  x) const
inlineoverride

Gets the distance between the origin and x

Definition at line 58 of file otbEuclideanDistanceMetricWithMissingValuePow2.hxx.

◆ Evaluate() [2/3]

template<class TVector >
double otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >::Evaluate ( const TVector &  x1,
const TVector &  x2 
) const
inlineoverride

Gets the distance between x1 and x2

Definition at line 36 of file otbEuclideanDistanceMetricWithMissingValuePow2.hxx.

◆ Evaluate() [3/3]

template<class TVector >
double otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< 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 83 of file otbEuclideanDistanceMetricWithMissingValuePow2.hxx.

◆ GetNameOfClass()

template<class TVector >
virtual const char* otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >::GetNameOfClass ( ) const
virtual

◆ IsMissingValue()

template<class TVector >
bool otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >::IsMissingValue ( const ValueType v)
static

Check if a value is NaN or not

Definition at line 95 of file otbEuclideanDistanceMetricWithMissingValuePow2.hxx.

◆ IsWithinRange()

template<class TVector >
bool otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< 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 84 of file otbEuclideanDistanceMetricWithMissingValuePow2.h.

◆ New()

template<class TVector >
static Pointer otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >::New ( )
static

Method for creation through the object factory.

◆ SetToMissingValue()

template<class TVector >
void otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2< TVector >::SetToMissingValue ( ValueType v)
static

Set a value to Nan

Definition at line 102 of file otbEuclideanDistanceMetricWithMissingValuePow2.hxx.


The documentation for this class was generated from the following files:
otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2::SetToMissingValue
static void SetToMissingValue(ValueType &v)
Definition: otbEuclideanDistanceMetricWithMissingValuePow2.hxx:102