Changeset ada37fa in ammosreader for doc/html/PDW.html


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

File:
1 edited

Legend:

Unmodified
Added
Removed

  • doc/html/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">
     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>PDW module &#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" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
     8
     9    <title>PDW module &#8212; AmmosReader 0.314 documentation</title>
     10    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     11    <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     12    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
     13    <script src="_static/jquery.js"></script>
     14    <script src="_static/underscore.js"></script>
     15    <script src="_static/doctools.js"></script>
    1716    <link rel="index" title="Index" href="genindex.html" />
    1817    <link rel="search" title="Search" href="search.html" />
    19     <link rel="prev" title="radardex" href="index.html" />
    2018   
    2119  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
     20 
    2221 
    2322  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
    … …  
    2928      <div class="documentwrapper">
    3029        <div class="bodywrapper">
     30         
     31
    3132          <div class="body" role="main">
    3233           
    33   <div class="section" id="module-PDW">
    34 <span id="pdw-module"></span><h1>PDW module<a class="headerlink" href="#module-PDW" title="Permalink to this headline">¶</a></h1>
    35 <dl class="class">
    36 <dt id="PDW.PDW">
    37 <em class="property">class </em><code class="descclassname">PDW.</code><code class="descname">PDW</code><span class="sig-paren">(</span><em>time_of_arrival</em>, <em>pdw_format_identifier</em>, <em>center_frequency</em>, <em>is_valid</em>, <em>is_pulse</em>, <em>level_unit</em>, <em>signal_start_missing</em>, <em>signal_end_missing</em>, <em>pulse_width</em>, <em>frequency_shift_or_bandwidth</em>, <em>pulse_level_or_pulse_field_strength</em>, <em>region_of_interest</em>, <em>azimuth_confidence</em>, <em>modulation</em>, <em>sector</em>, <em>polarity</em>, <em>df_quality</em>, <em>elevation</em>, <em>azimuth</em>, <em>channel</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/PDW.html#PDW"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#PDW.PDW" title="Permalink to this definition">¶</a></dt>
     34  <section id="module-ammosreader.PDW">
     35<span id="pdw-module"></span><h1>PDW module<a class="headerlink" href="#module-ammosreader.PDW" title="Permalink to this headline">¶</a></h1>
     36<dl class="py class">
     37<dt class="sig sig-object py" id="ammosreader.PDW.PDW">
     38<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">ammosreader.PDW.</span></span><span class="sig-name descname"><span class="pre">PDW</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time_of_arrival</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pdw_format_identifier</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">center_frequency</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_valid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_pulse</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level_unit</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signal_start_missing</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signal_end_missing</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pulse_width</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frequency_shift_or_bandwidth</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pulse_level_or_pulse_field_strength</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">region_of_interest</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">azimuth_confidence</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">modulation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sector</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">polarity</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">df_quality</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">elevation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">azimuth</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/PDW.html#PDW"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.PDW.PDW" title="Permalink to this definition">¶</a></dt>
    3839<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
    39 <p>I store information from a single ppdw data block</p>
    40 <dl class="method">
    41 <dt id="PDW.PDW.__init__">
    42 <code class="descname">__init__</code><span class="sig-paren">(</span><em>time_of_arrival</em>, <em>pdw_format_identifier</em>, <em>center_frequency</em>, <em>is_valid</em>, <em>is_pulse</em>, <em>level_unit</em>, <em>signal_start_missing</em>, <em>signal_end_missing</em>, <em>pulse_width</em>, <em>frequency_shift_or_bandwidth</em>, <em>pulse_level_or_pulse_field_strength</em>, <em>region_of_interest</em>, <em>azimuth_confidence</em>, <em>modulation</em>, <em>sector</em>, <em>polarity</em>, <em>df_quality</em>, <em>elevation</em>, <em>azimuth</em>, <em>channel</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/PDW.html#PDW.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#PDW.PDW.__init__" title="Permalink to this definition">¶</a></dt>
    43 <dd><table class="docutils field-list" frame="void" rules="none">
    44 <col class="field-name" />
    45 <col class="field-body" />
    46 <tbody valign="top">
    47 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    48 <li><strong>time_of_arrival</strong> (<em>Integer</em>) – nanoseconds since 1970-01-01 00:00:00</li>
    49 <li><strong>pdw_format</strong> (<em>Integer</em>) – format code</li>
    50 <li><strong>center_frequency</strong> (<em>Integer</em>) – center frequency in KHz</li>
    51 <li><strong>is_valid</strong> (<em>Boolean</em>) – flag to mark if pdw data body is valid</li>
    52 <li><strong>is_pulse</strong> (<em>Boolean</em>) – flag to mark if pdw data body contains a pulse or a continuous wave signal</li>
    53 <li><strong>level_unit</strong> (<em>Integer</em>) – 0 means dBµV - 1 means dBµV/m</li>
    54 <li><strong>signal_start_missing</strong> (<em>Boolean</em>) – signal started before time of arrival</li>
    55 <li><strong>signal_end_missing</strong> (<em>Boolean</em>) – signal stops after time of arrival</li>
    56 <li><strong>pulse_width</strong> (<em>Integer</em>) – pulse width in nanoseconds - Zero if no valid pulse detected</li>
    57 <li><strong>frequency_shift_or_bandwidth</strong> (<em>Integer</em>) – Value in KHz - Value set to 1048575 means Unknown</li>
    58 <li><strong>pulse_level_or_pulse_field_strength</strong> (<em>Float</em>) – Pulse level or Pulse Field Strength depending on level_unit          (-200.0…200.0) in 0.1 steps / minus 204.8 means no valid level detected</li>
    59 <li><strong>region_of_interest</strong> (<em>Boolean</em>) – Marks if signal is from region of interest</li>
    60 <li><strong>azimuth_confidence</strong> (<em>Float</em>) – degree in steps of 0.1 (0.0-6.2) / 6.3 means confidence unknown</li>
    61 <li><strong>modulation</strong> (<em>String</em>) – type of modulation (e.g. PSK-2, PSK-4, FM etc.)</li>
    62 <li><strong>sector</strong> (<em>Integer</em>) – reference antenna sector (0-15)</li>
    63 <li><strong>polarity</strong> (<em>String</em>) – Horizontal, Vertical, Clockwise, Counter clockwise</li>
    64 <li><strong>df_quality</strong> (<em>Integer</em>) – Direction finding quality in percent (0-100) - Zero means unknown</li>
    65 <li><strong>elevation</strong> (<em>Float</em>) – elevation of incoming signal (from -90 to 90 degree) in steps of 0.1 degree         minus 102.4 means unknown</li>
    66 <li><strong>azimuth</strong> (<em>Float</em>) – azimuth of incoming signal (from 0 to 359.9 degree) in steps of 0.1 degree         plus 409.5 means unknown</li>
    67 <li><strong>channel</strong> (<em>Integer</em>) – detecting channel (0-16) - Zero means unknown</li>
     40<p>I store information from a single ppdw data block.</p>
     41<dl class="py method">
     42<dt class="sig sig-object py" id="ammosreader.PDW.PDW.__init__">
     43<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time_of_arrival</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pdw_format_identifier</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">center_frequency</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_valid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_pulse</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level_unit</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signal_start_missing</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signal_end_missing</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pulse_width</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frequency_shift_or_bandwidth</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pulse_level_or_pulse_field_strength</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">region_of_interest</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">azimuth_confidence</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">modulation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sector</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">polarity</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">df_quality</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">elevation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">azimuth</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/PDW.html#PDW.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.PDW.PDW.__init__" title="Permalink to this definition">¶</a></dt>
     44<dd><dl class="field-list simple">
     45<dt class="field-odd">Parameters</dt>
     46<dd class="field-odd"><ul class="simple">
     47<li><p><strong>time_of_arrival</strong> (<em>Integer</em>) – nanoseconds since 1970-01-01 00:00:00</p></li>
     48<li><p><strong>pdw_format</strong> (<em>Integer</em>) – format code</p></li>
     49<li><p><strong>center_frequency</strong> (<em>Integer</em>) – center frequency in KHz</p></li>
     50<li><p><strong>is_valid</strong> (<em>Boolean</em>) – flag to mark if pdw data body is valid</p></li>
     51<li><p><strong>is_pulse</strong> (<em>Boolean</em>) – flag to mark if pdw data body contains a pulse or a continuous wave signal</p></li>
     52<li><p><strong>level_unit</strong> (<em>Integer</em>) – 0 means dBµV - 1 means dBµV/m</p></li>
     53<li><p><strong>signal_start_missing</strong> (<em>Boolean</em>) – signal started before time of arrival</p></li>
     54<li><p><strong>signal_end_missing</strong> (<em>Boolean</em>) – signal stops after time of arrival</p></li>
     55<li><p><strong>pulse_width</strong> (<em>Integer</em>) – pulse width in nanoseconds - Zero if no valid pulse detected</p></li>
     56<li><p><strong>frequency_shift_or_bandwidth</strong> (<em>Integer</em>) – Value in KHz - Value set to 1048575 means Unknown</p></li>
     57<li><p><strong>pulse_level_or_pulse_field_strength</strong> (<em>Float</em>) – Pulse level or Pulse Field Strength depending on level_unit          (-200.0…200.0) in 0.1 steps / minus 204.8 means no valid level detected</p></li>
     58<li><p><strong>region_of_interest</strong> (<em>Boolean</em>) – Marks if signal is from region of interest</p></li>
     59<li><p><strong>azimuth_confidence</strong> (<em>Float</em>) – degree in steps of 0.1 (0.0-6.2) / 6.3 means confidence unknown</p></li>
     60<li><p><strong>modulation</strong> (<em>String</em>) – type of modulation (e.g. PSK-2, PSK-4, FM etc.)</p></li>
     61<li><p><strong>sector</strong> (<em>Integer</em>) – reference antenna sector (0-15)</p></li>
     62<li><p><strong>polarity</strong> (<em>String</em>) – Horizontal, Vertical, Clockwise, Counter clockwise</p></li>
     63<li><p><strong>df_quality</strong> (<em>Integer</em>) – Direction finding quality in percent (0-100) - Zero means unknown</p></li>
     64<li><p><strong>elevation</strong> (<em>Float</em>) – elevation of incoming signal (from -90 to 90 degree) in steps of 0.1 degree         minus 102.4 means unknown</p></li>
     65<li><p><strong>azimuth</strong> (<em>Float</em>) – azimuth of incoming signal (from 0 to 359.9 degree) in steps of 0.1 degree         plus 409.5 means unknown</p></li>
     66<li><p><strong>channel</strong> (<em>Integer</em>) – detecting channel (0-16) - Zero means unknown</p></li>
    6867</ul>
    69 </td>
    70 </tr>
    71 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An instance of class PDW with attributes set according to the data of a data body</p>
    72 </td>
    73 </tr>
    74 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#PDW.PDW" title="PDW.PDW">PDW</a></p>
    75 </td>
    76 </tr>
    77 </tbody>
    78 </table>
     68</dd>
     69<dt class="field-even">Returns</dt>
     70<dd class="field-even"><p>An instance of class PDW with attributes set according to the data of a data body</p>
     71</dd>
     72<dt class="field-odd">Return type</dt>
     73<dd class="field-odd"><p><a class="reference internal" href="ammosreader.html#ammosreader.PDW.PDW" title="ammosreader.PDW.PDW">PDW</a></p>
     74</dd>
     75</dl>
    7976</dd></dl>
    8077
    81 <dl class="classmethod">
    82 <dt id="PDW.PDW.from_bytes">
    83 <em class="property">classmethod </em><code class="descname">from_bytes</code><span class="sig-paren">(</span><em>byte_string</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/PDW.html#PDW.from_bytes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#PDW.PDW.from_bytes" title="Permalink to this definition">¶</a></dt>
     78<dl class="py method">
     79<dt class="sig sig-object py" id="ammosreader.PDW.PDW.from_bytes">
     80<em class="property"><span class="pre">classmethod</span> </em><span class="sig-name descname"><span class="pre">from_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">byte_string</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/PDW.html#PDW.from_bytes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.PDW.PDW.from_bytes" title="Permalink to this definition">¶</a></dt>
    8481<dd><p>I create an instance of class PDW from data body (8 * 32 bits)</p>
    85 <table class="docutils field-list" frame="void" rules="none">
    86 <col class="field-name" />
    87 <col class="field-body" />
    88 <tbody valign="top">
    89 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>byte_string</strong> (<em>byte string</em>) – a byte string containing a single data body read from a ppdw file</td>
    90 </tr>
    91 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">an instance of class PDW with attributes set according to the data of a data body</td>
    92 </tr>
    93 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#PDW.PDW" title="PDW.PDW">PDW</a></td>
    94 </tr>
    95 </tbody>
    96 </table>
     82<dl class="field-list simple">
     83<dt class="field-odd">Parameters</dt>
     84<dd class="field-odd"><p><strong>byte_string</strong> (<em>byte string</em>) – a byte string containing a single data body read from a ppdw file</p>
     85</dd>
     86<dt class="field-even">Returns</dt>
     87<dd class="field-even"><p>an instance of class PDW with attributes set according to the data of a data body</p>
     88</dd>
     89<dt class="field-odd">Return type</dt>
     90<dd class="field-odd"><p><a class="reference internal" href="ammosreader.html#ammosreader.PDW.PDW" title="ammosreader.PDW.PDW">PDW</a></p>
     91</dd>
     92</dl>
    9793</dd></dl>
    9894
    9995</dd></dl>
    10096
    101 </div>
     97</section>
    10298
    10399
    104100          </div>
     101         
    105102        </div>
    106103      </div>
    107104      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    108105        <div class="sphinxsidebarwrapper">
    109 <h1 class="logo"><a href="index.html">RadarDex</a></h1>
     106<h1 class="logo"><a href="index.html">AmmosReader</a></h1>
    110107
    111108
    … …  
    117114
    118115<h3>Navigation</h3>
    119 <ul class="current">
    120 <li class="toctree-l1 current"><a class="current reference internal" href="#">PDW module</a></li>
     116<ul>
     117<li class="toctree-l1"><a class="reference internal" href="ammosreader.html">ammosreader package</a></li>
    121118</ul>
    122119
    … …  
    125122<ul>
    126123  <li><a href="index.html">Documentation overview</a><ul>
    127       <li>Previous: <a href="index.html" title="previous chapter">radardex</a></li>
    128124  </ul></li>
    129125</ul>
    130126</div>
    131127<div id="searchbox" style="display: none" role="search">
    132   <h3>Quick search</h3>
     128  <h3 id="searchlabel">Quick search</h3>
    133129    <div class="searchformwrapper">
    134130    <form class="search" action="search.html" method="get">
    135       <input type="text" name="q" />
     131      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
    136132      <input type="submit" value="Go" />
    137       <input type="hidden" name="check_keywords" value="yes" />
    138       <input type="hidden" name="area" value="default" />
    139133    </form>
    140134    </div>
    141135</div>
    142 <script type="text/javascript">$('#searchbox').show(0);</script>
     136<script>$('#searchbox').show(0);</script>
     137
     138
     139
     140
     141
     142
     143
     144
    143145        </div>
    144146      </div>
    … …  
    146148    </div>
    147149    <div class="footer">
    148       &copy;2020, Enrico Schwass.
     150      &copy;2022, Enrico Schwass.
    149151     
    150152      |
    151       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.5</a>
    152       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
     153      Powered by <a href="http://sphinx-doc.org/">Sphinx 4.2.0</a>
     154      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
    153155     
    154156      |
Note: See TracChangeset for help on using the changeset viewer.