Zonstat 2.84 KB
Newer Older
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1
2
3
4
5
6
@BeginModule
@NewPage
@Name      = Zonstat
@Title     = Zonal statistical values
@Section   = Statistical values
@Class     = Statistic
Uwe Schulzweida's avatar
Uwe Schulzweida committed
7
@Arguments = infile outfile
Uwe Schulzweida's avatar
Uwe Schulzweida committed
8
@Operators = zonmin zonmax zonrange zonsum zonmean zonavg zonstd zonstd1 zonvar zonvar1 zonpctl
Uwe Schulzweida's avatar
Uwe Schulzweida committed
9
10
11

@BeginDescription
This module computes zonal statistical values of the input fields.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
12
According to the chosen operator the zonal minimum, maximum, range, sum, average,
Uwe Schulzweida's avatar
Uwe Schulzweida committed
13
variance, standard deviation or a certain percentile is written to @file{outfile}.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
14
This operator requires all variables on the same regular lon/lat grid.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
@EndDescription
@EndModule


@BeginOperator_zonmin
@Title     = Zonal minimum

@BeginDescription
For every latitude the minimum over all longitudes is computed.
@EndDescription
@EndOperator


@BeginOperator_zonmax
@Title     = Zonal maximum

@BeginDescription
For every latitude the maximum over all longitudes is computed.
@EndDescription
@EndOperator


Uwe Schulzweida's avatar
Uwe Schulzweida committed
37
38
39
40
41
42
43
44
45
@BeginOperator_zonrange
@Title     = Zonal range

@BeginDescription
For every latitude the range over all longitudes is computed.
@EndDescription
@EndOperator


Uwe Schulzweida's avatar
Uwe Schulzweida committed
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
@BeginOperator_zonsum
@Title     = Zonal sum

@BeginDescription
For every latitude the sum over all longitudes is computed.
@EndDescription
@EndOperator


@BeginOperator_zonmean
@Title     = Zonal mean

@BeginDescription
For every latitude the mean over all longitudes is computed.
@EndDescription
@EndOperator


@BeginOperator_zonavg
@Title     = Zonal average

@BeginDescription
For every latitude the average over all longitudes is computed.
@EndDescription
@EndOperator


@BeginOperator_zonvar
@Title     = Zonal variance

@BeginDescription
Uwe Schulzweida's avatar
Uwe Schulzweida committed
77
For every latitude the variance over all longitudes is computed. Normalize by n.
78
79
80
81
82
@EndDescription
@EndOperator


@BeginOperator_zonvar1
Uwe Schulzweida's avatar
Uwe Schulzweida committed
83
@Title     = Zonal variance (n-1)
84
85

@BeginDescription
Uwe Schulzweida's avatar
Uwe Schulzweida committed
86
For every latitude the variance over all longitudes is computed. Normalize by (n-1).
Uwe Schulzweida's avatar
Uwe Schulzweida committed
87
88
89
90
91
92
93
94
@EndDescription
@EndOperator


@BeginOperator_zonstd
@Title     = Zonal standard deviation

@BeginDescription
Uwe Schulzweida's avatar
Uwe Schulzweida committed
95
For every latitude the standard deviation over all longitudes is computed. Normalize by n.
96
97
98
99
100
@EndDescription
@EndOperator


@BeginOperator_zonstd1
Uwe Schulzweida's avatar
Uwe Schulzweida committed
101
@Title     = Zonal standard deviation (n-1)
102
103

@BeginDescription
Uwe Schulzweida's avatar
Uwe Schulzweida committed
104
For every latitude the standard deviation over all longitudes is computed. Normalize by (n-1). 
Uwe Schulzweida's avatar
Uwe Schulzweida committed
105
106
107
108
@EndDescription
@EndOperator


Uwe Schulzweida's avatar
Uwe Schulzweida committed
109
110
111
112
113
114
115
116
117
118
119
120
@BeginOperator_zonpctl
@Title     = Zonal percentiles
@Parameter = p

@BeginDescription
For every latitude the pth percentile over all longitudes is computed.
@EndDescription
@EndOperator


@BeginParameter
@Item = p
121
FLOAT  Percentile number in {0, ..., 100}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
122
123
124
@EndParameter


Uwe Schulzweida's avatar
Uwe Schulzweida committed
125
@BeginExample
Uwe Schulzweida's avatar
Uwe Schulzweida committed
126
To compute the zonal mean of all input fields use:
Uwe Schulzweida's avatar
Uwe Schulzweida committed
127
@BeginVerbatim
Uwe Schulzweida's avatar
Uwe Schulzweida committed
128
   cdo zonmean infile outfile
Uwe Schulzweida's avatar
Uwe Schulzweida committed
129
@EndVerbatim
Uwe Schulzweida's avatar
Uwe Schulzweida committed
130

Uwe Schulzweida's avatar
Uwe Schulzweida committed
131
To compute the 50th meridional percentile (median) of all input fields use:
Uwe Schulzweida's avatar
Uwe Schulzweida committed
132
@BeginVerbatim
Uwe Schulzweida's avatar
Uwe Schulzweida committed
133
   cdo zonpctl,50 infile outfile
Uwe Schulzweida's avatar
Uwe Schulzweida committed
134
@EndVerbatim
Uwe Schulzweida's avatar
Uwe Schulzweida committed
135
@EndExample