-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathreduce.html
525 lines (499 loc) · 40.7 KB
/
reduce.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Axis Reductions — PyGeode 1.4.1-rc2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/pygtheme.css" />
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/pygeode_icon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Array manipulation routines" href="varops.html" />
<link rel="prev" title="Element-wise math" href="ufunc.html" />
<link href="http://fonts.googleapis.com/css?family=Ubuntu:300,300italic,regular,italic,500,500italic,bold,bolditalic" rel="stylesheet" type="text/css">
<link href='http://fonts.googleapis.com/css?family=Ubuntu+Mono:400,700' rel='stylesheet' type='text/css'>
</head><body>
<div class="header" role="banner"><img class="logo" src="_static/pygeode_logo.png" width=79px alt="Logo"/>
<h1 class="heading"><a href="index.html">
<span>PyGeode 1.4.1-rc2 documentation</span></a></h1>
<h2 class="heading"><span>Axis Reductions</span></h2>
</div>
<div class="topnav" role="navigation" aria-label="top navigation">
<p>
«  <a href="ufunc.html">Element-wise math</a>
  ::  
<a class="uplink" href="reference.html">Reference</a>
  ::  
<a class="uplink" href="tutorial.html">Tutorial</a>
  ::  
<a class="uplink" href="gallery/index.html">Gallery</a>
  ::  
<a href="varops.html">Array manipulation routines</a>  »
</p>
</div>
<div class="content">
<div class="section" id="axis-reductions">
<h1>Axis Reductions<a class="headerlink" href="#axis-reductions" title="Permalink to this headline">¶</a></h1>
<p>These functions compute summary statistics over specified axes of a variable.
In general multiple axes can be reduced over at the same time. Many of them
wrap similar numpy functions, though they are also capable of performing these
operations on datasets too large to fit in memory. Most operations have two
versions, one which computes the reduction including every element without
checking for the presence of NaNs, and one which ignores any element which is a NaN, adjusting
the relevant normalization.</p>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.mean">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">mean</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">axes</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pygeode.Var.mean" title="Permalink to this definition">¶</a></dt>
<dd><p>Computes the mean of this variable. If weights are present on any of the
axes, a weighted mean is computed by default.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>*axes</strong><span class="classifier">any number of axis identifiers (string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a>, or int) (optional)</span></dt><dd><p>Axes over which the average should be computed. If none are provided, the
mean is computed over the whole domain.</p>
</dd>
<dt><strong>weights</strong><span class="classifier">boolean or <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> (optional)</span></dt><dd><p>If provided, a weighted mean is performed. If True (the default), the default
weights associated with the variable are used (getweights). If False, or None, no
weighting is performed. Finally, custom weights can be provided in the form of a
<a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a>; this var must be defined on a subset of the axes being averaged over.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>out</strong><span class="classifier"><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a></span></dt><dd><p><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> defined on a subgrid of this variable. If the mean is computed over
the whole domain, a python scalar is returned.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#pygeode.Var.nanmean" title="pygeode.Var.nanmean"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nanmean</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="varquery.html#pygeode.Var.getweights" title="pygeode.Var.getweights"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getweights</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.nanmean">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">nanmean</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">axes</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pygeode.Var.nanmean" title="Permalink to this definition">¶</a></dt>
<dd><p>Computes the mean of this variable, ignoring any NaNs in the domain.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>*axes</strong><span class="classifier">any number of axis identifiers (string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a>, or int) (optional)</span></dt><dd><p>Axes over which the average should be computed. If none are provided, the
mean is computed over the whole domain.</p>
</dd>
<dt><strong>weights</strong><span class="classifier">boolean or <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> (optional)</span></dt><dd><p>If provided, a weighted mean is performed. If True (the default), the default
weights associated with the variable are used (getweights). If False, or None, no
weighting is performed. Finally, custom weights can be provided in the form of a
<a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a>; this var must be defined on a subset of the axes being averaged over.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>out</strong><span class="classifier"><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a></span></dt><dd><p><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> defined on a subgrid of this variable. If the mean is computed over
the whole domain, a python scalar is returned.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#pygeode.Var.mean" title="pygeode.Var.mean"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mean</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="varquery.html#pygeode.Var.getweights" title="pygeode.Var.getweights"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getweights</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.sum">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">sum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">axes</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pygeode.Var.sum" title="Permalink to this definition">¶</a></dt>
<dd><p>Computes the sum of this variable. NB: Unlike mean, weights are not used by default.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>*axes</strong><span class="classifier">any number of axis identifiers (string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a>, or int) (optional)</span></dt><dd><p>Axes over which the sum should be computed. If none are provided, the
sum is computed over the whole domain.</p>
</dd>
<dt><strong>weights</strong><span class="classifier">boolean or <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> (optional)</span></dt><dd><p>If provided, a weighted sum is performed. If True, the default
weights associated with the variable are used (getweights). If False or None (the default), no
weighting is performed. Finally, custom weights can be provided in the form of a <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a>;
this var must be defined on a subset of the axes being summed over.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>out</strong><span class="classifier"><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a></span></dt><dd><p><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> defined on a subgrid of this variable. If the sum is computed over
the whole domain, a python scalar is returned.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="varquery.html#pygeode.Var.getweights" title="pygeode.Var.getweights"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getweights</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.nansum">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">nansum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">axes</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pygeode.Var.nansum" title="Permalink to this definition">¶</a></dt>
<dd><p>Computes the sum of this variable, ignoring any NaNs.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>*axes</strong><span class="classifier">any number of axis identifiers (string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a>, or int) (optional)</span></dt><dd><p>Axes over which the sum should be computed. If none are provided, the
sum is computed over the whole domain.</p>
</dd>
<dt><strong>weights</strong><span class="classifier">boolean or <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> (optional)</span></dt><dd><p>If provided, a weighted sum is performed. If True, the default
weights associated with the variable are used (getweights). If False or None (the default), no
weighting is performed. Finally, custom weights can be provided in the form of a <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a>;
this var must be defined on a subset of the axes being summed over.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>out</strong><span class="classifier"><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a></span></dt><dd><p><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> defined on a subgrid of this variable. If the sum is computed over
the whole domain, a python scalar is returned.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="varquery.html#pygeode.Var.getweights" title="pygeode.Var.getweights"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getweights</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.stdev">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">stdev</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">axes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pygeode.Var.stdev" title="Permalink to this definition">¶</a></dt>
<dd><p>Computes the standard deviation of this variable.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>*axes</strong><span class="classifier">any number of axis identifiers (string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a>, or int) (optional)</span></dt><dd><p>Axes over which the standard deviation should be computed. If none are provided, the
standard deviation is computed over the whole domain.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>out</strong><span class="classifier"><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a></span></dt><dd><p><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> defined on a subgrid of this variable. If the variance is
computed over the whole domain, a python scalar is returned.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#pygeode.Var.variance" title="pygeode.Var.variance"><code class="xref py py-obj docutils literal notranslate"><span class="pre">variance</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="#pygeode.Var.nanstdev" title="pygeode.Var.nanstdev"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nanstdev</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="#pygeode.Var.nanvariance" title="pygeode.Var.nanvariance"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nanvariance</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.nanstdev">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">nanstdev</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">axes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pygeode.Var.nanstdev" title="Permalink to this definition">¶</a></dt>
<dd><p>Computes the standard deviation of this variable, ignoring any NaNs present.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>*axes</strong><span class="classifier">any number of axis identifiers (string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a>, or int) (optional)</span></dt><dd><p>Axes over which the standard deviation should be computed. If none are provided, the
standard deviation is computed over the whole domain.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>out</strong><span class="classifier"><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a></span></dt><dd><p><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> defined on a subgrid of this variable. If the variance is
computed over the whole domain, a python scalar is returned.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#pygeode.Var.stdev" title="pygeode.Var.stdev"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stdev</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="#pygeode.Var.variance" title="pygeode.Var.variance"><code class="xref py py-obj docutils literal notranslate"><span class="pre">variance</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="#pygeode.Var.nanvariance" title="pygeode.Var.nanvariance"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nanvariance</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.variance">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">variance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">axes</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pygeode.Var.variance" title="Permalink to this definition">¶</a></dt>
<dd><p>Computes the variance of this variable.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>*axes</strong><span class="classifier">any number of axis identifiers (string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a>, or int) (optional)</span></dt><dd><p>Axes over which the variance should be computed. If none are provided, the
variance is computed over the whole domain.</p>
</dd>
<dt><strong>weights</strong><span class="classifier">boolean or <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> (optional, default False)</span></dt><dd><p>If provided, a weighted variance is calculated. If True, the default
weights associated with the variable are used (getweights). If False, or None, no
weighting is performed. Finally, custom weights can be provided in the form of a
<a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a>; this var must be defined on a subset of the axes being reduced.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>out</strong><span class="classifier"><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a></span></dt><dd><p><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> defined on a subgrid of this variable. If the variance is
computed over the whole domain, a python scalar is returned.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#pygeode.Var.stdev" title="pygeode.Var.stdev"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stdev</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="#pygeode.Var.nanvariance" title="pygeode.Var.nanvariance"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nanvariance</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="#pygeode.Var.nanstdev" title="pygeode.Var.nanstdev"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nanstdev</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.nanvariance">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">nanvariance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">axes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pygeode.Var.nanvariance" title="Permalink to this definition">¶</a></dt>
<dd><p>Computes the variance of this variable, ignoring any NaNs.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>*axes</strong><span class="classifier">any number of axis identifiers (string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a>, or int) (optional)</span></dt><dd><p>Axes over which the variance should be computed. If none are provided, the
variance is computed over the whole domain.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>out</strong><span class="classifier"><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a></span></dt><dd><p><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> defined on a subgrid of this variable. If the variance is
computed over the whole domain, a python scalar is returned.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#pygeode.Var.variance" title="pygeode.Var.variance"><code class="xref py py-obj docutils literal notranslate"><span class="pre">variance</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="#pygeode.Var.stdev" title="pygeode.Var.stdev"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stdev</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="#pygeode.Var.nanstdev" title="pygeode.Var.nanstdev"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nanstdev</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.min">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">min</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">axes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pygeode.Var.min" title="Permalink to this definition">¶</a></dt>
<dd><p>Computes the minimum value of this variable.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>*axes</strong><span class="classifier">any number of axis identifiers (string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a>, or int) (optional)</span></dt><dd><p>Axes over which the minimum should be found. If none are provided, the
global minimum is found.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>out</strong><span class="classifier"><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a></span></dt><dd><p><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> defined on a subgrid of this variable. If the global minimum
is requested, a python scalar is returned.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#pygeode.Var.max" title="pygeode.Var.max"><code class="xref py py-obj docutils literal notranslate"><span class="pre">max</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="#pygeode.Var.nanmax" title="pygeode.Var.nanmax"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nanmax</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="#pygeode.Var.nanmin" title="pygeode.Var.nanmin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nanmin</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.nanmin">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">nanmin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">axes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pygeode.Var.nanmin" title="Permalink to this definition">¶</a></dt>
<dd><p>Computes the minimum value of this variable, ignoring NaNs.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>*axes</strong><span class="classifier">any number of axis identifiers (string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a>, or int) (optional)</span></dt><dd><p>Axes over which the minimum should be found. If none are provided, the
global minimum is found.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>out</strong><span class="classifier"><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a></span></dt><dd><p><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> defined on a subgrid of this variable. If the global minimum
is requested, a python scalar is returned.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#pygeode.Var.min" title="pygeode.Var.min"><code class="xref py py-obj docutils literal notranslate"><span class="pre">min</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="#pygeode.Var.max" title="pygeode.Var.max"><code class="xref py py-obj docutils literal notranslate"><span class="pre">max</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="#pygeode.Var.nanmax" title="pygeode.Var.nanmax"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nanmax</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.max">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">max</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">axes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pygeode.Var.max" title="Permalink to this definition">¶</a></dt>
<dd><p>Computes the maximum value of this variable.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>*axes</strong><span class="classifier">any number of axis identifiers (string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a>, or int) (optional)</span></dt><dd><p>Axes over which the maximum should be found. If none are provided, the
global maximum is found.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>out</strong><span class="classifier"><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a></span></dt><dd><p><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> defined on a subgrid of this variable. If the global maximum
is requested, a python scalar is returned.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#pygeode.Var.min" title="pygeode.Var.min"><code class="xref py py-obj docutils literal notranslate"><span class="pre">min</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="#pygeode.Var.nanmax" title="pygeode.Var.nanmax"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nanmax</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="#pygeode.Var.nanmin" title="pygeode.Var.nanmin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nanmin</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.nanmax">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">nanmax</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">axes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pygeode.Var.nanmax" title="Permalink to this definition">¶</a></dt>
<dd><p>Computes the maximum value of this variable, ignoring NaNs.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>*axes</strong><span class="classifier">any number of axis identifiers (string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a>, or int) (optional)</span></dt><dd><p>Axes over which the maximum should be found. If none are provided, the
global maximum is found.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>out</strong><span class="classifier"><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a></span></dt><dd><p><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> defined on a subgrid of this variable. If the global maximum
is requested, a python scalar is returned.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#pygeode.Var.max" title="pygeode.Var.max"><code class="xref py py-obj docutils literal notranslate"><span class="pre">max</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="#pygeode.Var.min" title="pygeode.Var.min"><code class="xref py py-obj docutils literal notranslate"><span class="pre">min</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="#pygeode.Var.nanmin" title="pygeode.Var.nanmin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nanmin</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.argmin">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">argmin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">axis</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pygeode.Var.argmin" title="Permalink to this definition">¶</a></dt>
<dd><p>Finds the index of the minumum value of this variable along the given axis.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>axis</strong><span class="classifier">a single axis identifier (string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a>, or int) (optional)</span></dt><dd><p>Axis over which the index of the minimum should be found.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>out</strong><span class="classifier"><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a></span></dt><dd><p><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> defined on all axes of this variable except <code class="docutils literal notranslate"><span class="pre">axis</span></code>,
containing the index of the minimum.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#pygeode.Var.argmax" title="pygeode.Var.argmax"><code class="xref py py-obj docutils literal notranslate"><span class="pre">argmax</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.argmax">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">argmax</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">axis</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pygeode.Var.argmax" title="Permalink to this definition">¶</a></dt>
<dd><p>Finds the index of the maximum value of this variable along the given axis.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>axis</strong><span class="classifier">a single axis identifier (string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a>, or int) (optional)</span></dt><dd><p>Axis over which the index of the maximum should be found.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>out</strong><span class="classifier"><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a></span></dt><dd><p><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> defined on all axes of this variable except <code class="docutils literal notranslate"><span class="pre">axis</span></code>,
containing the index of the maximum.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#pygeode.Var.argmin" title="pygeode.Var.argmin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">argmin</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl>
<dt><strong>See Also:</strong></dt><dd><p><a class="reference internal" href="var.html"><span class="doc">Var class overview</span></a></p>
<p><a class="reference external" href="https://numpy.org/doc/stable/reference/arrays.ndarray.html#arrays-ndarray" title="(in NumPy v1.22)"><span>The N-dimensional array (ndarray)</span></a> (external Numpy documentation)</p>
</dd>
</dl>
</div>
</div>
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
<p>
«  <a href="ufunc.html">Element-wise math</a>
  ::  
<a class="uplink" href="reference.html">Reference</a>
  ::  
<a class="uplink" href="tutorial.html">Tutorial</a>
  ::  
<a class="uplink" href="gallery/index.html">Gallery</a>
  ::  
<a href="varops.html">Array manipulation routines</a>  »
</p>
</div>
<div class="footer" role="contentinfo">
© Copyright 2020, Mike Neish, Peter Hitchcock.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
</div>
</body>
</html>