Repository navigation
Expand file tree
/
Copy pathvarquery.html
More file actions
202 lines (186 loc) · 15.1 KB
/
Copy pathvarquery.html
File metadata and controls
202 lines (186 loc) · 15.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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Variable Querying Routines — PyGeode 1.4.1-rc2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/pygtheme.css" />
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/pygeode_icon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Retrieving values from a variable" href="var.get.html" />
<link rel="prev" title="Var class overview" href="var.html" />
<link href="http://fonts.googleapis.com/css?family=Ubuntu:300,300italic,regular,italic,500,500italic,bold,bolditalic" rel="stylesheet" type="text/css">
<link href='http://fonts.googleapis.com/css?family=Ubuntu+Mono:400,700' rel='stylesheet' type='text/css'>
</head><body>
<div class="header" role="banner"><img class="logo" src="_static/pygeode_logo.png" width=79px alt="Logo"/>
<h1 class="heading"><a href="index.html">
<span>PyGeode 1.4.1-rc2 documentation</span></a></h1>
<h2 class="heading"><span>Variable Querying Routines</span></h2>
</div>
<div class="topnav" role="navigation" aria-label="top navigation">
<p>
«  <a href="var.html">Var class overview</a>
  ::  
<a class="uplink" href="reference.html">Reference</a>
  ::  
<a class="uplink" href="tutorial.html">Tutorial</a>
  ::  
<a class="uplink" href="gallery/index.html">Gallery</a>
  ::  
<a href="var.get.html">Retrieving values from a variable</a>  »
</p>
</div>
<div class="content">
<div class="section" id="variable-querying-routines">
<h1>Variable Querying Routines<a class="headerlink" href="#variable-querying-routines" title="Permalink to this headline">¶</a></h1>
<p>Operations that retrieve information about the variable.</p>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.whichaxis">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">whichaxis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iaxis</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/var.html#Var.whichaxis"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.Var.whichaxis" title="Permalink to this definition">¶</a></dt>
<dd><p>Locates a particular <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a> associated with this variable.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>iaxis</strong><span class="classifier">string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a> class, or int</span></dt><dd><p>The search criteria for finding the class.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>i</strong><span class="classifier">The index of the matching Axis. Raises <code class="docutils literal notranslate"><span class="pre">KeyError</span></code> if there is no match.</span></dt><dd></dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#pygeode.Var.getaxis" title="pygeode.Var.getaxis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getaxis</span></code></a>, <a class="reference internal" href="#pygeode.Var.hasaxis" title="pygeode.Var.hasaxis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hasaxis</span></code></a>, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis</span></code></a></dt><dd></dd>
</dl>
</div>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><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="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="nb">print</span><span class="p">(</span><span class="n">T</span><span class="o">.</span><span class="n">axes</span><span class="p">)</span>
<span class="go">(<Lat>, <Lon>)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">T</span><span class="o">.</span><span class="n">whichaxis</span><span class="p">(</span><span class="s1">'lat'</span><span class="p">))</span>
<span class="go">0</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">T</span><span class="o">.</span><span class="n">whichaxis</span><span class="p">(</span><span class="s1">'lon'</span><span class="p">))</span>
<span class="go">1</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">T</span><span class="o">.</span><span class="n">whichaxis</span><span class="p">(</span><span class="s1">'time'</span><span class="p">))</span>
<span class="gt">Traceback (most recent call last):</span>
File <span class="nb">"<stdin>"</span>, line <span class="m">1</span>, in <span class="n"><module></span>
File <span class="nb">"/usr/local/lib/python2.6/dist-packages/pygeode/var.py"</span>, line <span class="m">352</span>, in <span class="n">whichaxis</span>
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">,</span> <span class="s2">"axis </span><span class="si">%s</span><span class="s2"> not found in </span><span class="si">%s</span><span class="s2">"</span><span class="o">%</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="n">iaxis</span><span class="p">),</span><span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="p">)</span>
<span class="gr">KeyError</span>: <span class="n">"axis 'time' not found in (<Lat>, <Lon>)"</span>
</pre></div>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.hasaxis">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">hasaxis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iaxis</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/var.html#Var.hasaxis"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.Var.hasaxis" title="Permalink to this definition">¶</a></dt>
<dd><p>Determines if a particular <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a> is associated with this variable.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>iaxis</strong><span class="classifier">string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a> class, or int</span></dt><dd><p>The search criteria for finding the class.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>found</strong><span class="classifier">boolean. <code class="docutils literal notranslate"><span class="pre">True</span></code> if found, otherwise <code class="docutils literal notranslate"><span class="pre">False</span></code></span></dt><dd></dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#pygeode.Var.getaxis" title="pygeode.Var.getaxis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getaxis</span></code></a>, <a class="reference internal" href="#pygeode.Var.whichaxis" title="pygeode.Var.whichaxis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">whichaxis</span></code></a>, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.getaxis">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">getaxis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iaxis</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/var.html#Var.getaxis"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.Var.getaxis" title="Permalink to this definition">¶</a></dt>
<dd><p>Grabs a reference to a particular <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a> associated with this variable.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>iaxis</strong><span class="classifier">string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a> class, or int</span></dt><dd><p>The search criteria for finding the class.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>axis</strong><span class="classifier"><a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a> object that matches. Raises <code class="docutils literal notranslate"><span class="pre">KeyError</span></code> if there is no match.</span></dt><dd></dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#pygeode.Var.whichaxis" title="pygeode.Var.whichaxis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">whichaxis</span></code></a>, <a class="reference internal" href="#pygeode.Var.hasaxis" title="pygeode.Var.hasaxis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hasaxis</span></code></a>, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Var.getweights">
<span class="sig-prename descclassname"><span class="pre">Var.</span></span><span class="sig-name descname"><span class="pre">getweights</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iaxes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/var.html#Var.getweights"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.Var.getweights" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns weights associated with the axes of this variable.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>iaxes</strong><span class="classifier">list of axis identifiers (string, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a>, or int) (optional)</span></dt><dd><p>Axes over which to compute the weights</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>weights</strong><span class="classifier"><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a></span></dt><dd><p>defined on the subgrid of this variable on which weights are defined.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="axis.html#pygeode.Axis.__init__" title="pygeode.Axis.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis.__init__</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="simple">
<dt><strong>See Also:</strong></dt><dd><p><a class="reference internal" href="var.html"><span class="doc">Var class overview</span></a></p>
</dd>
</dl>
</div>
</div>
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
<p>
«  <a href="var.html">Var class overview</a>
  ::  
<a class="uplink" href="reference.html">Reference</a>
  ::  
<a class="uplink" href="tutorial.html">Tutorial</a>
  ::  
<a class="uplink" href="gallery/index.html">Gallery</a>
  ::  
<a href="var.get.html">Retrieving values from a variable</a>  »
</p>
</div>
<div class="footer" role="contentinfo">
© Copyright 2020, Mike Neish, Peter Hitchcock.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
</div>
</body>
</html>