forked from pygeode/pygeode.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathvarops.html
666 lines (645 loc) · 38.5 KB
/
varops.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
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Array manipulation routines — PyGeode 1.0 alpha documentation</title>
<link rel="stylesheet" href="_static/pygtheme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.0 alpha',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="top" title="PyGeode 1.0 alpha documentation" href="index.html" />
<link rel="up" title="Var class overview" href="var.html" />
<link rel="next" title="Other operations" href="var.other.html" />
<link rel="prev" title="Axis Reductions" href="reduce.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="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="var.other.html" title="Other operations"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="reduce.html" title="Axis Reductions"
accesskey="P">previous</a> |</li>
<li><a href="index.html">PyGeode 1.0 alpha documentation</a> »</li>
<li><a href="reference.html" >Reference</a> »</li>
<li><a href="var.html" accesskey="U">Var class overview</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="array-manipulation-routines">
<h1>Array manipulation routines<a class="headerlink" href="#array-manipulation-routines" title="Permalink to this headline">¶</a></h1>
<p>Operations that affect the shape or other attributes of the <cite>Var</cite>, while leaving the data intact.</p>
<dl class="method">
<dt id="pygeode.Var.__call__">
<tt class="descclassname">Var.</tt><tt class="descname">__call__</tt><big>(</big><em>ignore_mismatch=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pygeode.Var.__call__" title="Permalink to this definition">¶</a></dt>
<dd><p>Keyword-based data subsetting.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>ignore_mismatch</strong> : boolean (optional)</p>
<blockquote>
<div><p>If <tt class="docutils literal"><span class="pre">True</span></tt>, any keywords that don’t match an axis are ignored.
Default is <tt class="docutils literal"><span class="pre">False</span></tt></p>
</div></blockquote>
<p><strong>**kwargs</strong> : one or more keyword parameters</p>
<blockquote>
<div><p>The keys are the Axis names (or Axis class names), and the values are
either a <cite>tuple</cite> of the desired (lower,upper) range, or a single Axis
value. E.g., <tt class="docutils literal"><span class="pre">lat</span> <span class="pre">=</span> <span class="pre">(-45,45)</span></tt> or <tt class="docutils literal"><span class="pre">lat</span> <span class="pre">=</span> <span class="pre">10.5</span></tt></p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>subset_var</strong> : Var</p>
<blockquote class="last">
<div><p>A new Var, restricted to the specified domain.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>There are a couple of special prefixes which can be prepended to each
keyword to alter the subsetting behaviour. They can be used together.</p>
<blockquote>
<div><ul class="simple">
<li><strong>i_</strong> indicates that the values are <em>indices</em> into the axis, and not
the axis values themselves. Indices start at 0.
E.g. <tt class="docutils literal"><span class="pre">myvar(i_time</span> <span class="pre">=</span> <span class="pre">0)</span></tt> selects the first time step of the variable,
and <tt class="docutils literal"><span class="pre">myvar(i_lon=(10,20))</span></tt> selects the 11th through 21st longitudes.</li>
<li><strong>l_</strong> indicates that you are providing an explicit list of
coordinates, instead of a range.
E.g. <tt class="docutils literal"><span class="pre">myvar(l_lon</span> <span class="pre">=</span> <span class="pre">(105.,106.,107.,108))</span></tt></li>
<li><strong>n_</strong> returns the complement of the set you request; that is,
everything except the specified selection.
E.g. <tt class="docutils literal"><span class="pre">myvar(n_lat</span> <span class="pre">=</span> <span class="pre">(60,</span> <span class="pre">90))</span></tt> returns all latitudes except those between 60 and 90N.</li>
<li><strong>m_</strong> triggers an arithmetic mean over the specified range.
E.g., <tt class="docutils literal"><span class="pre">myvar(m_lon</span> <span class="pre">=</span> <span class="pre">(10,</span> <span class="pre">80))</span></tt> is a shortcut for doing
<tt class="docutils literal"><span class="pre">myvar(lon</span> <span class="pre">=</span> <span class="pre">(10,80)).mean('lon')</span></tt>.</li>
<li><strong>s_</strong> triggers a call to squeeze on the specified axis, so
that if only one value is selected the degenerate axis is removed.
E.g., <tt class="docutils literal"><span class="pre">myvar(s_lon</span> <span class="pre">=</span> <span class="pre">5)</span></tt> is a shortcut for doing
<tt class="docutils literal"><span class="pre">myvar(lon</span> <span class="pre">=</span> <span class="pre">5).squeeze()</span></tt> or <tt class="docutils literal"><span class="pre">myvar.squeeze(lon=5)</span></tt>.</li>
</ul>
</div></blockquote>
<p class="rubric">Examples</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pygeode.tutorial</span> <span class="kn">import</span> <span class="n">t1</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">t1</span><span class="o">.</span><span class="n">vars</span>
<span class="go">[<Var 'Temp'>]</span>
<span class="gp">>>> </span><span class="n">T</span> <span class="o">=</span> <span class="n">t1</span><span class="o">.</span><span class="n">Temp</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">T</span>
<span class="go"><Var 'Temp'>:</span>
<span class="go"> Shape: (lat,lon) (32,64)</span>
<span class="go"> Axes:</span>
<span class="go"> lat <Lat> : 85 S to 85 N (32 values)</span>
<span class="go"> lon <Lon> : 0 E to 354 E (64 values)</span>
<span class="go"> Attributes:</span>
<span class="go"> {'units': 'K'}</span>
<span class="go"> Type: Var (dtype="float64")</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">T</span><span class="p">(</span><span class="n">lat</span><span class="o">=</span><span class="mi">30</span><span class="p">,</span><span class="n">lon</span><span class="o">=</span><span class="p">(</span><span class="mi">100</span><span class="p">,</span><span class="mi">200</span><span class="p">))</span>
<span class="go"><Var 'Temp'>:</span>
<span class="go"> Shape: (lat,lon) (1,18)</span>
<span class="go"> Axes:</span>
<span class="go"> lat <Lat> : 30 N</span>
<span class="go"> lon <Lon> : 101 E to 196 E (18 values)</span>
<span class="go"> Attributes:</span>
<span class="go"> {'units': 'K'}</span>
<span class="go"> Type: SlicedVar (dtype="float64")</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pygeode.Var.squeeze">
<tt class="descclassname">Var.</tt><tt class="descname">squeeze</tt><big>(</big><em>*iaxes</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pygeode.Var.squeeze" title="Permalink to this definition">¶</a></dt>
<dd><p>Removes degenerate axes from a variable, reducing its dimensionality.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>*iaxes</strong> : one or more axes (optional)</p>
<blockquote>
<div><p>The axes to remove (they must already be degenerate). If no explicit axes
are provided, then <em>all</em> degenerate axes are removed.</p>
</div></blockquote>
<p><strong>**kwargs</strong> : keyword arguments</p>
<blockquote>
<div><p>Keyword-based axis slicing. Selects a particular value along the axis and
then removes the axis from the output. See <a class="reference internal" href="#pygeode.Var.__call__" title="pygeode.Var.__call__"><tt class="xref py py-meth docutils literal"><span class="pre">Var.__call__()</span></tt></a> for a
similar method which uses this keyword syntax.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>squeezed</strong> : Var</p>
<blockquote class="last">
<div><p>The squeezed variable</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pygeode.Var.extend">
<tt class="descclassname">Var.</tt><tt class="descname">extend</tt><big>(</big><em>pos</em>, <em>*newaxes</em><big>)</big><a class="headerlink" href="#pygeode.Var.extend" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds more axes to a variable. Data will be duplicated along these new axes.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>pos</strong> : int</p>
<blockquote>
<div><p>The position (within the variable’s current axes) to start inserting the
new axes.</p>
</div></blockquote>
<p><strong>*newaxes</strong> : one or more axes</p>
<blockquote>
<div><p>The new axes to insert</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>extended_var</strong> : Var</p>
<blockquote class="last">
<div><p>The variable, extended to include the new axes.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pygeode.tutorial</span> <span class="kn">import</span> <span class="n">t1</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">t1</span><span class="o">.</span><span class="n">Temp</span>
<span class="go"><Var 'Temp'>:</span>
<span class="go"> Shape: (lat,lon) (32,64)</span>
<span class="go"> Axes:</span>
<span class="go"> lat <Lat> : 85 S to 85 N (32 values)</span>
<span class="go"> lon <Lon> : 0 E to 354 E (64 values)</span>
<span class="go"> Attributes:</span>
<span class="go"> {'units': 'K'}</span>
<span class="go"> Type: Var (dtype="float64")</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pygeode</span> <span class="kn">import</span> <span class="n">Pres</span>
<span class="gp">>>> </span><span class="n">paxis</span> <span class="o">=</span> <span class="n">Pres</span><span class="p">([</span><span class="mi">1000</span><span class="p">,</span><span class="mi">850</span><span class="p">,</span><span class="mi">700</span><span class="p">])</span> <span class="c"># Create a pressure axis</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">paxis</span>
<span class="go">pres <Pres> : 1000 hPa to 700 hPa (3 values)</span>
<span class="gp">>>> </span><span class="n">extended_var</span> <span class="o">=</span> <span class="n">t1</span><span class="o">.</span><span class="n">Temp</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">paxis</span><span class="p">)</span> <span class="c"># Extend the data with this axis</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">extended_var</span>
<span class="go"><Var 'Temp'>:</span>
<span class="go"> Shape: (pres,lat,lon) (3,32,64)</span>
<span class="go"> Axes:</span>
<span class="go"> pres <Pres> : 1000 hPa to 700 hPa (3 values)</span>
<span class="go"> lat <Lat> : 85 S to 85 N (32 values)</span>
<span class="go"> lon <Lon> : 0 E to 354 E (64 values)</span>
<span class="go"> Attributes:</span>
<span class="go"> {'units': 'K'}</span>
<span class="go"> Type: ExtendedVar (dtype="float64")</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pygeode.Var.transpose">
<tt class="descclassname">Var.</tt><tt class="descname">transpose</tt><big>(</big><em>*axes</em><big>)</big><a class="headerlink" href="#pygeode.Var.transpose" title="Permalink to this definition">¶</a></dt>
<dd><p>Transposes the axes of a variable.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>*axes</strong> : one or more axis identifiers (strings, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><tt class="xref py py-class docutils literal"><span class="pre">Axis</span></tt></a> classes, integer indices)</p>
<blockquote>
<div><p>The new order of the axes. Any unspecified axes will be appended after these.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>transposed_var</strong> : Var</p>
<blockquote class="last">
<div><p>The transposed variable.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pygeode.tutorial</span> <span class="kn">import</span> <span class="n">t1</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">t1</span><span class="o">.</span><span class="n">Temp</span>
<span class="go"><Var 'Temp'>:</span>
<span class="go"> Shape: (lat,lon) (32,64)</span>
<span class="go"> Axes:</span>
<span class="go"> lat <Lat> : 85 S to 85 N (32 values)</span>
<span class="go"> lon <Lon> : 0 E to 354 E (64 values)</span>
<span class="go"> Attributes:</span>
<span class="go"> {'units': 'K'}</span>
<span class="go"> Type: Var (dtype="float64")</span>
<span class="gp">>>> </span><span class="n">transposed_var</span> <span class="o">=</span> <span class="n">t1</span><span class="o">.</span><span class="n">Temp</span><span class="o">.</span><span class="n">transpose</span><span class="p">(</span><span class="s">'lon'</span><span class="p">,</span><span class="s">'lat'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">transposed_var</span>
<span class="go"><Var 'Temp'>:</span>
<span class="go"> Shape: (lon,lat) (64,32)</span>
<span class="go"> Axes:</span>
<span class="go"> lon <Lon> : 0 E to 354 E (64 values)</span>
<span class="go"> lat <Lat> : 85 S to 85 N (32 values)</span>
<span class="go"> Attributes:</span>
<span class="go"> {'units': 'K'}</span>
<span class="go"> Type: TransposedVar (dtype="float64")</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pygeode.Var.sorted">
<tt class="descclassname">Var.</tt><tt class="descname">sorted</tt><big>(</big><em>*iaxes</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pygeode.Var.sorted" title="Permalink to this definition">¶</a></dt>
<dd><p>Sorts the data so that the axes have monotonically increasing values.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>*iaxes</strong> : (optional)</p>
<blockquote>
<div><p>Which axes to sort. If not specified, then <em>all</em> axes are sorted.
Axes can also be passed as keyword arguments, with a value of 1/0/-1 to
specifiy a sort order of increasing/default/decreasing.
If positional arguments are passed, or if an order of ‘0’ is specified,
then the natural (default) order will be used for that type of axis.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>sorted_var</strong> : Var</p>
<blockquote class="last">
<div><p>The sorted version of the data.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pygeode.tutorial</span> <span class="kn">import</span> <span class="n">t2</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">t2</span><span class="o">.</span><span class="n">Temp</span>
<span class="go"><Var 'Temp'>:</span>
<span class="go"> Shape: (time,pres,lat,lon) (3650,20,32,64)</span>
<span class="go"> Axes:</span>
<span class="go"> time <ModelTime365>: Jan 1, 2011 00:00:00 to Dec 31, 2020 00:00:00 (3650 values)</span>
<span class="go"> pres <Pres> : 1000 hPa to 50 hPa (20 values)</span>
<span class="go"> lat <Lat> : 85 S to 85 N (32 values)</span>
<span class="go"> lon <Lon> : 0 E to 354 E (64 values)</span>
<span class="go"> Attributes:</span>
<span class="go"> {}</span>
<span class="go"> Type: Mul_Var (dtype="float64")</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">t2</span><span class="o">.</span><span class="n">Temp</span><span class="o">.</span><span class="n">sorted</span><span class="p">(</span><span class="s">'pres'</span><span class="p">)</span> <span class="c"># Sort by default/natural order</span>
<span class="go"><Var 'Temp'>:</span>
<span class="go"> Shape: (time,pres,lat,lon) (3650,20,32,64)</span>
<span class="go"> Axes:</span>
<span class="go"> time <ModelTime365>: Jan 1, 2011 00:00:00 to Dec 31, 2020 00:00:00 (3650 values)</span>
<span class="go"> pres <Pres> : 1000 hPa to 50 hPa (20 values)</span>
<span class="go"> lat <Lat> : 85 S to 85 N (32 values)</span>
<span class="go"> lon <Lon> : 0 E to 354 E (64 values)</span>
<span class="go"> Attributes:</span>
<span class="go"> {}</span>
<span class="go"> Type: SortedVar (dtype="float64")</span>
<span class="gp">>>> </span><span class="c"># ^^ no change, since pressure was already in its natrual order (decreasing)</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">t2</span><span class="o">.</span><span class="n">Temp</span><span class="o">.</span><span class="n">sorted</span><span class="p">(</span><span class="n">pres</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="c"># Sort pressure explicitly as increasing order</span>
<span class="go"><Var 'Temp'>:</span>
<span class="go"> Shape: (time,pres,lat,lon) (3650,20,32,64)</span>
<span class="go"> Axes:</span>
<span class="go"> time <ModelTime365>: Jan 1, 2011 00:00:00 to Dec 31, 2020 00:00:00 (3650 values)</span>
<span class="go"> pres <Pres> : 50 hPa to 1000 hPa (20 values)</span>
<span class="go"> lat <Lat> : 85 S to 85 N (32 values)</span>
<span class="go"> lon <Lon> : 0 E to 354 E (64 values)</span>
<span class="go"> Attributes:</span>
<span class="go"> {}</span>
<span class="go"> Type: SortedVar (dtype="float64")</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pygeode.Var.replace_axes">
<tt class="descclassname">Var.</tt><tt class="descname">replace_axes</tt><big>(</big><em>axisdict={}</em>, <em>ignore_mismatch=False</em>, <em>newaxes=None</em>, <em>keep_old_name=True</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pygeode.Var.replace_axes" title="Permalink to this definition">¶</a></dt>
<dd><p>Replaces one or more axes of a variable with new axes. The axis length
must remain the same.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>axisdict</strong> : dict (optional)</p>
<blockquote>
<div><p>The keys are identifiers for the current axes, and the values are the
replacement axes.</p>
</div></blockquote>
<p><strong>ignore_mismatch</strong> : boolean (optional)</p>
<blockquote>
<div><p>If <tt class="docutils literal"><span class="pre">True</span></tt>, will ignore axis identifiers that don’t match any axes of
this variable. If <tt class="docutils literal"><span class="pre">False</span></tt>, will raise an exception on a mismatch.
Default is <tt class="docutils literal"><span class="pre">False</span></tt>.</p>
</div></blockquote>
<p><strong>newaxes</strong> : list of axes (optional)</p>
<blockquote>
<div><p>An explicit list of axes to use as replacements. Useful if you want to
replace <em>all</em> the axes at the same time.</p>
</div></blockquote>
<p><strong>keep_old_name</strong> : boolean (optional)</p>
<blockquote>
<div><p>If <tt class="docutils literal"><span class="pre">True</span></tt>, will keep the old axis name (with the new values). If
<tt class="docutils literal"><span class="pre">False</span></tt>, the name ofthe new axis will be used. Default is <tt class="docutils literal"><span class="pre">True</span></tt>.</p>
</div></blockquote>
<p><strong>**kwargs</strong> : keyword arguments</p>
<blockquote>
<div><p>Similar to <cite>axisdict</cite>, but using keyword parameters instead of a
dictionary.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>new_var</strong> : Var</p>
<blockquote class="last">
<div><p>The same variable, but with different axes. The variable data will remain
unchanged.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pygeode.tutorial</span> <span class="kn">import</span> <span class="n">t1</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">t1</span><span class="o">.</span><span class="n">Temp</span>
<span class="go"><Var 'Temp'>:</span>
<span class="go"> Shape: (lat,lon) (32,64)</span>
<span class="go"> Axes:</span>
<span class="go"> lat <Lat> : 85 S to 85 N (32 values)</span>
<span class="go"> lon <Lon> : 0 E to 354 E (64 values)</span>
<span class="go"> Attributes:</span>
<span class="go"> {'units': 'K'}</span>
<span class="go"> Type: Var (dtype="float64")</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pygeode</span> <span class="kn">import</span> <span class="n">XAxis</span><span class="p">,</span> <span class="n">YAxis</span>
<span class="gp">>>> </span><span class="n">new_var</span> <span class="o">=</span> <span class="n">t1</span><span class="o">.</span><span class="n">Temp</span><span class="o">.</span><span class="n">replace_axes</span><span class="p">(</span><span class="n">lon</span><span class="o">=</span><span class="n">XAxis</span><span class="p">,</span> <span class="n">lat</span><span class="o">=</span><span class="n">YAxis</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">new_var</span>
<span class="go"><Var 'Temp'>:</span>
<span class="go"> Shape: (lat,lon) (32,64)</span>
<span class="go"> Axes:</span>
<span class="go"> lat <YAxis> : -85.7606 to 85.7606 (32 values)</span>
<span class="go"> lon <XAxis> : 0 to 354.375 (64 values)</span>
<span class="go"> Attributes:</span>
<span class="go"> {'units': 'K'}</span>
<span class="go"> Type: Replace_axes (dtype="float64")</span>
<span class="gp">>>> </span><span class="n">new_var</span> <span class="o">=</span> <span class="n">t1</span><span class="o">.</span><span class="n">Temp</span><span class="o">.</span><span class="n">replace_axes</span><span class="p">(</span><span class="n">lon</span><span class="o">=</span><span class="n">XAxis</span><span class="p">,</span> <span class="n">lat</span><span class="o">=</span><span class="n">YAxis</span><span class="p">,</span> <span class="n">keep_old_name</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">new_var</span>
<span class="go"><Var 'Temp'>:</span>
<span class="go"> Shape: (yaxis,xaxis) (32,64)</span>
<span class="go"> Axes:</span>
<span class="go"> yaxis <YAxis> : -85.7606 to 85.7606 (32 values)</span>
<span class="go"> xaxis <XAxis> : 0 to 354.375 (64 values)</span>
<span class="go"> Attributes:</span>
<span class="go"> {'units': 'K'}</span>
<span class="go"> Type: Replace_axes (dtype="float64")</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pygeode.Var.rename">
<tt class="descclassname">Var.</tt><tt class="descname">rename</tt><big>(</big><em>newname</em><big>)</big><a class="headerlink" href="#pygeode.Var.rename" title="Permalink to this definition">¶</a></dt>
<dd><p>Assigns a new name to a variable</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>newname</strong> : string</p>
<blockquote>
<div><p>The new name of the variable.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>renamed_var</strong> : Var</p>
<blockquote class="last">
<div><p>The same variable, but with a different name.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>In most cases, you could probably change the <tt class="docutils literal"><span class="pre">name</span></tt> attribute of the
variable directly instead of calling this method. However, if the variable
is being used in other places, this method guarantees that the name change
will only affect a local version of the variable, and won’t have any
side-effects on other existing references.</p>
<p class="rubric">Examples</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">x</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">rename</span><span class="p">(</span><span class="s">'i_prefer_really_long_variable_names'</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pygeode.Var.rename_axes">
<tt class="descclassname">Var.</tt><tt class="descname">rename_axes</tt><big>(</big><em>ignore_mismatch=False</em>, <em>axisdict={}</em>, <em>**namemap</em><big>)</big><a class="headerlink" href="#pygeode.Var.rename_axes" title="Permalink to this definition">¶</a></dt>
<dd><p>Renames the axes of a variable.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>ignore_mismatch</strong> : boolean (optional)</p>
<blockquote>
<div><p>If <tt class="docutils literal"><span class="pre">True</span></tt>, will ignore axis identifiers that don’t match any axes of
this variable. If <tt class="docutils literal"><span class="pre">False</span></tt>, will raise an exception on a mismatch.
Default is <tt class="docutils literal"><span class="pre">False</span></tt>.</p>
</div></blockquote>
<p><strong>axisdict</strong> : dictionary</p>
<blockquote>
<div><p>An explicit dictionary mapping old names to new names.</p>
</div></blockquote>
<p><strong>**namemap</strong> : keyword arguments</p>
<blockquote>
<div><p>One or more keyword-based arguments. The parameters are the existing axis
names, and the values are the new names to substitute.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>new_var</strong> : Var</p>
<blockquote class="last">
<div><p>The same variable, but with new names for the axes.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pygeode.tutorial</span> <span class="kn">import</span> <span class="n">t1</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">t1</span><span class="o">.</span><span class="n">Temp</span>
<span class="go"><Var 'Temp'>:</span>
<span class="go"> Shape: (lat,lon) (32,64)</span>
<span class="go"> Axes:</span>
<span class="go"> lat <Lat> : 85 S to 85 N (32 values)</span>
<span class="go"> lon <Lon> : 0 E to 354 E (64 values)</span>
<span class="go"> Attributes:</span>
<span class="go"> {'units': 'K'}</span>
<span class="go"> Type: Var (dtype="float64")</span>
<span class="gp">>>> </span><span class="n">new_var</span> <span class="o">=</span> <span class="n">t1</span><span class="o">.</span><span class="n">Temp</span><span class="o">.</span><span class="n">rename_axes</span><span class="p">(</span><span class="n">lat</span><span class="o">=</span><span class="s">"latitude"</span><span class="p">,</span><span class="n">lon</span><span class="o">=</span><span class="s">"longitude"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">new_var</span>
<span class="go"><Var 'Temp'>:</span>
<span class="go"> Shape: (latitude,longitude) (32,64)</span>
<span class="go"> Axes:</span>
<span class="go"> latitude <Lat> : 85 S to 85 N (32 values)</span>
<span class="go"> longitude <Lon>: 0 E to 354 E (64 values)</span>
<span class="go"> Attributes:</span>
<span class="go"> {'units': 'K'}</span>
<span class="go"> Type: Replace_axes (dtype="float64")</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pygeode.Var.fill">
<tt class="descclassname">Var.</tt><tt class="descname">fill</tt><big>(</big><em>fill</em><big>)</big><a class="headerlink" href="#pygeode.Var.fill" title="Permalink to this definition">¶</a></dt>
<dd><p>Replaces <tt class="docutils literal"><span class="pre">NaN</span></tt> (missing values) with some fill value.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>fill</strong> : float or int</p>
<blockquote>
<div><p>The fill value</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>filled_var</strong> : Var</p>
<blockquote class="last">
<div><p>A new representation of the variable with missing values filled in.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="#pygeode.Var.unfill" title="pygeode.Var.unfill"><tt class="xref py py-obj docutils literal"><span class="pre">unfill</span></tt></a></p>
</div>
</dd></dl>
<dl class="method">
<dt id="pygeode.Var.unfill">
<tt class="descclassname">Var.</tt><tt class="descname">unfill</tt><big>(</big><em>fill</em><big>)</big><a class="headerlink" href="#pygeode.Var.unfill" title="Permalink to this definition">¶</a></dt>
<dd><p>Replaces all occurrences of the specified value with an <tt class="docutils literal"><span class="pre">NaN</span></tt> (missing
value).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>fill - float or int</strong> :</p>
<blockquote>
<div><p>The value to treat as missing</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>unfilled_var</strong> : Var</p>
<blockquote class="last">
<div><p>A new represntation of the variable with the ‘fill’ values removed
(replaced with <tt class="docutils literal"><span class="pre">NaN</span></tt>).</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="#pygeode.Var.fill" title="pygeode.Var.fill"><tt class="xref py py-obj docutils literal"><span class="pre">fill</span></tt></a></p>
</div>
</dd></dl>
<dl class="method">
<dt id="pygeode.Var.as_type">
<tt class="descclassname">Var.</tt><tt class="descname">as_type</tt><big>(</big><em>dtype</em><big>)</big><a class="headerlink" href="#pygeode.Var.as_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Casts a variable to a new data type (I.e., float32, float64, etc.)</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>dtype</strong> : <tt class="docutils literal"><span class="pre">numpy.dtype</span></tt> or string</p>
<blockquote>
<div><p>The new data type to use.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>casted_var</strong> : Var</p>
<blockquote class="last">
<div><p>The same var, but with its values cast into a new type.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># Treat the values as double-precision</span>
<span class="gp">>>> </span><span class="n">x</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">as_type</span><span class="p">(</span><span class="s">'float64'</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<hr class="docutils" />
<p>See Also:
<a class="reference internal" href="var.html"><em>Var class overview</em></a></p>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="reduce.html"
title="previous chapter">Axis Reductions</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="var.other.html"
title="next chapter">Other operations</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/varops.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="var.other.html" title="Other operations"
>next</a> |</li>
<li class="right" >
<a href="reduce.html" title="Axis Reductions"
>previous</a> |</li>
<li><a href="index.html">PyGeode 1.0 alpha documentation</a> »</li>
<li><a href="reference.html" >Reference</a> »</li>
<li><a href="var.html" >Var class overview</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2013, Mike Neish, Peter Hitchcock.
Last updated on Sep 13, 2015.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>