View Source

Description

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

Input

Timeseries

Options

In the configuration of peak selections there are two choices for refining the selection:

An attribute "totalNumberBeforeT0" must be defined. The value attribute defines the maximum number of peaks to consider before T0.
An attribute "totalNumberAfterT0" must be defined. The value attribute defines the maximum number of peaks to consider after T0.
An attribute "skipJustBeforeT0" indicates how many peaks to skip just before T0. (optional)
An attribute "skipJustAfterT0" indicates how many peaks to skip just after T0. (optional)

or

An attribute "totalNumber" must be defined. The value attribute defines the maximum number of peaks to consider.

Output

Timeseries containing the selection of peaks

Configuration example

<transformation id="peaks function test">
   <selection>
      <peaks>
         <inputVariable>
            <timeSeriesSet>
               <moduleInstanceId>SelectionPeaksFunctionTest</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>
         <totalNumberBeforeT0>3</totalNumberBeforeT0>
         <totalNumberAfterT0>4</totalNumberAfterT0>
         <skipJustBeforeT0>2</skipJustBeforeT0>
         <skipJustAfterT0>2</skipJustAfterT0>			
         <outputVariable>
            <timeSeriesSet>
               <moduleInstanceId>SelectionPeaksFunctionTest</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>
      </peaks>
   </selection>
</transformation>

In this example:

Only the last three peaks before T0 and the first four peaks after T0 are considered.
The first two peaks of the last three lows just before T0 are skipped, leaving only the third last one.
Similarly the first two peaks just after T0 are skipped, leaving the third and fourth ones.