-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathudpdetspec.html
434 lines (414 loc) · 17.1 KB
/
udpdetspec.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Detector Specific Fields — slsDetectorPackage documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="_static/css/extra.css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Receivers" href="receivers.html" />
<link rel="prev" title="Config file" href="udpconfig.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
slsDetectorPackage
</a>
<div class="version">
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Installation:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="consuming.html">Consuming slsDetectorPackage</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">C++ API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="detector.html">Detector</a></li>
<li class="toctree-l1"><a class="reference internal" href="result.html">Result</a></li>
<li class="toctree-l1"><a class="reference internal" href="receiver_api.html">Receiver</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Python API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="pygettingstarted.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="pydetector.html">Detector</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyenums.html">Enums</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyexamples.html">Examples</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Command line</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="commandline.html">Command line interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">Quick Start Guide</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="container_utils.html">ContainerUtils</a></li>
<li class="toctree-l1"><a class="reference internal" href="type_traits.html">TypeTraits</a></li>
<li class="toctree-l1"><a class="reference internal" href="ToString.html">ToString</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Firmware</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="firmware.html">Firmware Upgrade</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Detector Server</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="servers.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="serverupgrade.html">Upgrade</a></li>
<li class="toctree-l1"><a class="reference internal" href="virtualserver.html">Simulators</a></li>
<li class="toctree-l1"><a class="reference internal" href="serverdefaults.html">Default Values</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Detector UDP Header</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="udpheader.html">Format</a></li>
<li class="toctree-l1"><a class="reference internal" href="udpconfig.html">Config file</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Detector Specific Fields</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#eiger">Eiger</a></li>
<li class="toctree-l2"><a class="reference internal" href="#jungfrau">Jungfrau</a></li>
<li class="toctree-l2"><a class="reference internal" href="#gotthard2">Gotthard2</a></li>
<li class="toctree-l2"><a class="reference internal" href="#mythen3">Mythen3</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Receiver</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="receivers.html">Receivers</a></li>
<li class="toctree-l1"><a class="reference internal" href="slsreceiver.html">slsReceiver/ slsMultiReceiver</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Receiver Files</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="fileformat.html">File format</a></li>
<li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
<li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryfileformat.html">Binary File Format</a></li>
<li class="toctree-l1"><a class="reference internal" href="hdf5fileformat.html">HDF5 File Format</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Receiver ZMQ Stream</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="zmqjsonheaderformat.html">ZMQ: Json Header Format</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Troubleshooting</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">slsDetectorPackage</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Detector Specific Fields</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/udpdetspec.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="detector-specific-fields">
<span id="id1"></span><h1>Detector Specific Fields<a class="headerlink" href="#detector-specific-fields" title="Permalink to this heading"></a></h1>
<p>Please check out <a class="reference internal" href="udpheader.html#detector-udp-header"><span class="std std-ref">the current detector header</span></a> to see
where the detector specific fields are placed.</p>
<section id="eiger">
<h2>Eiger<a class="headerlink" href="#eiger" title="Permalink to this heading"></a></h2>
<table class="docutils align-default" id="id8">
<caption><span class="caption-text">Detector Specific Field</span><a class="headerlink" href="#id8" title="Permalink to this table"></a></caption>
<colgroup>
<col style="width: 25%" />
<col style="width: 75%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>expLength</p></td>
<td><p>Sub Frame Number</p></td>
</tr>
<tr class="row-even"><td><p>detSpec1</p></td>
<td><p>0x0</p></td>
</tr>
<tr class="row-odd"><td><p>detSpec2</p></td>
<td><p>0x0</p></td>
</tr>
<tr class="row-even"><td><p>detSpec3</p></td>
<td><p>e14a</p></td>
</tr>
<tr class="row-odd"><td><p>detSpec4</p></td>
<td><p>Round Robin Interface Number</p></td>
</tr>
</tbody>
</table>
</section>
<section id="jungfrau">
<h2>Jungfrau<a class="headerlink" href="#jungfrau" title="Permalink to this heading"></a></h2>
<table class="docutils align-default" id="id9">
<caption><span class="caption-text">Detector Specific Field</span><a class="headerlink" href="#id9" title="Permalink to this table"></a></caption>
<colgroup>
<col style="width: 25%" />
<col style="width: 75%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>detSpec1</p></td>
<td><p>Bunch Id <a class="footnote-reference brackets" href="#id5" id="id2">1</a></p></td>
</tr>
<tr class="row-even"><td><p>detSpec2</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-odd"><td><p>detSpec3</p></td>
<td><p>DAQ info</p></td>
</tr>
<tr class="row-even"><td><p>detSpec4</p></td>
<td><p>0</p></td>
</tr>
</tbody>
</table>
<table class="docutils align-default" id="id10">
<caption><span class="caption-text">DAQ Info Field</span><a class="headerlink" href="#id10" title="Permalink to this table"></a></caption>
<colgroup>
<col style="width: 14%" />
<col style="width: 27%" />
<col style="width: 7%" />
<col style="width: 7%" />
<col style="width: 7%" />
<col style="width: 38%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>Bits</p></td>
<td><p>Name</p></td>
<td colspan="4"><p>Description</p></td>
</tr>
<tr class="row-even"><td rowspan="2"><p>0</p></td>
<td rowspan="2"><p>High gain</p></td>
<td><p>1</p></td>
<td colspan="3"><p>High Gain enabled</p></td>
</tr>
<tr class="row-odd"><td><p>0</p></td>
<td colspan="3"><p>High Gain disabled</p></td>
</tr>
<tr class="row-even"><td rowspan="2"><p>1</p></td>
<td rowspan="2"><p>Fix gain stage 1</p></td>
<td><p>1</p></td>
<td colspan="3"><p>Gain stage 1 fixed. The switch that
selects the gains stage 1 is active all
the time.</p></td>
</tr>
<tr class="row-odd"><td><p>0</p></td>
<td colspan="3"><p>Gain stage 1 unset. The switch that
selects the gains stage 1 is inactive
all the time.</p></td>
</tr>
<tr class="row-even"><td rowspan="2"><p>2</p></td>
<td rowspan="2"><p>Fix gain stage 2</p></td>
<td><p>1</p></td>
<td colspan="3"><p>Gain stage 2 fixed. The switch that
selects the gains stage 2 is active all
the time.</p></td>
</tr>
<tr class="row-odd"><td><p>0</p></td>
<td colspan="3"><p>Gain stage 2 unset. The switch that
selects the gains stage 2 is inactive
all the time.</p></td>
</tr>
<tr class="row-even"><td rowspan="2"><p>4</p></td>
<td rowspan="2"><p>Comparator reset</p></td>
<td><p>1</p></td>
<td colspan="3"><p>On-chip comparator in reset state.
Dynamic-gain switching is therefore
disabled.</p></td>
</tr>
<tr class="row-odd"><td><p>0</p></td>
<td colspan="3"><p>On-chip comparator active.</p></td>
</tr>
<tr class="row-even"><td rowspan="5"><p>7-5</p></td>
<td rowspan="5"><p>Jungfrau chip
version</p></td>
<td><p>Bit 7</p></td>
<td><p>Bit 6</p></td>
<td><p>Bit 5</p></td>
<td><p>Description</p></td>
</tr>
<tr class="row-odd"><td><p>0</p></td>
<td><p>0</p></td>
<td><p>0</p></td>
<td><p>v1.0</p></td>
</tr>
<tr class="row-even"><td><p>0</p></td>
<td><p>0</p></td>
<td><p>1</p></td>
<td><p>v1.1</p></td>
</tr>
<tr class="row-odd"><td><p>0</p></td>
<td><p>1</p></td>
<td><p>X</p></td>
<td><p>Reserved</p></td>
</tr>
<tr class="row-even"><td><p>1</p></td>
<td><p>X</p></td>
<td><p>X</p></td>
<td><p>Reserved</p></td>
</tr>
<tr class="row-odd"><td><p>11-8</p></td>
<td><p>Storage cell select</p></td>
<td colspan="4"><p>Storage cell used for this exposure. This
field defines the storage cell that was used
to acquire the data of this frame</p></td>
</tr>
<tr class="row-even"><td rowspan="2"><p>12</p></td>
<td rowspan="2"><p>Force switching
to gain stage 1</p></td>
<td><p>1</p></td>
<td colspan="3"><p>Forced switching to gain stage 1 at the
start of the exposure period.</p></td>
</tr>
<tr class="row-odd"><td><p>0</p></td>
<td colspan="3"><p>Disabled forced gain switching to gain
stage 1. Dynamic gain switching
conditions apply.</p></td>
</tr>
<tr class="row-even"><td rowspan="2"><p>13</p></td>
<td rowspan="2"><p>Force switching
to gain stage 2</p></td>
<td><p>1</p></td>
<td colspan="3"><p>Forced switching to gain stage 2 at the
start of the exposure period.</p></td>
</tr>
<tr class="row-odd"><td><p>0</p></td>
<td colspan="3"><p>Disabled forced gain switching to gain
stage 2. Dynamic gain switching
conditions apply.</p></td>
</tr>
<tr class="row-even"><td><p>23-16</p></td>
<td><p>10-Gigabit event
code</p></td>
<td colspan="4"><p>The 8-bit event code contains value of the
event received over the 10 GbE interface by
JUNGFRAU detector at the moment of the frame
acquisition.</p></td>
</tr>
<tr class="row-odd"><td rowspan="2"><p>31</p></td>
<td rowspan="2"><p>External input flag</p></td>
<td><p>1</p></td>
<td colspan="3"><p>External input flag detected in the
last exposure.</p></td>
</tr>
<tr class="row-even"><td><p>0</p></td>
<td colspan="3"><p>External input flag not detected in the
last exposure.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="gotthard2">
<h2>Gotthard2<a class="headerlink" href="#gotthard2" title="Permalink to this heading"></a></h2>
<table class="docutils align-default" id="id11">
<caption><span class="caption-text">Detector Specific Field</span><a class="headerlink" href="#id11" title="Permalink to this table"></a></caption>
<colgroup>
<col style="width: 25%" />
<col style="width: 75%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>detSpec1</p></td>
<td><p>Train Id <a class="footnote-reference brackets" href="#id6" id="id3">2</a></p></td>
</tr>
<tr class="row-even"><td><p>detSpec2</p></td>
<td><p>Bunch Id <a class="footnote-reference brackets" href="#id7" id="id4">3</a></p></td>
</tr>
<tr class="row-odd"><td><p>detSpec3</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-even"><td><p>detSpec4</p></td>
<td><p>0</p></td>
</tr>
</tbody>
</table>
</section>
<section id="mythen3">
<h2>Mythen3<a class="headerlink" href="#mythen3" title="Permalink to this heading"></a></h2>
<table class="docutils align-default" id="id12">
<caption><span class="caption-text">Detector Specific Field</span><a class="headerlink" href="#id12" title="Permalink to this table"></a></caption>
<colgroup>
<col style="width: 25%" />
<col style="width: 75%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>detSpec1</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-even"><td><p>detSpec2</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-odd"><td><p>detSpec3</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-even"><td><p>detSpec4</p></td>
<td><p>0</p></td>
</tr>
</tbody>
</table>
<dl class="footnote brackets">
<dt class="label" id="id5"><span class="brackets"><a class="fn-backref" href="#id2">1</a></span></dt>
<dd><p><strong>Bunch Id</strong>: bunch identification number received by the detector at the moment of frame acquisition.</p>
</dd>
<dt class="label" id="id6"><span class="brackets"><a class="fn-backref" href="#id3">2</a></span></dt>
<dd><p><strong>Train Id</strong>: train identification number received by the detector at the moment of frame acquisition.</p>
</dd>
<dt class="label" id="id7"><span class="brackets"><a class="fn-backref" href="#id4">3</a></span></dt>
<dd><p><strong>Bunch Id</strong>: bunch identification number to identify every single exposure during a burst acquisition.</p>
</dd>
</dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="udpconfig.html" class="btn btn-neutral float-left" title="Config file" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="receivers.html" class="btn btn-neutral float-right" title="Receivers" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2020, PSD Detector Group.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>