Aggregation InstantaneousToMean

InstantaneousToMean

Input

• inputVariable

Options

• allowMissingValues
• includeFirstValueOfAggregationPeriodInCalculation

Output

• outputVariable

Description

Equidistant Timeseries

This transformations calculates the mean value of instantaneous values over a certain period. If the option allowMissingValues is true, then a missing value is returned if one of the input values in the period is a missing value. If the option allowMissingValues is false (this is the default behaviour), then a mean value is calculated if there are 1 or more non-missing values in the aggregation period, i.e. missing values are ignored in this case.

The transformation offers two different ways for calculating the mean value over a period.  The default method (used by setting the includeFirstValueOfAggregationPeriodInCalculation option to true - this is the default behaviour) calculates the mean of the last n pairs, averages that, and stores it at the output time. An alternate method (similar to the MeanToMean aggregation) is enabled by setting the includeFirstValueOfAggregationPeriodInCalculation option to false) calculates the mean of all values that fit in the output interval, excluding the start time itself, and stores that at the output time.

In the four tables below examples of in and output using the different options are given.

Example for includeFirstValueOfAggregationPeriodInCalculation = true and allowMissingValues = false:

Example for includeFirstValueOfAggregationPeriodInCalculation = true and allowMissingValues = true:

Example for includeFirstValueOfAggregationPeriodInCalculation = false and allowMissingValues = false:

Example for includeFirstValueOfAggregationPeriodInCalculation = false and allowMissingValues = true:

Non Equidistant Timeseries

In the case of a non equidistant timeries, the allowMissingValues option does not bear much meaning, as it is unknown how much (if any) points should be available in the aggregation period. Setting this option does handle the case where a (non equidistant) timestep is available without an actual value (NaN). Furthermore, for non equidistant timeseries the includeFirstValueOfAggregationPeriodInCalculation option is not taken into account, as it is unknown what the first value of the aggregation period would be. The following calculation methodology is executed to determine the mean over the aggregation period:

First the (linearly interpolated) values at the aggregation period boundaries are determined from the non equidistant timeseries. Then, the average of each pair of connected values (including the calculated boundary values) is calculated and multiplied with the respective time between the measurement points. The weighted average of these mean values constitutes the aggregation period mean.

It should be noted that a mean value will be calculated even if no measurement points are available within the aggregation period. This is because the aggregation period boundary values will be calculated when measurement values are available at each side of the aggregation period and these will then be taken as input for the mean value calculation.

The image below visually explains the calculation methodology for non equidistant timeseries, where the interpolated value of one boundary is determined, before the weighted average of the connected pairs is taken.

Validation rules

See Aggregation Accumulative

Configuration example

<transformation id="aggregation instantaneousToMean">
	<aggregation>
		<instantaneousToMean>
			<inputVariable>
				<timeSeriesSet>
					<moduleInstanceId>ImportTelemetry</moduleInstanceId>
					<valueType>scalar</valueType>
					<parameterId>H.obs</parameterId>
					<locationSetId>hydgauges</locationSetId>
					<timeSeriesType>external historical</timeSeriesType>
					<timeStep unit="minute" multiplier="15"/>
					<relativeViewPeriod unit="day" startOverrulable="true" start="-7" end="0"/>
					<readWriteMode>read only</readWriteMode>
					<delay unit="minute" multiplier="0"/>
				</timeSeriesSet>
			</inputVariable>
			<allowMissingValues>true</allowMissingValues>
			<includeFirstValueOfAggregationPeriodInCalculation>true</includeFirstValueOfAggregationPeriodInCalculation>
			<outputVariable>
				<timeSeriesSet>
					<moduleInstanceId>Aggregate_Historic</moduleInstanceId>
					<valueType>scalar</valueType>
					<parameterId>instantaneousToMean</parameterId>
					<locationSetId>hydgauges</locationSetId>
					<timeSeriesType>external historical</timeSeriesType>
					<timeStep unit="hour" multiplier="1"/>
					<relativeViewPeriod unit="day" startOverrulable="true" start="-7" end="0"/>
					<readWriteMode>add originals</readWriteMode>
				</timeSeriesSet>
			</outputVariable>
		</instantaneousToMean>
	</aggregation>
</transformation>