python-awips/_modules/awips/RadarCommon.html
2022-01-05 21:21:19 +00:00

245 lines
No EOL
23 KiB
HTML

<!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.RadarCommon &mdash; python-awips documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<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>
<script src="../../_static/js/theme.js"></script>
<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>
<body class="wy-body-for-nav">
<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" >
<a href="../../index.html" class="icon icon-home"> python-awips
</a>
<div class="version">
18.1.8
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<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>
<li class="toctree-l1"><a class="reference external" href="http://unidata.github.io/awips2/appendix/appendix-grid-parameters/">AWIPS Grid Parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../about.html">About Unidata AWIPS</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<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">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../index.html">Module code</a> &raquo;</li>
<li>awips.RadarCommon</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for awips.RadarCommon</h1><div class="highlight"><pre>
<span></span><span class="c1">#</span>
<span class="c1"># Common methods for the a2gtrad and a2advrad scripts.</span>
<span class="c1">#</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"># 08/13/2014 3393 nabowle Initial creation to contain common</span>
<span class="c1"># code for a2*radStub scripts.</span>
<span class="c1"># 03/15/2015 mjames@ucar Edited/added to awips package as RadarCommon</span>
<span class="c1">#</span>
<span class="c1">#</span>
<div class="viewcode-block" id="get_datetime_str"><a class="viewcode-back" href="../../api/RadarCommon.html#awips.RadarCommon.get_datetime_str">[docs]</a><span class="k">def</span> <span class="nf">get_datetime_str</span><span class="p">(</span><span class="n">record</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Get the datetime string for a record.</span>
<span class="sd"> Args:</span>
<span class="sd"> record: the record to get data for.</span>
<span class="sd"> Returns:</span>
<span class="sd"> datetime string.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">getDataTime</span><span class="p">())[</span><span class="mi">0</span><span class="p">:</span><span class="mi">19</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot; &quot;</span><span class="p">,</span> <span class="s2">&quot;_&quot;</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;.0&quot;</span></div>
<div class="viewcode-block" id="get_data_type"><a class="viewcode-back" href="../../api/RadarCommon.html#awips.RadarCommon.get_data_type">[docs]</a><span class="k">def</span> <span class="nf">get_data_type</span><span class="p">(</span><span class="n">azdat</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Get the radar file type (radial or raster).</span>
<span class="sd"> Args:</span>
<span class="sd"> azdat: Boolean.</span>
<span class="sd"> Returns:</span>
<span class="sd"> Radial or raster.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">azdat</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;radial&quot;</span>
<span class="k">return</span> <span class="s2">&quot;raster&quot;</span></div>
<div class="viewcode-block" id="get_hdf5_data"><a class="viewcode-back" href="../../api/RadarCommon.html#awips.RadarCommon.get_hdf5_data">[docs]</a><span class="k">def</span> <span class="nf">get_hdf5_data</span><span class="p">(</span><span class="n">idra</span><span class="p">):</span>
<span class="n">rdat</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">azdat</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">depVals</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">threshVals</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">idra</span><span class="p">:</span>
<span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">idra</span><span class="p">:</span>
<span class="k">if</span> <span class="n">item</span><span class="o">.</span><span class="n">getName</span><span class="p">()</span> <span class="o">==</span> <span class="s2">&quot;Data&quot;</span><span class="p">:</span>
<span class="n">rdat</span> <span class="o">=</span> <span class="n">item</span>
<span class="k">elif</span> <span class="n">item</span><span class="o">.</span><span class="n">getName</span><span class="p">()</span> <span class="o">==</span> <span class="s2">&quot;Angles&quot;</span><span class="p">:</span>
<span class="n">azdat</span> <span class="o">=</span> <span class="n">item</span>
<span class="c1"># dattyp = &quot;radial&quot;</span>
<span class="k">elif</span> <span class="n">item</span><span class="o">.</span><span class="n">getName</span><span class="p">()</span> <span class="o">==</span> <span class="s2">&quot;DependentValues&quot;</span><span class="p">:</span>
<span class="n">depVals</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">getShortData</span><span class="p">()</span>
<span class="k">elif</span> <span class="n">item</span><span class="o">.</span><span class="n">getName</span><span class="p">()</span> <span class="o">==</span> <span class="s2">&quot;Thresholds&quot;</span><span class="p">:</span>
<span class="n">threshVals</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">getShortData</span><span class="p">()</span>
<span class="k">return</span> <span class="n">rdat</span><span class="p">,</span> <span class="n">azdat</span><span class="p">,</span> <span class="n">depVals</span><span class="p">,</span> <span class="n">threshVals</span></div>
<div class="viewcode-block" id="get_header"><a class="viewcode-back" href="../../api/RadarCommon.html#awips.RadarCommon.get_header">[docs]</a><span class="k">def</span> <span class="nf">get_header</span><span class="p">(</span><span class="n">record</span><span class="p">,</span> <span class="n">headerFormat</span><span class="p">,</span> <span class="n">xLen</span><span class="p">,</span> <span class="n">yLen</span><span class="p">,</span> <span class="n">azdat</span><span class="p">,</span> <span class="n">description</span><span class="p">):</span>
<span class="c1"># Encode dimensions, time, mapping, description, tilt, and VCP</span>
<span class="n">mytime</span> <span class="o">=</span> <span class="n">get_datetime_str</span><span class="p">(</span><span class="n">record</span><span class="p">)</span>
<span class="n">dattyp</span> <span class="o">=</span> <span class="n">get_data_type</span><span class="p">(</span><span class="n">azdat</span><span class="p">)</span>
<span class="k">if</span> <span class="n">headerFormat</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">xLen</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">yLen</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> <span class="n">mytime</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> \
<span class="n">dattyp</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">getLatitude</span><span class="p">())</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> \
<span class="nb">str</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">getLongitude</span><span class="p">())</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> \
<span class="nb">str</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">getElevation</span><span class="p">())</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> \
<span class="nb">str</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">getElevationNumber</span><span class="p">())</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> \
<span class="n">description</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">getTrueElevationAngle</span><span class="p">())</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> \
<span class="nb">str</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">getVolumeCoveragePattern</span><span class="p">())</span> <span class="o">+</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">xLen</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">yLen</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> <span class="n">mytime</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> \
<span class="n">dattyp</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> <span class="n">description</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> \
<span class="nb">str</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">getTrueElevationAngle</span><span class="p">())</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> \
<span class="nb">str</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">getVolumeCoveragePattern</span><span class="p">())</span> <span class="o">+</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span>
<span class="k">return</span> <span class="n">msg</span></div>
<div class="viewcode-block" id="encode_thresh_vals"><a class="viewcode-back" href="../../api/RadarCommon.html#awips.RadarCommon.encode_thresh_vals">[docs]</a><span class="k">def</span> <span class="nf">encode_thresh_vals</span><span class="p">(</span><span class="n">threshVals</span><span class="p">):</span>
<span class="n">spec</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;.&quot;</span><span class="p">,</span> <span class="s2">&quot;TH&quot;</span><span class="p">,</span> <span class="s2">&quot;ND&quot;</span><span class="p">,</span> <span class="s2">&quot;RF&quot;</span><span class="p">,</span> <span class="s2">&quot;BI&quot;</span><span class="p">,</span> <span class="s2">&quot;GC&quot;</span><span class="p">,</span> <span class="s2">&quot;IC&quot;</span><span class="p">,</span> <span class="s2">&quot;GR&quot;</span><span class="p">,</span> <span class="s2">&quot;WS&quot;</span><span class="p">,</span> <span class="s2">&quot;DS&quot;</span><span class="p">,</span>
<span class="s2">&quot;RA&quot;</span><span class="p">,</span> <span class="s2">&quot;HR&quot;</span><span class="p">,</span> <span class="s2">&quot;BD&quot;</span><span class="p">,</span> <span class="s2">&quot;HA&quot;</span><span class="p">,</span> <span class="s2">&quot;UK&quot;</span><span class="p">]</span>
<span class="n">nnn</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">threshVals</span><span class="p">)</span>
<span class="n">j</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="k">while</span> <span class="n">j</span> <span class="o">&lt;</span> <span class="n">nnn</span><span class="p">:</span>
<span class="n">lo</span> <span class="o">=</span> <span class="n">threshVals</span><span class="p">[</span><span class="n">j</span><span class="p">]</span> <span class="o">%</span> <span class="mi">256</span>
<span class="n">hi</span> <span class="o">=</span> <span class="n">threshVals</span><span class="p">[</span><span class="n">j</span><span class="p">]</span> <span class="o">/</span> <span class="mi">256</span>
<span class="n">msg</span> <span class="o">+=</span> <span class="s2">&quot; &quot;</span>
<span class="n">j</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">hi</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">if</span> <span class="n">lo</span> <span class="o">&gt;</span> <span class="mi">14</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">+=</span> <span class="s2">&quot;.&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">+=</span> <span class="n">spec</span><span class="p">[</span><span class="n">lo</span><span class="p">]</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">hi</span> <span class="o">%</span> <span class="mi">16</span> <span class="o">&gt;=</span> <span class="mi">8</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">+=</span> <span class="s2">&quot;&gt;&quot;</span>
<span class="k">elif</span> <span class="n">hi</span> <span class="o">%</span> <span class="mi">8</span> <span class="o">&gt;=</span> <span class="mi">4</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">+=</span> <span class="s2">&quot;&lt;&quot;</span>
<span class="k">if</span> <span class="n">hi</span> <span class="o">%</span> <span class="mi">4</span> <span class="o">&gt;=</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">+=</span> <span class="s2">&quot;+&quot;</span>
<span class="k">elif</span> <span class="n">hi</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">&gt;=</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">+=</span> <span class="s2">&quot;-&quot;</span>
<span class="k">if</span> <span class="n">hi</span> <span class="o">&gt;=</span> <span class="mi">64</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">+=</span> <span class="s2">&quot;</span><span class="si">%.2f</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">lo</span><span class="o">*</span><span class="mf">0.01</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">hi</span> <span class="o">%</span> <span class="mi">64</span> <span class="o">&gt;=</span> <span class="mi">32</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">+=</span> <span class="s2">&quot;</span><span class="si">%.2f</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">lo</span><span class="o">*</span><span class="mf">0.05</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">hi</span> <span class="o">%</span> <span class="mi">32</span> <span class="o">&gt;=</span> <span class="mi">16</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">+=</span> <span class="s2">&quot;</span><span class="si">%.1f</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">lo</span><span class="o">*</span><span class="mf">0.1</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">+=</span> <span class="nb">str</span><span class="p">(</span><span class="n">lo</span><span class="p">)</span>
<span class="n">msg</span> <span class="o">+=</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span>
<span class="k">return</span> <span class="n">msg</span></div>
<div class="viewcode-block" id="encode_dep_vals"><a class="viewcode-back" href="../../api/RadarCommon.html#awips.RadarCommon.encode_dep_vals">[docs]</a><span class="k">def</span> <span class="nf">encode_dep_vals</span><span class="p">(</span><span class="n">depVals</span><span class="p">):</span>
<span class="n">nnn</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">depVals</span><span class="p">)</span>
<span class="n">j</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">msg</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">while</span> <span class="n">j</span> <span class="o">&lt;</span> <span class="n">nnn</span><span class="p">:</span>
<span class="n">msg</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">depVals</span><span class="p">[</span><span class="n">j</span><span class="p">]))</span>
<span class="n">j</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">return</span> <span class="n">msg</span></div>
<div class="viewcode-block" id="encode_radial"><a class="viewcode-back" href="../../api/RadarCommon.html#awips.RadarCommon.encode_radial">[docs]</a><span class="k">def</span> <span class="nf">encode_radial</span><span class="p">(</span><span class="n">azVals</span><span class="p">):</span>
<span class="n">azValsLen</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">azVals</span><span class="p">)</span>
<span class="n">j</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">msg</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">while</span> <span class="n">j</span> <span class="o">&lt;</span> <span class="n">azValsLen</span><span class="p">:</span>
<span class="n">msg</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">azVals</span><span class="p">[</span><span class="n">j</span><span class="p">])</span>
<span class="n">j</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">return</span> <span class="n">msg</span></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2018, Unidata.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>