aggregate.mjs

"use strict";

import {
  extractObservationValuesWithinDatesInterval,
  extractObservationValuesWithinMonthInterval,
} from "./aggregateHelpers.mjs";

/**
 * 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
) {
  return obsValuesForDaysIntervalArr.reduce(
    (accumulator, currentValue) => accumulator + currentValue
  );
};

/**
 * 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
) {
  return (
    calculateSumOfObservationValuesWithinDatesInterval(
      obsValuesForDaysIntervalArr
    ) / obsValuesForDaysIntervalArr.length
  );
};

/**
 * 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
) {
  return obsValuesForMonthIntervalArr.reduce(
    (accumulator, currentValue) => accumulator + currentValue
  );
};

/**
 * 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
) {
  return (
    calculateSumOfObservationValuesWithinMonthInterval(
      obsValuesForMonthIntervalArr
    ) / obsValuesForMonthIntervalArr.length
  );
};

/**
 * 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