![(please configure the [header_logo] section in trac.ini)](/playground/chrome/site/playground.png)
Changeset 5547430 in ammosreader for doc/html/ammosreader.html
- Timestamp:
- 05/04/22 16:12:24 (3 years ago)
- Branches:
- AmmosSource, guix
- Children:
- 1b72462
- Parents:
- f3421e6
- File:
-
- 1 edited
-
doc/html/ammosreader.html (modified) (19 diffs)
Legend:
- Unmodified
- Added
- Removed
-
doc/html/ammosreader.html
rf3421e6 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>ammosreader package — 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" /> 19 <link rel="top" title="AmmosReader 0.314 documentation" href="index.html" /> 18 20 <link rel="prev" title="ammosreader" href="index.html" /> 19 20 <link rel="stylesheet" href="_static/custom.css" type="text/css" /> 21 22 23 <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> 24 21 <link media="only screen and (max-device-width: 480px)" href="_static/css/mobile.css" type="text/css" rel="stylesheet" /> 25 22 </head><body> 26 23 <div id="docstitle"> 24 <p>AmmosReader 0.314 documentation</p> 25 </div> 26 <div id="header"> 27 <div id="title"><h1>ammosreader package</h1></div> 28 <ul id="headerButtons"> 29 <li id="toc_button"><div class="headerButton"><a href="#">Table of Contents</a></div></li> 30 <li id="page_buttons"> 31 <div class="headerButton"><a href="genindex.html" title="General Index" accesskey="I">index</a></div> 32 <div class="headerButton"><a href="py-modindex.html" title="Python Module Index" >modules</a></div> 33 <div class="headerButton"><a href="index.html" title="ammosreader" accesskey="P">previous</a></div> 34 </li> 35 </ul> 36 </div> 37 38 <div id="sphinxsidebar"> 39 <div class="sphinxsidebarwrapper"> 40 <ul><li class="toctree-l1"><a href="index.html">Main Page</a></li></ul> 41 <ul class="current"> 42 <li class="toctree-l1 current"><a class="current reference internal" href="#">ammosreader package</a><ul> 43 <li class="toctree-l2"><a class="reference internal" href="#submodules">Submodules</a></li> 44 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosAudioDataHeader">ammosreader.AmmosAudioDataHeader module</a></li> 45 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosAudioReader">ammosreader.AmmosAudioReader module</a></li> 46 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosAudioSocketReader">ammosreader.AmmosAudioSocketReader module</a></li> 47 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosContainer">ammosreader.AmmosContainer module</a></li> 48 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosExtendedAudioDataHeader">ammosreader.AmmosExtendedAudioDataHeader module</a></li> 49 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosExtendedIFDataHeader">ammosreader.AmmosExtendedIFDataHeader module</a></li> 50 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosGlobalFrameBody">ammosreader.AmmosGlobalFrameBody module</a></li> 51 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosGlobalFrameHeader">ammosreader.AmmosGlobalFrameHeader module</a></li> 52 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosIFDataBlock">ammosreader.AmmosIFDataBlock module</a></li> 53 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosIFDataHeader">ammosreader.AmmosIFDataHeader module</a></li> 54 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosIFReader">ammosreader.AmmosIFReader module</a></li> 55 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosSingleFrame">ammosreader.AmmosSingleFrame module</a></li> 56 <li class="toctree-l2"><a class="reference internal" href="#ammosreader-iqdwtxblock-module">ammosreader.IQDWTXBlock module</a></li> 57 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.PDW">ammosreader.PDW module</a></li> 58 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.PPDWContainer">ammosreader.PPDWContainer module</a></li> 59 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader">Module contents</a></li> 60 </ul> 61 </li> 62 </ul> 63 64 <h3>This Page</h3> 65 <ul class="this-page-menu"> 66 <li><a href="_sources/ammosreader.rst.txt" 67 rel="nofollow">Show Source</a></li> 68 </ul> 69 <div id="searchbox" style="display: none"> 70 <form class="search" action="search.html" method="get"> 71 <div class="search-wrapper"> 72 <input type="submit" value="" class="search-left"/> 73 <input class="prettysearch" type="text" name="q" size="18" title="Enter search terms or a module, class or function name."/> 74 <span class="search-right"> </span> 75 </div> 76 <input type="hidden" name="check_keywords" value="yes" /> 77 <input type="hidden" name="area" value="default" /> 78 </form> 79 </div> 80 <script type="text/javascript">$('#searchbox').show(0);</script> 81 </div> 82 </div> 83 84 27 85 28 86 <div class="document"> 29 87 <div class="documentwrapper"> 30 88 <div class="bodywrapper"> 31 32 33 <div class="body" role="main"> 89 <div class="body"> 34 90 35 91 <section id="ammosreader-package"> … … 42 98 <dl class="py class"> 43 99 <dt class="sig sig-object py" id="ammosreader.AmmosAudioDataHeader.AmmosAudioDataHeader"> 44 <em class="property"><span class="pre">class</span> 100 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ammosreader.AmmosAudioDataHeader.</span></span><span class="sig-name descname"><span class="pre">AmmosAudioDataHeader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frequency</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">demod_bandwidth</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">demod_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_size</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosAudioDataHeader.html#AmmosAudioDataHeader"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioDataHeader.AmmosAudioDataHeader" title="Permalink to this definition">¶</a></dt> 45 101 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> 46 102 <dl class="py method"> 47 103 <dt class="sig sig-object py" id="ammosreader.AmmosAudioDataHeader.AmmosAudioDataHeader.from_bytes"> 48 <em class="property"><span class="pre">classmethod</span> 104 <em class="property"><span class="pre">classmethod</span><span class="w"> </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">bytes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosAudioDataHeader.html#AmmosAudioDataHeader.from_bytes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioDataHeader.AmmosAudioDataHeader.from_bytes" title="Permalink to this definition">¶</a></dt> 49 105 <dd></dd></dl> 50 106 … … 53 109 <dl class="py class"> 54 110 <dt class="sig sig-object py" id="ammosreader.AmmosAudioDataHeader.AmmosAudioDemodType"> 55 <em class="property"><span class="pre">class</span> 111 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ammosreader.AmmosAudioDataHeader.</span></span><span class="sig-name descname"><span class="pre">AmmosAudioDemodType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">demod_type</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosAudioDataHeader.html#AmmosAudioDemodType"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioDataHeader.AmmosAudioDemodType" title="Permalink to this definition">¶</a></dt> 56 112 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> 57 113 <dl class="py property"> 58 114 <dt class="sig sig-object py" id="ammosreader.AmmosAudioDataHeader.AmmosAudioDemodType.mapping"> 59 <em class="property"><span class="pre">class</span> <span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">mapping</span></span><a class="headerlink" href="#ammosreader.AmmosAudioDataHeader.AmmosAudioDemodType.mapping" title="Permalink to this definition">¶</a></dt> 60 <dd></dd></dl> 115 <em class="property"><span class="pre">class</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">mapping</span></span><a class="headerlink" href="#ammosreader.AmmosAudioDataHeader.AmmosAudioDemodType.mapping" title="Permalink to this definition">¶</a></dt> 116 <dd><p>dict() -> new empty dictionary 117 dict(mapping) -> new dictionary initialized from a mapping object’s</p> 118 <blockquote> 119 <div><p>(key, value) pairs</p> 120 </div></blockquote> 121 <dl> 122 <dt>dict(iterable) -> new dictionary initialized as if via:</dt><dd><p>d = {} 123 for k, v in iterable:</p> 124 <blockquote> 125 <div><p>d[k] = v</p> 126 </div></blockquote> 127 </dd> 128 <dt>dict(<a href="#id1"><span class="problematic" id="id2">**</span></a>kwargs) -> new dictionary initialized with the name=value pairs</dt><dd><p>in the keyword argument list. For example: dict(one=1, two=2)</p> 129 </dd> 130 </dl> 131 </dd></dl> 61 132 62 133 </dd></dl> … … 68 139 <dl class="py class"> 69 140 <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader"> 70 <em class="property"><span class="pre">class</span> 141 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ammosreader.AmmosAudioReader.</span></span><span class="sig-name descname"><span class="pre">AmmosAudioReader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosAudioReader.html#AmmosAudioReader"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader" title="Permalink to this definition">¶</a></dt> 71 142 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> 72 143 <p>I read the audio data embedded in an R&S AMMOS recording.</p> 73 144 <dl class="py attribute"> 74 145 <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.EXTENDED_AUDIO_DATA_HEADER_SIZE"> 75 <span class="sig-name descname"><span class="pre">EXTENDED_AUDIO_DATA_HEADER_SIZE</span></span><em class="property"> <span class="pre">=</span><span class="pre">44</span></em><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader.EXTENDED_AUDIO_DATA_HEADER_SIZE" title="Permalink to this definition">¶</a></dt>146 <span class="sig-name descname"><span class="pre">EXTENDED_AUDIO_DATA_HEADER_SIZE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">44</span></em><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader.EXTENDED_AUDIO_DATA_HEADER_SIZE" title="Permalink to this definition">¶</a></dt> 76 147 <dd></dd></dl> 77 148 78 149 <dl class="py attribute"> 79 150 <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.GLOBAL_HEADER_SIZE"> 80 <span class="sig-name descname"><span class="pre">GLOBAL_HEADER_SIZE</span></span><em class="property"> <span class="pre">=</span><span class="pre">24</span></em><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader.GLOBAL_HEADER_SIZE" title="Permalink to this definition">¶</a></dt>151 <span class="sig-name descname"><span class="pre">GLOBAL_HEADER_SIZE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">24</span></em><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader.GLOBAL_HEADER_SIZE" title="Permalink to this definition">¶</a></dt> 81 152 <dd></dd></dl> 82 153 83 154 <dl class="py attribute"> 84 155 <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.STANDARD_AUDIO_DATA_HEADER_SIZE"> 85 <span class="sig-name descname"><span class="pre">STANDARD_AUDIO_DATA_HEADER_SIZE</span></span><em class="property"> <span class="pre">=</span><span class="pre">36</span></em><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader.STANDARD_AUDIO_DATA_HEADER_SIZE" title="Permalink to this definition">¶</a></dt>156 <span class="sig-name descname"><span class="pre">STANDARD_AUDIO_DATA_HEADER_SIZE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">36</span></em><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader.STANDARD_AUDIO_DATA_HEADER_SIZE" title="Permalink to this definition">¶</a></dt> 86 157 <dd></dd></dl> 87 158 … … 200 271 <dl class="py class"> 201 272 <dt class="sig sig-object py" id="ammosreader.AmmosAudioSocketReader.AmmosAudioSocketReader"> 202 <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">ammosreader.AmmosAudioSocketReader.</span></span><span class="sig-name descname"><span class="pre">AmmosAudioSocketReader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">socket</span></span><span class="p"><span class="pre">:</span></span><span class="n"><span class="pre">socket.socket</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosAudioSocketReader.html#AmmosAudioSocketReader"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioSocketReader.AmmosAudioSocketReader" title="Permalink to this definition">¶</a></dt>273 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ammosreader.AmmosAudioSocketReader.</span></span><span class="sig-name descname"><span class="pre">AmmosAudioSocketReader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">socket</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">socket.socket</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosAudioSocketReader.html#AmmosAudioSocketReader"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioSocketReader.AmmosAudioSocketReader" title="Permalink to this definition">¶</a></dt> 203 274 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> 204 275 <dl class="py method"> 205 276 <dt class="sig sig-object py" id="ammosreader.AmmosAudioSocketReader.AmmosAudioSocketReader.read_next_frame"> 206 <span class="sig-name descname"><span class="pre">read_next_frame</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">bytearray</span><span class="p"><span class="pre">,</span> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/ammosreader/AmmosAudioSocketReader.html#AmmosAudioSocketReader.read_next_frame"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioSocketReader.AmmosAudioSocketReader.read_next_frame" title="Permalink to this definition">¶</a></dt>277 <span class="sig-name descname"><span class="pre">read_next_frame</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">bytearray</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/ammosreader/AmmosAudioSocketReader.html#AmmosAudioSocketReader.read_next_frame"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioSocketReader.AmmosAudioSocketReader.read_next_frame" title="Permalink to this definition">¶</a></dt> 207 278 <dd><p>reads the next ammos audio frame</p> 208 279 <dl class="simple"> … … 219 290 <dl class="py class"> 220 291 <dt class="sig sig-object py" id="ammosreader.AmmosContainer.AmmosContainer"> 221 <em class="property"><span class="pre">class</span> 292 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ammosreader.AmmosContainer.</span></span><span class="sig-name descname"><span class="pre">AmmosContainer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frames</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosContainer.html#AmmosContainer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosContainer.AmmosContainer" title="Permalink to this definition">¶</a></dt> 222 293 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> 223 294 <dl class="py method"> … … 248 319 <dl class="py class"> 249 320 <dt class="sig sig-object py" id="ammosreader.AmmosExtendedAudioDataHeader.AmmosExtendedAudioDataHeader"> 250 <em class="property"><span class="pre">class</span> 321 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ammosreader.AmmosExtendedAudioDataHeader.</span></span><span class="sig-name descname"><span class="pre">AmmosExtendedAudioDataHeader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frequency</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">demod_bandwidth</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">demod_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosExtendedAudioDataHeader.html#AmmosExtendedAudioDataHeader"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosExtendedAudioDataHeader.AmmosExtendedAudioDataHeader" title="Permalink to this definition">¶</a></dt> 251 322 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> 252 323 <dl class="py method"> 253 324 <dt class="sig sig-object py" id="ammosreader.AmmosExtendedAudioDataHeader.AmmosExtendedAudioDataHeader.from_bytes"> 254 <em class="property"><span class="pre">classmethod</span> 325 <em class="property"><span class="pre">classmethod</span><span class="w"> </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">bytes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosExtendedAudioDataHeader.html#AmmosExtendedAudioDataHeader.from_bytes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosExtendedAudioDataHeader.AmmosExtendedAudioDataHeader.from_bytes" title="Permalink to this definition">¶</a></dt> 255 326 <dd></dd></dl> 256 327 … … 262 333 <dl class="py class"> 263 334 <dt class="sig sig-object py" id="ammosreader.AmmosExtendedIFDataHeader.AmmosExtendedIFDataHeader"> 264 <em class="property"><span class="pre">class</span> 335 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ammosreader.AmmosExtendedIFDataHeader.</span></span><span class="sig-name descname"><span class="pre">AmmosExtendedIFDataHeader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">block_count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">block_length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source_state</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frequency</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bandwidth</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interpolation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decimation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">voltage_ref</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream_start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_counter</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">antenna_correction</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosExtendedIFDataHeader.html#AmmosExtendedIFDataHeader"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosExtendedIFDataHeader.AmmosExtendedIFDataHeader" title="Permalink to this definition">¶</a></dt> 265 336 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> 266 337 <dl class="py method"> 267 338 <dt class="sig sig-object py" id="ammosreader.AmmosExtendedIFDataHeader.AmmosExtendedIFDataHeader.from_bytes"> 268 <em class="property"><span class="pre">classmethod</span> 339 <em class="property"><span class="pre">classmethod</span><span class="w"> </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">bytes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosExtendedIFDataHeader.html#AmmosExtendedIFDataHeader.from_bytes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosExtendedIFDataHeader.AmmosExtendedIFDataHeader.from_bytes" title="Permalink to this definition">¶</a></dt> 269 340 <dd></dd></dl> 270 341 … … 276 347 <dl class="py class"> 277 348 <dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameBody.AmmosGlobalFrameBody"> 278 <em class="property"><span class="pre">class</span> 349 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ammosreader.AmmosGlobalFrameBody.</span></span><span class="sig-name descname"><span class="pre">AmmosGlobalFrameBody</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_header</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_body</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosGlobalFrameBody.html#AmmosGlobalFrameBody"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosGlobalFrameBody.AmmosGlobalFrameBody" title="Permalink to this definition">¶</a></dt> 279 350 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> 280 351 <dl class="py method"> … … 290 361 <dl class="py class"> 291 362 <dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader"> 292 <em class="property"><span class="pre">class</span> 363 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ammosreader.AmmosGlobalFrameHeader.</span></span><span class="sig-name descname"><span class="pre">AmmosGlobalFrameHeader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">magic_word</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frame_length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">running_frame_number</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frame_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_header_length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reserved</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosGlobalFrameHeader.html#AmmosGlobalFrameHeader"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader" title="Permalink to this definition">¶</a></dt> 293 364 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> 294 365 <dl class="py attribute"> 295 366 <dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader.MAGIC_WORD"> 296 <span class="sig-name descname"><span class="pre">MAGIC_WORD</span></span><em class="property"> <span class="pre">=</span><span class="pre">'726574fb'</span></em><a class="headerlink" href="#ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader.MAGIC_WORD" title="Permalink to this definition">¶</a></dt>367 <span class="sig-name descname"><span class="pre">MAGIC_WORD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'726574fb'</span></em><a class="headerlink" href="#ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader.MAGIC_WORD" title="Permalink to this definition">¶</a></dt> 297 368 <dd></dd></dl> 298 369 299 370 <dl class="py method"> 300 371 <dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader.from_bytes"> 301 <em class="property"><span class="pre">classmethod</span> 372 <em class="property"><span class="pre">classmethod</span><span class="w"> </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">bytes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosGlobalFrameHeader.html#AmmosGlobalFrameHeader.from_bytes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader.from_bytes" title="Permalink to this definition">¶</a></dt> 302 373 <dd></dd></dl> 303 374 … … 314 385 <dl class="py class"> 315 386 <dt class="sig sig-object py" id="ammosreader.AmmosIFDataBlock.AmmosIFDataBlock"> 316 <em class="property"><span class="pre">class</span> 387 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ammosreader.AmmosIFDataBlock.</span></span><span class="sig-name descname"><span class="pre">AmmosIFDataBlock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">if_datablock_header</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">if_data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosIFDataBlock.html#AmmosIFDataBlock"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosIFDataBlock.AmmosIFDataBlock" title="Permalink to this definition">¶</a></dt> 317 388 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> 318 389 </dd></dl> … … 323 394 <dl class="py class"> 324 395 <dt class="sig sig-object py" id="ammosreader.AmmosIFDataHeader.AmmosIFDataHeader"> 325 <em class="property"><span class="pre">class</span> 396 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ammosreader.AmmosIFDataHeader.</span></span><span class="sig-name descname"><span class="pre">AmmosIFDataHeader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">block_count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">block_length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source_state</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frequency</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bandwidth</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interpolation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decimation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">voltage_ref</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosIFDataHeader.html#AmmosIFDataHeader"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosIFDataHeader.AmmosIFDataHeader" title="Permalink to this definition">¶</a></dt> 326 397 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> 327 398 <dl class="py method"> 328 399 <dt class="sig sig-object py" id="ammosreader.AmmosIFDataHeader.AmmosIFDataHeader.from_bytes"> 329 <em class="property"><span class="pre">classmethod</span> 400 <em class="property"><span class="pre">classmethod</span><span class="w"> </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">bytes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosIFDataHeader.html#AmmosIFDataHeader.from_bytes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosIFDataHeader.AmmosIFDataHeader.from_bytes" title="Permalink to this definition">¶</a></dt> 330 401 <dd></dd></dl> 331 402 … … 342 413 <dl class="py class"> 343 414 <dt class="sig sig-object py" id="ammosreader.AmmosIFReader.AmmosIFReader"> 344 <em class="property"><span class="pre">class</span> 415 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ammosreader.AmmosIFReader.</span></span><span class="sig-name descname"><span class="pre">AmmosIFReader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosIFReader.html#AmmosIFReader"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosIFReader.AmmosIFReader" title="Permalink to this definition">¶</a></dt> 345 416 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> 346 417 <dl class="py method"> … … 396 467 <dl class="py class"> 397 468 <dt class="sig sig-object py" id="ammosreader.AmmosSingleFrame.AmmosSingleFrame"> 398 <em class="property"><span class="pre">class</span> 469 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ammosreader.AmmosSingleFrame.</span></span><span class="sig-name descname"><span class="pre">AmmosSingleFrame</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">global_frame_header</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">global_frame_body</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosSingleFrame.html#AmmosSingleFrame"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosSingleFrame.AmmosSingleFrame" title="Permalink to this definition">¶</a></dt> 399 470 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> 400 471 <dl class="py method"> … … 418 489 <dl class="py class"> 419 490 <dt class="sig sig-object py" id="ammosreader.PDW.PDW"> 420 <em class="property"><span class="pre">class</span> 491 <em class="property"><span class="pre">class</span><span class="w"> </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> 421 492 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> 422 493 <p>I store information from a single ppdw data block.</p> … … 460 531 <dl class="py method"> 461 532 <dt class="sig sig-object py" id="ammosreader.PDW.PDW.from_bytes"> 462 <em class="property"><span class="pre">classmethod</span> 533 <em class="property"><span class="pre">classmethod</span><span class="w"> </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> 463 534 <dd><p>I create an instance of class PDW from data body (8 * 32 bits)</p> 464 535 <dl class="field-list simple"> … … 482 553 <dl class="py class"> 483 554 <dt class="sig sig-object py" id="ammosreader.PPDWContainer.PPDWContainer"> 484 <em class="property"><span class="pre">class</span> 555 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ammosreader.PPDWContainer.</span></span><span class="sig-name descname"><span class="pre">PPDWContainer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">signals</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/PPDWContainer.html#PPDWContainer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.PPDWContainer.PPDWContainer" title="Permalink to this definition">¶</a></dt> 485 556 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> 486 557 <p>I store multiple signals imported from one or more .ppdw files</p> … … 499 570 500 571 501 </div> 502 572 </div> 503 573 </div> 504 574 </div> 505 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> 506 <div class="sphinxsidebarwrapper"> 507 <h1 class="logo"><a href="index.html">AmmosReader</a></h1> 508 509 510 511 512 513 514 515 516 <h3>Navigation</h3> 517 <ul class="current"> 518 <li class="toctree-l1 current"><a class="current reference internal" href="#">ammosreader package</a><ul> 519 <li class="toctree-l2"><a class="reference internal" href="#submodules">Submodules</a></li> 520 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosAudioDataHeader">ammosreader.AmmosAudioDataHeader module</a></li> 521 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosAudioReader">ammosreader.AmmosAudioReader module</a></li> 522 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosAudioSocketReader">ammosreader.AmmosAudioSocketReader module</a></li> 523 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosContainer">ammosreader.AmmosContainer module</a></li> 524 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosExtendedAudioDataHeader">ammosreader.AmmosExtendedAudioDataHeader module</a></li> 525 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosExtendedIFDataHeader">ammosreader.AmmosExtendedIFDataHeader module</a></li> 526 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosGlobalFrameBody">ammosreader.AmmosGlobalFrameBody module</a></li> 527 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosGlobalFrameHeader">ammosreader.AmmosGlobalFrameHeader module</a></li> 528 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosIFDataBlock">ammosreader.AmmosIFDataBlock module</a></li> 529 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosIFDataHeader">ammosreader.AmmosIFDataHeader module</a></li> 530 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosIFReader">ammosreader.AmmosIFReader module</a></li> 531 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.AmmosSingleFrame">ammosreader.AmmosSingleFrame module</a></li> 532 <li class="toctree-l2"><a class="reference internal" href="#ammosreader-iqdwtxblock-module">ammosreader.IQDWTXBlock module</a></li> 533 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.PDW">ammosreader.PDW module</a></li> 534 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.PPDWContainer">ammosreader.PPDWContainer module</a></li> 535 <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader">Module contents</a></li> 536 </ul> 537 </li> 538 </ul> 539 540 <div class="relations"> 541 <h3>Related Topics</h3> 542 <ul> 543 <li><a href="index.html">Documentation overview</a><ul> 544 <li>Previous: <a href="index.html" title="previous chapter">ammosreader</a></li> 545 </ul></li> 546 </ul> 547 </div> 548 <div id="searchbox" style="display: none" role="search"> 549 <h3 id="searchlabel">Quick search</h3> 550 <div class="searchformwrapper"> 551 <form class="search" action="search.html" method="get"> 552 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> 553 <input type="submit" value="Go" /> 554 </form> 575 <div class="footer"> 576 <p> 577 © Copyright 2022, KIDZg. 578 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> . 579 (Revision ) 580 </p> 555 581 </div> 556 </div>557 <script>$('#searchbox').show(0);</script>558 559 560 561 562 563 564 565 566 </div>567 </div>568 582 <div class="clearer"></div> 569 583 </div> 570 <div class="footer"> 571 ©2022, Enrico Schwass. 572 573 | 574 Powered by <a href="http://sphinx-doc.org/">Sphinx 4.2.0</a> 575 & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> 576 577 | 578 <a href="_sources/ammosreader.rst.txt" 579 rel="nofollow">Page source</a> 580 </div> 581 582 583 584 584 <div id="breadcrumbs"> 585 ammosreader package 586 </div> 587 <script type="text/javascript" charset="utf-8" src="_static/js/toc.js"></script> 585 588 </body> 586 589 </html>
Note:
See TracChangeset
for help on using the changeset viewer.
