Aggregation InstantaneousToMean

InstantaneousToMean

Input

• inputVariable

Options

• allowMissingValues
• includeFirstValueOfAggregationPeriodInCalculation

Output

• outputVariable

Description

This transformations calculates the mean value of instantaneous values over a certain period. If the option allowMissingValues is true (this is the default behaviour), 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, 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:

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>
				<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>
						<synchLevel>1</synchLevel>
					</timeSeriesSet>
				</outputVariable>
			</instantaneousToMean>
		</aggregation>
	</transformation>