Timstat 3.32 KB
Newer Older
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1
2
3
@BeginModule
@NewPage
@Name      = Timstat
Uwe Schulzweida's avatar
Uwe Schulzweida committed
4
@Title     = Statistical values over all timesteps
Uwe Schulzweida's avatar
Uwe Schulzweida committed
5
6
@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 = timmin timmax timrange timsum timmean timavg timstd timstd1 timvar timvar1
Uwe Schulzweida's avatar
Uwe Schulzweida committed
9
10

@BeginDescription
Uwe Schulzweida's avatar
Uwe Schulzweida committed
11
12
This module computes statistical values over all timesteps in @file{infile}. Depending on 
the chosen operator the minimum, maximum, range, sum, average, variance or standard deviation of 
Uwe Schulzweida's avatar
Uwe Schulzweida committed
13
14
all timesteps read from @file{infile} is written to @file{outfile}.
The time of @file{outfile} is determined by the time in the middle of all contributing timesteps of @file{infile}.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
15
16
17
18
19
20
21
22
23
24
25
26
27
@EndDescription
@EndModule


@BeginOperator_timmin
@Title     = Time minimum

@BeginDescription
@IfMan
o(1,x) = min{i(t',x), t_1<t'<=t_n}
@EndifMan
@IfDoc
@BeginMath
Uwe Schulzweida's avatar
Uwe Schulzweida committed
28
o(1,x) = \mbox{\textbf{min}}\{i(t',x), t_1 < t' \leq t_n\}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
@EndMath
@EndifDoc
@EndDescription
@EndOperator


@BeginOperator_timmax
@Title     = Time maximum

@BeginDescription
@IfMan
o(1,x) = max{i(t',x), t_1<t'<=t_n}
@EndifMan
@IfDoc
@BeginMath
Uwe Schulzweida's avatar
Uwe Schulzweida committed
44
o(1,x) = \mbox{\textbf{max}}\{i(t',x), t_1 < t' \leq t_n\}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
@EndMath
@EndifDoc
@EndDescription
@EndOperator


@BeginOperator_timrange
@Title     = Time range

@BeginDescription
@IfMan
o(1,x) = range{i(t',x), t_1<t'<=t_n}
@EndifMan
@IfDoc
@BeginMath
o(1,x) = \mbox{\textbf{range}}\{i(t',x), t_1 < t' \leq t_n\}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
@EndMath
@EndifDoc
@EndDescription
@EndOperator


@BeginOperator_timsum
@Title     = Time sum

@BeginDescription
@IfMan
o(1,x) = sum{i(t',x), t_1<t'<=t_n}
@EndifMan
@IfDoc
@BeginMath
Uwe Schulzweida's avatar
Uwe Schulzweida committed
76
o(1,x) = \mbox{\textbf{sum}}\{i(t',x), t_1 < t' \leq t_n\}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
@EndMath
@EndifDoc
@EndDescription
@EndOperator


@BeginOperator_timmean
@Title     = Time mean

@BeginDescription
@IfMan
o(1,x) = mean{i(t',x), t_1<t'<=t_n}
@EndifMan
@IfDoc
@BeginMath
Uwe Schulzweida's avatar
Uwe Schulzweida committed
92
o(1,x) = \mbox{\textbf{mean}}\{i(t',x), t_1 < t' \leq t_n\}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
@EndMath
@EndifDoc
@EndDescription
@EndOperator


@BeginOperator_timavg
@Title     = Time average

@BeginDescription
@IfMan
o(1,x) = avg{i(t',x), t_1<t'<=t_n}
@EndifMan
@IfDoc
@BeginMath
Uwe Schulzweida's avatar
Uwe Schulzweida committed
108
o(1,x) = \mbox{\textbf{avg}}\{i(t',x), t_1 < t' \leq t_n\}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
109
110
111
112
113
114
@EndMath
@EndifDoc
@EndDescription
@EndOperator


Uwe Schulzweida's avatar
Uwe Schulzweida committed
115
116
117
118
@BeginOperator_timvar
@Title     = Time variance

@BeginDescription
Uwe Schulzweida's avatar
Uwe Schulzweida committed
119
Normalize by n. 
Uwe Schulzweida's avatar
Uwe Schulzweida committed
120

Uwe Schulzweida's avatar
Uwe Schulzweida committed
121
122
123
124
125
@IfMan
o(1,x) = var{i(t',x), t_1<t'<=t_n}
@EndifMan
@IfDoc
@BeginMath
Uwe Schulzweida's avatar
Uwe Schulzweida committed
126
o(1,x) = \mbox{\textbf{var}}\{i(t',x), t_1 < t' \leq t_n\}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
127
128
129
130
131
132
@EndMath
@EndifDoc
@EndDescription
@EndOperator


Uwe Schulzweida's avatar
Uwe Schulzweida committed
133
@BeginOperator_timvar1
Uwe Schulzweida's avatar
Uwe Schulzweida committed
134
@Title     = Time variance (n-1)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
135
136

@BeginDescription
Uwe Schulzweida's avatar
Uwe Schulzweida committed
137
Normalize by (n-1). 
Uwe Schulzweida's avatar
Uwe Schulzweida committed
138
139
140
141
142
143

@IfMan
o(1,x) = var1{i(t',x), t_1<t'<=t_n}
@EndifMan
@IfDoc
@BeginMath
Uwe Schulzweida's avatar
Uwe Schulzweida committed
144
o(1,x) = \mbox{\textbf{var1}}\{i(t',x), t_1 < t' \leq t_n\}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
145
146
147
148
149
150
@EndMath
@EndifDoc
@EndDescription
@EndOperator


Uwe Schulzweida's avatar
Uwe Schulzweida committed
151
152
153
154
@BeginOperator_timstd
@Title     = Time standard deviation

@BeginDescription
Uwe Schulzweida's avatar
Uwe Schulzweida committed
155
Normalize by n. 
Uwe Schulzweida's avatar
Uwe Schulzweida committed
156

Uwe Schulzweida's avatar
Uwe Schulzweida committed
157
158
159
160
161
@IfMan
o(1,x) = std{i(t',x), t_1<t'<=t_n}
@EndifMan
@IfDoc
@BeginMath
Uwe Schulzweida's avatar
Uwe Schulzweida committed
162
o(1,x) = \mbox{\textbf{std}}\{i(t',x), t_1 < t' \leq t_n\}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
163
164
165
166
167
168
@EndMath
@EndifDoc
@EndDescription
@EndOperator


Uwe Schulzweida's avatar
Uwe Schulzweida committed
169
@BeginOperator_timstd1
Uwe Schulzweida's avatar
Uwe Schulzweida committed
170
@Title     = Time standard deviation (n-1)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
171
172

@BeginDescription
Uwe Schulzweida's avatar
Uwe Schulzweida committed
173
Normalize by (n-1). 
Uwe Schulzweida's avatar
Uwe Schulzweida committed
174
175
176
177
178
179

@IfMan
o(1,x) = std1{i(t',x), t_1<t'<=t_n}
@EndifMan
@IfDoc
@BeginMath
Uwe Schulzweida's avatar
Uwe Schulzweida committed
180
o(1,x) = \mbox{\textbf{std1}}\{i(t',x), t_1 < t' \leq t_n\}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
181
182
183
184
185
186
@EndMath
@EndifDoc
@EndDescription
@EndOperator


Uwe Schulzweida's avatar
Uwe Schulzweida committed
187
@BeginExample
Uwe Schulzweida's avatar
Uwe Schulzweida committed
188
To compute the mean over all input timesteps use:
Uwe Schulzweida's avatar
Uwe Schulzweida committed
189
@BeginVerbatim
Uwe Schulzweida's avatar
Uwe Schulzweida committed
190
   cdo timmean infile outfile
Uwe Schulzweida's avatar
Uwe Schulzweida committed
191
192
@EndVerbatim
@EndExample