Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathplot.html
More file actions
Latest commit
522 lines (494 loc) · 54.1 KB
/
Copy pathplot.html
File metadata and controls
522 lines (494 loc) · 54.1 KB
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
<!DOCTYPE html>
<html>
<head>
<metacharset="utf-8" />
<metaname="viewport" content="width=device-width, initial-scale=1.0" />
<title>Plot module — PyGeode 1.4.1-rc2 documentation</title>
<linkrel="stylesheet" type="text/css" href="_static/pygments.css" />
<linkrel="stylesheet" type="text/css" href="_static/pygtheme.css" />
<linkrel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<linkrel="stylesheet" type="text/css" href="_static/sg_gallery.css" />
<linkrel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css" />
<linkrel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css" />
<linkrel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css" />
<scriptdata-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<scriptsrc="_static/jquery.js"></script>
<scriptsrc="_static/underscore.js"></script>
<scriptsrc="_static/doctools.js"></script>
<linkrel="shortcut icon" href="_static/pygeode_icon.ico"/>
<linkrel="index" title="Index" href="genindex.html" />
<linkrel="search" title="Search" href="search.html" />
<linkrel="next" title="File Input and Output" href="fileio.html" />
<linkrel="prev" title="General Operations" href="genops.html" />
<linkhref="http://fonts.googleapis.com/css?family=Ubuntu:300,300italic,regular,italic,500,500italic,bold,bolditalic" rel="stylesheet" type="text/css">
<linkhref='http://fonts.googleapis.com/css?family=Ubuntu+Mono:400,700' rel='stylesheet' type='text/css'>
</head><body>
<divclass="header" role="banner"><imgclass="logo" src="_static/pygeode_logo.png" width=79pxalt="Logo"/>
<h1class="heading"><ahref="index.html">
<span>PyGeode 1.4.1-rc2 documentation</span></a></h1>
<h2class="heading"><span>Plot module</span></h2>
</div>
<divclass="topnav" role="navigation" aria-label="top navigation">
<p>
«  <ahref="genops.html">General Operations</a>
  ::  
<aclass="uplink" href="reference.html">Reference</a>
  ::  
<aclass="uplink" href="tutorial.html">Tutorial</a>
  ::  
<aclass="uplink" href="gallery/index.html">Gallery</a>
  ::  
<ahref="fileio.html">File Input and Output</a>  »
</p>
</div>
<divclass="content">
<divclass="section" id="plot-module">
<h1>Plot module<aclass="headerlink" href="#plot-module" title="Permalink to this headline">¶</a></h1>
<divclass="module docutils container">
<p>pygeode.plot</p>
<p>Module containing most plotting-related commands for PyGeode.</p>
<pclass="rubric">Top-level routines</p>
<tableclass="longtable docutils align-default">
<colgroup>
<colstyle="width: 10%" />
<colstyle="width: 90%" />
</colgroup>
<tbody>
<trclass="row-odd"><td><p><aclass="reference internal" href="#pygeode.showvar" title="pygeode.showvar"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">showvar</span></code></a>(var, *args, **kwargs)</p></td>
<td><p>Plot variable, showing a contour plot for 2d variables or a line plot for 1d variables.</p></td>
</tr>
<trclass="row-even"><td><p><aclass="reference internal" href="#pygeode.showgrid" title="pygeode.showgrid"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">showgrid</span></code></a>(vf[, vl, ncol, size, lbl])</p></td>
<td><p>Create grid of contour plots of multiple variables.</p></td>
</tr>
<trclass="row-odd"><td><p><aclass="reference internal" href="#pygeode.showlines" title="pygeode.showlines"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">showlines</span></code></a>(vs[, fmts, labels, size, lblx, lbly])</p></td>
<td><p>Produce line plots of a list of 1D variables on a single figure.</p></td>
</tr>
</tbody>
</table>
<pclass="rubric">Second-level routines</p>
<tableclass="longtable docutils align-default">
<colgroup>
<colstyle="width: 10%" />
<colstyle="width: 90%" />
</colgroup>
<tbody>
<trclass="row-odd"><td><p><aclass="reference internal" href="#pygeode.vplot" title="pygeode.vplot"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">vplot</span></code></a>(var[, fmt, axes, transpose, lblx, lbly])</p></td>
<td><p>Create a line plot of a variable.</p></td>
</tr>
<trclass="row-even"><td><p><aclass="reference internal" href="#pygeode.vcontour" title="pygeode.vcontour"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">vcontour</span></code></a>(var[, clevs, clines, axes, lblx, ...])</p></td>
<td><p>Create a contour plot (lines, filled, or both) from a variable.</p></td>
</tr>
<trclass="row-odd"><td><p><aclass="reference internal" href="#pygeode.vscatter" title="pygeode.vscatter"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">vscatter</span></code></a>(varx, vary[, axes, lblx, lbly])</p></td>
<td><p>Create a scatter plot from two variables with the same shape.</p></td>
</tr>
<trclass="row-even"><td><p><aclass="reference internal" href="#pygeode.vhist" title="pygeode.vhist"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">vhist</span></code></a>(var[, axes, lblx, lbly])</p></td>
<td><p>Create a histogram of values taken by a variable.</p></td>
</tr>
<trclass="row-odd"><td><p><aclass="reference internal" href="#pygeode.vsigmask" title="pygeode.vsigmask"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">vsigmask</span></code></a>(pval, axes[, mjsig, mnsig, mjsigp, ...])</p></td>
<td><p>Add significance shading to a contour plot from a variable.</p></td>
</tr>
<trclass="row-even"><td><p><aclass="reference internal" href="#pygeode.vstreamplot" title="pygeode.vstreamplot"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">vstreamplot</span></code></a>(varu, varv[, axes, lblx, lbly, ...])</p></td>
<td><p>Create a streamplot from two variables.</p></td>
</tr>
<trclass="row-odd"><td><p><aclass="reference internal" href="#pygeode.vquiver" title="pygeode.vquiver"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">vquiver</span></code></a>(varu, varv[, varc, axes, lblx, ...])</p></td>
<td><p>Create a quiver plot from two variables.</p></td>
</tr>
</tbody>
</table>
<pclass="rubric">Contouring helper functions</p>
<tableclass="longtable docutils align-default">
<colgroup>
<colstyle="width: 10%" />
<colstyle="width: 90%" />
</colgroup>
<tbody>
<trclass="row-odd"><td><p><aclass="reference internal" href="#pygeode.clfdict" title="pygeode.clfdict"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">clfdict</span></code></a>(cdelt[, min, mid, nf, nl, ndiv, ...])</p></td>
<td><p>Returns kwargs to <aclass="reference internal" href="#pygeode.showvar" title="pygeode.showvar"><codeclass="xref py py-meth docutils literal notranslate"><spanclass="pre">showvar()</span></code></a> for a filled contour plot.</p></td>
</tr>
<trclass="row-even"><td><p><aclass="reference internal" href="#pygeode.cldict" title="pygeode.cldict"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">cldict</span></code></a>(cdelt[, range, min, mid, cidelt, nozero])</p></td>
<td><p>Returns kwargs to <aclass="reference internal" href="#pygeode.showvar" title="pygeode.showvar"><codeclass="xref py py-meth docutils literal notranslate"><spanclass="pre">showvar()</span></code></a> for a line contour plot.</p></td>
</tr>
<trclass="row-odd"><td><p><aclass="reference internal" href="#pygeode.log1sdict" title="pygeode.log1sdict"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">log1sdict</span></code></a>(cmin[, cdelt, nf, nl, ndiv])</p></td>
<td><p>Returns kwargs to <aclass="reference internal" href="#pygeode.showvar" title="pygeode.showvar"><codeclass="xref py py-meth docutils literal notranslate"><spanclass="pre">showvar()</span></code></a> for a one-sided logarithmically-spaced contour plot.</p></td>
</tr>
<trclass="row-even"><td><p><aclass="reference internal" href="#pygeode.log2sdict" title="pygeode.log2sdict"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">log2sdict</span></code></a>(cmin[, cdelt, nf, nl, ndiv, nozero])</p></td>
<td><p>Returns kwargs to <aclass="reference internal" href="#pygeode.showvar" title="pygeode.showvar"><codeclass="xref py py-meth docutils literal notranslate"><spanclass="pre">showvar()</span></code></a> for a two-sided logarithmically-spaced contour plot.</p></td>
</tr>
</tbody>
</table>
<pclass="rubric">Matplotlib wrappers</p>
<p>PyGeode uses a thin set of wrapper classes around matplotlib. The central
object is the AxesWrapper class which provides an object that can produce a
matplotlib plot. It was intended to make it possible to pickle and unpickle
plots, though this often doesn’t work. Most of the higher-level plotting
functions return an AxesWrapper instance.</p>
<p>The routines (most accessible as equivalent member functions of
AxesWrapper) permit modifying and adding to plots much as one would with
standard matplotlib figures. AxesWrappers can also be combined using
into compound plots using <aclass="reference internal" href="#pygeode.plot.grid" title="pygeode.plot.grid"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">plot.grid()</span></code></a>.</p>
<tableclass="longtable docutils align-default">
<colgroup>
<colstyle="width: 10%" />
<colstyle="width: 90%" />
</colgroup>
<tbody>
<trclass="row-odd"><td><p><aclass="reference internal" href="#pygeode.plot.AxesWrapper" title="pygeode.plot.AxesWrapper"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">plot.AxesWrapper</span></code></a>([parent, rect, size, pad, ...])</p></td>
<td><p><pclass="rubric">Methods</p>
</p></td>
</tr>
<trclass="row-even"><td><p><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">plot.plot</span></code>(*args, **kwargs)</p></td>
<td><p></p></td>
</tr>
<trclass="row-odd"><td><p><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">plot.fill_between</span></code>(*args, **kwargs)</p></td>
<td><p></p></td>
</tr>
<trclass="row-even"><td><p><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">plot.scatter</span></code>(*args, **kwargs)</p></td>
<td><p></p></td>
</tr>
<trclass="row-odd"><td><p><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">plot.hist</span></code>(*args, **kwargs)</p></td>
<td><p></p></td>
</tr>
<trclass="row-even"><td><p><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">plot.axhline</span></code>(*args, **kwargs)</p></td>
<td><p></p></td>
</tr>
<trclass="row-odd"><td><p><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">plot.axvline</span></code>(*args, **kwargs)</p></td>
<td><p></p></td>
</tr>
<trclass="row-even"><td><p><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">plot.legend</span></code>(*args, **kwargs)</p></td>
<td><p></p></td>
</tr>
<trclass="row-odd"><td><p><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">plot.text</span></code>(*args, **kwargs)</p></td>
<td><p></p></td>
</tr>
<trclass="row-even"><td><p><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">plot.colorbar</span></code>(axes, cnt[, cax, rect])</p></td>
<td><p></p></td>
</tr>
<trclass="row-odd"><td><p><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">plot.contour</span></code>(*args, **kwargs)</p></td>
<td><p></p></td>
</tr>
<trclass="row-even"><td><p><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">plot.contourf</span></code>(*args, **kwargs)</p></td>
<td><p></p></td>
</tr>
<trclass="row-odd"><td><p><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">plot.quiver</span></code>(*args, **kwargs)</p></td>
<td><p></p></td>
</tr>
<trclass="row-even"><td><p><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">plot.quiverkey</span></code>(*args, **kwargs)</p></td>
<td><p></p></td>
</tr>
<trclass="row-odd"><td><p><aclass="reference internal" href="#pygeode.plot.grid" title="pygeode.plot.grid"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">plot.grid</span></code></a>(axes[, size])</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
</div>
<dlclass="py function">
<dtclass="sig sig-object py" id="pygeode.showvar">
<spanclass="sig-prename descclassname"><spanclass="pre">pygeode.</span></span><spanclass="sig-name descname"><spanclass="pre">showvar</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">var</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">args</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/pygeode/plot/pyg_helpers.html#showvar"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#pygeode.showvar" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot variable, showing a contour plot for 2d variables or a line plot for
1d variables.</p>
<dlclass="field-list">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><dl>
<dt><strong>var</strong><spanclass="classifier"><aclass="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Var</span></code></a></span></dt><dd><p>The variable to plot. Should have either 1 or 2 non-degenerate axes.
Arguments below relevant only for the 1 dimensional case are labelled [1D],
those relevant only for the 2 dimensional case are labelled [2D].</p>
</dd>
<dt><strong>fmt</strong><spanclass="classifier">string, optional</span></dt><dd><p>[1D] matplotlib format to plot line. See <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">matplotlib.plot()</span></code>. Will also
be recognized as the second positional argument (after var).</p>
</dd>
<dt><strong>type</strong><spanclass="classifier">string, optional [‘clf’]</span></dt><dd><p>[2D] style of plot to produce. See Notes.</p>
</dd>
<dt><strong>axes</strong><spanclass="classifier"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AxesWrapper</span></code> instance, optional</span></dt><dd><p>Axes object on which to plot variable. A new one is created if this is not specified.</p>
</dd>
<dt><strong>transpose: boolean, optional [False]</strong></dt><dd><p>If True, reverse axes.</p>
</dd>
<dt><strong>lblx: boolean, optional [True]</strong></dt><dd><p>If True, label horizontal axes</p>
</dd>
<dt><strong>lbly: boolean, optional [True]</strong></dt><dd><p>If True, label vertical axes</p>
</dd>
<dt><strong>*args, **kwargs :</strong></dt><dd><p>Further arguments are passed on to the underlying plotting routine. See
Notes.</p>
</dd>
</dl>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><dlclass="simple">
<dt><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AxesWrapper</span></code> object with plot.</dt><dd></dd>
</dl>
</dd>
</dl>
<divclass="admonition seealso">
<pclass="admonition-title">See also</p>
<dlclass="simple">
<dt><aclass="reference internal" href="#pygeode.vplot" title="pygeode.vplot"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">vplot</span></code></a>, <aclass="reference internal" href="#pygeode.vcontour" title="pygeode.vcontour"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">vcontour</span></code></a>, <codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">colorbar</span></code></dt><dd></dd>
</dl>
</div>
<pclass="rubric">Notes</p>
<p>This function is intended as the simplest way to display the contents of a
variable, choosing appropriate parameter values as automatically as possible.
For 1d variables it calls <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Var.vplot()</span></code>, and for 2d variables
<codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Var.vcontour()</span></code>. In the latter case, if filled contours were produced, it
calls <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">AxesWrapper.colorbar()</span></code>. A dictionary <codeclass="docutils literal notranslate"><spanclass="pre">colorbar</span></code> can be provided to
pass arguments through. Setting <codeclass="docutils literal notranslate"><spanclass="pre">colorbar</span></code> to <codeclass="docutils literal notranslate"><spanclass="pre">False</span></code> suppresses the
colorbar.</p>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="pygeode.showgrid">
<spanclass="sig-prename descclassname"><spanclass="pre">pygeode.</span></span><spanclass="sig-name descname"><spanclass="pre">showgrid</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vf</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vl</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">[]</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ncol</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">1</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">size</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">(3.5,</span><spanclass="pre">1.5)</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lbl</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/pygeode/plot/pyg_helpers.html#showgrid"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#pygeode.showgrid" title="Permalink to this definition">¶</a></dt>
<dd><p>Create grid of contour plots of multiple variables.</p>
<dlclass="field-list">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><dl>
<dt><strong>vf</strong><spanclass="classifier">list of lists of <aclass="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Var</span></code></a></span></dt><dd><p>The variables to plot. Should have 2 non-degenerate axes.</p>
</dd>
<dt><strong>ncol</strong><spanclass="classifier">integer</span></dt><dd><p>Number of columns</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="pygeode.showlines">
<spanclass="sig-prename descclassname"><spanclass="pre">pygeode.</span></span><spanclass="sig-name descname"><spanclass="pre">showlines</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vs</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">fmts</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">labels</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">size</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">(4.1,</span><spanclass="pre">2)</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lblx</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lbly</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/pygeode/plot/pyg_helpers.html#showlines"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#pygeode.showlines" title="Permalink to this definition">¶</a></dt>
<dd><p>Produce line plots of a list of 1D variables on a single figure.</p>
<dlclass="field-list">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><dl>
<dt><strong>vs</strong><spanclass="classifier">list of <aclass="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Var</span></code></a></span></dt><dd><p>The variables to plot. Should all have 1 non-degenerate axis.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="pygeode.vplot">
<spanclass="sig-prename descclassname"><spanclass="pre">pygeode.</span></span><spanclass="sig-name descname"><spanclass="pre">vplot</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">var</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">fmt</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">''</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">axes</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">transpose</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">False</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lblx</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lbly</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/pygeode/plot/pyg_helpers.html#vplot"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#pygeode.vplot" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a line plot of a variable.</p>
<dlclass="field-list">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><dl>
<dt><strong>var</strong><spanclass="classifier"><aclass="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Var</span></code></a></span></dt><dd><p>The variable to plot. Should have 1 non-degenerate axis.</p>
</dd>
<dt><strong>fmt</strong><spanclass="classifier">string, optional</span></dt><dd><p>Format of the line. See <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">pylab.plot()</span></code>.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="pygeode.vcontour">
<spanclass="sig-prename descclassname"><spanclass="pre">pygeode.</span></span><spanclass="sig-name descname"><spanclass="pre">vcontour</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">var</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">clevs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">clines</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">axes</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lblx</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lbly</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">label</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">transpose</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/pygeode/plot/pyg_helpers.html#vcontour"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#pygeode.vcontour" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a contour plot (lines, filled, or both) from a variable.</p>
<dlclass="field-list">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><dl>
<dt><strong>var</strong><spanclass="classifier"><aclass="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Var</span></code></a></span></dt><dd><p>The variable to plot. Should have 2 non-degenerate axes.</p>
</dd>
<dt><strong>clevs</strong><spanclass="classifier">integer or collection of numbers, optional</span></dt><dd><p>Levels at which to construct filled contours through an underlying call to
<codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">matplotlib.contourf()</span></code>. If None is specified, no filled contours will
be produced, unless clines is also None. If a number is specified, that
number of equally spaced contours are chosen. Otherwise the explicit
values are used.</p>
</dd>
<dt><strong>clines</strong><spanclass="classifier">integer or collection of numbers, optional</span></dt><dd><p>Levels at which to construct contour lines through an underlying call to
<codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">matplotlib.contour()</span></code>. If None is specified, no contour lines are
produced. If a number is specified, that number of equally spaced contours
are chosen. Otherwise the explicit values are used.</p>
</dd>
<dt><strong>axes</strong><spanclass="classifier"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AxisWrapper</span></code>, optional</span></dt><dd><p>Axes on which to produce contour plot. If none is specified, one is created.</p>
</dd>
<dt><strong>lblx</strong><spanclass="classifier">bool, optional</span></dt><dd><p>If True, add appropriate tick labels and an axis label on the x axis; if
False, the x axis a is left unlabeled. Defaults to True.</p>
</dd>
<dt><strong>lbly</strong><spanclass="classifier">bool, optional</span></dt><dd><p>If True, add appropriate tick labels and an axis label on the y axis; if
False, the y axis a is left unlabeled. Defaults to True.</p>
</dd>
<dt><strong>transpose</strong><spanclass="classifier">bool, optional</span></dt><dd><p>The x and y axes are chosen based on the two degenerate axes of the variable
to plot. This order can be reversed by setting transpose to True.</p>
</dd>
<dt><strong>map</strong><spanclass="classifier">dict, optional</span></dt><dd><p>If</p>
</dd>
<dt><strong>*args, **kwargs</strong><spanclass="classifier">arguments to pass on to underlying matplotlib contour</span></dt><dd><p>plotting routines, see Notes.</p>
</dd>
</dl>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><dl>
<dt><strong>axes</strong><spanclass="classifier"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AxesWrapper</span></code></span></dt><dd><p>The axes object containing the contour plots.</p>
</dd>
</dl>
</dd>
</dl>
<divclass="admonition seealso">
<pclass="admonition-title">See also</p>
<dlclass="simple">
<dt><aclass="reference internal" href="#pygeode.showvar" title="pygeode.showvar"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">showvar</span></code></a>, <codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">colorbar</span></code></dt><dd></dd>
</dl>
</div>
<pclass="rubric">Notes</p>
<p>If the two axes of the variable are a <aclass="reference internal" href="horizontalaxes.html#pygeode.Lat" title="pygeode.Lat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Lat</span></code></a> and <aclass="reference internal" href="horizontalaxes.html#pygeode.Lon" title="pygeode.Lon"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Lon</span></code></a> axes,
a map projection is created automatically.</p>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="pygeode.vscatter">
<spanclass="sig-prename descclassname"><spanclass="pre">pygeode.</span></span><spanclass="sig-name descname"><spanclass="pre">vscatter</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">varx</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vary</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">axes</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lblx</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lbly</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/pygeode/plot/pyg_helpers.html#vscatter"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#pygeode.vscatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a scatter plot from two variables with the same shape.</p>
<dlclass="field-list">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><dl>
<dt><strong>varx</strong><spanclass="classifier"><aclass="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Var</span></code></a></span></dt><dd><p>Variable to use as abscissa values. Must have the same size as vary.</p>
</dd>
<dt><strong>vary</strong><spanclass="classifier"><aclass="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Var</span></code></a></span></dt><dd><p>Variable to use as ordinate values.</p>
</dd>
</dl>
</dd>
</dl>
<pclass="rubric">Notes</p>
<p>Wraps matplotlib.scatter</p>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="pygeode.vhist">
<spanclass="sig-prename descclassname"><spanclass="pre">pygeode.</span></span><spanclass="sig-name descname"><spanclass="pre">vhist</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">var</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">axes</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lblx</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lbly</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/pygeode/plot/pyg_helpers.html#vhist"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#pygeode.vhist" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a histogram of values taken by a variable.</p>
<dlclass="field-list">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><dl>
<dt><strong>var</strong><spanclass="classifier"><aclass="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Var</span></code></a></span></dt><dd><p>The variable to compute the histogram of.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="pygeode.vsigmask">
<spanclass="sig-prename descclassname"><spanclass="pre">pygeode.</span></span><spanclass="sig-name descname"><spanclass="pre">vsigmask</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">pval</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">axes</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">mjsig</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">0.95</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">mnsig</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">mjsigp</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">mnsigp</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nsigp</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">transpose</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/pygeode/plot/pyg_helpers.html#vsigmask"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#pygeode.vsigmask" title="Permalink to this definition">¶</a></dt>
<dd><p>Add significance shading to a contour plot from a variable.</p>
<dlclass="field-list">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><dl>
<dt><strong>pval</strong><spanclass="classifier"><aclass="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Var</span></code></a></span></dt><dd><p>The variable containing a p-value of the significance mask. The mask will
be applied where abs(pval) > mjsig (and optionally an additional mask will
be applied for mnsig < abs(pval) < mjsig. Signed p-values for two-sided
tests ensure that a gap will appear between significant regions of opposite sign.
Should have two non-degenerate axes that match the quantity plotted.</p>
</dd>
<dt><strong>axes</strong><spanclass="classifier"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AxesWrapper</span></code></span></dt><dd><p>The axis on which to add the mask.</p>
</dd>
<dt><strong>mjsig</strong><spanclass="classifier">float, optional [0.95]</span></dt><dd><p>The p-value dividing significant from non-significant values.</p>
</dd>
<dt><strong>mnsig</strong><spanclass="classifier">float or None, optional [None]</span></dt><dd><p>The p-value dividing minor significance from non-significant values.</p>
</dd>
<dt><strong>mjsigp</strong><spanclass="classifier">dictionary, optional</span></dt><dd><p>A dictionary of keyword arguments that determine the properties of the
(major) significant filled contours. See notes.</p>
</dd>
<dt><strong>mnsigp</strong><spanclass="classifier">dictionary, optional</span></dt><dd><p>A dictionary of keyword arguments that determine the properties of the
minor significant filled contours. See notes.</p>
</dd>
<dt><strong>nsigp</strong><spanclass="classifier">dictionary, optional</span></dt><dd><p>A dictionary of keyword arguments that determine the properties of the
non-significant filled contour. See notes.</p>
</dd>
<dt><strong>transpose</strong><spanclass="classifier">bool or None, optional [None]</span></dt><dd><p>If True, transpose the axes of the plot.</p>
</dd>
</dl>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><dlclass="simple">
<dt><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AxesWrapper</span></code> object with plot.</dt><dd></dd>
</dl>
</dd>
</dl>
<pclass="rubric">Notes</p>
<p>The significance mask is plotted as three (or five) filled contours, with
boundaries at [-1.1, -mjsig, mjsig, 1.1] or [-1.1, -mjsig, -mnsig, mnsig,
mjsig, 1.1]. Their respective graphical properties can be set using the
dictionary kw arguments.</p>
<p>By default, the non-significant contours are set to be invisible and the
significant contours are set to a hatching pattern; this is equivalent to
passing in mjsigp = dict(alpha = 0., hatch = ‘…’) and nsigp = dict(visible
= False). Any property of the filled contour can be set.</p>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="pygeode.vstreamplot">
<spanclass="sig-prename descclassname"><spanclass="pre">pygeode.</span></span><spanclass="sig-name descname"><spanclass="pre">vstreamplot</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">varu</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">varv</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">axes</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lblx</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lbly</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">label</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">transpose</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/pygeode/plot/pyg_helpers.html#vstreamplot"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#pygeode.vstreamplot" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a streamplot from two variables.</p>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="pygeode.vquiver">
<spanclass="sig-prename descclassname"><spanclass="pre">pygeode.</span></span><spanclass="sig-name descname"><spanclass="pre">vquiver</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">varu</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">varv</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">varc</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">axes</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lblx</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lbly</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">label</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">transpose</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/pygeode/plot/pyg_helpers.html#vquiver"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#pygeode.vquiver" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a quiver plot from two variables.</p>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="pygeode.clfdict">
<spanclass="sig-prename descclassname"><spanclass="pre">pygeode.</span></span><spanclass="sig-name descname"><spanclass="pre">clfdict</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cdelt</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">min</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">mid</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">0.0</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nf</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">6</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nl</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">2</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ndiv</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">3</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nozero</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">False</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">style</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">clr</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/pygeode/plot/cnt_helpers.html#clfdict"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#pygeode.clfdict" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns kwargs to <aclass="reference internal" href="#pygeode.showvar" title="pygeode.showvar"><codeclass="xref py py-meth docutils literal notranslate"><spanclass="pre">showvar()</span></code></a> for a filled contour plot.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><dlclass="simple">
<dt><strong>cdelt</strong><spanclass="classifier">float</span></dt><dd><p>Spacing of a single division. Each division is spanned by a certain number of filled
contours and contour lines, and the colorbar will span a set number of divisions. See notes.</p>
</dd>
<dt><strong>min</strong><spanclass="classifier">float or None (optional)</span></dt><dd><p>If specified, contours span ndiv equal divisions starting with the value
min. If None, the colorbar is centred on the value of mid. Default is None.</p>
</dd>
<dt><strong>mid</strong><spanclass="classifier">float (optional)</span></dt><dd><p>If min is None, contours span ndiv equal divisions both above and below the value of mid.</p>
</dd>
<dt><strong>nf</strong><spanclass="classifier">integer (optional)</span></dt><dd><p>Number of filled contours per division. Default is 6.</p>
</dd>
<dt><strong>nl</strong><spanclass="classifier">integer (optional)</span></dt><dd><p>Number of contour lines per division. Default is 2.</p>
</dd>
<dt><strong>nozero</strong><spanclass="classifier">boolean (optional)</span></dt><dd><p>If True, the contour line at mid is omitted. Defalt is False.</p>
</dd>
<dt><strong>style</strong><spanclass="classifier">string (optional)</span></dt><dd><p>Either ‘seq’ or ‘div’. Deterimines which style of colourmap to use; a
sequential or divergent. Default is ‘div’, unless ‘’min’’ is set to
something other than None.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="pygeode.cldict">
<spanclass="sig-prename descclassname"><spanclass="pre">pygeode.</span></span><spanclass="sig-name descname"><spanclass="pre">cldict</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cdelt</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">range</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">min</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">mid</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">0</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cidelt</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">0.0</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nozero</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">False</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/pygeode/plot/cnt_helpers.html#cldict"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#pygeode.cldict" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns kwargs to <aclass="reference internal" href="#pygeode.showvar" title="pygeode.showvar"><codeclass="xref py py-meth docutils literal notranslate"><spanclass="pre">showvar()</span></code></a> for a line contour plot.</p>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="pygeode.log1sdict">
<spanclass="sig-prename descclassname"><spanclass="pre">pygeode.</span></span><spanclass="sig-name descname"><spanclass="pre">log1sdict</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cmin</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cdelt</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">10.0</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nf</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">6</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nl</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">2</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ndiv</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">5</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/pygeode/plot/cnt_helpers.html#log1sdict"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#pygeode.log1sdict" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns kwargs to <aclass="reference internal" href="#pygeode.showvar" title="pygeode.showvar"><codeclass="xref py py-meth docutils literal notranslate"><spanclass="pre">showvar()</span></code></a> for a one-sided
logarithmically-spaced contour plot.</p>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="pygeode.log2sdict">
<spanclass="sig-prename descclassname"><spanclass="pre">pygeode.</span></span><spanclass="sig-name descname"><spanclass="pre">log2sdict</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cmin</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cdelt</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">10</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nf</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">6</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nl</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">2</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ndiv</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">3</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nozero</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">False</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/pygeode/plot/cnt_helpers.html#log2sdict"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#pygeode.log2sdict" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns kwargs to <aclass="reference internal" href="#pygeode.showvar" title="pygeode.showvar"><codeclass="xref py py-meth docutils literal notranslate"><spanclass="pre">showvar()</span></code></a> for a two-sided logarithmically-spaced contour plot.</p>
</dd></dl>
<spanclass="target" id="module-pygeode.plot"></span><dlclass="py class">
<dtclass="sig sig-object py" id="pygeode.plot.AxesWrapper">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">pygeode.plot.</span></span><spanclass="sig-name descname"><spanclass="pre">AxesWrapper</span></span><aclass="reference internal" href="_modules/pygeode/plot/wrappers.html#AxesWrapper"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#pygeode.plot.AxesWrapper" title="Permalink to this definition">¶</a></dt>
<dd><p>A PyGeode wrapper class for a matplotlib figure or subplot</p>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="pygeode.plot.grid">
<spanclass="sig-prename descclassname"><spanclass="pre">pygeode.plot.</span></span><spanclass="sig-name descname"><spanclass="pre">grid</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">axes</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">size</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/pygeode/plot/wrappers.html#grid"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#pygeode.plot.grid" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</div>
<divclass="bottomnav" role="navigation" aria-label="bottom navigation">
<p>
«  <ahref="genops.html">General Operations</a>
  ::  
<aclass="uplink" href="reference.html">Reference</a>
  ::  
<aclass="uplink" href="tutorial.html">Tutorial</a>
  ::  
<aclass="uplink" href="gallery/index.html">Gallery</a>
  ::  
<ahref="fileio.html">File Input and Output</a>  »
</p>
</div>
<divclass="footer" role="contentinfo">
© Copyright 2020, Mike Neish, Peter Hitchcock.
Created using <ahref="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
</div>
</body>
</html>