Changeset ada37fa in ammosreader for doc/html/_modules


Ignore:
Timestamp:
05/04/22 12:00:45 (3 years ago)
Author:
Enrico Schwass <ennoausberlin@…>
Branches:
AmmosSource, guix
Children:
64565fe
Parents:
1846087
Message:

docs generated

Location:
doc/html/_modules
Files:
13 added
1 edited
1 moved

Legend:

Unmodified
Added
Removed

  • doc/html/_modules/ammosreader/PDW.html

    r1846087 rada37fa  
    11
    2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    4 
    5 <html xmlns="http://www.w3.org/1999/xhtml">
     2<!DOCTYPE html>
     3
     4<html>
    65  <head>
    7     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    9     <title>PDW &#8212; RadarDex 0.314 documentation</title>
    10     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
    11     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    12     <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
    13     <script type="text/javascript" src="../_static/jquery.js"></script>
    14     <script type="text/javascript" src="../_static/underscore.js"></script>
    15     <script type="text/javascript" src="../_static/doctools.js"></script>
    16     <script type="text/javascript" src="../_static/language_data.js"></script>
    17     <link rel="index" title="Index" href="../genindex.html" />
    18     <link rel="search" title="Search" href="../search.html" />
     6    <meta charset="utf-8" />
     7    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     8    <title>ammosreader.PDW &#8212; AmmosReader 0.314 documentation</title>
     9    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
     10    <link rel="stylesheet" type="text/css" href="../../_static/alabaster.css" />
     11    <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
     12    <script src="../../_static/jquery.js"></script>
     13    <script src="../../_static/underscore.js"></script>
     14    <script src="../../_static/doctools.js"></script>
     15    <link rel="index" title="Index" href="../../genindex.html" />
     16    <link rel="search" title="Search" href="../../search.html" />
    1917   
    20   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
     18  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
     19 
    2120 
    2221  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
    … …  
    2827      <div class="documentwrapper">
    2928        <div class="bodywrapper">
     29         
     30
    3031          <div class="body" role="main">
    3132           
    32   <h1>Source code for PDW</h1><div class="highlight"><pre>
     33  <h1>Source code for ammosreader.PDW</h1><div class="highlight"><pre>
    3334<span></span><span class="kn">import</span> <span class="nn">struct</span>
    3435<span class="kn">import</span> <span class="nn">math</span>
    35 <span class="kn">import</span> <span class="nn">datetime</span>
     36<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
    3637
    3738<span class="c1"># TODO: Use BitArray module in future versions</span>
    3839
    3940
    40 <div class="viewcode-block" id="PDW"><a class="viewcode-back" href="../PDW.html#PDW.PDW">[docs]</a><span class="k">class</span> <span class="nc">PDW</span><span class="p">():</span>
    41 
     41<div class="viewcode-block" id="PDW"><a class="viewcode-back" href="../../ammosreader.html#ammosreader.PDW.PDW">[docs]</a><span class="k">class</span> <span class="nc">PDW</span><span class="p">():</span>
    4242    <span class="sd">&quot;&quot;&quot;</span>
    43 
    44 <span class="sd">    I store information from a single ppdw data block</span>
     43<span class="sd">    I store information from a single ppdw data block.</span>
    4544
    4645<span class="sd">    .. automethod:: __init__</span>
    … …  
    4847<span class="sd">    &quot;&quot;&quot;</span>
    4948
    50 <div class="viewcode-block" id="PDW.from_bytes"><a class="viewcode-back" href="../PDW.html#PDW.PDW.from_bytes">[docs]</a>    <span class="nd">@classmethod</span>
     49<div class="viewcode-block" id="PDW.from_bytes"><a class="viewcode-back" href="../../ammosreader.html#ammosreader.PDW.PDW.from_bytes">[docs]</a>    <span class="nd">@classmethod</span>
    5150    <span class="k">def</span> <span class="nf">from_bytes</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">byte_string</span><span class="p">):</span>
    5251
    … …  
    6665
    6766        <span class="n">parts</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">&#39;Q4s4s4s4s4s4s&#39;</span><span class="p">,</span> <span class="n">byte_string</span><span class="p">)</span>
    68         <span class="n">seconds</span> <span class="o">=</span> <span class="p">(</span><span class="n">parts</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
    69         <span class="n">time_of_arrival</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcfromtimestamp</span><span class="p">(</span><span class="n">seconds</span> <span class="o">/</span> <span class="mi">1000000000</span><span class="p">)</span>
     67        <span class="n">nanoseconds</span> <span class="o">=</span> <span class="p">(</span><span class="n">parts</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
     68        <span class="n">time_of_arrival</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">datetime64</span><span class="p">(</span><span class="n">nanoseconds</span><span class="p">,</span> <span class="s1">&#39;ns&#39;</span><span class="p">)</span>  <span class="c1">#datetime.datetime.utcfromtimestamp(seconds / 1000000000)</span>
    7069
    7170        <span class="n">third_entry</span> <span class="o">=</span> <span class="nb">bin</span><span class="p">(</span><span class="nb">int</span><span class="o">.</span><span class="n">from_bytes</span><span class="p">(</span><span class="n">parts</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">byteorder</span><span class="o">=</span><span class="s1">&#39;little&#39;</span><span class="p">))</span>
    … …  
    124123                   <span class="n">sector</span><span class="p">,</span> <span class="n">polarity</span><span class="p">,</span> <span class="n">df_quality</span><span class="p">,</span> <span class="n">elevation</span><span class="p">,</span> <span class="n">azimuth</span><span class="p">,</span> <span class="n">channel</span><span class="p">)</span></div>
    125124
    126 <div class="viewcode-block" id="PDW.__init__"><a class="viewcode-back" href="../PDW.html#PDW.PDW.__init__">[docs]</a>    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">time_of_arrival</span><span class="p">,</span> <span class="n">pdw_format_identifier</span><span class="p">,</span> <span class="n">center_frequency</span><span class="p">,</span> <span class="n">is_valid</span><span class="p">,</span> <span class="n">is_pulse</span><span class="p">,</span>
     125<div class="viewcode-block" id="PDW.__init__"><a class="viewcode-back" href="../../ammosreader.html#ammosreader.PDW.PDW.__init__">[docs]</a>    <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">time_of_arrival</span><span class="p">,</span> <span class="n">pdw_format_identifier</span><span class="p">,</span> <span class="n">center_frequency</span><span class="p">,</span> <span class="n">is_valid</span><span class="p">,</span> <span class="n">is_pulse</span><span class="p">,</span>
    127126                 <span class="n">level_unit</span><span class="p">,</span> <span class="n">signal_start_missing</span><span class="p">,</span> <span class="n">signal_end_missing</span><span class="p">,</span> <span class="n">pulse_width</span><span class="p">,</span> <span class="n">frequency_shift_or_bandwidth</span><span class="p">,</span>
    128127                 <span class="n">pulse_level_or_pulse_field_strength</span><span class="p">,</span> <span class="n">region_of_interest</span><span class="p">,</span> <span class="n">azimuth_confidence</span><span class="p">,</span> <span class="n">modulation</span><span class="p">,</span>
    … …  
    200199        <span class="bp">self</span><span class="o">.</span><span class="n">channel</span> <span class="o">=</span> <span class="n">channel</span></div>
    201200
    202     <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     201    <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    203202        <span class="n">output</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;Time of arrival: &quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">time_of_arrival</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="o">+</span>
    204203                  <span class="s2">&quot;PDW Format identifier: &quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pdw_format_identifier</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="o">+</span>
    … …  
    264263
    265264          </div>
     265         
    266266        </div>
    267267      </div>
    268268      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    269269        <div class="sphinxsidebarwrapper">
    270 <h1 class="logo"><a href="../index.html">RadarDex</a></h1>
     270<h1 class="logo"><a href="../../index.html">AmmosReader</a></h1>
    271271
    272272
    … …  
    279279<h3>Navigation</h3>
    280280<ul>
    281 <li class="toctree-l1"><a class="reference internal" href="../PDW.html">PDW module</a></li>
     281<li class="toctree-l1"><a class="reference internal" href="../../ammosreader.html">ammosreader package</a></li>
    282282</ul>
    283283
    … …  
    285285<h3>Related Topics</h3>
    286286<ul>
    287   <li><a href="../index.html">Documentation overview</a><ul>
    288   <li><a href="index.html">Module code</a><ul>
     287  <li><a href="../../index.html">Documentation overview</a><ul>
     288  <li><a href="../index.html">Module code</a><ul>
    289289  </ul></li>
    290290  </ul></li>
    … …  
    292292</div>
    293293<div id="searchbox" style="display: none" role="search">
    294   <h3>Quick search</h3>
     294  <h3 id="searchlabel">Quick search</h3>
    295295    <div class="searchformwrapper">
    296     <form class="search" action="../search.html" method="get">
    297       <input type="text" name="q" />
     296    <form class="search" action="../../search.html" method="get">
     297      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
    298298      <input type="submit" value="Go" />
    299       <input type="hidden" name="check_keywords" value="yes" />
    300       <input type="hidden" name="area" value="default" />
    301299    </form>
    302300    </div>
    303301</div>
    304 <script type="text/javascript">$('#searchbox').show(0);</script>
     302<script>$('#searchbox').show(0);</script>
     303
     304
     305
     306
     307
     308
     309
     310
    305311        </div>
    306312      </div>
    … …  
    308314    </div>
    309315    <div class="footer">
    310       &copy;2020, Enrico Schwass.
     316      &copy;2022, Enrico Schwass.
    311317     
    312318      |
    313       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.5</a>
    314       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
     319      Powered by <a href="http://sphinx-doc.org/">Sphinx 4.2.0</a>
     320      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
    315321     
    316322    </div>

  • doc/html/_modules/index.html

    r1846087 rada37fa  
    11
    2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
     2<!DOCTYPE html>
    43
    5 <html xmlns="http://www.w3.org/1999/xhtml">
     4<html>
    65  <head>
    7     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    9     <title>Overview: module code &#8212; RadarDex 0.314 documentation</title>
    10     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
    11     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    12     <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
    13     <script type="text/javascript" src="../_static/jquery.js"></script>
    14     <script type="text/javascript" src="../_static/underscore.js"></script>
    15     <script type="text/javascript" src="../_static/doctools.js"></script>
    16     <script type="text/javascript" src="../_static/language_data.js"></script>
     6    <meta charset="utf-8" />
     7    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     8    <title>Overview: module code &#8212; AmmosReader 0.314 documentation</title>
     9    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     10    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
     11    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
     12    <script src="../_static/jquery.js"></script>
     13    <script src="../_static/underscore.js"></script>
     14    <script src="../_static/doctools.js"></script>
    1715    <link rel="index" title="Index" href="../genindex.html" />
    1816    <link rel="search" title="Search" href="../search.html" />
    1917   
    2018  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
     19 
    2120 
    2221  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
    … …  
    2827      <div class="documentwrapper">
    2928        <div class="bodywrapper">
     29         
     30
    3031          <div class="body" role="main">
    3132           
    3233  <h1>All modules for which code is available</h1>
    33 <ul><li><a href="PDW.html">PDW</a></li>
     34<ul><li><a href="ammosreader/AmmosAudioDataHeader.html">ammosreader.AmmosAudioDataHeader</a></li>
     35<li><a href="ammosreader/AmmosAudioReader.html">ammosreader.AmmosAudioReader</a></li>
     36<li><a href="ammosreader/AmmosAudioSocketReader.html">ammosreader.AmmosAudioSocketReader</a></li>
     37<li><a href="ammosreader/AmmosContainer.html">ammosreader.AmmosContainer</a></li>
     38<li><a href="ammosreader/AmmosExtendedAudioDataHeader.html">ammosreader.AmmosExtendedAudioDataHeader</a></li>
     39<li><a href="ammosreader/AmmosExtendedIFDataHeader.html">ammosreader.AmmosExtendedIFDataHeader</a></li>
     40<li><a href="ammosreader/AmmosGlobalFrameBody.html">ammosreader.AmmosGlobalFrameBody</a></li>
     41<li><a href="ammosreader/AmmosGlobalFrameHeader.html">ammosreader.AmmosGlobalFrameHeader</a></li>
     42<li><a href="ammosreader/AmmosIFDataBlock.html">ammosreader.AmmosIFDataBlock</a></li>
     43<li><a href="ammosreader/AmmosIFDataHeader.html">ammosreader.AmmosIFDataHeader</a></li>
     44<li><a href="ammosreader/AmmosIFReader.html">ammosreader.AmmosIFReader</a></li>
     45<li><a href="ammosreader/AmmosSingleFrame.html">ammosreader.AmmosSingleFrame</a></li>
     46<li><a href="ammosreader/PDW.html">ammosreader.PDW</a></li>
     47<li><a href="ammosreader/PPDWContainer.html">ammosreader.PPDWContainer</a></li>
    3448</ul>
    3549
    3650          </div>
     51         
    3752        </div>
    3853      </div>
    3954      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    4055        <div class="sphinxsidebarwrapper">
    41 <h1 class="logo"><a href="../index.html">RadarDex</a></h1>
     56<h1 class="logo"><a href="../index.html">AmmosReader</a></h1>
    4257
    4358
    … …  
    5065<h3>Navigation</h3>
    5166<ul>
    52 <li class="toctree-l1"><a class="reference internal" href="../PDW.html">PDW module</a></li>
     67<li class="toctree-l1"><a class="reference internal" href="../ammosreader.html">ammosreader package</a></li>
    5368</ul>
    5469
    … …  
    6176</div>
    6277<div id="searchbox" style="display: none" role="search">
    63   <h3>Quick search</h3>
     78  <h3 id="searchlabel">Quick search</h3>
    6479    <div class="searchformwrapper">
    6580    <form class="search" action="../search.html" method="get">
    66       <input type="text" name="q" />
     81      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
    6782      <input type="submit" value="Go" />
    68       <input type="hidden" name="check_keywords" value="yes" />
    69       <input type="hidden" name="area" value="default" />
    7083    </form>
    7184    </div>
    7285</div>
    73 <script type="text/javascript">$('#searchbox').show(0);</script>
     86<script>$('#searchbox').show(0);</script>
     87
     88
     89
     90
     91
     92
     93
     94
    7495        </div>
    7596      </div>
    … …  
    7798    </div>
    7899    <div class="footer">
    79       &copy;2020, Enrico Schwass.
     100      &copy;2022, Enrico Schwass.
    80101     
    81102      |
    82       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.5</a>
    83       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
     103      Powered by <a href="http://sphinx-doc.org/">Sphinx 4.2.0</a>
     104      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
    84105     
    85106    </div>
Note: See TracChangeset for help on using the changeset viewer.