Changes in doc/html/PDW.html [ada37fa:5547430] in ammosreader
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/html/PDW.html
rada37fa r5547430 1 2 <!DOCTYPE html>1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3 3 4 4 <html> … … 9 9 <title>PDW module — AmmosReader 0.314 documentation</title> 10 10 <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> 11 <link rel="stylesheet" type="text/css" href="_static/ alabaster.css" />11 <link rel="stylesheet" type="text/css" href="_static/css/adctheme.css" /> 12 12 <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> 13 13 <script src="_static/jquery.js"></script> 14 14 <script src="_static/underscore.js"></script> 15 15 <script src="_static/doctools.js"></script> 16 <meta name="generator" content="Sphinx/ADC Theme by Mirounga www.mirounga.fr"/> 16 17 <link rel="index" title="Index" href="genindex.html" /> 17 18 <link rel="search" title="Search" href="search.html" /> 18 19 <link rel="stylesheet" href="_static/custom.css" type="text/css" /> 20 21 22 <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> 19 <link rel="top" title="AmmosReader 0.314 documentation" href="index.html" /> 20 <link media="only screen and (max-device-width: 480px)" href="_static/css/mobile.css" type="text/css" rel="stylesheet" /> 21 </head><body> 22 <div id="docstitle"> 23 <p>AmmosReader 0.314 documentation</p> 24 </div> 25 <div id="header"> 26 <div id="title"><h1>PDW module</h1></div> 27 <ul id="headerButtons"> 28 <li id="toc_button"><div class="headerButton"><a href="#">Table of Contents</a></div></li> 29 <li id="page_buttons"> 30 <div class="headerButton"><a href="genindex.html" title="General Index" accesskey="I">index</a></div> 31 </li> 32 </ul> 33 </div> 23 34 24 </head><body> 25 35 <div id="sphinxsidebar"> 36 <div class="sphinxsidebarwrapper"> 37 <ul><li class="toctree-l1"><a href="index.html">Main Page</a></li></ul> 38 <ul> 39 <li class="toctree-l1"><a class="reference internal" href="ammosreader.html">ammosreader package</a></li> 40 </ul> 41 42 <h3>This Page</h3> 43 <ul class="this-page-menu"> 44 <li><a href="_sources/PDW.rst.txt" 45 rel="nofollow">Show Source</a></li> 46 </ul> 47 <div id="searchbox" style="display: none"> 48 <form class="search" action="search.html" method="get"> 49 <div class="search-wrapper"> 50 <input type="submit" value="" class="search-left"/> 51 <input class="prettysearch" type="text" name="q" size="18" title="Enter search terms or a module, class or function name."/> 52 <span class="search-right"> </span> 53 </div> 54 <input type="hidden" name="check_keywords" value="yes" /> 55 <input type="hidden" name="area" value="default" /> 56 </form> 57 </div> 58 <script type="text/javascript">$('#searchbox').show(0);</script> 59 </div> 60 </div> 61 62 26 63 27 64 <div class="document"> 28 65 <div class="documentwrapper"> 29 66 <div class="bodywrapper"> 30 31 32 <div class="body" role="main"> 67 <div class="body"> 33 68 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> 39 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> 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> 67 </ul> 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> 76 </dd></dl> 77 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> 81 <dd><p>I create an instance of class PDW from data body (8 * 32 bits)</p> 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> 93 </dd></dl> 94 95 </dd></dl> 96 69 <section id="pdw-module"> 70 <h1>PDW module<a class="headerlink" href="#pdw-module" title="Permalink to this headline">¶</a></h1> 97 71 </section> 98 72 99 73 100 </div> 101 74 </div> 102 75 </div> 103 76 </div> 104 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> 105 <div class="sphinxsidebarwrapper"> 106 <h1 class="logo"><a href="index.html">AmmosReader</a></h1> 107 108 109 110 111 112 113 114 115 <h3>Navigation</h3> 116 <ul> 117 <li class="toctree-l1"><a class="reference internal" href="ammosreader.html">ammosreader package</a></li> 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"> 128 <h3 id="searchlabel">Quick search</h3> 129 <div class="searchformwrapper"> 130 <form class="search" action="search.html" method="get"> 131 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> 132 <input type="submit" value="Go" /> 133 </form> 77 <div class="footer"> 78 <p> 79 © Copyright 2022, KIDZg. 80 Created using <a href="http://www.sphinx-doc.org/">Sphinx</a> 4.4.0 <a href="https://github.com/mga-sphinx/sphinx_adc_theme">ADC Theme</a> . 81 (Revision ) 82 </p> 134 83 </div> 135 </div>136 <script>$('#searchbox').show(0);</script>137 138 139 140 141 142 143 144 145 </div>146 </div>147 84 <div class="clearer"></div> 148 85 </div> 149 <div class="footer"> 150 ©2022, Enrico Schwass. 151 152 | 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> 155 156 | 157 <a href="_sources/PDW.rst.txt" 158 rel="nofollow">Page source</a> 159 </div> 160 161 162 163 86 <div id="breadcrumbs"> 87 PDW module 88 </div> 89 <script type="text/javascript" charset="utf-8" src="_static/js/toc.js"></script> 164 90 </body> 165 91 </html>
Note:
See TracChangeset
for help on using the changeset viewer.