View Source

Description

Set of rules to allow selection of maximum values from an input time series.

Input

Scalar or grid time series

Options

An optional attribute "selectNumberOfHighestMax" may be defined. The value attribute defines the number of highest maximum values which will be written to the output timeseries.
The periodTransformation may be applied to this transformation (see Configuration example 2 below).

Output

Timeseries containing the selection of maximum values.

Configuration example 1

<transformation id="maximum function test">
   <selection>
      <maximum>
         <inputVariable>
            <timeSeriesSet>
               <moduleInstanceId>Import</moduleInstanceId>
               <valueType>scalar</valueType>
               <parameterId>H.tidal</parameterId>
               <locationId>H-2010</locationId>
               <timeSeriesType>external historical</timeSeriesType>
               <timeStep unit="minute" multiplier="15"/>
               <relativeViewPeriod unit="day" start="0" end="365"/>
               <readWriteMode>editing visible to all future task runs</readWriteMode>
            </timeSeriesSet>
         </inputVariable>
         <outputVariable>
            <timeSeriesSet>
               <moduleInstanceId>SelectionMaximumFunctionTest</moduleInstanceId>
               <valueType>scalar</valueType>
               <parameterId>H.updated</parameterId>
               <locationId>H-2010</locationId>
               <timeSeriesType>external historical</timeSeriesType>
               <timeStep unit="nonequidistant"/>
               <relativeViewPeriod unit="day" start="-5" end="15"/>
               <readWriteMode>add originals</readWriteMode>
            </timeSeriesSet>
         </outputVariable>
      </maximum>
   </selection>
</transformation>

Grid example:

<transformation id="maximum function test">
   <selection>
      <maximum>
         <inputVariable>
            <timeSeriesSet>
               <moduleInstanceId>Import</moduleInstanceId>
               <valueType>grid</valueType>
               <parameterId>H.obs</parameterId>
               <locationId>H-2010</locationId>
               <timeSeriesType>external historical</timeSeriesType>
               <timeStep unit="minute" multiplier="15"/>
               <relativeViewPeriod unit="day" start="0" end="365"/>
               <readWriteMode>editing visible to all future task runs</readWriteMode>
            </timeSeriesSet>
         </inputVariable>
         <outputVariable>
            <timeSeriesSet>
               <moduleInstanceId>SelectionMaximumFunctionTest</moduleInstanceId>
               <valueType>grid</valueType>
               <parameterId>param</parameterId>
               <locationId>H-2010</locationId>
               <timeSeriesType>external historical</timeSeriesType>
               <timeStep unit="nonequidistant"/>
               <relativeViewPeriod unit="day" start="-5" end="15"/>
               <readWriteMode>add originals</readWriteMode>
            </timeSeriesSet>
         </outputVariable>
      </maximum>
   </selection>
</transformation>

In this example:

The highest maximum value of the input series is returned by the output time series.

Configuration example 2

<transformation id="period maximum function test">
	<periodTransformation>
		<period>
			<season>
				<startMonthDay>--04-01</startMonthDay>
				<endMonthDay>--03-31</endMonthDay>
			</season>
		</period>
		<selection>
			<maximum>
				<inputVariable>
					<timeSeriesSet>
						<moduleInstanceId>Import</moduleInstanceId>
						<valueType>scalar</valueType>
						<parameterId>RH_24H</parameterId>
						<locationSetId>KNMIDAG</locationSetId>
						<timeSeriesType>external historical</timeSeriesType>
						<timeStep unit="day" multiplier="1" />
						<relativeViewPeriod unit="day" start="-2924" end="0"/>
						<readWriteMode>editing visible to all future task runs</readWriteMode>
					</timeSeriesSet>
				</inputVariable>
				<selectNumberOfHighestMax>3</selectNumberOfHighestMax>
				<outputVariable>
					<timeSeriesSet>
						<moduleInstanceId>SelectionPeriodMaximumFunctionTest</moduleInstanceId>
						<valueType>scalar</valueType>
						<parameterId>RH_24H.max</parameterId>
						<locationSetId>KNMIDAG</locationSetId>
						<timeSeriesType>external historical</timeSeriesType>
						<timeStep unit="nonequidistant"/>
						<relativeViewPeriod unit="day" start="-2924" end="0"/>
						<readWriteMode>editing visible to all future task runs</readWriteMode>
					</timeSeriesSet>
				</outputVariable>
			</maximum>
		</selection>
	</periodTransformation>
</transformation>

In this example:

For each hydrologic year, the three highest maximum values are returned by the output time series.