2021-06-08 22:04:00 +00:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html class="writer-html5" lang="en" >
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8" />
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
|
|
|
<title>awips.dataaccess.PyGridData — python-awips documentation</title>
|
2021-09-20 20:37:21 +00:00
|
|
|
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
|
|
|
|
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
|
2021-06-08 22:04:00 +00:00
|
|
|
<!--[if lt IE 9]>
|
|
|
|
|
<script src="../../../_static/js/html5shiv.min.js"></script>
|
|
|
|
|
<![endif]-->
|
|
|
|
|
|
2023-09-18 20:56:23 +00:00
|
|
|
<script src="../../../_static/jquery.js?v=5d32c60e"></script>
|
|
|
|
|
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
|
|
|
|
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=b3ba4146"></script>
|
|
|
|
|
<script src="../../../_static/doctools.js?v=888ff710"></script>
|
|
|
|
|
<script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
|
2021-09-20 20:37:21 +00:00
|
|
|
<script src="../../../_static/js/theme.js"></script>
|
2021-06-08 22:04:00 +00:00
|
|
|
<link rel="author" title="About these documents" href="../../../about.html" />
|
|
|
|
|
<link rel="index" title="Index" href="../../../genindex.html" />
|
|
|
|
|
<link rel="search" title="Search" href="../../../search.html" />
|
|
|
|
|
</head>
|
|
|
|
|
|
2021-09-20 20:37:21 +00:00
|
|
|
<body class="wy-body-for-nav">
|
2021-06-08 22:04:00 +00:00
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
|
|
|
<div class="wy-side-scroll">
|
|
|
|
|
<div class="wy-side-nav-search" >
|
2023-02-27 20:38:55 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../index.html" class="icon icon-home">
|
|
|
|
|
python-awips
|
2021-06-08 22:04:00 +00:00
|
|
|
</a>
|
|
|
|
|
<div class="version">
|
2022-01-05 21:21:19 +00:00
|
|
|
18.1.8
|
2021-06-08 22:04:00 +00:00
|
|
|
</div>
|
|
|
|
|
<div role="search">
|
|
|
|
|
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
|
2023-02-27 20:38:55 +00:00
|
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
2021-06-08 22:04:00 +00:00
|
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
|
|
|
<input type="hidden" name="area" value="default" />
|
|
|
|
|
</form>
|
|
|
|
|
</div>
|
2021-09-20 20:37:21 +00:00
|
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
2021-06-08 22:04:00 +00:00
|
|
|
<ul>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../api/index.html">API Documentation</a></li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../datatypes.html">Available Data Types</a></li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../examples/index.html">Data Plotting Examples</a></li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../dev.html">Development Guide</a></li>
|
2021-09-20 20:37:21 +00:00
|
|
|
<li class="toctree-l1"><a class="reference external" href="http://unidata.github.io/awips2/appendix/appendix-grid-parameters/">AWIPS Grid Parameters</a></li>
|
2021-06-08 22:04:00 +00:00
|
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../about.html">About Unidata AWIPS</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</nav>
|
|
|
|
|
|
2021-09-20 20:37:21 +00:00
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
2021-06-08 22:04:00 +00:00
|
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
|
|
|
<a href="../../../index.html">python-awips</a>
|
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
|
|
|
<div class="rst-content">
|
2021-09-20 20:37:21 +00:00
|
|
|
<div role="navigation" aria-label="Page navigation">
|
2021-06-08 22:04:00 +00:00
|
|
|
<ul class="wy-breadcrumbs">
|
2023-02-27 20:38:55 +00:00
|
|
|
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
2022-11-09 18:56:39 +00:00
|
|
|
<li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
|
|
|
|
|
<li class="breadcrumb-item"><a href="../dataaccess.html">awips.dataaccess</a></li>
|
|
|
|
|
<li class="breadcrumb-item active">awips.dataaccess.PyGridData</li>
|
2021-06-08 22:04:00 +00:00
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<hr/>
|
|
|
|
|
</div>
|
|
|
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
|
|
|
<div itemprop="articleBody">
|
2021-09-20 20:37:21 +00:00
|
|
|
|
2021-06-08 22:04:00 +00:00
|
|
|
<h1>Source code for awips.dataaccess.PyGridData</h1><div class="highlight"><pre>
|
|
|
|
|
<span></span><span class="c1">#</span>
|
|
|
|
|
<span class="c1"># Implements IGridData for use by native Python clients to the Data Access</span>
|
|
|
|
|
<span class="c1"># Framework.</span>
|
|
|
|
|
<span class="c1">#</span>
|
|
|
|
|
<span class="c1">#</span>
|
|
|
|
|
<span class="c1"># SOFTWARE HISTORY</span>
|
|
|
|
|
<span class="c1">#</span>
|
|
|
|
|
<span class="c1"># Date Ticket# Engineer Description</span>
|
|
|
|
|
<span class="c1"># ------------ ---------- ----------- --------------------------</span>
|
|
|
|
|
<span class="c1"># 06/03/13 #2023 dgilling Initial Creation.</span>
|
|
|
|
|
<span class="c1"># 10/13/16 #5916 bsteffen Correct grid shape, allow lat/lon</span>
|
|
|
|
|
<span class="c1"># 11/10/16 #5900 bsteffen Correct grid shape</span>
|
|
|
|
|
<span class="c1"># to be requested by a delegate</span>
|
|
|
|
|
<span class="c1">#</span>
|
|
|
|
|
<span class="c1">#</span>
|
|
|
|
|
|
|
|
|
|
<span class="kn">import</span> <span class="nn">numpy</span>
|
|
|
|
|
<span class="kn">import</span> <span class="nn">warnings</span>
|
|
|
|
|
<span class="kn">import</span> <span class="nn">six</span>
|
|
|
|
|
|
|
|
|
|
<span class="kn">from</span> <span class="nn">awips.dataaccess</span> <span class="kn">import</span> <span class="n">IGridData</span>
|
|
|
|
|
<span class="kn">from</span> <span class="nn">awips.dataaccess</span> <span class="kn">import</span> <span class="n">PyData</span>
|
|
|
|
|
|
|
|
|
|
<span class="n">NO_UNIT_CONVERT_WARNING</span> <span class="o">=</span> <span class="s2">"""</span>
|
|
|
|
|
<span class="s2">The ability to unit convert grid data is not currently available in this version of the Data Access Framework.</span>
|
|
|
|
|
<span class="s2">"""</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="PyGridData"><a class="viewcode-back" href="../../../api/PyGridData.html#awips.dataaccess.PyGridData.PyGridData">[docs]</a><span class="k">class</span> <span class="nc">PyGridData</span><span class="p">(</span><span class="n">IGridData</span><span class="p">,</span> <span class="n">PyData</span><span class="o">.</span><span class="n">PyData</span><span class="p">):</span>
|
|
|
|
|
|
|
|
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">gridDataRecord</span><span class="p">,</span> <span class="n">nx</span><span class="p">,</span> <span class="n">ny</span><span class="p">,</span> <span class="n">latLonGrid</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">latLonDelegate</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
|
|
<span class="n">PyData</span><span class="o">.</span><span class="n">PyData</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">gridDataRecord</span><span class="p">)</span>
|
|
|
|
|
<span class="n">nx</span> <span class="o">=</span> <span class="n">nx</span>
|
|
|
|
|
<span class="n">ny</span> <span class="o">=</span> <span class="n">ny</span>
|
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">__parameter</span> <span class="o">=</span> <span class="n">gridDataRecord</span><span class="o">.</span><span class="n">getParameter</span><span class="p">()</span>
|
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">__unit</span> <span class="o">=</span> <span class="n">gridDataRecord</span><span class="o">.</span><span class="n">getUnit</span><span class="p">()</span>
|
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">__gridData</span> <span class="o">=</span> <span class="n">numpy</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">numpy</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">gridDataRecord</span><span class="o">.</span><span class="n">getGridData</span><span class="p">()),</span> <span class="p">(</span><span class="n">ny</span><span class="p">,</span> <span class="n">nx</span><span class="p">))</span>
|
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">__latLonGrid</span> <span class="o">=</span> <span class="n">latLonGrid</span>
|
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">__latLonDelegate</span> <span class="o">=</span> <span class="n">latLonDelegate</span>
|
|
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="PyGridData.getParameter"><a class="viewcode-back" href="../../../api/PyGridData.html#awips.dataaccess.PyGridData.PyGridData.getParameter">[docs]</a> <span class="k">def</span> <span class="nf">getParameter</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__parameter</span></div>
|
|
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="PyGridData.getUnit"><a class="viewcode-back" href="../../../api/PyGridData.html#awips.dataaccess.PyGridData.PyGridData.getUnit">[docs]</a> <span class="k">def</span> <span class="nf">getUnit</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
|
|
<span class="k">if</span> <span class="n">six</span><span class="o">.</span><span class="n">PY2</span><span class="p">:</span>
|
|
|
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__unit</span>
|
|
|
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">__unit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__unit</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
|
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__unit</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span>
|
|
|
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__unit</span></div>
|
|
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="PyGridData.getRawData"><a class="viewcode-back" href="../../../api/PyGridData.html#awips.dataaccess.PyGridData.PyGridData.getRawData">[docs]</a> <span class="k">def</span> <span class="nf">getRawData</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">unit</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
|
|
<span class="c1"># TODO: Find a proper python library that deals will with numpy and</span>
|
|
|
|
|
<span class="c1"># javax.measure style unit strings and hook it in to this method to</span>
|
|
|
|
|
<span class="c1"># allow end-users to perform unit conversion for grid data.</span>
|
|
|
|
|
<span class="k">if</span> <span class="n">unit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
|
|
|
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="n">NO_UNIT_CONVERT_WARNING</span><span class="p">,</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
|
|
|
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__gridData</span></div>
|
|
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="PyGridData.getLatLonCoords"><a class="viewcode-back" href="../../../api/PyGridData.html#awips.dataaccess.PyGridData.PyGridData.getLatLonCoords">[docs]</a> <span class="k">def</span> <span class="nf">getLatLonCoords</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">__latLonGrid</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
|
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__latLonGrid</span>
|
|
|
|
|
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">__latLonDelegate</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
|
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__latLonDelegate</span><span class="p">()</span>
|
|
|
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__latLonGrid</span></div></div>
|
|
|
|
|
</pre></div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<footer>
|
|
|
|
|
|
|
|
|
|
<hr/>
|
|
|
|
|
|
|
|
|
|
<div role="contentinfo">
|
2021-09-20 20:37:21 +00:00
|
|
|
<p>© Copyright 2018, Unidata.</p>
|
2021-06-08 22:04:00 +00:00
|
|
|
</div>
|
2021-09-20 20:37:21 +00:00
|
|
|
|
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
2021-06-08 22:04:00 +00:00
|
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
2021-09-20 20:37:21 +00:00
|
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
2021-06-08 22:04:00 +00:00
|
|
|
|
|
|
|
|
</footer>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
</div>
|
2021-09-20 20:37:21 +00:00
|
|
|
<script>
|
2021-06-08 22:04:00 +00:00
|
|
|
jQuery(function () {
|
|
|
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
|
|
|
});
|
2021-09-20 20:37:21 +00:00
|
|
|
</script>
|
2021-06-08 22:04:00 +00:00
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
