[1e781ba] | 1 |
|
---|
[ada37fa] | 2 | <!DOCTYPE html>
|
---|
[1e781ba] | 3 |
|
---|
[ada37fa] | 4 | <html>
|
---|
[1e781ba] | 5 | <head>
|
---|
[ada37fa] | 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 — 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>
|
---|
[1e781ba] | 16 | <link rel="index" title="Index" href="genindex.html" />
|
---|
| 17 | <link rel="search" title="Search" href="search.html" />
|
---|
| 18 |
|
---|
| 19 | <link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
---|
| 20 |
|
---|
[ada37fa] | 21 |
|
---|
[1e781ba] | 22 | <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
---|
| 23 |
|
---|
| 24 | </head><body>
|
---|
| 25 |
|
---|
| 26 |
|
---|
| 27 | <div class="document">
|
---|
| 28 | <div class="documentwrapper">
|
---|
| 29 | <div class="bodywrapper">
|
---|
[ada37fa] | 30 |
|
---|
| 31 |
|
---|
[1e781ba] | 32 | <div class="body" role="main">
|
---|
| 33 |
|
---|
[ada37fa] | 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>
|
---|
[1e781ba] | 39 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
[ada37fa] | 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>
|
---|
[1e781ba] | 67 | </ul>
|
---|
[ada37fa] | 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>
|
---|
[1e781ba] | 76 | </dd></dl>
|
---|
| 77 |
|
---|
[ada37fa] | 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>
|
---|
[1e781ba] | 81 | <dd><p>I create an instance of class PDW from data body (8 * 32 bits)</p>
|
---|
[ada37fa] | 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>
|
---|
[1e781ba] | 93 | </dd></dl>
|
---|
| 94 |
|
---|
| 95 | </dd></dl>
|
---|
| 96 |
|
---|
[ada37fa] | 97 | </section>
|
---|
[1e781ba] | 98 |
|
---|
| 99 |
|
---|
| 100 | </div>
|
---|
[ada37fa] | 101 |
|
---|
[1e781ba] | 102 | </div>
|
---|
| 103 | </div>
|
---|
| 104 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
---|
| 105 | <div class="sphinxsidebarwrapper">
|
---|
[ada37fa] | 106 | <h1 class="logo"><a href="index.html">AmmosReader</a></h1>
|
---|
[1e781ba] | 107 |
|
---|
| 108 |
|
---|
| 109 |
|
---|
| 110 |
|
---|
| 111 |
|
---|
| 112 |
|
---|
| 113 |
|
---|
| 114 |
|
---|
| 115 | <h3>Navigation</h3>
|
---|
[ada37fa] | 116 | <ul>
|
---|
| 117 | <li class="toctree-l1"><a class="reference internal" href="ammosreader.html">ammosreader package</a></li>
|
---|
[1e781ba] | 118 | </ul>
|
---|
| 119 |
|
---|
| 120 | <div class="relations">
|
---|
| 121 | <h3>Related Topics</h3>
|
---|
| 122 | <ul>
|
---|
| 123 | <li><a href="index.html">Documentation overview</a><ul>
|
---|
| 124 | </ul></li>
|
---|
| 125 | </ul>
|
---|
| 126 | </div>
|
---|
| 127 | <div id="searchbox" style="display: none" role="search">
|
---|
[ada37fa] | 128 | <h3 id="searchlabel">Quick search</h3>
|
---|
[1e781ba] | 129 | <div class="searchformwrapper">
|
---|
| 130 | <form class="search" action="search.html" method="get">
|
---|
[ada37fa] | 131 | <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
---|
[1e781ba] | 132 | <input type="submit" value="Go" />
|
---|
| 133 | </form>
|
---|
| 134 | </div>
|
---|
| 135 | </div>
|
---|
[ada37fa] | 136 | <script>$('#searchbox').show(0);</script>
|
---|
| 137 |
|
---|
| 138 |
|
---|
| 139 |
|
---|
| 140 |
|
---|
| 141 |
|
---|
| 142 |
|
---|
| 143 |
|
---|
| 144 |
|
---|
[1e781ba] | 145 | </div>
|
---|
| 146 | </div>
|
---|
| 147 | <div class="clearer"></div>
|
---|
| 148 | </div>
|
---|
| 149 | <div class="footer">
|
---|
[ada37fa] | 150 | ©2022, Enrico Schwass.
|
---|
[1e781ba] | 151 |
|
---|
| 152 | |
|
---|
[ada37fa] | 153 | Powered by <a href="http://sphinx-doc.org/">Sphinx 4.2.0</a>
|
---|
| 154 | & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
---|
[1e781ba] | 155 |
|
---|
| 156 | |
|
---|
| 157 | <a href="_sources/PDW.rst.txt"
|
---|
| 158 | rel="nofollow">Page source</a>
|
---|
| 159 | </div>
|
---|
| 160 |
|
---|
| 161 |
|
---|
| 162 |
|
---|
| 163 |
|
---|
| 164 | </body>
|
---|
| 165 | </html> |
---|