[5547430] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
---|
| 2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
---|
[ada37fa] | 3 |
|
---|
| 4 | <html>
|
---|
| 5 | <head>
|
---|
| 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>ammosreader package — AmmosReader 0.314 documentation</title>
|
---|
| 10 | <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
---|
[5547430] | 11 | <link rel="stylesheet" type="text/css" href="_static/css/adctheme.css" />
|
---|
[ada37fa] | 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>
|
---|
[5547430] | 16 | <meta name="generator" content="Sphinx/ADC Theme by Mirounga www.mirounga.fr"/>
|
---|
[ada37fa] | 17 | <link rel="index" title="Index" href="genindex.html" />
|
---|
| 18 | <link rel="search" title="Search" href="search.html" />
|
---|
[5547430] | 19 | <link rel="top" title="AmmosReader 0.314 documentation" href="index.html" />
|
---|
[ada37fa] | 20 | <link rel="prev" title="ammosreader" href="index.html" />
|
---|
[5547430] | 21 | <link media="only screen and (max-device-width: 480px)" href="_static/css/mobile.css" type="text/css" rel="stylesheet" />
|
---|
[ada37fa] | 22 | </head><body>
|
---|
[5547430] | 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>
|
---|
[8413944] | 56 | <li class="toctree-l2"><a class="reference internal" href="#module-ammosreader.IQDWTXBlock">ammosreader.IQDWTXBlock module</a></li>
|
---|
[5547430] | 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 |
|
---|
[ada37fa] | 85 |
|
---|
| 86 | <div class="document">
|
---|
| 87 | <div class="documentwrapper">
|
---|
| 88 | <div class="bodywrapper">
|
---|
[5547430] | 89 | <div class="body">
|
---|
[ada37fa] | 90 |
|
---|
| 91 | <section id="ammosreader-package">
|
---|
| 92 | <h1>ammosreader package<a class="headerlink" href="#ammosreader-package" title="Permalink to this headline">¶</a></h1>
|
---|
| 93 | <section id="submodules">
|
---|
| 94 | <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
---|
| 95 | </section>
|
---|
| 96 | <section id="module-ammosreader.AmmosAudioDataHeader">
|
---|
| 97 | <span id="ammosreader-ammosaudiodataheader-module"></span><h2>ammosreader.AmmosAudioDataHeader module<a class="headerlink" href="#module-ammosreader.AmmosAudioDataHeader" title="Permalink to this headline">¶</a></h2>
|
---|
| 98 | <dl class="py class">
|
---|
| 99 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioDataHeader.AmmosAudioDataHeader">
|
---|
[5547430] | 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>
|
---|
[ada37fa] | 101 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
| 102 | <dl class="py method">
|
---|
| 103 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioDataHeader.AmmosAudioDataHeader.from_bytes">
|
---|
[5547430] | 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>
|
---|
[ada37fa] | 105 | <dd></dd></dl>
|
---|
| 106 |
|
---|
| 107 | </dd></dl>
|
---|
| 108 |
|
---|
| 109 | <dl class="py class">
|
---|
| 110 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioDataHeader.AmmosAudioDemodType">
|
---|
[5547430] | 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>
|
---|
[ada37fa] | 112 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
| 113 | <dl class="py property">
|
---|
| 114 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioDataHeader.AmmosAudioDemodType.mapping">
|
---|
[5547430] | 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>
|
---|
[ada37fa] | 132 |
|
---|
| 133 | </dd></dl>
|
---|
| 134 |
|
---|
| 135 | </section>
|
---|
| 136 | <section id="module-ammosreader.AmmosAudioReader">
|
---|
| 137 | <span id="ammosreader-ammosaudioreader-module"></span><h2>ammosreader.AmmosAudioReader module<a class="headerlink" href="#module-ammosreader.AmmosAudioReader" title="Permalink to this headline">¶</a></h2>
|
---|
| 138 | <p>I parse an R&S AMMOS recording.</p>
|
---|
| 139 | <dl class="py class">
|
---|
| 140 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader">
|
---|
[5547430] | 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>
|
---|
[ada37fa] | 142 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
| 143 | <p>I read the audio data embedded in an R&S AMMOS recording.</p>
|
---|
| 144 | <dl class="py attribute">
|
---|
| 145 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.EXTENDED_AUDIO_DATA_HEADER_SIZE">
|
---|
[5547430] | 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>
|
---|
[ada37fa] | 147 | <dd></dd></dl>
|
---|
| 148 |
|
---|
| 149 | <dl class="py attribute">
|
---|
| 150 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.GLOBAL_HEADER_SIZE">
|
---|
[5547430] | 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>
|
---|
[ada37fa] | 152 | <dd></dd></dl>
|
---|
| 153 |
|
---|
| 154 | <dl class="py attribute">
|
---|
| 155 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.STANDARD_AUDIO_DATA_HEADER_SIZE">
|
---|
[5547430] | 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>
|
---|
[ada37fa] | 157 | <dd></dd></dl>
|
---|
| 158 |
|
---|
| 159 | <dl class="py method">
|
---|
| 160 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.add_tag">
|
---|
| 161 | <span class="sig-name descname"><span class="pre">add_tag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosAudioReader.html#AmmosAudioReader.add_tag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader.add_tag" title="Permalink to this definition">¶</a></dt>
|
---|
| 162 | <dd><p>I add a tag to my tag list.</p>
|
---|
| 163 | <dl class="field-list simple">
|
---|
| 164 | <dt class="field-odd">Parameters</dt>
|
---|
| 165 | <dd class="field-odd"><p><strong>tag</strong> (<em>dict</em>) – The tag to add to my tag list</p>
|
---|
| 166 | </dd>
|
---|
| 167 | </dl>
|
---|
| 168 | </dd></dl>
|
---|
| 169 |
|
---|
| 170 | <dl class="py method">
|
---|
| 171 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.read_all_frames_left">
|
---|
| 172 | <span class="sig-name descname"><span class="pre">read_all_frames_left</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosAudioReader.html#AmmosAudioReader.read_all_frames_left"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader.read_all_frames_left" title="Permalink to this definition">¶</a></dt>
|
---|
| 173 | <dd><p>I read all remaining frames into my container until end of file is reached.</p>
|
---|
| 174 | <dl class="field-list simple">
|
---|
| 175 | <dt class="field-odd">Returns</dt>
|
---|
| 176 | <dd class="field-odd"><p>a container containing all frames read</p>
|
---|
| 177 | </dd>
|
---|
| 178 | <dt class="field-even">Return type</dt>
|
---|
| 179 | <dd class="field-even"><p><a class="reference internal" href="#ammosreader.AmmosContainer.AmmosContainer" title="ammosreader.AmmosContainer.AmmosContainer">AmmosContainer</a></p>
|
---|
| 180 | </dd>
|
---|
| 181 | </dl>
|
---|
| 182 | </dd></dl>
|
---|
| 183 |
|
---|
| 184 | <dl class="py method">
|
---|
| 185 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.read_next_audio_data_body">
|
---|
| 186 | <span class="sig-name descname"><span class="pre">read_next_audio_data_body</span></span><span class="sig-paren">(</span><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/AmmosAudioReader.html#AmmosAudioReader.read_next_audio_data_body"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader.read_next_audio_data_body" title="Permalink to this definition">¶</a></dt>
|
---|
| 187 | <dd><p>I return the next audio data read from current position in file.</p>
|
---|
| 188 | <dl class="field-list simple">
|
---|
| 189 | <dt class="field-odd">Parameters</dt>
|
---|
| 190 | <dd class="field-odd"><ul class="simple">
|
---|
| 191 | <li><p><strong>sample_count</strong> (<em>int</em>) – the number of samples per channel inside data body</p></li>
|
---|
| 192 | <li><p><strong>channel_count</strong> (<em>int</em>) – number of channels (e.g. mono, stereo or even more)</p></li>
|
---|
| 193 | <li><p><strong>sample_size</strong> (<em>int</em>) – sample size in bytes (1, 2 or 4 bytes)</p></li>
|
---|
| 194 | </ul>
|
---|
| 195 | </dd>
|
---|
| 196 | <dt class="field-even">Returns</dt>
|
---|
| 197 | <dd class="field-even"><p>the next audio data or None if incomplete</p>
|
---|
| 198 | </dd>
|
---|
| 199 | <dt class="field-odd">Return type</dt>
|
---|
| 200 | <dd class="field-odd"><p>bytes</p>
|
---|
| 201 | </dd>
|
---|
| 202 | </dl>
|
---|
| 203 | </dd></dl>
|
---|
| 204 |
|
---|
| 205 | <dl class="py method">
|
---|
| 206 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.read_next_global_frame_body">
|
---|
| 207 | <span class="sig-name descname"><span class="pre">read_next_global_frame_body</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">global_frame_header</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosAudioReader.html#AmmosAudioReader.read_next_global_frame_body"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader.read_next_global_frame_body" title="Permalink to this definition">¶</a></dt>
|
---|
| 208 | <dd></dd></dl>
|
---|
| 209 |
|
---|
| 210 | <dl class="py method">
|
---|
| 211 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.read_next_global_frame_body_data_header">
|
---|
| 212 | <span class="sig-name descname"><span class="pre">read_next_global_frame_body_data_header</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosAudioReader.html#AmmosAudioReader.read_next_global_frame_body_data_header"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader.read_next_global_frame_body_data_header" title="Permalink to this definition">¶</a></dt>
|
---|
| 213 | <dd><p>I return the next global frame body data header from current position in file.</p>
|
---|
| 214 | <dl class="field-list simple">
|
---|
| 215 | <dt class="field-odd">Parameters</dt>
|
---|
| 216 | <dd class="field-odd"><p><strong>data_header_size</strong> (<em>int</em>) – the number of bytes to read</p>
|
---|
| 217 | </dd>
|
---|
| 218 | <dt class="field-even">Returns</dt>
|
---|
| 219 | <dd class="field-even"><p>the next Ammos Audio Data header or None if incomplete</p>
|
---|
| 220 | </dd>
|
---|
| 221 | <dt class="field-odd">Return type</dt>
|
---|
| 222 | <dd class="field-odd"><p><a class="reference internal" href="#ammosreader.AmmosAudioDataHeader.AmmosAudioDataHeader" title="ammosreader.AmmosAudioDataHeader.AmmosAudioDataHeader">AmmosAudioDataHeader</a></p>
|
---|
| 223 | </dd>
|
---|
| 224 | </dl>
|
---|
| 225 | </dd></dl>
|
---|
| 226 |
|
---|
| 227 | <dl class="py method">
|
---|
| 228 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.read_next_global_frame_body_extended_data_header">
|
---|
| 229 | <span class="sig-name descname"><span class="pre">read_next_global_frame_body_extended_data_header</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosAudioReader.html#AmmosAudioReader.read_next_global_frame_body_extended_data_header"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader.read_next_global_frame_body_extended_data_header" title="Permalink to this definition">¶</a></dt>
|
---|
| 230 | <dd><p>I return the next global frame body extended data header from current position in file.</p>
|
---|
| 231 | <dl class="field-list simple">
|
---|
| 232 | <dt class="field-odd">Returns</dt>
|
---|
| 233 | <dd class="field-odd"><p>the next Ammos Audio Extended Data header or None if incomplete</p>
|
---|
| 234 | </dd>
|
---|
| 235 | <dt class="field-even">Return type</dt>
|
---|
| 236 | <dd class="field-even"><p><a class="reference internal" href="#ammosreader.AmmosExtendedAudioDataHeader.AmmosExtendedAudioDataHeader" title="ammosreader.AmmosExtendedAudioDataHeader.AmmosExtendedAudioDataHeader">AmmosExtendedAudioDataHeader</a></p>
|
---|
| 237 | </dd>
|
---|
| 238 | </dl>
|
---|
| 239 | </dd></dl>
|
---|
| 240 |
|
---|
| 241 | <dl class="py method">
|
---|
| 242 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.read_next_global_frame_header">
|
---|
| 243 | <span class="sig-name descname"><span class="pre">read_next_global_frame_header</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosAudioReader.html#AmmosAudioReader.read_next_global_frame_header"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader.read_next_global_frame_header" title="Permalink to this definition">¶</a></dt>
|
---|
| 244 | <dd><p>I return the next global frame header read from current position in file.</p>
|
---|
| 245 | <dl class="field-list simple">
|
---|
| 246 | <dt class="field-odd">Returns</dt>
|
---|
| 247 | <dd class="field-odd"><p>the next global frame header or None if incomplete</p>
|
---|
| 248 | </dd>
|
---|
| 249 | <dt class="field-even">Return type</dt>
|
---|
| 250 | <dd class="field-even"><p><a class="reference internal" href="#ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader" title="ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader">AmmosGlobalFrameHeader</a></p>
|
---|
| 251 | </dd>
|
---|
| 252 | </dl>
|
---|
| 253 | </dd></dl>
|
---|
| 254 |
|
---|
| 255 | <dl class="py method">
|
---|
| 256 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.read_next_single_frame">
|
---|
| 257 | <span class="sig-name descname"><span class="pre">read_next_single_frame</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosAudioReader.html#AmmosAudioReader.read_next_single_frame"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader.read_next_single_frame" title="Permalink to this definition">¶</a></dt>
|
---|
| 258 | <dd></dd></dl>
|
---|
| 259 |
|
---|
| 260 | <dl class="py method">
|
---|
| 261 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.rewind_to_start">
|
---|
| 262 | <span class="sig-name descname"><span class="pre">rewind_to_start</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosAudioReader.html#AmmosAudioReader.rewind_to_start"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader.rewind_to_start" title="Permalink to this definition">¶</a></dt>
|
---|
| 263 | <dd><p>I set the file pointer to the beginning of the file for the next operation.</p>
|
---|
| 264 | </dd></dl>
|
---|
| 265 |
|
---|
| 266 | </dd></dl>
|
---|
| 267 |
|
---|
| 268 | </section>
|
---|
| 269 | <section id="module-ammosreader.AmmosAudioSocketReader">
|
---|
| 270 | <span id="ammosreader-ammosaudiosocketreader-module"></span><h2>ammosreader.AmmosAudioSocketReader module<a class="headerlink" href="#module-ammosreader.AmmosAudioSocketReader" title="Permalink to this headline">¶</a></h2>
|
---|
| 271 | <dl class="py class">
|
---|
| 272 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioSocketReader.AmmosAudioSocketReader">
|
---|
[5547430] | 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>
|
---|
[ada37fa] | 274 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
| 275 | <dl class="py method">
|
---|
| 276 | <dt class="sig sig-object py" id="ammosreader.AmmosAudioSocketReader.AmmosAudioSocketReader.read_next_frame">
|
---|
[5547430] | 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>
|
---|
[ada37fa] | 278 | <dd><p>reads the next ammos audio frame</p>
|
---|
[8413944] | 279 | <dl class="field-list simple">
|
---|
| 280 | <dt class="field-odd">Returns</dt>
|
---|
| 281 | <dd class="field-odd"><p>contains the audio data and the sample rate</p>
|
---|
| 282 | </dd>
|
---|
| 283 | <dt class="field-even">Return type</dt>
|
---|
| 284 | <dd class="field-even"><p>tuple[bytearray, int]</p>
|
---|
[ada37fa] | 285 | </dd>
|
---|
| 286 | </dl>
|
---|
| 287 | </dd></dl>
|
---|
| 288 |
|
---|
| 289 | </dd></dl>
|
---|
| 290 |
|
---|
| 291 | </section>
|
---|
| 292 | <section id="module-ammosreader.AmmosContainer">
|
---|
| 293 | <span id="ammosreader-ammoscontainer-module"></span><h2>ammosreader.AmmosContainer module<a class="headerlink" href="#module-ammosreader.AmmosContainer" title="Permalink to this headline">¶</a></h2>
|
---|
| 294 | <dl class="py class">
|
---|
| 295 | <dt class="sig sig-object py" id="ammosreader.AmmosContainer.AmmosContainer">
|
---|
[5547430] | 296 | <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>
|
---|
[ada37fa] | 297 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
| 298 | <dl class="py method">
|
---|
| 299 | <dt class="sig sig-object py" id="ammosreader.AmmosContainer.AmmosContainer.add_frame">
|
---|
| 300 | <span class="sig-name descname"><span class="pre">add_frame</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">frame</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosContainer.html#AmmosContainer.add_frame"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosContainer.AmmosContainer.add_frame" title="Permalink to this definition">¶</a></dt>
|
---|
| 301 | <dd></dd></dl>
|
---|
| 302 |
|
---|
| 303 | <dl class="py method">
|
---|
| 304 | <dt class="sig sig-object py" id="ammosreader.AmmosContainer.AmmosContainer.add_tag">
|
---|
| 305 | <span class="sig-name descname"><span class="pre">add_tag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosContainer.html#AmmosContainer.add_tag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosContainer.AmmosContainer.add_tag" title="Permalink to this definition">¶</a></dt>
|
---|
| 306 | <dd></dd></dl>
|
---|
| 307 |
|
---|
| 308 | <dl class="py method">
|
---|
| 309 | <dt class="sig sig-object py" id="ammosreader.AmmosContainer.AmmosContainer.frequencies">
|
---|
| 310 | <span class="sig-name descname"><span class="pre">frequencies</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosContainer.html#AmmosContainer.frequencies"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosContainer.AmmosContainer.frequencies" title="Permalink to this definition">¶</a></dt>
|
---|
| 311 | <dd></dd></dl>
|
---|
| 312 |
|
---|
| 313 | <dl class="py method">
|
---|
| 314 | <dt class="sig sig-object py" id="ammosreader.AmmosContainer.AmmosContainer.size">
|
---|
| 315 | <span class="sig-name descname"><span class="pre">size</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosContainer.html#AmmosContainer.size"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosContainer.AmmosContainer.size" title="Permalink to this definition">¶</a></dt>
|
---|
| 316 | <dd></dd></dl>
|
---|
| 317 |
|
---|
| 318 | </dd></dl>
|
---|
| 319 |
|
---|
| 320 | </section>
|
---|
| 321 | <section id="module-ammosreader.AmmosExtendedAudioDataHeader">
|
---|
| 322 | <span id="ammosreader-ammosextendedaudiodataheader-module"></span><h2>ammosreader.AmmosExtendedAudioDataHeader module<a class="headerlink" href="#module-ammosreader.AmmosExtendedAudioDataHeader" title="Permalink to this headline">¶</a></h2>
|
---|
| 323 | <dl class="py class">
|
---|
| 324 | <dt class="sig sig-object py" id="ammosreader.AmmosExtendedAudioDataHeader.AmmosExtendedAudioDataHeader">
|
---|
[5547430] | 325 | <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>
|
---|
[ada37fa] | 326 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
| 327 | <dl class="py method">
|
---|
| 328 | <dt class="sig sig-object py" id="ammosreader.AmmosExtendedAudioDataHeader.AmmosExtendedAudioDataHeader.from_bytes">
|
---|
[5547430] | 329 | <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>
|
---|
[ada37fa] | 330 | <dd></dd></dl>
|
---|
| 331 |
|
---|
| 332 | </dd></dl>
|
---|
| 333 |
|
---|
| 334 | </section>
|
---|
| 335 | <section id="module-ammosreader.AmmosExtendedIFDataHeader">
|
---|
| 336 | <span id="ammosreader-ammosextendedifdataheader-module"></span><h2>ammosreader.AmmosExtendedIFDataHeader module<a class="headerlink" href="#module-ammosreader.AmmosExtendedIFDataHeader" title="Permalink to this headline">¶</a></h2>
|
---|
| 337 | <dl class="py class">
|
---|
| 338 | <dt class="sig sig-object py" id="ammosreader.AmmosExtendedIFDataHeader.AmmosExtendedIFDataHeader">
|
---|
[5547430] | 339 | <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>
|
---|
[ada37fa] | 340 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
| 341 | <dl class="py method">
|
---|
| 342 | <dt class="sig sig-object py" id="ammosreader.AmmosExtendedIFDataHeader.AmmosExtendedIFDataHeader.from_bytes">
|
---|
[5547430] | 343 | <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>
|
---|
[ada37fa] | 344 | <dd></dd></dl>
|
---|
| 345 |
|
---|
| 346 | </dd></dl>
|
---|
| 347 |
|
---|
| 348 | </section>
|
---|
| 349 | <section id="module-ammosreader.AmmosGlobalFrameBody">
|
---|
| 350 | <span id="ammosreader-ammosglobalframebody-module"></span><h2>ammosreader.AmmosGlobalFrameBody module<a class="headerlink" href="#module-ammosreader.AmmosGlobalFrameBody" title="Permalink to this headline">¶</a></h2>
|
---|
| 351 | <dl class="py class">
|
---|
| 352 | <dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameBody.AmmosGlobalFrameBody">
|
---|
[5547430] | 353 | <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>
|
---|
[ada37fa] | 354 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
| 355 | <dl class="py method">
|
---|
| 356 | <dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameBody.AmmosGlobalFrameBody.data_bytes_only">
|
---|
| 357 | <span class="sig-name descname"><span class="pre">data_bytes_only</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosGlobalFrameBody.html#AmmosGlobalFrameBody.data_bytes_only"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosGlobalFrameBody.AmmosGlobalFrameBody.data_bytes_only" title="Permalink to this definition">¶</a></dt>
|
---|
| 358 | <dd></dd></dl>
|
---|
| 359 |
|
---|
| 360 | </dd></dl>
|
---|
| 361 |
|
---|
| 362 | </section>
|
---|
| 363 | <section id="module-ammosreader.AmmosGlobalFrameHeader">
|
---|
| 364 | <span id="ammosreader-ammosglobalframeheader-module"></span><h2>ammosreader.AmmosGlobalFrameHeader module<a class="headerlink" href="#module-ammosreader.AmmosGlobalFrameHeader" title="Permalink to this headline">¶</a></h2>
|
---|
| 365 | <dl class="py class">
|
---|
| 366 | <dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader">
|
---|
[5547430] | 367 | <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>
|
---|
[ada37fa] | 368 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
| 369 | <dl class="py attribute">
|
---|
| 370 | <dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader.MAGIC_WORD">
|
---|
[5547430] | 371 | <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>
|
---|
[ada37fa] | 372 | <dd></dd></dl>
|
---|
| 373 |
|
---|
| 374 | <dl class="py method">
|
---|
| 375 | <dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader.from_bytes">
|
---|
[5547430] | 376 | <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>
|
---|
[ada37fa] | 377 | <dd></dd></dl>
|
---|
| 378 |
|
---|
| 379 | <dl class="py method">
|
---|
| 380 | <dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader.size">
|
---|
| 381 | <span class="sig-name descname"><span class="pre">size</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosGlobalFrameHeader.html#AmmosGlobalFrameHeader.size"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader.size" title="Permalink to this definition">¶</a></dt>
|
---|
| 382 | <dd></dd></dl>
|
---|
| 383 |
|
---|
| 384 | </dd></dl>
|
---|
| 385 |
|
---|
| 386 | </section>
|
---|
| 387 | <section id="module-ammosreader.AmmosIFDataBlock">
|
---|
| 388 | <span id="ammosreader-ammosifdatablock-module"></span><h2>ammosreader.AmmosIFDataBlock module<a class="headerlink" href="#module-ammosreader.AmmosIFDataBlock" title="Permalink to this headline">¶</a></h2>
|
---|
| 389 | <dl class="py class">
|
---|
| 390 | <dt class="sig sig-object py" id="ammosreader.AmmosIFDataBlock.AmmosIFDataBlock">
|
---|
[5547430] | 391 | <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>
|
---|
[ada37fa] | 392 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
| 393 | </dd></dl>
|
---|
| 394 |
|
---|
| 395 | </section>
|
---|
| 396 | <section id="module-ammosreader.AmmosIFDataHeader">
|
---|
| 397 | <span id="ammosreader-ammosifdataheader-module"></span><h2>ammosreader.AmmosIFDataHeader module<a class="headerlink" href="#module-ammosreader.AmmosIFDataHeader" title="Permalink to this headline">¶</a></h2>
|
---|
| 398 | <dl class="py class">
|
---|
| 399 | <dt class="sig sig-object py" id="ammosreader.AmmosIFDataHeader.AmmosIFDataHeader">
|
---|
[5547430] | 400 | <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>
|
---|
[ada37fa] | 401 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
| 402 | <dl class="py method">
|
---|
| 403 | <dt class="sig sig-object py" id="ammosreader.AmmosIFDataHeader.AmmosIFDataHeader.from_bytes">
|
---|
[5547430] | 404 | <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>
|
---|
[ada37fa] | 405 | <dd></dd></dl>
|
---|
| 406 |
|
---|
| 407 | <dl class="py method">
|
---|
| 408 | <dt class="sig sig-object py" id="ammosreader.AmmosIFDataHeader.AmmosIFDataHeader.header_size">
|
---|
| 409 | <span class="sig-name descname"><span class="pre">header_size</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosIFDataHeader.html#AmmosIFDataHeader.header_size"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosIFDataHeader.AmmosIFDataHeader.header_size" title="Permalink to this definition">¶</a></dt>
|
---|
| 410 | <dd></dd></dl>
|
---|
| 411 |
|
---|
| 412 | </dd></dl>
|
---|
| 413 |
|
---|
| 414 | </section>
|
---|
| 415 | <section id="module-ammosreader.AmmosIFReader">
|
---|
| 416 | <span id="ammosreader-ammosifreader-module"></span><h2>ammosreader.AmmosIFReader module<a class="headerlink" href="#module-ammosreader.AmmosIFReader" title="Permalink to this headline">¶</a></h2>
|
---|
| 417 | <dl class="py class">
|
---|
| 418 | <dt class="sig sig-object py" id="ammosreader.AmmosIFReader.AmmosIFReader">
|
---|
[5547430] | 419 | <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>
|
---|
[ada37fa] | 420 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
| 421 | <dl class="py method">
|
---|
| 422 | <dt class="sig sig-object py" id="ammosreader.AmmosIFReader.AmmosIFReader.add_tag">
|
---|
| 423 | <span class="sig-name descname"><span class="pre">add_tag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosIFReader.html#AmmosIFReader.add_tag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosIFReader.AmmosIFReader.add_tag" title="Permalink to this definition">¶</a></dt>
|
---|
| 424 | <dd></dd></dl>
|
---|
| 425 |
|
---|
| 426 | <dl class="py method">
|
---|
| 427 | <dt class="sig sig-object py" id="ammosreader.AmmosIFReader.AmmosIFReader.read_all_frames_left">
|
---|
| 428 | <span class="sig-name descname"><span class="pre">read_all_frames_left</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosIFReader.html#AmmosIFReader.read_all_frames_left"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosIFReader.AmmosIFReader.read_all_frames_left" title="Permalink to this definition">¶</a></dt>
|
---|
| 429 | <dd></dd></dl>
|
---|
| 430 |
|
---|
| 431 | <dl class="py method">
|
---|
| 432 | <dt class="sig sig-object py" id="ammosreader.AmmosIFReader.AmmosIFReader.read_next_global_frame_body">
|
---|
| 433 | <span class="sig-name descname"><span class="pre">read_next_global_frame_body</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">global_frame_header</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosIFReader.html#AmmosIFReader.read_next_global_frame_body"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosIFReader.AmmosIFReader.read_next_global_frame_body" title="Permalink to this definition">¶</a></dt>
|
---|
| 434 | <dd></dd></dl>
|
---|
| 435 |
|
---|
| 436 | <dl class="py method">
|
---|
| 437 | <dt class="sig sig-object py" id="ammosreader.AmmosIFReader.AmmosIFReader.read_next_global_frame_body_data_header">
|
---|
| 438 | <span class="sig-name descname"><span class="pre">read_next_global_frame_body_data_header</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosIFReader.html#AmmosIFReader.read_next_global_frame_body_data_header"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosIFReader.AmmosIFReader.read_next_global_frame_body_data_header" title="Permalink to this definition">¶</a></dt>
|
---|
| 439 | <dd></dd></dl>
|
---|
| 440 |
|
---|
| 441 | <dl class="py method">
|
---|
| 442 | <dt class="sig sig-object py" id="ammosreader.AmmosIFReader.AmmosIFReader.read_next_global_frame_body_extended_data_header">
|
---|
| 443 | <span class="sig-name descname"><span class="pre">read_next_global_frame_body_extended_data_header</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosIFReader.html#AmmosIFReader.read_next_global_frame_body_extended_data_header"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosIFReader.AmmosIFReader.read_next_global_frame_body_extended_data_header" title="Permalink to this definition">¶</a></dt>
|
---|
| 444 | <dd></dd></dl>
|
---|
| 445 |
|
---|
| 446 | <dl class="py method">
|
---|
| 447 | <dt class="sig sig-object py" id="ammosreader.AmmosIFReader.AmmosIFReader.read_next_global_frame_header">
|
---|
| 448 | <span class="sig-name descname"><span class="pre">read_next_global_frame_header</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosIFReader.html#AmmosIFReader.read_next_global_frame_header"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosIFReader.AmmosIFReader.read_next_global_frame_header" title="Permalink to this definition">¶</a></dt>
|
---|
| 449 | <dd></dd></dl>
|
---|
| 450 |
|
---|
| 451 | <dl class="py method">
|
---|
| 452 | <dt class="sig sig-object py" id="ammosreader.AmmosIFReader.AmmosIFReader.read_next_if_data_blocks">
|
---|
| 453 | <span class="sig-name descname"><span class="pre">read_next_if_data_blocks</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">length</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosIFReader.html#AmmosIFReader.read_next_if_data_blocks"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosIFReader.AmmosIFReader.read_next_if_data_blocks" title="Permalink to this definition">¶</a></dt>
|
---|
| 454 | <dd></dd></dl>
|
---|
| 455 |
|
---|
| 456 | <dl class="py method">
|
---|
| 457 | <dt class="sig sig-object py" id="ammosreader.AmmosIFReader.AmmosIFReader.read_next_single_frame">
|
---|
| 458 | <span class="sig-name descname"><span class="pre">read_next_single_frame</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosIFReader.html#AmmosIFReader.read_next_single_frame"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosIFReader.AmmosIFReader.read_next_single_frame" title="Permalink to this definition">¶</a></dt>
|
---|
| 459 | <dd></dd></dl>
|
---|
| 460 |
|
---|
| 461 | <dl class="py method">
|
---|
| 462 | <dt class="sig sig-object py" id="ammosreader.AmmosIFReader.AmmosIFReader.rewind_to_start">
|
---|
| 463 | <span class="sig-name descname"><span class="pre">rewind_to_start</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosIFReader.html#AmmosIFReader.rewind_to_start"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosIFReader.AmmosIFReader.rewind_to_start" title="Permalink to this definition">¶</a></dt>
|
---|
| 464 | <dd></dd></dl>
|
---|
| 465 |
|
---|
| 466 | </dd></dl>
|
---|
| 467 |
|
---|
| 468 | </section>
|
---|
| 469 | <section id="module-ammosreader.AmmosSingleFrame">
|
---|
| 470 | <span id="ammosreader-ammossingleframe-module"></span><h2>ammosreader.AmmosSingleFrame module<a class="headerlink" href="#module-ammosreader.AmmosSingleFrame" title="Permalink to this headline">¶</a></h2>
|
---|
| 471 | <dl class="py class">
|
---|
| 472 | <dt class="sig sig-object py" id="ammosreader.AmmosSingleFrame.AmmosSingleFrame">
|
---|
[5547430] | 473 | <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>
|
---|
[ada37fa] | 474 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
| 475 | <dl class="py method">
|
---|
| 476 | <dt class="sig sig-object py" id="ammosreader.AmmosSingleFrame.AmmosSingleFrame.data">
|
---|
| 477 | <span class="sig-name descname"><span class="pre">data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosSingleFrame.html#AmmosSingleFrame.data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosSingleFrame.AmmosSingleFrame.data" title="Permalink to this definition">¶</a></dt>
|
---|
| 478 | <dd></dd></dl>
|
---|
| 479 |
|
---|
| 480 | <dl class="py method">
|
---|
| 481 | <dt class="sig sig-object py" id="ammosreader.AmmosSingleFrame.AmmosSingleFrame.size_correct">
|
---|
| 482 | <span class="sig-name descname"><span class="pre">size_correct</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosSingleFrame.html#AmmosSingleFrame.size_correct"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosSingleFrame.AmmosSingleFrame.size_correct" title="Permalink to this definition">¶</a></dt>
|
---|
| 483 | <dd></dd></dl>
|
---|
| 484 |
|
---|
| 485 | </dd></dl>
|
---|
| 486 |
|
---|
| 487 | </section>
|
---|
[8413944] | 488 | <section id="module-ammosreader.IQDWTXBlock">
|
---|
| 489 | <span id="ammosreader-iqdwtxblock-module"></span><h2>ammosreader.IQDWTXBlock module<a class="headerlink" href="#module-ammosreader.IQDWTXBlock" title="Permalink to this headline">¶</a></h2>
|
---|
| 490 | <dl class="py class">
|
---|
| 491 | <dt class="sig sig-object py" id="ammosreader.IQDWTXBlock.IQDWTXBLOCK">
|
---|
| 492 | <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ammosreader.IQDWTXBlock.</span></span><span class="sig-name descname"><span class="pre">IQDWTXBLOCK</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pdw</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iq</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/IQDWTXBlock.html#IQDWTXBLOCK"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.IQDWTXBlock.IQDWTXBLOCK" title="Permalink to this definition">¶</a></dt>
|
---|
| 493 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
| 494 | <dl class="py method">
|
---|
| 495 | <dt class="sig sig-object py" id="ammosreader.IQDWTXBlock.IQDWTXBLOCK.from_bytes">
|
---|
| 496 | <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/IQDWTXBlock.html#IQDWTXBLOCK.from_bytes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.IQDWTXBlock.IQDWTXBLOCK.from_bytes" title="Permalink to this definition">¶</a></dt>
|
---|
| 497 | <dd></dd></dl>
|
---|
| 498 |
|
---|
| 499 | </dd></dl>
|
---|
| 500 |
|
---|
[ada37fa] | 501 | </section>
|
---|
| 502 | <section id="module-ammosreader.PDW">
|
---|
| 503 | <span id="ammosreader-pdw-module"></span><h2>ammosreader.PDW module<a class="headerlink" href="#module-ammosreader.PDW" title="Permalink to this headline">¶</a></h2>
|
---|
| 504 | <dl class="py class">
|
---|
| 505 | <dt class="sig sig-object py" id="ammosreader.PDW.PDW">
|
---|
[5547430] | 506 | <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>
|
---|
[ada37fa] | 507 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
| 508 | <p>I store information from a single ppdw data block.</p>
|
---|
| 509 | <dl class="py method">
|
---|
| 510 | <dt class="sig sig-object py" id="ammosreader.PDW.PDW.__init__">
|
---|
| 511 | <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>
|
---|
| 512 | <dd><dl class="field-list simple">
|
---|
| 513 | <dt class="field-odd">Parameters</dt>
|
---|
| 514 | <dd class="field-odd"><ul class="simple">
|
---|
| 515 | <li><p><strong>time_of_arrival</strong> (<em>Integer</em>) – nanoseconds since 1970-01-01 00:00:00</p></li>
|
---|
| 516 | <li><p><strong>pdw_format</strong> (<em>Integer</em>) – format code</p></li>
|
---|
| 517 | <li><p><strong>center_frequency</strong> (<em>Integer</em>) – center frequency in KHz</p></li>
|
---|
| 518 | <li><p><strong>is_valid</strong> (<em>Boolean</em>) – flag to mark if pdw data body is valid</p></li>
|
---|
| 519 | <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>
|
---|
| 520 | <li><p><strong>level_unit</strong> (<em>Integer</em>) – 0 means dBµV - 1 means dBµV/m</p></li>
|
---|
| 521 | <li><p><strong>signal_start_missing</strong> (<em>Boolean</em>) – signal started before time of arrival</p></li>
|
---|
| 522 | <li><p><strong>signal_end_missing</strong> (<em>Boolean</em>) – signal stops after time of arrival</p></li>
|
---|
| 523 | <li><p><strong>pulse_width</strong> (<em>Integer</em>) – pulse width in nanoseconds - Zero if no valid pulse detected</p></li>
|
---|
| 524 | <li><p><strong>frequency_shift_or_bandwidth</strong> (<em>Integer</em>) – Value in KHz - Value set to 1048575 means Unknown</p></li>
|
---|
| 525 | <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>
|
---|
| 526 | <li><p><strong>region_of_interest</strong> (<em>Boolean</em>) – Marks if signal is from region of interest</p></li>
|
---|
| 527 | <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>
|
---|
| 528 | <li><p><strong>modulation</strong> (<em>String</em>) – type of modulation (e.g. PSK-2, PSK-4, FM etc.)</p></li>
|
---|
| 529 | <li><p><strong>sector</strong> (<em>Integer</em>) – reference antenna sector (0-15)</p></li>
|
---|
| 530 | <li><p><strong>polarity</strong> (<em>String</em>) – Horizontal, Vertical, Clockwise, Counter clockwise</p></li>
|
---|
| 531 | <li><p><strong>df_quality</strong> (<em>Integer</em>) – Direction finding quality in percent (0-100) - Zero means unknown</p></li>
|
---|
| 532 | <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>
|
---|
| 533 | <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>
|
---|
| 534 | <li><p><strong>channel</strong> (<em>Integer</em>) – detecting channel (0-16) - Zero means unknown</p></li>
|
---|
| 535 | </ul>
|
---|
| 536 | </dd>
|
---|
| 537 | <dt class="field-even">Returns</dt>
|
---|
| 538 | <dd class="field-even"><p>An instance of class PDW with attributes set according to the data of a data body</p>
|
---|
| 539 | </dd>
|
---|
| 540 | <dt class="field-odd">Return type</dt>
|
---|
| 541 | <dd class="field-odd"><p><a class="reference internal" href="#ammosreader.PDW.PDW" title="ammosreader.PDW.PDW">PDW</a></p>
|
---|
| 542 | </dd>
|
---|
| 543 | </dl>
|
---|
| 544 | </dd></dl>
|
---|
| 545 |
|
---|
| 546 | <dl class="py method">
|
---|
| 547 | <dt class="sig sig-object py" id="ammosreader.PDW.PDW.from_bytes">
|
---|
[5547430] | 548 | <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>
|
---|
[ada37fa] | 549 | <dd><p>I create an instance of class PDW from data body (8 * 32 bits)</p>
|
---|
| 550 | <dl class="field-list simple">
|
---|
| 551 | <dt class="field-odd">Parameters</dt>
|
---|
| 552 | <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>
|
---|
| 553 | </dd>
|
---|
| 554 | <dt class="field-even">Returns</dt>
|
---|
| 555 | <dd class="field-even"><p>an instance of class PDW with attributes set according to the data of a data body</p>
|
---|
| 556 | </dd>
|
---|
| 557 | <dt class="field-odd">Return type</dt>
|
---|
| 558 | <dd class="field-odd"><p><a class="reference internal" href="#ammosreader.PDW.PDW" title="ammosreader.PDW.PDW">PDW</a></p>
|
---|
| 559 | </dd>
|
---|
| 560 | </dl>
|
---|
| 561 | </dd></dl>
|
---|
| 562 |
|
---|
| 563 | </dd></dl>
|
---|
| 564 |
|
---|
| 565 | </section>
|
---|
| 566 | <section id="module-ammosreader.PPDWContainer">
|
---|
| 567 | <span id="ammosreader-ppdwcontainer-module"></span><h2>ammosreader.PPDWContainer module<a class="headerlink" href="#module-ammosreader.PPDWContainer" title="Permalink to this headline">¶</a></h2>
|
---|
| 568 | <dl class="py class">
|
---|
| 569 | <dt class="sig sig-object py" id="ammosreader.PPDWContainer.PPDWContainer">
|
---|
[5547430] | 570 | <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>
|
---|
[ada37fa] | 571 | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
---|
| 572 | <p>I store multiple signals imported from one or more .ppdw files</p>
|
---|
| 573 | <dl class="py method">
|
---|
| 574 | <dt class="sig sig-object py" id="ammosreader.PPDWContainer.PPDWContainer.__init__">
|
---|
| 575 | <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">signals</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/PPDWContainer.html#PPDWContainer.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.PPDWContainer.PPDWContainer.__init__" title="Permalink to this definition">¶</a></dt>
|
---|
| 576 | <dd></dd></dl>
|
---|
| 577 |
|
---|
| 578 | </dd></dl>
|
---|
| 579 |
|
---|
| 580 | </section>
|
---|
| 581 | <section id="module-ammosreader">
|
---|
| 582 | <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-ammosreader" title="Permalink to this headline">¶</a></h2>
|
---|
| 583 | </section>
|
---|
| 584 | </section>
|
---|
| 585 |
|
---|
| 586 |
|
---|
[5547430] | 587 | </div>
|
---|
[ada37fa] | 588 | </div>
|
---|
| 589 | </div>
|
---|
[5547430] | 590 | <div class="footer">
|
---|
| 591 | <p>
|
---|
| 592 | © Copyright 2022, KIDZg.
|
---|
| 593 | 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> .
|
---|
| 594 | (Revision )
|
---|
| 595 | </p>
|
---|
[ada37fa] | 596 | </div>
|
---|
| 597 | <div class="clearer"></div>
|
---|
| 598 | </div>
|
---|
[5547430] | 599 | <div id="breadcrumbs">
|
---|
| 600 | ammosreader package
|
---|
| 601 | </div>
|
---|
| 602 | <script type="text/javascript" charset="utf-8" src="_static/js/toc.js"></script>
|
---|
[ada37fa] | 603 | </body>
|
---|
| 604 | </html> |
---|