1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
/*
* Copyright (C) 2005-2020 Centre National d'Etudes Spatiales (CNES)
* Copyright (C) 2007-2012 Institut Mines Telecom / Telecom Bretagne
*
* This file is part of Orfeo Toolbox
*
* https://www.orfeo-toolbox.org/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef otbFlexibleDistanceWithMissingValue_h
#define otbFlexibleDistanceWithMissingValue_h
#include "otbEuclideanDistanceMetricWithMissingValuePow2.h"
namespace otb
{
namespace Statistics
{
/** \class FlexibleDistanceWithMissingValue
* \brief Non-Euclidean distance function facing missing value.
*
* This class is derived from EuclideanDistanceMetricWithMissingValuePow2 class to
* deal with missing data. In addition, the initial Evaluate method performs
* a flexible calculation of distance when a component does contain data.
*
* The general formulation is defined as:
* \f$
d(x, y) = \sum_i | x_i^a - y_i^a |^b.
\f$
*
* 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 \code NaN \endcode.
*
* \sa EuclideanDistanceMetricWithMissingValuePow2
*
* \ingroup OTBImageManipulation
*/
template <class TVector>
class ITK_EXPORT FlexibleDistanceWithMissingValue : public otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2<TVector>
{
public:
/** Standard "Self" typedef. */
typedef FlexibleDistanceWithMissingValue Self;
typedef otb::Statistics::EuclideanDistanceMetricWithMissingValuePow2<TVector> Superclass;
typedef itk::SmartPointer<Self> Pointer;
typedef itk::SmartPointer<const Self> ConstPointer;
typedef typename Superclass::MeasurementVectorSizeType MeasurementVectorSizeType;
/** Run-time type information (and related methods). */
itkTypeMacro(FlexibleDistanceWithMissingValue, EuclideanDistanceMetricWithMissingValuePow2);
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Type of the component of a vector */
typedef typename TVector::ValueType ValueType;
/** Gets the distance between the origin and x */
double Evaluate(const TVector& x) const override;
/** Gets the distance between x1 and x2 */
double Evaluate(const TVector& x1, const TVector& x2) const override;
/** Gets the cooridnate distance between a and b. NOTE: a and b
* should be type of component */
double Evaluate(const ValueType& a, const ValueType& b) const;
/** Returns true if the distance between x and the origin is less
* than radius */
bool IsWithinRange(const TVector& x, const double radius) const
{
return Superclass::IsWithinRange(x, radius);
}
/** Set the value of the parameter a and b.
* Those parameters are defined as static component in order to call it far
* away from the instantiation of the class (through the SOM training for instance) */
static double Alpha;
static double Beta;
static void SetAlphaBeta(double a, double b);
/** test if it is ordinary Euclidean distance */
static bool IsEuclidean();
protected:
FlexibleDistanceWithMissingValue()
{
}
~FlexibleDistanceWithMissingValue() override
{
}
}; // end of class
/** Static variable instantiation */
template <class TVector>
double FlexibleDistanceWithMissingValue<TVector>::Alpha = 1.0;
template <class TVector>
double FlexibleDistanceWithMissingValue<TVector>::Beta = 2.0;
} // end namespace statistics
} // end namespace otb
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbFlexibleDistanceWithMissingValue.hxx"
#endif
#endif
|
