Consecstat 1.5 KB
Newer Older
Ralf Mueller's avatar
Ralf Mueller committed
1
2
3
4
5
6
7
8
9
@BeginModule
@Name      = Consecstat
@Title     = Consecute timestep periods
@Section   = Statistical values
@Class     = Statistic
@Arguments = ifile ofile
@Operators = consecsum consects

@BeginDescription
Uwe Schulzweida's avatar
Uwe Schulzweida committed
10
This module computes periods over all timesteps in @file{ifile} where a
Uwe Schulzweida's avatar
Uwe Schulzweida committed
11
certain property is valid. The propery can be chosen by creating a mask from
Ralf Mueller's avatar
Ralf Mueller committed
12
13
14
15
16
17
the original data, which is the expected input format for operators of this
module. Depending on the operator full information about each period or
just its length and ending date are computed.
@EndDescription
@EndModule

Uwe Schulzweida's avatar
Uwe Schulzweida committed
18

Ralf Mueller's avatar
Ralf Mueller committed
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
@BeginOperator_consecsum
@Title     = Consecutive Sum

@BeginDescription
This operator computes periods of consecutive timesteps similar to a
@mod{runsum}, but periods are finished, when the mask value is 0. That way
multiple periods can be found. Timesteps from the input are preserved. Missing
values are handled like 0, i.e. finish periods of consecutive timesteps.
@EndDescription
@EndOperator


@BeginOperator_consects
@Title     = Consecutive Timesteps

@BeginDescription
In contrast to the operator above consects only computes the lenght of each
period together with its last timestep. To be able to perform statistical
37
analysis like min, max or mean, everything else is set to missing value.
Ralf Mueller's avatar
Ralf Mueller committed
38
39
40
41
42
@EndDescription
@EndOperator


@BeginExample
Uwe Schulzweida's avatar
Uwe Schulzweida committed
43
44
For a given time series of daily temperatures, the periods of summer days can be
calculated with inplace maskting the input field:
Ralf Mueller's avatar
Ralf Mueller committed
45
@BeginVerbatim
Uwe Schulzweida's avatar
Uwe Schulzweida committed
46
   cdo consects -gtc,20.0 ifile1 ofile
Ralf Mueller's avatar
Ralf Mueller committed
47
48
@EndVerbatim
@EndExample