AccumulationSumOriginAtTimeZero

Information

Transformation:	SumOriginAtTimeZero
Transformation Group:	Accumulation
Description:	Calculates the accumulated sum of the input values for each timestep in the output period from timezero forwards and backwards in time. In case the input is instantaneous or mean and the output is accumulation, then the sum is multiplied by the duration of the input time step in seconds. The sum of the historical data is accumulated backwards in time starting at T0. The sum of the forecast data is accumulated forwards in time starting at T0.

Hydrological Information

Purpose and use of Transformation:	This transformation can for instance be used to report the historical accumulated sum backwards in time and the forecast accumulated sum of the discharge per month.

Background and Exceptions:	In case the input is instantaneous or mean and the output is accumulation, the unit of the input must be unit/s. The input type (scalar or grid) must be the same as the output type and their timestep must be regular. In case the ignoreMissing value is set to false, once a missing value is encountered, the output will only contain missing values after that time step.

Input

inputVariable Regular scalar timeseries or regular grid.

Options

ignoreMissing Treat a missing value as 0 (default true).

CoefficientSets

No connection to CoefficientSets.

Output

outputVariable Accumulated sum of the input data.

Configuration Example

Configuration example for calculation of Accumulation SumOriginAtTimeZero.

<?xml version="1.0" encoding="UTF-8"?>
<transformationModule version="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.wldelft.nl/fews" xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/transformationModule.xsd">
	<!-- input variables -->
	<variable>
		<variableId>input</variableId>
		<timeSeriesSet>
			<moduleInstanceId>AccumulationSumOriginAtTimeZero</moduleInstanceId>
			<valueType>scalar</valueType>
			<parameterId>H.m</parameterId>
			<locationId>H-2001</locationId>
			<timeSeriesType>external historical</timeSeriesType>
			<timeStep unit="day"/>
			<relativeViewPeriod unit="day" start="-15" end="15"/>
			<readWriteMode>editing visible to all future task runs</readWriteMode>
		</timeSeriesSet>
	</variable>
	<!-- output variables -->
	<variable>
		<variableId>output</variableId>
		<timeSeriesSet>
			<moduleInstanceId>AccumulationSumOriginAtTimeZero</moduleInstanceId>
			<valueType>scalar</valueType>
			<parameterId>Q.m</parameterId>
			<locationId>H-2001</locationId>
			<timeSeriesType>external historical</timeSeriesType>
			<timeStep unit="day"/>
			<relativeViewPeriod unit="day" start="-15" end="15"/>
			<readWriteMode>add originals</readWriteMode>
		</timeSeriesSet>
	</variable>
	<!-- transformations -->
	<transformation id="accumulation sum origin at time zero">
		<accumulation>
			<sumOriginAtTimeZero>
				<inputVariable>
					<variableId>input</variableId>
				</inputVariable>
				<ignoreMissing>false</ignoreMissing>
				<outputVariable>
					<variableId>output</variableId>
				</outputVariable>
			</sumOriginAtTimeZero>
		</accumulation>
	</transformation>
</transformationModule>

Page tree