forked from pygeode/pygeode.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathverticalaxes.html
257 lines (238 loc) · 14.1 KB
/
verticalaxes.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
<!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>Vertical axes object reference — 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="Axis class overview" href="axes.html" />
<link rel="next" title="Time axes objects reference" href="timeaxes.html" />
<link rel="prev" title="Horizonal axis objects reference" href="horizontalaxes.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="timeaxes.html" title="Time axes objects reference"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="horizontalaxes.html" title="Horizonal axis objects reference"
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="axes.html" accesskey="U">Axis class overview</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="vertical-axes-object-reference">
<h1>Vertical axes object reference<a class="headerlink" href="#vertical-axes-object-reference" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="pygeode.ZAxis">
<em class="property">class </em><tt class="descclassname">pygeode.</tt><tt class="descname">ZAxis</tt><a class="headerlink" href="#pygeode.ZAxis" title="Permalink to this definition">¶</a></dt>
<dd><p>Inherits from <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></p>
<p>Generic parent class for axes representing vertical coordinates, plotted by default on
the vertical axis in line plots and in contour plots. No new or overridden methods.</p>
</dd></dl>
<dl class="class">
<dt id="pygeode.Height">
<em class="property">class </em><tt class="descclassname">pygeode.</tt><tt class="descname">Height</tt><a class="headerlink" href="#pygeode.Height" title="Permalink to this definition">¶</a></dt>
<dd><p>Inherits from <a class="reference internal" href="#pygeode.ZAxis" title="pygeode.ZAxis"><tt class="xref py py-class docutils literal"><span class="pre">ZAxis</span></tt></a></p>
<p>Represents a geometric height. No new or overridden methods.</p>
</dd></dl>
<dl class="class">
<dt id="pygeode.Pres">
<em class="property">class </em><tt class="descclassname">pygeode.</tt><tt class="descname">Pres</tt><a class="headerlink" href="#pygeode.Pres" title="Permalink to this definition">¶</a></dt>
<dd><p>Inherits from <a class="reference internal" href="#pygeode.ZAxis" title="pygeode.ZAxis"><tt class="xref py py-class docutils literal"><span class="pre">ZAxis</span></tt></a></p>
<p>Represents a pressure vertical coordinate.</p>
<p class="rubric">New and overridden methods</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#pygeode.Pres.logPAxis" title="pygeode.Pres.logPAxis"><tt class="xref py py-obj docutils literal"><span class="pre">Pres.logPAxis</span></tt></a>([p0, H])</td>
<td>logPAxis(p0, H) - returns a pygeode axis with log pressure heights</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#pygeode.Pres.locator" title="pygeode.Pres.locator"><tt class="xref py py-obj docutils literal"><span class="pre">Pres.locator</span></tt></a>()</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#pygeode.Pres.formatvalue" title="pygeode.Pres.formatvalue"><tt class="xref py py-obj docutils literal"><span class="pre">Pres.formatvalue</span></tt></a>(value[, fmt, units, unitstr])</td>
<td>Returns formatted string representation of pressure <tt class="docutils literal"><span class="pre">value</span></tt>.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="pygeode.Hybrid">
<em class="property">class </em><tt class="descclassname">pygeode.</tt><tt class="descname">Hybrid</tt><a class="headerlink" href="#pygeode.Hybrid" title="Permalink to this definition">¶</a></dt>
<dd><p>Inherits from <a class="reference internal" href="#pygeode.ZAxis" title="pygeode.ZAxis"><tt class="xref py py-class docutils literal"><span class="pre">ZAxis</span></tt></a></p>
<p>Represents a hybridized pressure coordinate, of the form <span class="math">\(p(\eta) = A(\eta) p_0 + B(\eta) p_s\)</span>.</p>
<p>Auxilliary arrays: <tt class="docutils literal"><span class="pre">A</span></tt> and <tt class="docutils literal"><span class="pre">B</span></tt></p>
<p class="rubric">New and overridden methods</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#pygeode.Hybrid.__init__" title="pygeode.Hybrid.__init__"><tt class="xref py py-obj docutils literal"><span class="pre">Hybrid.__init__</span></tt></a>(values, A, B, **kwargs)</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#pygeode.Hybrid.locator" title="pygeode.Hybrid.locator"><tt class="xref py py-obj docutils literal"><span class="pre">Hybrid.locator</span></tt></a>()</td>
<td></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pygeode.Pres.logPAxis">
<tt class="descclassname">Pres.</tt><tt class="descname">logPAxis</tt><big>(</big><em>p0=1000.0</em>, <em>H=7.1</em><big>)</big><a class="headerlink" href="#pygeode.Pres.logPAxis" title="Permalink to this definition">¶</a></dt>
<dd><p>logPAxis(p0, H) - returns a pygeode axis with log pressure heights
corresponding to this axis. By default p0 = 1000 hPa and H = 7.1 (km).</p>
</dd></dl>
<dl class="method">
<dt id="pygeode.Pres.formatvalue">
<tt class="descclassname">Pres.</tt><tt class="descname">formatvalue</tt><big>(</big><em>value</em>, <em>fmt=None</em>, <em>units=True</em>, <em>unitstr=None</em><big>)</big><a class="headerlink" href="#pygeode.Pres.formatvalue" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns formatted string representation of pressure <tt class="docutils literal"><span class="pre">value</span></tt>.</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>value</strong> : float or int</p>
<blockquote>
<div><p>Value to format.</p>
</div></blockquote>
<p><strong>fmt</strong> : string (optional)</p>
<blockquote>
<div><p>Format specification; see Notes. If the default <tt class="docutils literal"><span class="pre">None</span></tt> is specified,
<tt class="docutils literal"><span class="pre">self.formatstr</span></tt> is used.</p>
</div></blockquote>
<p><strong>units</strong> : boolean (optional)</p>
<blockquote>
<div><p>If <tt class="docutils literal"><span class="pre">True</span></tt>, will include the units in the string returned.
Default is <tt class="docutils literal"><span class="pre">True</span></tt>.</p>
</div></blockquote>
<p><strong>unitstr</strong> : string (optional)</p>
<blockquote>
<div><p>String to use for the units; default is <tt class="docutils literal"><span class="pre">self.units</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 last"><strong>Formatted representation of the pressure. See notes.</strong> :</p>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>If <tt class="docutils literal"><span class="pre">fmt</span></tt> includes the character ‘<’, it is interpreted as ‘fmt<break’,
such that values less than float(break) are formatted using the format
string fmt, while those greater than float(break) are formatted as integers.
Otherwise the behaviour is like <tt class="xref py py-func docutils literal"><span class="pre">Var.formatvalue()</span></tt>.</p>
<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">pres</span><span class="o">.</span><span class="n">formatvalue</span><span class="p">(</span><span class="mi">1000</span><span class="p">)</span>
<span class="go"> 1000 hPa</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">t2</span><span class="o">.</span><span class="n">pres</span><span class="o">.</span><span class="n">formatvalue</span><span class="p">(</span><span class="mf">1.52</span><span class="p">)</span>
<span class="go"> 1.5 hPa</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">t2</span><span class="o">.</span><span class="n">pres</span><span class="o">.</span><span class="n">formatvalue</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span> <span class="s">'</span><span class="si">%.1g</span><span class="s">'</span><span class="p">)</span>
<span class="go"> 2e+01 hPa</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">t2</span><span class="o">.</span><span class="n">pres</span><span class="o">.</span><span class="n">formatvalue</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span> <span class="s">'</span><span class="si">%.1g</span><span class="s"><10'</span><span class="p">)</span>
<span class="go"> 20 hPa</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pygeode.Pres.locator">
<tt class="descclassname">Pres.</tt><tt class="descname">locator</tt><big>(</big><big>)</big><a class="headerlink" href="#pygeode.Pres.locator" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pygeode.Hybrid.__init__">
<tt class="descclassname">Hybrid.</tt><tt class="descname">__init__</tt><big>(</big><em>values</em>, <em>A</em>, <em>B</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pygeode.Hybrid.__init__" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pygeode.Hybrid.locator">
<tt class="descclassname">Hybrid.</tt><tt class="descname">locator</tt><big>(</big><big>)</big><a class="headerlink" href="#pygeode.Hybrid.locator" 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="horizontalaxes.html"
title="previous chapter">Horizonal axis objects reference</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="timeaxes.html"
title="next chapter">Time axes objects reference</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/verticalaxes.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="timeaxes.html" title="Time axes objects reference"
>next</a> |</li>
<li class="right" >
<a href="horizontalaxes.html" title="Horizonal axis objects reference"
>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="axes.html" >Axis 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>