forked from pygeode/pygeode.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathplot.html
356 lines (334 loc) · 19 KB
/
plot.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
<!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>Plot module — 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="Reference" href="reference.html" />
<link rel="next" title="File Input and Output" href="fileio.html" />
<link rel="prev" title="Dataset overview" href="dataset.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="fileio.html" title="File Input and Output"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="dataset.html" title="Dataset overview"
accesskey="P">previous</a> |</li>
<li><a href="index.html">PyGeode 1.0 alpha documentation</a> »</li>
<li><a href="reference.html" accesskey="U">Reference</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="plot-module">
<h1>Plot module<a class="headerlink" href="#plot-module" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="pygeode.showvar">
<tt class="descclassname">pygeode.</tt><tt class="descname">showvar</tt><big>(</big><em>var</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="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>
<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>var</strong> : <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><tt class="xref py py-class docutils literal"><span class="pre">Var</span></tt></a></p>
<blockquote>
<div><p>The variable to plot. Should have either 1 or 2 non-degenerate axes.</p>
</div></blockquote>
<p><strong>*args, **kwargs</strong> : arguments to pass on to underlying plotting routines, see</p>
<blockquote class="last">
<div><p>Notes.</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.vplot" title="pygeode.vplot"><tt class="xref py py-obj docutils literal"><span class="pre">vplot</span></tt></a>, <a class="reference internal" href="#pygeode.vcontour" title="pygeode.vcontour"><tt class="xref py py-obj docutils literal"><span class="pre">vcontour</span></tt></a>, <tt class="xref py py-obj docutils literal"><span class="pre">colorbar</span></tt></p>
</div>
<p class="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 <tt class="xref py py-func docutils literal"><span class="pre">Var.vplot()</span></tt>, and for 2d variables
<tt class="xref py py-func docutils literal"><span class="pre">Var.vcontour()</span></tt>. In the latter case, if filled contours were produced, it
calls <cite>AxesWrapper.colorbar()’. A dictionary ``colorbar`</cite> can be provided to
pass arguments through. Setting <tt class="docutils literal"><span class="pre">colorbar</span></tt> to <tt class="docutils literal"><span class="pre">False</span></tt> suppresses the
colorbar.</p>
</dd></dl>
<dl class="function">
<dt id="pygeode.showcol">
<tt class="descclassname">pygeode.</tt><tt class="descname">showcol</tt><big>(</big><em>vs</em>, <em>size=(4.1</em>, <em>2)</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pygeode.showcol" 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>
<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>v</strong> : list of lists of <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><tt class="xref py py-class docutils literal"><span class="pre">Var</span></tt></a></p>
<blockquote class="last">
<div><p>The variables to plot. Should have either 1 or 2 non-degenerate axes.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="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.</p>
</dd></dl>
<dl class="function">
<dt id="pygeode.showgrid">
<tt class="descclassname">pygeode.</tt><tt class="descname">showgrid</tt><big>(</big><em>vf</em>, <em>vl=</em>, <span class="optional">[</span><span class="optional">]</span><em>ncol=1</em>, <em>size=(3.5</em>, <em>1.5)</em>, <em>lbl=True</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pygeode.showgrid" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot contours</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>v</strong> : list of lists of <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><tt class="xref py py-class docutils literal"><span class="pre">Var</span></tt></a></p>
<blockquote class="last">
<div><p>The variables to plot. Should have either 1 or 2 non-degenerate axes.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="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.</p>
</dd></dl>
<dl class="function">
<dt id="pygeode.showlines">
<tt class="descclassname">pygeode.</tt><tt class="descname">showlines</tt><big>(</big><em>vs</em>, <em>fmts=None</em>, <em>labels=None</em>, <em>size=(4.1</em>, <em>2)</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pygeode.showlines" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot line plots of a list of 1D variables on the same plot.</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>vs</strong> : list of <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><tt class="xref py py-class docutils literal"><span class="pre">Var</span></tt></a></p>
<blockquote class="last">
<div><p>The variables to plot. Should all have 1 non-degenerate axis.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pygeode.vcontour">
<tt class="descclassname">pygeode.</tt><tt class="descname">vcontour</tt><big>(</big><em>var</em>, <em>clevs=None</em>, <em>clines=None</em>, <em>axes=None</em>, <em>lblx=True</em>, <em>lbly=True</em>, <em>label=True</em>, <em>transpose=None</em>, <em>**kwargs</em><big>)</big><a class="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>
<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>var</strong> : <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><tt class="xref py py-class docutils literal"><span class="pre">Var</span></tt></a></p>
<blockquote>
<div><p>The variable to plot. Should have 2 non-degenerate axes.</p>
</div></blockquote>
<p><strong>clevs</strong> : integer or collection of numbers, optional</p>
<blockquote>
<div><p>Levels at which to construct filled contours through an underlying call to
<tt class="xref py py-func docutils literal"><span class="pre">matplotlib.contourf()</span></tt>. 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>
</div></blockquote>
<p><strong>clines</strong> : integer or collection of numbers, optional</p>
<blockquote>
<div><p>Levels at which to construct contour lines through an underlying call to
<tt class="xref py py-func docutils literal"><span class="pre">matplotlib.contour()</span></tt>. 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>
</div></blockquote>
<p><strong>axes</strong> : <tt class="xref py py-class docutils literal"><span class="pre">AxisWrapper</span></tt>, optional</p>
<blockquote>
<div><p>Axes on which to produce contour plot. If none is specified, one is created.</p>
</div></blockquote>
<p><strong>lblx</strong> : bool, optional</p>
<blockquote>
<div><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>
</div></blockquote>
<p><strong>lbly</strong> : bool, optional</p>
<blockquote>
<div><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>
</div></blockquote>
<p><strong>transpose</strong> : bool, optional</p>
<blockquote>
<div><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>
</div></blockquote>
<p><strong>map</strong> : dict, optional</p>
<blockquote>
<div><p>If</p>
</div></blockquote>
<p><strong>*args, **kwargs</strong> : arguments to pass on to underlying matplotlib contour</p>
<blockquote>
<div><p>plotting routines, see Notes.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>axes</strong> : <tt class="xref py py-class docutils literal"><span class="pre">AxesWrapper</span></tt></p>
<blockquote class="last">
<div><p>The axes object containing the contour plots.</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.showvar" title="pygeode.showvar"><tt class="xref py py-obj docutils literal"><span class="pre">showvar</span></tt></a>, <tt class="xref py py-obj docutils literal"><span class="pre">colorbar</span></tt></p>
</div>
<p class="rubric">Notes</p>
<p>If the two axes of the variable are a <a class="reference internal" href="horizontalaxes.html#pygeode.Lat" title="pygeode.Lat"><tt class="xref py py-class docutils literal"><span class="pre">Lat</span></tt></a> and <a class="reference internal" href="horizontalaxes.html#pygeode.Lon" title="pygeode.Lon"><tt class="xref py py-class docutils literal"><span class="pre">Lon</span></tt></a> axes,
a map projection is created automatically.</p>
</dd></dl>
<dl class="function">
<dt id="pygeode.vplot">
<tt class="descclassname">pygeode.</tt><tt class="descname">vplot</tt><big>(</big><em>var</em>, <em>fmt=''</em>, <em>axes=None</em>, <em>transpose=False</em>, <em>lblx=True</em>, <em>lbly=True</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pygeode.vplot" 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>
<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>var</strong> : <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><tt class="xref py py-class docutils literal"><span class="pre">Var</span></tt></a></p>
<blockquote class="last">
<div><p>The variable to plot. Should have either 1 or 2 non-degenerate axes.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="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.</p>
</dd></dl>
<dl class="function">
<dt id="pygeode.vscatter">
<tt class="descclassname">pygeode.</tt><tt class="descname">vscatter</tt><big>(</big><em>varx</em>, <em>vary</em>, <em>axes=None</em>, <em>lblx=True</em>, <em>lbly=True</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pygeode.vscatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Do a scatter plot 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>varx</strong> : <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><tt class="xref py py-class docutils literal"><span class="pre">Var</span></tt></a></p>
<blockquote>
<div><p>Variable to use as abscissa values. Must have the same size as vary.</p>
</div></blockquote>
<p><strong>vary</strong> : <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><tt class="xref py py-class docutils literal"><span class="pre">Var</span></tt></a></p>
<blockquote class="last">
<div><p>Variable to use as ordinate values.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>Wraps matplotlib.scatter</p>
</dd></dl>
<dl class="function">
<dt id="pygeode.vquiver">
<tt class="descclassname">pygeode.</tt><tt class="descname">vquiver</tt><big>(</big><em>varu</em>, <em>varv</em>, <em>varc=None</em>, <em>axes=None</em>, <em>lblx=True</em>, <em>lbly=True</em>, <em>label=True</em>, <em>transpose=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pygeode.vquiver" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pygeode.vstreamplot">
<tt class="descclassname">pygeode.</tt><tt class="descname">vstreamplot</tt><big>(</big><em>varu</em>, <em>varv</em>, <em>axes=None</em>, <em>lblx=True</em>, <em>lbly=True</em>, <em>label=True</em>, <em>transpose=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pygeode.vstreamplot" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pygeode.vsigmask">
<tt class="descclassname">pygeode.</tt><tt class="descname">vsigmask</tt><big>(</big><em>var</em>, <em>axes</em>, <em>mjsig=0.9</em>, <em>mjc='0.8'</em>, <em>mjalpha=1.0</em>, <em>mnsig=None</em>, <em>mnc='0.9'</em>, <em>mnalpha=1.0</em>, <em>transpose=None</em><big>)</big><a class="headerlink" href="#pygeode.vsigmask" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<span class="target" id="module-pygeode.plot"></span><dl class="class">
<dt id="pygeode.plot.AxesWrapper">
<em class="property">class </em><tt class="descclassname">pygeode.plot.</tt><tt class="descname">AxesWrapper</tt><a class="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>
<dl class="function">
<dt id="pygeode.plot.grid">
<tt class="descclassname">pygeode.plot.</tt><tt class="descname">grid</tt><big>(</big><em>axes</em>, <em>size=None</em><big>)</big><a class="headerlink" href="#pygeode.plot.grid" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="dataset.html"
title="previous chapter">Dataset overview</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="fileio.html"
title="next chapter">File Input and Output</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/plot.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="fileio.html" title="File Input and Output"
>next</a> |</li>
<li class="right" >
<a href="dataset.html" title="Dataset overview"
>previous</a> |</li>
<li><a href="index.html">PyGeode 1.0 alpha documentation</a> »</li>
<li><a href="reference.html" >Reference</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>