Blame view

src/ExternLib/StatisticFunctions/CorrelationFunctions.hh 13.2 KB
e8db9c26   Hacene SI HADJ MOHAND   structure ok
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
/*
 * To change this license header, choose License Headers in Project Properties.
 * To change this template file, choose Tools | Templates
 * and open the template in the editor.
 */

/* 
 * File:   CorrelationFunctions.hh
 * Author: hacene
 *
 * Created on September 27, 2021, 3:35 PM
 */

#ifndef CORRELATIONFUNCTIONS_HH
#define CORRELATIONFUNCTIONS_HH

403992c8   Hacene SI HADJ MOHAND   scalr ok tested
17
18
#include "DicError.hh"
#include "AMDA_exception.hh"
e8db9c26   Hacene SI HADJ MOHAND   structure ok
19
20
21
22
#include "Parameter.hh"
#include "ParamData.hh"
#include "DataTypeMath.hh"
#include "Operation.hh"
e6a241e7   Hacene SI HADJ MOHAND   structure ok
23
24
#include <vector>
#include <iostream>
e8db9c26   Hacene SI HADJ MOHAND   structure ok
25
26
27
#include <iterator>
#include <c++/4.8.2/bits/stl_vector.h>
#include <c++/4.8.2/bits/stl_pair.h>
403992c8   Hacene SI HADJ MOHAND   scalr ok tested
28
#include "Toolbox.hh"
e6a241e7   Hacene SI HADJ MOHAND   structure ok
29
#include "AbstractFunc.hh"
e8db9c26   Hacene SI HADJ MOHAND   structure ok
30
31
32
33
34
35
36

namespace AMDA {
    namespace Parameters {
        namespace StatisticFunctions {

#define AVERAGE_TIME 1200 // (seconds)
#define MAX_GAP_SIZE 3600 // (seconds)
e6a241e7   Hacene SI HADJ MOHAND   structure ok
37

403992c8   Hacene SI HADJ MOHAND   scalr ok tested
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
            enum COEFS {
                COVARIANCE = 1,
                PAERSON = 2,
                SPEARMAN = 3,
                KENDALL = 4,
            };
            static std::map<std::string, COEFS> coefsToStr = {
                {"covariance", COEFS::COVARIANCE},
                {"pearson", COEFS::PAERSON},
                {"spearman", COEFS::SPEARMAN},
                {"kendall", COEFS::KENDALL},
                {"1", COEFS::COVARIANCE},
                {"2", COEFS::PAERSON},
                {"3", COEFS::SPEARMAN},
                {"4", COEFS::KENDALL},
e8db9c26   Hacene SI HADJ MOHAND   structure ok
53
54
55
            };

            template <typename InputElemType, typename OutputElemType>
e6a241e7   Hacene SI HADJ MOHAND   structure ok
56
            class AbstractCorrelationFunc : public AbstractFuncBase {
e8db9c26   Hacene SI HADJ MOHAND   structure ok
57
58
59
60
61
62
            public:

                /**
                 * @brief Constructor.
                 * @details Create the ParamData type of the input ParamData.
                 */
e6a241e7   Hacene SI HADJ MOHAND   structure ok
63
64
                AbstractCorrelationFunc(Process& pProcess, TimeIntervalListSPtr pTimeIntervalList, ParamDataSpec<InputElemType>& firstParamInput, ParamDataSpec<InputElemType>& secondParamInput, double windowtime)
                : AbstractFuncBase(pProcess, pTimeIntervalList, windowtime),
e8db9c26   Hacene SI HADJ MOHAND   structure ok
65
66
                _firstParamInput(firstParamInput),
                _secondParamInput(secondParamInput),
e8db9c26   Hacene SI HADJ MOHAND   structure ok
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
                _paramOutput(new ParamDataSpec<OutputElemType>) {
                    _paramDataOutput = _paramOutput;
                }

                virtual ~AbstractCorrelationFunc() {
                }

                virtual void pushData(double time, std::pair<InputElemType, InputElemType>& elem) = 0;

                virtual OutputElemType compute() = 0;

                void pushSecondParamData(ParamDataIndexInfo &pParamDataIndexInfo) {
                    for (unsigned int _index = pParamDataIndexInfo._startIndex;
                            _index < pParamDataIndexInfo._startIndex + pParamDataIndexInfo._nbDataToProcess;
                            ++_index) {
e6a241e7   Hacene SI HADJ MOHAND   structure ok
82
                        double time = _secondParamInput.getTime(_index);
e8db9c26   Hacene SI HADJ MOHAND   structure ok
83
                        InputElemType val_ = _secondParamInput.get(_index);
e6a241e7   Hacene SI HADJ MOHAND   structure ok
84
                        _secondParamInputData.push_back(std::pair<double, InputElemType> (time, val_));
e8db9c26   Hacene SI HADJ MOHAND   structure ok
85
86
87
88
89
90
91
92
93
94
                    }
                }

                virtual InputElemType getValue(std::vector<std::pair<double, InputElemType> >& input, double time) = 0;

                /**
                 * @overload Operation::write(ParamDataIndexInfo &pParamDataIndexInfo)
                 */

                void write(ParamDataIndexInfo &pParamDataIndexInfo) {
f5c74402   Hacene SI HADJ MOHAND   compilation ok
95

e8db9c26   Hacene SI HADJ MOHAND   structure ok
96
97
98
99
100
101
102
103
104
105
106
107
108
                    if ((pParamDataIndexInfo._nbDataToProcess > 0)) {
                        if (pParamDataIndexInfo._startIndex == 0) {
                            _nanVal = _firstParamInput.get(0);
                            _nanVal << NotANumber();
                        }
                        for (unsigned int _index = pParamDataIndexInfo._startIndex;
                                _index < pParamDataIndexInfo._startIndex + pParamDataIndexInfo._nbDataToProcess;
                                ++_index) {
                            double crtTime = _firstParamInput.getTime(_index);
                            InputElemType firstVal = _firstParamInput.get(_index);
                            // get the second element 
                            InputElemType secondVal = getValue(_secondParamInputData, crtTime);
                            std::pair<InputElemType, InputElemType> crtVal(firstVal, secondVal);
e6a241e7   Hacene SI HADJ MOHAND   structure ok
109

e8db9c26   Hacene SI HADJ MOHAND   structure ok
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
                            if (needToChangeTarget(crtTime)) {
                                _paramOutput->pushTime(getTarget());
                                _paramOutput->push(compute());
                                pushData(crtTime, crtVal);
                                nextTarget();
                                bool skip = false;
                                while (!skip && needToChangeTarget(crtTime)) {
                                    _paramOutput->pushTime(getTarget());
                                    _paramOutput->push(compute());
                                    skip = nextTarget();
                                }
                            } else {
                                pushData(crtTime, crtVal);
                                if (needInit()) {
                                    init();
                                }
                            }
                        }
                    }
                    if (pParamDataIndexInfo._timeIntToProcessChanged || pParamDataIndexInfo._noMoreTimeInt) {
                        if (!needInit()) {
                            do {
                                if (inInt(getTarget())) {
                                    _paramOutput->pushTime(getTarget());
                                    _paramOutput->push(compute());
                                }
                            } while (nextTarget());
                        }
                    }
f5c74402   Hacene SI HADJ MOHAND   compilation ok
139

e8db9c26   Hacene SI HADJ MOHAND   structure ok
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
                }

                double getInputParamSampling() {
                    return _firstParamInput.getMinSampling();
                }

            private:
                ParamDataSpec<InputElemType>& _firstParamInput;

                ParamDataSpec<InputElemType>& _secondParamInput;

                ParamDataSpec<OutputElemType>* _paramOutput;

                std::vector<std::pair<double, InputElemType> > _secondParamInputData;

            protected:
                OutputElemType _nanVal;
e8db9c26   Hacene SI HADJ MOHAND   structure ok
157
158
159
160
161
162
163
164
165
166
167
168
            };

            /**
             * 
             * @param pProcess
             * @param pTimeIntervalList
             * @param firstParamInput
             * @param secondParamInput
             * @param windowtime
             * @param type
             */
            template <typename InputElemType, typename OutputElemType>
e6a241e7   Hacene SI HADJ MOHAND   structure ok
169
            class Correlation : public AbstractCorrelationFunc<InputElemType, OutputElemType> {
e8db9c26   Hacene SI HADJ MOHAND   structure ok
170
171
            public:

f5c74402   Hacene SI HADJ MOHAND   compilation ok
172
173
174
                Correlation(Process & pProcess, TimeIntervalListSPtr pTimeIntervalList, ParamDataSpec<InputElemType>& firstParamInput,
                        ParamDataSpec<InputElemType>& secondParamInput, double windowtime, std::string correlationType) :
                AbstractCorrelationFunc<InputElemType, OutputElemType> (pProcess, pTimeIntervalList, firstParamInput, secondParamInput, windowtime), _correlationType(correlationType) {
e8db9c26   Hacene SI HADJ MOHAND   structure ok
175
176
177

                }

e6a241e7   Hacene SI HADJ MOHAND   structure ok
178
                virtual ~Correlation() {
e8db9c26   Hacene SI HADJ MOHAND   structure ok
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
                }

                virtual void init() {
                    AbstractCorrelationFunc<InputElemType, OutputElemType>::setTarget(AbstractCorrelationFunc<InputElemType, OutputElemType>::getIntStartTime());
                    AbstractCorrelationFunc<InputElemType, OutputElemType>::setNeedInit(false);
                }

                virtual bool nextTarget() {
                    double target = AbstractCorrelationFunc<InputElemType, OutputElemType>::getTarget() + AbstractCorrelationFunc<InputElemType, OutputElemType>::getWindowTime();
                    bool res = AbstractCorrelationFunc<InputElemType, OutputElemType>::setTarget(target);
                    while (!_mem.empty() && !AbstractCorrelationFunc<InputElemType, OutputElemType>::inWindow(_mem.front().first)) {
                        _mem.pop_front();
                    }
                    return res;
                }

                virtual bool needToChangeTarget(double crtTime) {
                    return !AbstractCorrelationFunc<InputElemType, OutputElemType>::needInit() && !AbstractCorrelationFunc<InputElemType, OutputElemType>::inWindow(crtTime);
                }

                virtual double getSampling() {
                    return AbstractCorrelationFunc<InputElemType, OutputElemType>::getWindowTime();
                }

                virtual void pushData(double time, std::pair<InputElemType, InputElemType>& elem) {
                    _mem.push_back(std::make_pair(time, elem));
                }

                virtual void resetFunc() {
                    _mem.clear();
                }

                InputElemType getValue(std::vector<std::pair<double, InputElemType> >& input, double time) {
                    double min_t = time - AVERAGE_TIME / 2.;
                    double max_t = time + AVERAGE_TIME / 2.;
                    std::vector<std::pair<double, InputElemType> > values_for_mean;
f5c74402   Hacene SI HADJ MOHAND   compilation ok
215
                    InputElemType nanVal;
e8db9c26   Hacene SI HADJ MOHAND   structure ok
216
217
218
                    nanVal << NotANumber();
                    std::pair<double, InputElemType> prev_value(NAN, nanVal);
                    std::pair<double, InputElemType> next_value(NAN, nanVal);
403992c8   Hacene SI HADJ MOHAND   scalr ok tested
219
                    InputElemType value = nanVal;
f5c74402   Hacene SI HADJ MOHAND   compilation ok
220
                    for (auto it = input.begin(); it != input.end(); ++it) {
403992c8   Hacene SI HADJ MOHAND   scalr ok tested
221
222
223
224
225
                        if (it->first == time) {
                            value = it->second;
                            return value;
                            break;
                        } else if (isNAN(it->second))
e8db9c26   Hacene SI HADJ MOHAND   structure ok
226
227
228
229
230
231
232
233
234
235
                            continue;
                        else if (it->first > max_t) {
                            next_value = *it;
                            break;
                        } else if (it->first < min_t) {
                            prev_value = *it;
                        } else {
                            values_for_mean.push_back(*it);
                        }
                    }
e8db9c26   Hacene SI HADJ MOHAND   structure ok
236
237
238
                    if (!values_for_mean.empty()) {
                        //Compute mean
                        InputElemType sum = 0;
f5c74402   Hacene SI HADJ MOHAND   compilation ok
239
                        for (auto it = values_for_mean.begin(); it != values_for_mean.end(); ++it) {
e8db9c26   Hacene SI HADJ MOHAND   structure ok
240
241
242
243
244
245
246
247
248
249
250
251
                            sum += it->second;
                        }
                        value = sum / (InputElemType) values_for_mean.size();
                    } else {
                        if (!isNAN(prev_value.first) && !isNAN(next_value.first) && (next_value.first - prev_value.first <= MAX_GAP_SIZE)) {
                            //Compute interpolated value
                            value = prev_value.second + (time - prev_value.first) / (next_value.first - prev_value.first) * (next_value.second - prev_value.second);
                        }
                    }

                    return value;
                }
f5c74402   Hacene SI HADJ MOHAND   compilation ok
252
                
403992c8   Hacene SI HADJ MOHAND   scalr ok tested
253
254
                                OutputElemType compute() {
                    return computeCorrelation(_mem, AbstractCorrelationFunc<InputElemType, OutputElemType>::_nanVal, _correlationType);
e8db9c26   Hacene SI HADJ MOHAND   structure ok
255
                }
f5c74402   Hacene SI HADJ MOHAND   compilation ok
256

e6a241e7   Hacene SI HADJ MOHAND   structure ok
257
258
259
260
261
262
263
264
265
                OutputElemType computeCorrelation(std::list<std::pair<double, std::pair<InputElemType, InputElemType>>>&mem, OutputElemType& nanVal, std::string type) {
                    OutputElemType result = nanVal;
                    if (mem.empty()) {
                        return result;
                    }
                    std::list<std::pair<InputElemType, InputElemType>> list;
                    for (typename std::list<std::pair<double, std::pair < InputElemType, InputElemType>>>::iterator it = mem.begin(); it != mem.end(); ++it) {
                        list.push_back(it->second);
                    }
403992c8   Hacene SI HADJ MOHAND   scalr ok tested
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
                    if (coefsToStr.find(type) == coefsToStr.end()) {
                        BOOST_THROW_EXCEPTION(AMDA::AMDA_exception() << AMDA::errno_code(AMDA_ERROR_UNKNOWN) << AMDA::ex_msg("StatisticFunctions::CorrelationFunction  unknown correlation type " + type));
                    }

                    switch (coefsToStr[type]) {
                        case COEFS::COVARIANCE:
                            getCovariance(list, result);
                            break;
                        case COEFS::PAERSON:
                            getPearson(list, result);
                            break;
                        case COEFS::SPEARMAN:
                            getSpearman(list, result);
                            break;
                        case COEFS::KENDALL:
                            getKendall(list, result);
                            break;
                        default:
                            BOOST_THROW_EXCEPTION(AMDA::AMDA_exception() << AMDA::errno_code(AMDA_ERROR_UNKNOWN) << AMDA::ex_msg("StatisticFunctions::CorrelationFunction  unknown correlation type :" + type));
                    }

e6a241e7   Hacene SI HADJ MOHAND   structure ok
287
                    return result;
e8db9c26   Hacene SI HADJ MOHAND   structure ok
288
                }
403992c8   Hacene SI HADJ MOHAND   scalr ok tested
289
                
e6a241e7   Hacene SI HADJ MOHAND   structure ok
290
291
292
            protected:
                std::string _correlationType;
                std::list<std::pair<double, std::pair<InputElemType, InputElemType>> > _mem;
e6a241e7   Hacene SI HADJ MOHAND   structure ok
293
            };
e8db9c26   Hacene SI HADJ MOHAND   structure ok
294
295
296
297
        }
    }
}

e6a241e7   Hacene SI HADJ MOHAND   structure ok
298

e8db9c26   Hacene SI HADJ MOHAND   structure ok
299
#endif /* CORRELATIONFUNCTIONS_HH */