Information

Transformation:

Duration

Transformation Group:

Events

Description:

Calculates either the net duration or the gross duration of the events initiated in the output period. An event in this transformation is defined as a the largest possible series of subsequent subevents where the duration of gaps (where there are no subevents) is shorter than the specified maxGapDuration parameter. A subevent is defined as a measurement in time in the input where the value is larger than the specified threshold parameter. The duration of a single subevent is equal to the duration of the input time step. The duration of an event is the sum of the duration of its subevents plus the duration of the gaps that do not exceed the maxGapDuration parameter, and is registered only in the output period where the event initiated.

Hydrological Information

Purpose and use of Transformation:

This transformation can for instance be used to report on the duration of sewer spillage events for each month.

Background and Exceptions:

The output time step must be bigger than the input time step. All input values must be non-missings, otherwise the result will be set to missing value. In case one of the inputs is doubtful, the output flag is set to ORIGINAL_DOUBTFUL.

Input

input Equidistant measurements (for instance m3/s).

Options

threshold Only measurements are used with a value above this value. Default is 0.
maxGapDuration When there is a gap between two subsequent subevents exceeding this duration, these subevents belong to two separate events. Default is 24 hours. In order to calculate the net duration instead of the gross duration, this value has to be set to zero.
outputTimeUnit Defines the time unit of the output (default is day).

CoefficientSets

No connection to CoefficientSets.

Output

output Duration of the selected events using the specified output unit.

Configuration Example

Configuration example for net duration of events for each month.

<?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 -->
	<!-- output variables -->
	<!-- transformations -->
	<transformation id="events net duration">
		<events>
			<duration>
				<input>
					<timeSeriesSet>
						<moduleInstanceId>EventsDuration_NetDuration</moduleInstanceId>
						<valueType>scalar</valueType>
						<parameterId>Q.dis</parameterId>
						<locationId>H-2001</locationId>
						<timeSeriesType>external historical</timeSeriesType>
						<timeStep unit="hour" multiplier="6"/>
						<relativeViewPeriod unit="day" start="0" end="113"/>
						<readWriteMode>editing visible to all future task runs</readWriteMode>
					</timeSeriesSet>
				</input>
				<maxGapDuration unit="day" multiplier="0" />
				<outputTimeUnit>hour</outputTimeUnit>
				<output>
					<timeSeriesSet>
						<moduleInstanceId>EventsDuration_NetDuration</moduleInstanceId>
						<valueType>scalar</valueType>
						<parameterId>Q.arg</parameterId>
						<locationId>H-2001</locationId>
						<timeSeriesType>external historical</timeSeriesType>
						<timeStep monthDays="--01-01 --02-01 --03-01 --04-01 --05-01 --06-01 --07-01 --08-01 --09-01 --10-01 --11-01 --12-01" />
						<relativeViewPeriod unit="day" start="0" end="113"/>
						<readWriteMode>add originals</readWriteMode>
					</timeSeriesSet>
				</output>
			</duration>
		</events>
	</transformation>
</transformationModule>

Configuration example for gross duration of events for each month.

<?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 -->
	<!-- output variables -->
	<!-- transformations -->
	<transformation id="events gross duration">
		<events>
			<duration>
				<input>
					<timeSeriesSet>
						<moduleInstanceId>EventsDuration_GrossDuration</moduleInstanceId>
						<valueType>scalar</valueType>
						<parameterId>Q.dis</parameterId>
						<locationId>H-2001</locationId>
						<timeSeriesType>external historical</timeSeriesType>
						<timeStep unit="hour" multiplier="6"/>
						<relativeViewPeriod unit="day" start="0" end="113"/>
						<readWriteMode>editing visible to all future task runs</readWriteMode>
					</timeSeriesSet>
				</input>
				<maxGapDuration unit="day" />
				<output>
					<timeSeriesSet>
						<moduleInstanceId>EventsDuration_GrossDuration</moduleInstanceId>
						<valueType>scalar</valueType>
						<parameterId>Q.arg</parameterId>
						<locationId>H-2001</locationId>
						<timeSeriesType>external historical</timeSeriesType>
						<timeStep monthDays="--01-01 --02-01 --03-01 --04-01 --05-01 --06-01 --07-01 --08-01 --09-01 --10-01 --11-01 --12-01" />
						<relativeViewPeriod unit="day" start="0" end="113"/>
						<readWriteMode>add originals</readWriteMode>
					</timeSeriesSet>
				</output>
			</duration>
		</events>
	</transformation>
</transformationModule>
  • No labels