An error occurred while loading the file. Please try again.
-
Pithon Kabiro authored
We were using the original VL observations array in the 'map' array method. Updated to use the final version of VL observations array
1255a80e
"use strict";import { extractObservationValuesWithinDatesInterval, extractObservationValuesWithinMonthInterval,} from "./aggregateHelpers.mjs";/** * Remove `null` observation values from an array of observation values * * @param {Array} obsValuesArr An array of observation values * @returns {Array} An array with `null` observation values removed */const filterOutNullObservationValues = function (obsValuesArr) { return obsValuesArr.filter((obs) => obs !== null);};/** * Calculate the minimum observation values that fall within a time interval delimited by a start date and end date * @param {Array} obsValuesForDaysIntervalArr An array of observation values that fall within our time interval * @returns {Number} A floating-point number representing the minimum of observation values */const calculateMinimumObservationValuesWithinDatesInterval = function ( obsValuesForDaysIntervalArr) { // If the observation value is `null`, skip the calculation return obsValuesForDaysIntervalArr.reduce((previousValue, obsValue) => obsValue === null ? null : Math.min(previousValue, obsValue) );};/** * Calculate the maximum observation values that fall within a time interval delimited by a start date and end date * @param {Array} obsValuesForDaysIntervalArr An array of observation values that fall within our time interval * @returns {Number} A floating-point number representing the maximum of observation values */const calculateMaximumObservationValuesWithinDatesInterval = function ( obsValuesForDaysIntervalArr) { // If the observation value is `null`, skip the calculation return obsValuesForDaysIntervalArr.reduce((previousValue, obsValue) => obsValue === null ? null : Math.max(previousValue, obsValue) );};/** * Calculate the sum of observation values that fall within a time interval delimited by a start date and end date * @param {Array} obsValuesForDaysIntervalArr An array of observation values that fall within our time interval * @returns {Number} A floating-point number representing the sum of observation values */const calculateSumOfObservationValuesWithinDatesInterval = function ( obsValuesForDaysIntervalArr) { // Remove the `null` observation values before calculating the sum return filterOutNullObservationValues(obsValuesForDaysIntervalArr).reduce( (previousValue, obsValue) => previousValue + obsValue, 0 );};/** * Calculate the average (arithmetic mean) of observation values that fall within a time interval delimited by a start date and end date * @param {Array} obsValuesForDaysIntervalArr An array of observation values that fall within our time interval * @returns {Number} A floating-point number representing the average (arithmetic mean) of observation values */const calculateAverageOfObservationValuesWithinDatesInterval = function ( obsValuesForDaysIntervalArr) { // The observation values array should only include non-`null` values return (
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
128
129
130
131
132
133
134
135
136
137
138
139
140
calculateSumOfObservationValuesWithinDatesInterval(
obsValuesForDaysIntervalArr
) / filterOutNullObservationValues(obsValuesForDaysIntervalArr).length
);
};
/**
* Calculate the minimum of observation values that fall within a time interval delimited by the first day and last day of a calendar month
* @param {Array} obsValuesForMonthIntervalArr An array of observation values that fall within one calendar month
* @returns {Number} A floating-point number representing the minimum of observation values within one calendar month
*/
const calculateMinimumObservationValuesWithinMonthInterval = function (
obsValuesForMonthIntervalArr
) {
// If the observation value is `null`, skip the calculation
return obsValuesForMonthIntervalArr.reduce((previousValue, obsValue) =>
obsValue === null ? null : Math.min(previousValue, obsValue)
);
};
/**
* Calculate the maximum of observation values that fall within a time interval delimited by the first day and last day of a calendar month
* @param {Array} obsValuesForMonthIntervalArr An array of observation values that fall within one calendar month
* @returns {Number} A floating-point number representing the maximum of observation values within one calendar month
*/
const calculateMaximumObservationValuesWithinMonthInterval = function (
obsValuesForMonthIntervalArr
) {
// If the observation value is `null`, skip the calculation
return obsValuesForMonthIntervalArr.reduce((previousValue, obsValue) =>
obsValue === null ? null : Math.max(previousValue, obsValue)
);
};
/**
* Calculate the sum of observation values that fall within a time interval delimited by the first day and last day of a calendar month
* @param {Array} obsValuesForMonthIntervalArr An array of observation values that fall within one calendar month
* @returns {Number} A floating-point number representing the sum of observation values within one calendar month
*/
const calculateSumOfObservationValuesWithinMonthInterval = function (
obsValuesForMonthIntervalArr
) {
// Remove the `null` observation values before calculating the sum
return filterOutNullObservationValues(obsValuesForMonthIntervalArr).reduce(
(previousValue, obsValue) => previousValue + obsValue,
0
);
};
/**
* Calculate the average (arithmetic mean) of observation values that fall within a time interval delimited by the first day and last day of a calendar month
* @param {Array} obsValuesForMonthIntervalArr An array of observation values that fall within one calendar month
* @returns {Number} A floating-point number representing the average (arithmetic mean) of observation values within one calendar month
*/
const calculateAverageOfObservationValuesWithinMonthInterval = function (
obsValuesForMonthIntervalArr
) {
// The observation values array should only include non-`null` values
return (
calculateSumOfObservationValuesWithinMonthInterval(
obsValuesForMonthIntervalArr
) / filterOutNullObservationValues(obsValuesForMonthIntervalArr).length
);
};
/**
* Calculate the minimum of observation values within a time interval delimited by a start date and end date. The time interval may be daily or monthly
* @param {Array} obsNestedArr A 1*N array that contains N nested arrays of observations (timestamp + value)
* @param {String} samplingRate The sampling rate of observations as a string, e.g. "15min", "60min"
* @param {Array} uniqueCalendarDatesOrMonthsArr A 1*N array of unique calendar dates or calendar months strings
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
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
* @param {String} aggregationInterval The aggregation interval as a string e.g. "daily", "monthly"
* @returns {Array} A 1*N array that contains N nested arrays of minimum values
*/
const calculateMinimumObservationValuesWithinInterval = function (
obsNestedArr,
samplingRate,
uniqueCalendarDatesOrMonthsArr,
aggregationInterval
) {
// Calculate minimum values of observations - daily
// Note the use of the two nested `map` methods
if (aggregationInterval === "daily") {
return uniqueCalendarDatesOrMonthsArr.map((uniqueCalendarDatesArr, i) =>
uniqueCalendarDatesArr.map((uniqueCalendarDate) =>
calculateMinimumObservationValuesWithinDatesInterval(
extractObservationValuesWithinDatesInterval(
obsNestedArr[i],
samplingRate,
uniqueCalendarDate,
uniqueCalendarDate
)
)
)
);
}
// Calculate minimum values of observations - monthly
// Note the use of the two nested `map` methods
else if (aggregationInterval === "monthly") {
return uniqueCalendarDatesOrMonthsArr.map((uniqueCalendarMonthsArr, i) =>
uniqueCalendarMonthsArr.map((uniqueCalendarMonth) =>
calculateMinimumObservationValuesWithinMonthInterval(
extractObservationValuesWithinMonthInterval(
obsNestedArr[i],
samplingRate,
uniqueCalendarMonth
)
)
)
);
}
};
/**
* Calculate the maximum of observation values within a time interval delimited by a start date and end date. The time interval may be daily or monthly
* @param {Array} obsNestedArr A 1*N array that contains N nested arrays of observations (timestamp + value)
* @param {String} samplingRate The sampling rate of observations as a string, e.g. "15min", "60min"
* @param {Array} uniqueCalendarDatesOrMonthsArr A 1*N array of unique calendar dates or calendar months strings
* @param {String} aggregationInterval The aggregation interval as a string e.g. "daily", "monthly"
* @returns {Array} A 1*N array that contains N nested arrays of maximum values
*/
const calculateMaximumObservationValuesWithinInterval = function (
obsNestedArr,
samplingRate,
uniqueCalendarDatesOrMonthsArr,
aggregationInterval
) {
// Calculate maximum values of observations - daily
// Note the use of the two nested `map` methods
if (aggregationInterval === "daily") {
return uniqueCalendarDatesOrMonthsArr.map((uniqueCalendarDatesArr, i) =>
uniqueCalendarDatesArr.map((uniqueCalendarDate) =>
calculateMaximumObservationValuesWithinDatesInterval(
extractObservationValuesWithinDatesInterval(
obsNestedArr[i],
samplingRate,
uniqueCalendarDate,
uniqueCalendarDate
)
)
)
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
);
}
// Calculate maximum values of observations - monthly
// Note the use of the two nested `map` methods
else if (aggregationInterval === "monthly") {
return uniqueCalendarDatesOrMonthsArr.map((uniqueCalendarMonthsArr, i) =>
uniqueCalendarMonthsArr.map((uniqueCalendarMonth) =>
calculateMaximumObservationValuesWithinMonthInterval(
extractObservationValuesWithinMonthInterval(
obsNestedArr[i],
samplingRate,
uniqueCalendarMonth
)
)
)
);
}
};
/**
* Calculate the sum of observation values within a time interval delimited by a start date and end date. The time interval may be daily or monthly
* @param {Array} obsNestedArr A 1*N array that contains N nested arrays of observations (timestamp + value)
* @param {String} samplingRate The sampling rate of observations as a string, e.g. "15min", "60min"
* @param {Array} uniqueCalendarDatesOrMonthsArr A 1*N array of unique calendar dates or calendar months strings
* @param {String} aggregationInterval The aggregation interval as a string e.g. "daily", "monthly"
* @returns {Array} A 1*N array that contains N nested arrays of sum values
*/
const calculateSumOfObservationValuesWithinInterval = function (
obsNestedArr,
samplingRate,
uniqueCalendarDatesOrMonthsArr,
aggregationInterval
) {
// Calculate sum of values of observations - daily
// Note the use of the two nested `map` methods
if (aggregationInterval === "daily") {
return uniqueCalendarDatesOrMonthsArr.map((uniqueCalendarDatesArr, i) =>
uniqueCalendarDatesArr.map((uniqueCalendarDate) =>
calculateSumOfObservationValuesWithinDatesInterval(
extractObservationValuesWithinDatesInterval(
obsNestedArr[i],
samplingRate,
uniqueCalendarDate,
uniqueCalendarDate
)
)
)
);
}
// Calculate sum of values of observations - monthly
// Note the use of the two nested `map` methods
else if (aggregationInterval === "monthly") {
return uniqueCalendarDatesOrMonthsArr.map((uniqueCalendarMonthsArr, i) =>
uniqueCalendarMonthsArr.map((uniqueCalendarMonth) =>
calculateSumOfObservationValuesWithinMonthInterval(
extractObservationValuesWithinMonthInterval(
obsNestedArr[i],
samplingRate,
uniqueCalendarMonth
)
)
)
);
}
};
/**
* Calculate the average (arithmetic mean) of observation values within a time interval delimited by a start date and end date. The time interval may be daily or monthly
* @param {Array} obsNestedArr A 1*N array that contains N nested arrays of observations (timestamp + value)
* @param {String} samplingRate The sampling rate of observations as a string, e.g. "15min", "60min"
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
* @param {Array} uniqueCalendarDatesOrMonthsArr A 1*N array of unique calendar dates or calendar months strings
* @param {String} aggregationInterval The aggregation interval as a string e.g. "daily", "monthly"
* @returns {Array} A 1*N array that contains N nested arrays of average (arithmetic mean) values
*/
const calculateAverageOfObservationValuesWithinInterval = function (
obsNestedArr,
samplingRate,
uniqueCalendarDatesOrMonthsArr,
aggregationInterval
) {
// Calculate average of values of observations - daily
// Note the use of the two nested `map` methods
if (aggregationInterval === "daily") {
return uniqueCalendarDatesOrMonthsArr.map((uniqueCalendarDatesArr, i) =>
uniqueCalendarDatesArr.map((uniqueCalendarDate) =>
calculateAverageOfObservationValuesWithinDatesInterval(
extractObservationValuesWithinDatesInterval(
obsNestedArr[i],
samplingRate,
uniqueCalendarDate,
uniqueCalendarDate
)
)
)
);
}
// Calculate average of values of observations - monthly
// Note the use of the two nested `map` methods
else if (aggregationInterval === "monthly") {
return uniqueCalendarDatesOrMonthsArr.map((uniqueCalendarMonthsArr, i) =>
uniqueCalendarMonthsArr.map((uniqueCalendarMonth) =>
calculateAverageOfObservationValuesWithinMonthInterval(
extractObservationValuesWithinMonthInterval(
obsNestedArr[i],
samplingRate,
uniqueCalendarMonth
)
)
)
);
}
};
export {
calculateMinimumObservationValuesWithinInterval,
calculateMaximumObservationValuesWithinInterval,
calculateSumOfObservationValuesWithinInterval,
calculateAverageOfObservationValuesWithinInterval,
};