source: ammosreader/doc/html/ammosreader.html@ 299c79c

AmmosSource guix
Last change on this file since 299c79c was 299c79c, checked in by Enrico Schwass <ennoausberlin@…>, 3 years ago

sphinx-apidoc run
  • Property mode set to 100644
File size: 72.2 KB
RevLine 
[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 &#8212; 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">&nbsp;</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>
[299c79c]98<p>I provide an AMMOS data header for audio data frames.</p>
[ada37fa]99<dl class="py class">
100<dt class="sig sig-object py" id="ammosreader.AmmosAudioDataHeader.AmmosAudioDataHeader">
[299c79c]101<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">number_of_samples</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">number_of_channels</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]102<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
[299c79c]103<p>I implement an AMMOS data header for audio data frames.</p>
104<dl class="py attribute">
105<dt class="sig sig-object py" id="ammosreader.AmmosAudioDataHeader.AmmosAudioDataHeader.HEADER_SIZE">
106<span class="sig-name descname"><span class="pre">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.AmmosAudioDataHeader.AmmosAudioDataHeader.HEADER_SIZE" title="Permalink to this definition">¶</a></dt>
107<dd></dd></dl>
108
[ada37fa]109<dl class="py method">
110<dt class="sig sig-object py" id="ammosreader.AmmosAudioDataHeader.AmmosAudioDataHeader.from_bytes">
[5547430]111<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>
[299c79c]112<dd><p>I return an AMMOS data header from given bytes.</p>
[5547430]113</dd></dl>
[ada37fa]114
115</dd></dl>
116
117</section>
118<section id="module-ammosreader.AmmosAudioReader">
119<span id="ammosreader-ammosaudioreader-module"></span><h2>ammosreader.AmmosAudioReader module<a class="headerlink" href="#module-ammosreader.AmmosAudioReader" title="Permalink to this headline">¶</a></h2>
[299c79c]120<p>I provide a specialized Ammos Reader for audio data.</p>
[ada37fa]121<dl class="py class">
122<dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader">
[5547430]123<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>
[299c79c]124<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ammosreader.AbstractAmmosReader.AbstractAmmosReader</span></code></p>
[ada37fa]125<p>I read the audio data embedded in an R&amp;S AMMOS recording.</p>
126<dl class="py method">
[299c79c]127<dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.pcm_for_channel">
128<span class="sig-name descname"><span class="pre">pcm_for_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">a_channel</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosAudioReader.html#AmmosAudioReader.pcm_for_channel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosAudioReader.AmmosAudioReader.pcm_for_channel" title="Permalink to this definition">¶</a></dt>
129<dd><p>I return the raw pcm audio data for a given channel.</p>
[ada37fa]130<dl class="field-list simple">
131<dt class="field-odd">Parameters</dt>
[299c79c]132<dd class="field-odd"><p><strong>a_channel</strong> (<em>int</em>) – the channel I have to extract</p>
[ada37fa]133</dd>
134<dt class="field-even">Return type</dt>
[299c79c]135<dd class="field-even"><p>bytes</p>
[ada37fa]136</dd>
137</dl>
138</dd></dl>
139
140<dl class="py method">
141<dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.read_next_audio_data_body">
[299c79c]142<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">number_of_samples</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">number_of_channels</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>
[ada37fa]143<dd><p>I return the next audio data read from current position in file.</p>
144<dl class="field-list simple">
145<dt class="field-odd">Parameters</dt>
146<dd class="field-odd"><ul class="simple">
[299c79c]147<li><p><strong>number_of_samples</strong> (<em>int</em>) – the number of samples per channel inside data body</p></li>
148<li><p><strong>number_of_channels</strong> (<em>int</em>) – number of channels (e.g. mono, stereo or even more)</p></li>
[ada37fa]149<li><p><strong>sample_size</strong> (<em>int</em>) – sample size in bytes (1, 2 or 4 bytes)</p></li>
150</ul>
151</dd>
152<dt class="field-even">Returns</dt>
153<dd class="field-even"><p>the next audio data or None if incomplete</p>
154</dd>
155<dt class="field-odd">Return type</dt>
156<dd class="field-odd"><p>bytes</p>
157</dd>
158</dl>
159</dd></dl>
160
161<dl class="py method">
162<dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.read_next_global_frame_body">
[299c79c]163<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">data_header_length</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>
164<dd><p>I return the next global frame body read from current position in file.</p>
165<dl class="field-list simple">
166<dt class="field-odd">Parameters</dt>
167<dd class="field-odd"><p><strong>global_frame_header</strong> – </p>
168</dd>
169</dl>
170</dd></dl>
[ada37fa]171
172<dl class="py method">
173<dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.read_next_global_frame_body_data_header">
174<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>
175<dd><p>I return the next global frame body data header from current position in file.</p>
176<dl class="field-list simple">
177<dt class="field-odd">Parameters</dt>
178<dd class="field-odd"><p><strong>data_header_size</strong> (<em>int</em>) – the number of bytes to read</p>
179</dd>
180<dt class="field-even">Returns</dt>
181<dd class="field-even"><p>the next Ammos Audio Data header or None if incomplete</p>
182</dd>
183<dt class="field-odd">Return type</dt>
184<dd class="field-odd"><p><a class="reference internal" href="#ammosreader.AmmosAudioDataHeader.AmmosAudioDataHeader" title="ammosreader.AmmosAudioDataHeader.AmmosAudioDataHeader">AmmosAudioDataHeader</a></p>
185</dd>
186</dl>
187</dd></dl>
188
189<dl class="py method">
190<dt class="sig sig-object py" id="ammosreader.AmmosAudioReader.AmmosAudioReader.read_next_global_frame_body_extended_data_header">
191<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>
192<dd><p>I return the next global frame body extended data header from current position in file.</p>
193<dl class="field-list simple">
194<dt class="field-odd">Returns</dt>
195<dd class="field-odd"><p>the next Ammos Audio Extended Data header or None if incomplete</p>
196</dd>
197<dt class="field-even">Return type</dt>
198<dd class="field-even"><p><a class="reference internal" href="#ammosreader.AmmosExtendedAudioDataHeader.AmmosExtendedAudioDataHeader" title="ammosreader.AmmosExtendedAudioDataHeader.AmmosExtendedAudioDataHeader">AmmosExtendedAudioDataHeader</a></p>
199</dd>
200</dl>
201</dd></dl>
202
203</dd></dl>
204
205</section>
206<section id="module-ammosreader.AmmosAudioSocketReader">
207<span id="ammosreader-ammosaudiosocketreader-module"></span><h2>ammosreader.AmmosAudioSocketReader module<a class="headerlink" href="#module-ammosreader.AmmosAudioSocketReader" title="Permalink to this headline">¶</a></h2>
[299c79c]208<p>I read a Ammos datastream from a socket.</p>
[ada37fa]209<dl class="py class">
210<dt class="sig sig-object py" id="ammosreader.AmmosAudioSocketReader.AmmosAudioSocketReader">
[299c79c]211<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>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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]212<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
213<dl class="py method">
214<dt class="sig sig-object py" id="ammosreader.AmmosAudioSocketReader.AmmosAudioSocketReader.read_next_frame">
[299c79c]215<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">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">numpy.ndarray</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>
216<dd><p>Reads the next ammos audio frame from socket</p>
[8413944]217<dl class="field-list simple">
[299c79c]218<dt class="field-odd">Raises</dt>
219<dd class="field-odd"><p><strong>TimeoutError</strong> – Raisees TimeoutError if the socket does not serve data anymore</p>
[8413944]220</dd>
[299c79c]221<dt class="field-even">Returns</dt>
222<dd class="field-even"><p>Contains the audio data and the sample rate</p>
223</dd>
224<dt class="field-odd">Return type</dt>
225<dd class="field-odd"><p>tuple[np.ndarray, int]</p>
[ada37fa]226</dd>
227</dl>
228</dd></dl>
229
230</dd></dl>
231
232</section>
233<section id="module-ammosreader.AmmosContainer">
234<span id="ammosreader-ammoscontainer-module"></span><h2>ammosreader.AmmosContainer module<a class="headerlink" href="#module-ammosreader.AmmosContainer" title="Permalink to this headline">¶</a></h2>
[a4a96fd]235<p>I store the content of an R&amp;S Ammos file in a more accessible way.</p>
[ada37fa]236<dl class="py class">
237<dt class="sig sig-object py" id="ammosreader.AmmosContainer.AmmosContainer">
[5547430]238<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]239<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
240<dl class="py method">
241<dt class="sig sig-object py" id="ammosreader.AmmosContainer.AmmosContainer.add_frame">
242<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>
243<dd></dd></dl>
244
245<dl class="py method">
246<dt class="sig sig-object py" id="ammosreader.AmmosContainer.AmmosContainer.add_tag">
247<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>
248<dd></dd></dl>
249
[299c79c]250<dl class="py method">
251<dt class="sig sig-object py" id="ammosreader.AmmosContainer.AmmosContainer.data_only">
252<span class="sig-name descname"><span class="pre">data_only</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosContainer.html#AmmosContainer.data_only"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosContainer.AmmosContainer.data_only" title="Permalink to this definition">¶</a></dt>
253<dd></dd></dl>
254
[ada37fa]255<dl class="py method">
256<dt class="sig sig-object py" id="ammosreader.AmmosContainer.AmmosContainer.frequencies">
257<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>
258<dd></dd></dl>
259
[299c79c]260<dl class="py property">
261<dt class="sig sig-object py" id="ammosreader.AmmosContainer.AmmosContainer.global_frames">
262<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">global_frames</span></span><a class="headerlink" href="#ammosreader.AmmosContainer.AmmosContainer.global_frames" title="Permalink to this definition">¶</a></dt>
263<dd></dd></dl>
264
265<dl class="py property">
266<dt class="sig sig-object py" id="ammosreader.AmmosContainer.AmmosContainer.name">
267<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#ammosreader.AmmosContainer.AmmosContainer.name" title="Permalink to this definition">¶</a></dt>
268<dd></dd></dl>
269
[ada37fa]270<dl class="py method">
271<dt class="sig sig-object py" id="ammosreader.AmmosContainer.AmmosContainer.size">
272<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>
273<dd></dd></dl>
274
275</dd></dl>
276
277</section>
278<section id="module-ammosreader.AmmosExtendedAudioDataHeader">
279<span id="ammosreader-ammosextendedaudiodataheader-module"></span><h2>ammosreader.AmmosExtendedAudioDataHeader module<a class="headerlink" href="#module-ammosreader.AmmosExtendedAudioDataHeader" title="Permalink to this headline">¶</a></h2>
[299c79c]280<p>I provide an Ammos extended data header for audio data frames.</p>
[ada37fa]281<dl class="py class">
282<dt class="sig sig-object py" id="ammosreader.AmmosExtendedAudioDataHeader.AmmosExtendedAudioDataHeader">
[299c79c]283<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">number_of_samples</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">number_of_channels</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]284<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
[299c79c]285<dl class="py attribute">
286<dt class="sig sig-object py" id="ammosreader.AmmosExtendedAudioDataHeader.AmmosExtendedAudioDataHeader.HEADER_SIZE">
287<span class="sig-name descname"><span class="pre">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.AmmosExtendedAudioDataHeader.AmmosExtendedAudioDataHeader.HEADER_SIZE" title="Permalink to this definition">¶</a></dt>
288<dd></dd></dl>
289
[ada37fa]290<dl class="py method">
291<dt class="sig sig-object py" id="ammosreader.AmmosExtendedAudioDataHeader.AmmosExtendedAudioDataHeader.from_bytes">
[5547430]292<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>
[299c79c]293<dd><p>I return a new AMMOS extended data header for audio frames built from given bytes.</p>
294</dd></dl>
[ada37fa]295
296</dd></dl>
297
298</section>
299<section id="module-ammosreader.AmmosExtendedIFDataHeader">
300<span id="ammosreader-ammosextendedifdataheader-module"></span><h2>ammosreader.AmmosExtendedIFDataHeader module<a class="headerlink" href="#module-ammosreader.AmmosExtendedIFDataHeader" title="Permalink to this headline">¶</a></h2>
301<dl class="py class">
302<dt class="sig sig-object py" id="ammosreader.AmmosExtendedIFDataHeader.AmmosExtendedIFDataHeader">
[5547430]303<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]304<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
[299c79c]305<p>I implement an Ammos extended data header for IF data frames.</p>
306<dl class="py attribute">
307<dt class="sig sig-object py" id="ammosreader.AmmosExtendedIFDataHeader.AmmosExtendedIFDataHeader.HEADER_SIZE">
308<span class="sig-name descname"><span class="pre">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">76</span></em><a class="headerlink" href="#ammosreader.AmmosExtendedIFDataHeader.AmmosExtendedIFDataHeader.HEADER_SIZE" title="Permalink to this definition">¶</a></dt>
309<dd></dd></dl>
310
[ada37fa]311<dl class="py method">
312<dt class="sig sig-object py" id="ammosreader.AmmosExtendedIFDataHeader.AmmosExtendedIFDataHeader.from_bytes">
[5547430]313<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>
[299c79c]314<dd><p>I return an AMMOS extended data header from given bytes.</p>
315</dd></dl>
[ada37fa]316
317</dd></dl>
318
319</section>
320<section id="module-ammosreader.AmmosGlobalFrameBody">
321<span id="ammosreader-ammosglobalframebody-module"></span><h2>ammosreader.AmmosGlobalFrameBody module<a class="headerlink" href="#module-ammosreader.AmmosGlobalFrameBody" title="Permalink to this headline">¶</a></h2>
[299c79c]322<p>I provide an AMMOS global frame body.</p>
[ada37fa]323<dl class="py class">
324<dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameBody.AmmosGlobalFrameBody">
[5547430]325<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]326<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
[299c79c]327<p>I implement an AMMOS global frame body.</p>
328<p>AMMOS frames can store data of various types.
329The data is described in the data header.
330The raw data is then stored in the data body.</p>
331<dl class="py property">
332<dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameBody.AmmosGlobalFrameBody.data_body">
333<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data_body</span></span><a class="headerlink" href="#ammosreader.AmmosGlobalFrameBody.AmmosGlobalFrameBody.data_body" title="Permalink to this definition">¶</a></dt>
334<dd></dd></dl>
335
[ada37fa]336<dl class="py method">
337<dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameBody.AmmosGlobalFrameBody.data_bytes_only">
338<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>
339<dd></dd></dl>
340
[299c79c]341<dl class="py property">
342<dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameBody.AmmosGlobalFrameBody.data_header">
343<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data_header</span></span><a class="headerlink" href="#ammosreader.AmmosGlobalFrameBody.AmmosGlobalFrameBody.data_header" title="Permalink to this definition">¶</a></dt>
344<dd></dd></dl>
345
[ada37fa]346</dd></dl>
347
348</section>
349<section id="module-ammosreader.AmmosGlobalFrameHeader">
350<span id="ammosreader-ammosglobalframeheader-module"></span><h2>ammosreader.AmmosGlobalFrameHeader module<a class="headerlink" href="#module-ammosreader.AmmosGlobalFrameHeader" title="Permalink to this headline">¶</a></h2>
351<dl class="py class">
352<dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader">
[5547430]353<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]354<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
355<dl class="py attribute">
356<dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader.MAGIC_WORD">
[5547430]357<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]358<dd></dd></dl>
359
360<dl class="py method">
361<dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader.from_bytes">
[5547430]362<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]363<dd></dd></dl>
364
365<dl class="py method">
366<dt class="sig sig-object py" id="ammosreader.AmmosGlobalFrameHeader.AmmosGlobalFrameHeader.size">
367<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>
368<dd></dd></dl>
369
370</dd></dl>
371
372</section>
373<section id="module-ammosreader.AmmosIFDataBlock">
374<span id="ammosreader-ammosifdatablock-module"></span><h2>ammosreader.AmmosIFDataBlock module<a class="headerlink" href="#module-ammosreader.AmmosIFDataBlock" title="Permalink to this headline">¶</a></h2>
375<dl class="py class">
376<dt class="sig sig-object py" id="ammosreader.AmmosIFDataBlock.AmmosIFDataBlock">
[299c79c]377<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">header</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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]378<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
[299c79c]379<dl class="py property">
380<dt class="sig sig-object py" id="ammosreader.AmmosIFDataBlock.AmmosIFDataBlock.data">
381<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data</span></span><a class="headerlink" href="#ammosreader.AmmosIFDataBlock.AmmosIFDataBlock.data" title="Permalink to this definition">¶</a></dt>
382<dd></dd></dl>
383
384<dl class="py property">
385<dt class="sig sig-object py" id="ammosreader.AmmosIFDataBlock.AmmosIFDataBlock.header">
386<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">header</span></span><a class="headerlink" href="#ammosreader.AmmosIFDataBlock.AmmosIFDataBlock.header" title="Permalink to this definition">¶</a></dt>
387<dd></dd></dl>
388
[ada37fa]389</dd></dl>
390
391</section>
392<section id="module-ammosreader.AmmosIFDataHeader">
393<span id="ammosreader-ammosifdataheader-module"></span><h2>ammosreader.AmmosIFDataHeader module<a class="headerlink" href="#module-ammosreader.AmmosIFDataHeader" title="Permalink to this headline">¶</a></h2>
[299c79c]394<p>I provide a Ammos data header for IF data frames.</p>
[ada37fa]395<dl class="py class">
396<dt class="sig sig-object py" id="ammosreader.AmmosIFDataHeader.AmmosIFDataHeader">
[5547430]397<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]398<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
[299c79c]399<p>I implement an Ammos data header for IF data frames.</p>
400<dl class="py attribute">
401<dt class="sig sig-object py" id="ammosreader.AmmosIFDataHeader.AmmosIFDataHeader.HEADER_SIZE">
402<span class="sig-name descname"><span class="pre">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">56</span></em><a class="headerlink" href="#ammosreader.AmmosIFDataHeader.AmmosIFDataHeader.HEADER_SIZE" title="Permalink to this definition">¶</a></dt>
[ada37fa]403<dd></dd></dl>
404
405<dl class="py method">
[299c79c]406<dt class="sig sig-object py" id="ammosreader.AmmosIFDataHeader.AmmosIFDataHeader.from_bytes">
407<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>
408<dd><p>I return an AMMOS data header from given bytes.</p>
409</dd></dl>
[ada37fa]410
411</dd></dl>
412
413</section>
414<section id="module-ammosreader.AmmosIFReader">
415<span id="ammosreader-ammosifreader-module"></span><h2>ammosreader.AmmosIFReader module<a class="headerlink" href="#module-ammosreader.AmmosIFReader" title="Permalink to this headline">¶</a></h2>
[299c79c]416<p>I provide a specialized Ammos Reader for IF data.</p>
[ada37fa]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>
[299c79c]420<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ammosreader.AbstractAmmosReader.AbstractAmmosReader</span></code></p>
421<p>I read the IF data embedded in an R&amp;S AMMOS recording.</p>
[ada37fa]422<dl class="py method">
[299c79c]423<dt class="sig sig-object py" id="ammosreader.AmmosIFReader.AmmosIFReader.data">
424<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/AmmosIFReader.html#AmmosIFReader.data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosIFReader.AmmosIFReader.data" title="Permalink to this definition">¶</a></dt>
[ada37fa]425<dd></dd></dl>
426
427<dl class="py method">
428<dt class="sig sig-object py" id="ammosreader.AmmosIFReader.AmmosIFReader.read_next_global_frame_body">
[299c79c]429<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">data_header_length</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>
430<dd><p>I return the next global frame body read from current position in file.</p>
431<dl class="field-list simple">
432<dt class="field-odd">Parameters</dt>
433<dd class="field-odd"><p><strong>data_header_length</strong> (<em>int</em>) – the length of the data header</p>
434</dd>
435</dl>
436</dd></dl>
[ada37fa]437
438<dl class="py method">
439<dt class="sig sig-object py" id="ammosreader.AmmosIFReader.AmmosIFReader.read_next_global_frame_body_data_header">
440<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>
441<dd></dd></dl>
442
443<dl class="py method">
444<dt class="sig sig-object py" id="ammosreader.AmmosIFReader.AmmosIFReader.read_next_global_frame_body_extended_data_header">
445<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>
[299c79c]446<dd><p>I return the next global frame body extended data header from current position in file.</p>
447<dl class="field-list simple">
448<dt class="field-odd">Returns</dt>
449<dd class="field-odd"><p>the next Ammos Extended IF data header or None if incomplete</p>
450</dd>
451<dt class="field-even">Return type</dt>
452<dd class="field-even"><p><a class="reference internal" href="#ammosreader.AmmosExtendedIFDataHeader.AmmosExtendedIFDataHeader" title="ammosreader.AmmosExtendedIFDataHeader.AmmosExtendedIFDataHeader">AmmosExtendedIFDataHeader</a></p>
453</dd>
454</dl>
455</dd></dl>
[ada37fa]456
457<dl class="py method">
[299c79c]458<dt class="sig sig-object py" id="ammosreader.AmmosIFReader.AmmosIFReader.read_next_if_data_body">
459<span class="sig-name descname"><span class="pre">read_next_if_data_body</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">number_of_data_blocks</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_length</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/AmmosIFReader.html#AmmosIFReader.read_next_if_data_body"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.AmmosIFReader.AmmosIFReader.read_next_if_data_body" title="Permalink to this definition">¶</a></dt>
460<dd><p>I return the next data body read from current position in file.</p>
461<dl class="field-list simple">
462<dt class="field-odd">Parameters</dt>
463<dd class="field-odd"><ul class="simple">
464<li><p><strong>number_of_data_blocks</strong> (<em>int</em>) – the number of data blocks inside the body</p></li>
465<li><p><strong>data_length</strong> (<em>int</em>) – the length of the raw data inside a single block</p></li>
466</ul>
467</dd>
468</dl>
469</dd></dl>
[ada37fa]470
471</dd></dl>
472
473</section>
474<section id="module-ammosreader.AmmosSingleFrame">
475<span id="ammosreader-ammossingleframe-module"></span><h2>ammosreader.AmmosSingleFrame module<a class="headerlink" href="#module-ammosreader.AmmosSingleFrame" title="Permalink to this headline">¶</a></h2>
476<dl class="py class">
477<dt class="sig sig-object py" id="ammosreader.AmmosSingleFrame.AmmosSingleFrame">
[5547430]478<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]479<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
480<dl class="py method">
481<dt class="sig sig-object py" id="ammosreader.AmmosSingleFrame.AmmosSingleFrame.data">
482<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>
483<dd></dd></dl>
484
[299c79c]485<dl class="py property">
486<dt class="sig sig-object py" id="ammosreader.AmmosSingleFrame.AmmosSingleFrame.global_frame_body">
487<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">global_frame_body</span></span><a class="headerlink" href="#ammosreader.AmmosSingleFrame.AmmosSingleFrame.global_frame_body" title="Permalink to this definition">¶</a></dt>
488<dd></dd></dl>
489
490<dl class="py property">
491<dt class="sig sig-object py" id="ammosreader.AmmosSingleFrame.AmmosSingleFrame.global_frame_header">
492<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">global_frame_header</span></span><a class="headerlink" href="#ammosreader.AmmosSingleFrame.AmmosSingleFrame.global_frame_header" title="Permalink to this definition">¶</a></dt>
493<dd></dd></dl>
494
[ada37fa]495<dl class="py method">
496<dt class="sig sig-object py" id="ammosreader.AmmosSingleFrame.AmmosSingleFrame.size_correct">
497<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>
498<dd></dd></dl>
499
500</dd></dl>
501
502</section>
[8413944]503<section id="module-ammosreader.IQDWTXBlock">
504<span id="ammosreader-iqdwtxblock-module"></span><h2>ammosreader.IQDWTXBlock module<a class="headerlink" href="#module-ammosreader.IQDWTXBlock" title="Permalink to this headline">¶</a></h2>
505<dl class="py class">
506<dt class="sig sig-object py" id="ammosreader.IQDWTXBlock.IQDWTXBLOCK">
507<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>
508<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
509<dl class="py method">
510<dt class="sig sig-object py" id="ammosreader.IQDWTXBlock.IQDWTXBLOCK.from_bytes">
511<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>
512<dd></dd></dl>
513
514</dd></dl>
515
[ada37fa]516</section>
517<section id="module-ammosreader.PDW">
518<span id="ammosreader-pdw-module"></span><h2>ammosreader.PDW module<a class="headerlink" href="#module-ammosreader.PDW" title="Permalink to this headline">¶</a></h2>
[299c79c]519<p>I store the information of a single PDW block.</p>
[ada37fa]520<dl class="py class">
521<dt class="sig sig-object py" id="ammosreader.PDW.PDW">
[5547430]522<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]523<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
524<p>I store information from a single ppdw data block.</p>
525<dl class="py method">
526<dt class="sig sig-object py" id="ammosreader.PDW.PDW.__init__">
527<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>
[299c79c]528<dd><p>I return an instance of an Pulse Data word.</p>
529<dl class="field-list simple">
[ada37fa]530<dt class="field-odd">Parameters</dt>
531<dd class="field-odd"><ul class="simple">
532<li><p><strong>time_of_arrival</strong> (<em>Integer</em>) – nanoseconds since 1970-01-01 00:00:00</p></li>
533<li><p><strong>pdw_format</strong> (<em>Integer</em>) – format code</p></li>
534<li><p><strong>center_frequency</strong> (<em>Integer</em>) – center frequency in KHz</p></li>
535<li><p><strong>is_valid</strong> (<em>Boolean</em>) – flag to mark if pdw data body is valid</p></li>
536<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>
537<li><p><strong>level_unit</strong> (<em>Integer</em>) – 0 means dBµV - 1 means dBµV/m</p></li>
538<li><p><strong>signal_start_missing</strong> (<em>Boolean</em>) – signal started before time of arrival</p></li>
539<li><p><strong>signal_end_missing</strong> (<em>Boolean</em>) – signal stops after time of arrival</p></li>
540<li><p><strong>pulse_width</strong> (<em>Integer</em>) – pulse width in nanoseconds - Zero if no valid pulse detected</p></li>
541<li><p><strong>frequency_shift_or_bandwidth</strong> (<em>Integer</em>) – Value in KHz - Value set to 1048575 means Unknown</p></li>
[299c79c]542<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>
[ada37fa]543<li><p><strong>region_of_interest</strong> (<em>Boolean</em>) – Marks if signal is from region of interest</p></li>
544<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>
545<li><p><strong>modulation</strong> (<em>String</em>) – type of modulation (e.g. PSK-2, PSK-4, FM etc.)</p></li>
546<li><p><strong>sector</strong> (<em>Integer</em>) – reference antenna sector (0-15)</p></li>
547<li><p><strong>polarity</strong> (<em>String</em>) – Horizontal, Vertical, Clockwise, Counter clockwise</p></li>
548<li><p><strong>df_quality</strong> (<em>Integer</em>) – Direction finding quality in percent (0-100) - Zero means unknown</p></li>
[299c79c]549<li><p><strong>elevation</strong> – elevation of incoming signal (from -90 to 90 degree) in steps of 0.1 degree </p></li>
[ada37fa]550</ul>
551</dd>
552</dl>
[299c79c]553<p>minus 102.4 means unknown
554:type elevation: Float
555:param azimuth: azimuth of incoming signal (from 0 to 359.9 degree) in steps of 0.1 degree plus 409.5 means unknown
556:type azimuth: Float
557:param channel: detecting channel (0-16) - Zero means unknown
558:type channel: Integer
559:return: An instance of class PDW with attributes set according to the data of a data body
560:rtype: PDW</p>
[ada37fa]561</dd></dl>
562
563<dl class="py method">
564<dt class="sig sig-object py" id="ammosreader.PDW.PDW.from_bytes">
[5547430]565<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>
[299c79c]566<dd><p>I create an instance of class PDW from data body (8 * 32 bits).</p>
[ada37fa]567<dl class="field-list simple">
568<dt class="field-odd">Parameters</dt>
569<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>
570</dd>
571<dt class="field-even">Returns</dt>
572<dd class="field-even"><p>an instance of class PDW with attributes set according to the data of a data body</p>
573</dd>
574<dt class="field-odd">Return type</dt>
575<dd class="field-odd"><p><a class="reference internal" href="#ammosreader.PDW.PDW" title="ammosreader.PDW.PDW">PDW</a></p>
576</dd>
577</dl>
578</dd></dl>
579
[299c79c]580<dl class="py method">
581<dt class="sig sig-object py" id="ammosreader.PDW.PDW.to_json">
582<span class="sig-name descname"><span class="pre">to_json</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/PDW.html#PDW.to_json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.PDW.PDW.to_json" title="Permalink to this definition">¶</a></dt>
583<dd></dd></dl>
584
[ada37fa]585</dd></dl>
586
587</section>
588<section id="module-ammosreader.PPDWContainer">
589<span id="ammosreader-ppdwcontainer-module"></span><h2>ammosreader.PPDWContainer module<a class="headerlink" href="#module-ammosreader.PPDWContainer" title="Permalink to this headline">¶</a></h2>
590<dl class="py class">
591<dt class="sig sig-object py" id="ammosreader.PPDWContainer.PPDWContainer">
[299c79c]592<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">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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]593<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
[299c79c]594<p>I store multiple signals imported from one or more .ppdw files
595.. automethod:: __init__</p>
596<dl class="py method">
597<dt class="sig sig-object py" id="ammosreader.PPDWContainer.PPDWContainer.add">
598<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">a_pdw</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/PPDWContainer.html#PPDWContainer.add"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.PPDWContainer.PPDWContainer.add" title="Permalink to this definition">¶</a></dt>
599<dd></dd></dl>
600
601<dl class="py method">
602<dt class="sig sig-object py" id="ammosreader.PPDWContainer.PPDWContainer.bandwidths">
603<span class="sig-name descname"><span class="pre">bandwidths</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/PPDWContainer.html#PPDWContainer.bandwidths"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.PPDWContainer.PPDWContainer.bandwidths" title="Permalink to this definition">¶</a></dt>
604<dd></dd></dl>
605
606<dl class="py method">
607<dt class="sig sig-object py" id="ammosreader.PPDWContainer.PPDWContainer.center_frequencies">
608<span class="sig-name descname"><span class="pre">center_frequencies</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/PPDWContainer.html#PPDWContainer.center_frequencies"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.PPDWContainer.PPDWContainer.center_frequencies" title="Permalink to this definition">¶</a></dt>
609<dd></dd></dl>
610
611<dl class="py method">
612<dt class="sig sig-object py" id="ammosreader.PPDWContainer.PPDWContainer.channels">
613<span class="sig-name descname"><span class="pre">channels</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/PPDWContainer.html#PPDWContainer.channels"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.PPDWContainer.PPDWContainer.channels" title="Permalink to this definition">¶</a></dt>
614<dd></dd></dl>
615
616<dl class="py method">
617<dt class="sig sig-object py" id="ammosreader.PPDWContainer.PPDWContainer.end_time">
618<span class="sig-name descname"><span class="pre">end_time</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/PPDWContainer.html#PPDWContainer.end_time"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.PPDWContainer.PPDWContainer.end_time" title="Permalink to this definition">¶</a></dt>
619<dd></dd></dl>
620
621<dl class="py method">
622<dt class="sig sig-object py" id="ammosreader.PPDWContainer.PPDWContainer.julian_date_string">
623<span class="sig-name descname"><span class="pre">julian_date_string</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/PPDWContainer.html#PPDWContainer.julian_date_string"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.PPDWContainer.PPDWContainer.julian_date_string" title="Permalink to this definition">¶</a></dt>
624<dd></dd></dl>
625
626<dl class="py method">
627<dt class="sig sig-object py" id="ammosreader.PPDWContainer.PPDWContainer.modulations">
628<span class="sig-name descname"><span class="pre">modulations</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/PPDWContainer.html#PPDWContainer.modulations"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.PPDWContainer.PPDWContainer.modulations" title="Permalink to this definition">¶</a></dt>
629<dd></dd></dl>
630
631<dl class="py method">
632<dt class="sig sig-object py" id="ammosreader.PPDWContainer.PPDWContainer.start_time">
633<span class="sig-name descname"><span class="pre">start_time</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/PPDWContainer.html#PPDWContainer.start_time"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.PPDWContainer.PPDWContainer.start_time" title="Permalink to this definition">¶</a></dt>
634<dd></dd></dl>
635
[ada37fa]636<dl class="py method">
[299c79c]637<dt class="sig sig-object py" id="ammosreader.PPDWContainer.PPDWContainer.to_json">
638<span class="sig-name descname"><span class="pre">to_json</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ammosreader/PPDWContainer.html#PPDWContainer.to_json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ammosreader.PPDWContainer.PPDWContainer.to_json" title="Permalink to this definition">¶</a></dt>
[ada37fa]639<dd></dd></dl>
640
641</dd></dl>
642
643</section>
644<section id="module-ammosreader">
645<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-ammosreader" title="Permalink to this headline">¶</a></h2>
646</section>
647</section>
648
649
[5547430]650 </div>
[ada37fa]651 </div>
652 </div>
[5547430]653 <div class="footer">
654 <p>
655 &copy; Copyright 2022, KIDZg.
[299c79c]656 Created using <a href="http://www.sphinx-doc.org/">Sphinx</a> 4.5.0 <a href="https://github.com/mga-sphinx/sphinx_adc_theme">ADC Theme</a> .
[5547430]657 (Revision )
658 </p>
[ada37fa]659 </div>
660 <div class="clearer"></div>
661 </div>
[5547430]662 <div id="breadcrumbs">
663 ammosreader package
664 </div>
665 <script type="text/javascript" charset="utf-8" src="_static/js/toc.js"></script>
[ada37fa]666 </body>
667</html>
Note: See TracBrowser for help on using the repository browser.