-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcommandline.html
2207 lines (2183 loc) · 142 KB
/
commandline.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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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>Command line interface — 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="Quick Start Guide" href="quick_start_guide.html" />
<link rel="prev" title="Examples" href="pyexamples.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 class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Command line interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="#help">Help</a></li>
<li class="toctree-l2"><a class="reference internal" href="#commands">Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="#deprecated-commands">Deprecated commands</a></li>
</ul>
</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>
<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"><a class="reference internal" href="udpdetspec.html">Detector Specific Fields</a></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">Command line interface</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/commandline.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="command-line-interface">
<h1>Command line interface<a class="headerlink" href="#command-line-interface" title="Permalink to this heading"></a></h1>
<section id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this heading"></a></h2>
<p>Commands can be used either with sls_detector_get or sls_detector_put</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sls_detector_get</span> <span class="n">exptime</span>
</pre></div>
</div>
</section>
<section id="help">
<h2>Help<a class="headerlink" href="#help" title="Permalink to this heading"></a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># get list of commands</span>
<span class="n">sls_detector_get</span> <span class="nb">list</span>
<span class="c1"># search for a particular command using a word</span>
<span class="n">sls_detector_get</span> <span class="nb">list</span> <span class="o">|</span> <span class="n">grep</span> <span class="n">adc</span>
<span class="c1"># get help for a particular command</span>
<span class="n">sls_detector_get</span> <span class="o">-</span><span class="n">h</span> <span class="n">fpath</span>
<span class="n">sls_detector_help</span> <span class="n">fpath</span>
<span class="c1"># list of deprecated commands</span>
<span class="nb">list</span> <span class="n">deprecated</span>
<span class="c1"># autocompletion</span>
<span class="c1"># bash_autocomplete.sh or zsh_autocomplete.sh must be sourced from the</span>
<span class="c1"># main package folder to enable auto completion of commands and arguments</span>
<span class="c1"># for the command line on that shell.</span>
<span class="n">source</span> <span class="n">bash_autocomplete</span><span class="o">.</span><span class="n">sh</span>
</pre></div>
</div>
</section>
<section id="commands">
<h2>Commands<a class="headerlink" href="#commands" title="Permalink to this heading"></a></h2>
<dl class="glossary">
<dt id="term-acquire">acquire<a class="headerlink" href="#term-acquire" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Acquire the number of frames set up.</div>
<div class="line">Blocking command, where control server is blocked and cannot accept other commands until acquisition is done.</div>
<div class="line">- sets acquiring flag</div>
<div class="line">- starts the receiver listener (if enabled)</div>
<div class="line">- starts detector acquisition for number of frames set</div>
<div class="line">- monitors detector status from running to idle</div>
<div class="line">- stops the receiver listener (if enabled)</div>
<div class="line">- increments file index if file write enabled</div>
<div class="line">- resets acquiring flag</div>
</div>
</dd>
<dt id="term-activate-0-1">activate [0, 1]<a class="headerlink" href="#term-activate-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger] 1 is default. 0 deactivates readout and does not send data.</div>
</div>
</dd>
<dt id="term-adcclk-n_clk-in-MHz">adcclk [n_clk in MHz]<a class="headerlink" href="#term-adcclk-n_clk-in-MHz" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] ADC clock frequency in MHz.</div>
</div>
</dd>
<dt id="term-adcenable-bitmask">adcenable [bitmask]<a class="headerlink" href="#term-adcenable-bitmask" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] ADC Enable Mask for 1Gb Enable for each 32 ADC channel.</div>
</div>
</dd>
<dt id="term-adcenable10g-bitmask">adcenable10g [bitmask]<a class="headerlink" href="#term-adcenable10g-bitmask" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] ADC Enable Mask for 10Gb mode for each 32 ADC channel. However, if any of a consecutive 4 bits are enabled, the complete 4 bits are enabled.</div>
</div>
</dd>
<dt id="term-adcindex-name">adcindex [name]<a class="headerlink" href="#term-adcindex-name" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Xilinx_Ctb] Get the adc index for the given name.</div>
</div>
</dd>
<dt id="term-adcinvert-bitmask">adcinvert [bitmask]<a class="headerlink" href="#term-adcinvert-bitmask" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Jungfrau][Moench] ADC Inversion Mask.</div>
<div class="line">[Jungfrau][Moench] Inversions on top of the default mask.</div>
</div>
</dd>
<dt id="term-adclist-adcname1-adcname2-..-adcname32">adclist [adcname1 adcname2 .. adcname32]<a class="headerlink" href="#term-adclist-adcname1-adcname2-..-adcname32" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Xilinx_Ctb] Set the list of adc names for this board.</div>
</div>
</dd>
<dt id="term-adcname-0-31-name">adcname [0-31][name]<a class="headerlink" href="#term-adcname-0-31-name" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Xilinx_Ctb] Set the adc at the given position to the given name.</div>
</div>
</dd>
<dt id="term-adcphase-n_value-optional-deg">adcphase [n_value] [(optional)deg]<a class="headerlink" href="#term-adcphase-n_value-optional-deg" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau][Moench][Ctb][Gotthard] Phase shift of ADC clock.</div>
<div class="line">[Jungfrau][Moench] Absolute phase shift. If deg used, then shift in degrees. Changing Speed also resets adcphase to recommended defaults.</div>
<div class="line">[Ctb] Absolute phase shift. If deg used, then shift in degrees. Changing adcclk also resets adcphase and sets it to previous values.</div>
<div class="line">[Gotthard] Relative phase shift. Cannot get</div>
</div>
</dd>
<dt id="term-adcpipeline-n_value">adcpipeline [n_value]<a class="headerlink" href="#term-adcpipeline-n_value" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Moench] Pipeline for ADC clock.</div>
</div>
</dd>
<dt id="term-adcreg-address-value">adcreg [address] [value]<a class="headerlink" href="#term-adcreg-address-value" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau][Moench][Ctb][Gotthard] Writes to an adc register in hex. Advanced user Function!</div>
</div>
</dd>
<dt id="term-adcvpp-dac-or-mV-value-optional-unit-mV">adcvpp [dac or mV value][(optional unit) mV]<a class="headerlink" href="#term-adcvpp-dac-or-mV-value-optional-unit-mV" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] Vpp of ADC.</div>
<div class="line-block">
<div class="line">0 -> 1V ; 1 -> 1.14V ; 2 -> 1.33V ; 3 -> 1.6V ; 4 -> 2V.</div>
</div>
<div class="line">Advanced User function!</div>
</div>
</dd>
<dt id="term-apulse-0-1">apulse [0, 1]<a class="headerlink" href="#term-apulse-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] Enables or disables analog pulsing. Default is disabled</div>
</div>
</dd>
<dt id="term-asamples-n_samples">asamples [n_samples]<a class="headerlink" href="#term-asamples-n_samples" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] Number of analog samples expected.</div>
</div>
</dd>
<dt id="term-autocompdisable-0-1">autocompdisable [0, 1]<a class="headerlink" href="#term-autocompdisable-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau] Auto comparator disable mode. By default, the on-chip gain switching is active during the entire exposure.This mode disables the on - chip gain switching comparator automatically after 93.75% (only for chipv1.0) of exposure time (only for longer than 100us). It is possible to set the duration for chipv1.1 using compdisabletime command.</div>
<div class="line">Default is 0 or this mode disabled(comparator enabled throughout). 1 enables mode. 0 disables mode.</div>
</div>
</dd>
<dt id="term-badchannels-fname-none-0">badchannels [fname|none|0]<a class="headerlink" href="#term-badchannels-fname-none-0" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard2][Mythen3] Sets the bad channels (from file of bad channel numbers) to be masked out. None or 0 unsets all the badchannels.</div>
<div class="line">[Mythen3] Also does trimming</div>
</div>
</dd>
<dt id="term-blockingtrigger">blockingtrigger<a class="headerlink" href="#term-blockingtrigger" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger][Jungfrau][Moench] Sends software trigger signal to detector and blocks till the frames are sent out for that trigger.</div>
</div>
</dd>
<dt id="term-burstmode-burst_internal-or-0-burst_external-or-1-cw_internal-or-2-cw_external-or-3">burstmode [burst_internal or 0, burst_external or 1, cw_internal or 2, cw_external or 3]<a class="headerlink" href="#term-burstmode-burst_internal-or-0-burst_external-or-1-cw_internal-or-2-cw_external-or-3" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard2] Default is burst_internal type. Also changes clkdiv 2, 3, 4</div>
</div>
</dd>
<dt id="term-burstperiod-duration-optional-unit-ns-us-ms-s">burstperiod [duration] [(optional unit) ns|us|ms|s]<a class="headerlink" href="#term-burstperiod-duration-optional-unit-ns-us-ms-s" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard2] Period between 2 bursts. Only in burst mode and auto timing mode.</div>
</div>
</dd>
<dt id="term-bursts-n_bursts">bursts [n_bursts]<a class="headerlink" href="#term-bursts-n_bursts" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard2] Number of bursts per aquire. Only in auto timing mode and burst mode. Use timing command to set timing mode and burstmode command to set burst mode.</div>
</div>
</dd>
<dt id="term-burstsl">burstsl<a class="headerlink" href="#term-burstsl" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard2] Number of bursts left in acquisition. Only in burst auto mode.</div>
</div>
</dd>
<dt id="term-bustest">bustest<a class="headerlink" href="#term-bustest" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau][Moench][Gotthard][Mythen3][Gotthard2][Ctb] Bus test, ie. Writes different values in a R/W register and confirms the writes to check bus.</div>
<div class="line">Advanced User function!</div>
</div>
</dd>
<dt id="term-cdsgain-0-1">cdsgain [0, 1]<a class="headerlink" href="#term-cdsgain-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard2] Enable or disable CDS gain. Default is disabled.</div>
</div>
</dd>
<dt id="term-chipversion">chipversion<a class="headerlink" href="#term-chipversion" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau] Returns chip version. Can be 1.0 or 1.1</div>
</div>
</dd>
<dt id="term-clearbit-reg-address-in-hex-bit-index">clearbit [reg address in hex] [bit index]<a class="headerlink" href="#term-clearbit-reg-address-in-hex-bit-index" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Clears bit in address.</div>
<div class="line">Use –validate to force validation.</div>
</div>
</dd>
<dt id="term-clearbusy">clearbusy<a class="headerlink" href="#term-clearbusy" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">If acquisition aborted during acquire command, use this to clear acquiring flag in shared memory before starting next acquisition</div>
</div>
</dd>
<dt id="term-clearroi">clearroi<a class="headerlink" href="#term-clearroi" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard] Resets Region of interest in detector. All channels enabled. Default is all channels enabled.</div>
</div>
</dd>
<dt id="term-clientversion">clientversion<a class="headerlink" href="#term-clientversion" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Client software version</div>
</div>
</dd>
<dt id="term-clkdiv-n_clock-n_divider">clkdiv [n_clock] [n_divider]<a class="headerlink" href="#term-clkdiv-n_clock-n_divider" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard2][Mythen3] Clock Divider of clock n_clock. Must be greater than 1.</div>
<div class="line">[Gotthard2] Clock index range: 0-5</div>
<div class="line">[Mythen3] Clock index range: 0</div>
</div>
</dd>
<dt id="term-clkfreq-n_clock-freq_in_Hz">clkfreq [n_clock] [freq_in_Hz]<a class="headerlink" href="#term-clkfreq-n_clock-freq_in_Hz" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard2][Mythen3] Frequency of clock n_clock in Hz. Use clkdiv to set frequency.</div>
<div class="line">[Gotthard2] Clock index range: 0-5</div>
<div class="line">[Mythen3] Clock index range: 0</div>
</div>
</dd>
<dt id="term-clkphase-n_clock-phase-deg-optional">clkphase [n_clock] [phase] [deg (optional)]<a class="headerlink" href="#term-clkphase-n_clock-phase-deg-optional" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard2][Mythen3] Phase of clock n_clock. If deg, then phase shift in degrees, else absolute phase shift values.n [Gotthard2] Clock index range: 0-5</div>
<div class="line">[Mythen3] Clock index range: 0</div>
</div>
</dd>
<dt id="term-collectionmode-hole-electron">collectionmode [hole|electron]<a class="headerlink" href="#term-collectionmode-hole-electron" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau] Sets collection mode to hole or electron. Default is hole.</div>
</div>
</dd>
<dt id="term-column-value">column [value]<a class="headerlink" href="#term-column-value" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Set Detector column (udp header) to value.</div>
<div class="line">Gui uses it to rearrange for complete image</div>
</div>
</dd>
<dt id="term-compdisabletime-duration-optional-unit-ns-us-ms-s">compdisabletime [duration] [(optional unit) ns|us|ms|s]<a class="headerlink" href="#term-compdisabletime-duration-optional-unit-ns-us-ms-s" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau] Time before end of exposure when comparator is disabled. It is only possible for chipv1.1.</div>
</div>
</dd>
<dt id="term-confadc-chip-index-0-9-1-for-all-adc-index-0-31-1-for-all-7-bit-configuration-value-in-hex">confadc [chip index 0-9, -1 for all] [adc index 0-31, -1 for all] [7 bit configuration value in hex]<a class="headerlink" href="#term-confadc-chip-index-0-9-1-for-all-adc-index-0-31-1-for-all-7-bit-configuration-value-in-hex" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard2] Sets configuration for specific chip and adc, but configures 1 chip (all adcs for that chip) at a time.</div>
</div>
</dd>
<dt id="term-config">config<a class="headerlink" href="#term-config" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Frees shared memory before loading configuration file. Set up once.</div>
</div>
</dd>
<dt id="term-configtransceiver">configtransceiver<a class="headerlink" href="#term-configtransceiver" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Xilinx Ctb] Waits for transceiver to be aligned. Chip had to be configured (powered on) before this.</div>
</div>
</dd>
<dt id="term-counters-i0-i1-i2-...">counters [i0] [i1] [i2]…<a class="headerlink" href="#term-counters-i0-i1-i2-..." title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] List of counters indices enabled. Each element in list can be 0 - 2 and must be non repetitive. Enabling counters sets vth dacs to remembered values and disabling sets them to disabled values.</div>
</div>
</dd>
<dt id="term-currentsource">currentsource<a class="headerlink" href="#term-currentsource" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[0|1]</div>
<div class="line-block">
<div class="line">[Gotthard2] Enable or disable current source. Default is disabled.</div>
</div>
<div class="line">[0|1] [fix|nofix] [select source] [(only for chipv1.1)normal|low]</div>
<div class="line-block">
<div class="line">[Jungfrau] Disable or enable current source with some parameters. The select source is 0-63 for chipv1.0 and a 64 bit mask for chipv1.1. To disable, one needs only one argument ‘0’.</div>
</div>
</div>
</dd>
<dt id="term-dac-dac-dac-name-dac-or-mV-value-optional-unit-mV">dac dac [dac name] [dac or mV value] [(optional unit) mV]<a class="headerlink" href="#term-dac-dac-dac-name-dac-or-mV-value-optional-unit-mV" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] Use dac index for dac name.</div>
</div>
</dd>
<dt id="term-dacindex-name">dacindex [name]<a class="headerlink" href="#term-dacindex-name" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Xilinx_Ctb] Get the dac index for the given name.</div>
</div>
</dd>
<dt id="term-daclist-dacname1-dacname2-..-dacname18">daclist [dacname1 dacname2 .. dacname18]<a class="headerlink" href="#term-daclist-dacname1-dacname2-..-dacname18" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Xilinx_Ctb] Set the list of dac names for this detector.</div>
<div class="line">[All] Gets the list of dac names for every dac for this detector.</div>
</div>
</dd>
<dt id="term-dacname-0-17-name">dacname [0-17][name]<a class="headerlink" href="#term-dacname-0-17-name" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Xilinx_Ctb] Set the dac at the given position to the given name.</div>
</div>
</dd>
<dt id="term-dacvalues-optional-unit-mV">dacvalues [(optional unit) mV]<a class="headerlink" href="#term-dacvalues-optional-unit-mV" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Gets the values for every dac for this detector.</div>
</div>
</dd>
<dt id="term-datastream-left-right-0-1">datastream [left|right] [0, 1]<a class="headerlink" href="#term-datastream-left-right-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger] Enables or disables data streaming from left or/and right side of detector for 10 GbE mode. 1 (enabled) by default.</div>
</div>
</dd>
<dt id="term-dbitclk-n_clk-in-MHz">dbitclk [n_clk in MHz]<a class="headerlink" href="#term-dbitclk-n_clk-in-MHz" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] Clock for latching the digital bits in MHz.</div>
</div>
</dd>
<dt id="term-dbitphase-n_value-optional-deg">dbitphase [n_value] [(optional)deg]<a class="headerlink" href="#term-dbitphase-n_value-optional-deg" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Jungfrau] Phase shift of clock to latch digital bits. Absolute phase shift. If deg used, then shift in degrees.</div>
<div class="line">[Ctb]Changing dbitclk also resets dbitphase and sets to previous values.</div>
</div>
</dd>
<dt id="term-dbitpipeline-n_value">dbitpipeline [n_value]<a class="headerlink" href="#term-dbitpipeline-n_value" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Gotthard2] Pipeline of the clock for latching digital bits.</div>
<div class="line">[Gotthard2] Options: 0-7</div>
<div class="line">[Ctb] Options: 0-255</div>
</div>
</dd>
<dt id="term-defaultdac-dac-name-value-optional-setting">defaultdac [dac name][value][(optional)setting]<a class="headerlink" href="#term-defaultdac-dac-name-value-optional-setting" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Sets the default for that dac to this value.</div>
<div class="line">[Jungfrau][Moench][Mythen3] When settings is provided, it sets the default value only for that setting</div>
</div>
</dd>
<dt id="term-defaultpattern">defaultpattern<a class="headerlink" href="#term-defaultpattern" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] Loads and runs default pattern in pattern generator. It is to go back to initial settings.</div>
</div>
</dd>
<dt id="term-delay-duration-optional-unit-ns-us-ms-s">delay [duration] [(optional unit) ns|us|ms|s]<a class="headerlink" href="#term-delay-duration-optional-unit-ns-us-ms-s" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau][Moench][Gotthard][Mythen3][Gotthard2][Ctb][Moench][Xilinx Ctb] Delay after trigger</div>
</div>
</dd>
<dt id="term-delayl">delayl<a class="headerlink" href="#term-delayl" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard][Jungfrau][Moench][Mythen3][Gotthard2][Ctb][Xilinx Ctb] Delay Left in Acquisition.</div>
<div class="line">[Gotthard2] only in continuous mode.</div>
</div>
</dd>
<dt id="term-detectorserverversion">detectorserverversion<a class="headerlink" href="#term-detectorserverversion" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">On-board detector server software version</div>
</div>
</dd>
<dt id="term-detsize-nx-ny">detsize [nx] [ny]<a class="headerlink" href="#term-detsize-nx-ny" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Detector size, ie. Number of channels in x and y dim. This is used to calculate module coordinates included in UDP data.</div>
<div class="line">By default, it adds module in y dimension for 2d detectors and in x dimension for 1d detectors packet header.</div>
</div>
</dd>
<dt id="term-diodelay-0-775">diodelay [0-775]<a class="headerlink" href="#term-diodelay-0-775" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] Delay for diode. Delay is in ps and max of 775 ps. Resolution is 25 ps.</div>
</div>
</dd>
<dt id="term-dpulse-0-1">dpulse [0, 1]<a class="headerlink" href="#term-dpulse-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] Enables or disables digital pulsing. Default is disabled</div>
</div>
</dd>
<dt id="term-dr-value">dr [value]<a class="headerlink" href="#term-dr-value" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Dynamic Range or number of bits per pixel in detector.</div>
<div class="line">[Eiger] Options: 4, 8, 12, 16, 32. If set to 32, also sets clkdivider to 2, else to 0.</div>
<div class="line">[Mythen3] Options: 8, 16, 32</div>
<div class="line">[Jungfrau][Moench][Gotthard][Ctb][Mythen3][Gotthard2][Xilinx Ctb] 16</div>
</div>
</dd>
<dt id="term-drlist">drlist<a class="headerlink" href="#term-drlist" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Gets the list of dynamic ranges for this detector.</div>
</div>
</dd>
<dt id="term-dsamples-n_value">dsamples [n_value]<a class="headerlink" href="#term-dsamples-n_value" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] Number of digital samples expected.</div>
</div>
</dd>
<dt id="term-execcommand-command">execcommand [command]<a class="headerlink" href="#term-execcommand-command" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Executes command on detector server console.</div>
</div>
</dd>
<dt id="term-exptime-duration-optional-unit-ns-us-ms-s">exptime [duration] [(optional unit) ns|us|ms|s]<a class="headerlink" href="#term-exptime-duration-optional-unit-ns-us-ms-s" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger][Jungfrau][Moench][Gotthard][Gotthard2][Ctb][Xilinx Ctb] Exposure time</div>
<div class="line">[Mythen3] Exposure time of all gate signals in auto and trigger mode (internal gating). To specify gate index, use exptime1, exptime2, exptime3.</div>
</div>
</dd>
<dt id="term-exptime1-n_value">exptime1 [n_value]<a class="headerlink" href="#term-exptime1-n_value" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] Exposure time of gate signal 1 in auto and trigger mode (internal gating).</div>
</div>
</dd>
<dt id="term-exptime2-n_value">exptime2 [n_value]<a class="headerlink" href="#term-exptime2-n_value" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] Exposure time of gate signal 2 in auto and trigger mode (internal gating).</div>
</div>
</dd>
<dt id="term-exptime3-n_value">exptime3 [n_value]<a class="headerlink" href="#term-exptime3-n_value" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] Exposure time of gate signal 3 in auto and trigger mode (internal gating).</div>
</div>
</dd>
<dt id="term-exptimel-optional-unit-ns-us-ms-s">exptimel [(optional unit) ns|us|ms|s]<a class="headerlink" href="#term-exptimel-optional-unit-ns-us-ms-s" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard] Exposure time left for current frame.</div>
</div>
</dd>
<dt id="term-extrastoragecells-0-15">extrastoragecells [0-15]<a class="headerlink" href="#term-extrastoragecells-0-15" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau] Only for chipv1.0. Number of additional storage cells. Default is 0. For advanced users only.</div>
<div class="line">The #images = #frames x #triggers x (#extrastoragecells + 1).</div>
</div>
</dd>
<dt id="term-extsampling-0-1">extsampling [0, 1]<a class="headerlink" href="#term-extsampling-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] Enable for external sampling signal for digital data to signal by extsampling src command. For advanced users only.</div>
</div>
</dd>
<dt id="term-extsamplingsrc-0-63">extsamplingsrc [0-63]<a class="headerlink" href="#term-extsamplingsrc-0-63" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] Sampling source signal for digital data. For advanced users only.</div>
</div>
</dd>
<dt id="term-extsig-n_signal-signal_type">extsig [n_signal] [signal_type]<a class="headerlink" href="#term-extsig-n_signal-signal_type" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard][Mythen3] External signal mode for trigger timing mode.</div>
<div class="line">[Gotthard] [0] [trigger_in_rising_edge|trigger_in_falling_edge]</div>
<div class="line">[Mythen3] [0-7] [trigger_in_rising_edge|trigger_in_falling_edge|inversion_on|inversion_off]</div>
<div class="line-block">
<div class="line">where 0 is master input trigger signal, 1-3 is master input gate signals, 4 is busy out signal and 5-7 is master output gate signals.</div>
</div>
</div>
</dd>
<dt id="term-fformat-binary-hdf5">fformat [binary|hdf5]<a class="headerlink" href="#term-fformat-binary-hdf5" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">File format of data file. For HDF5, package must be compiled with HDF5 flags. Default is binary.</div>
</div>
</dd>
<dt id="term-filtercells-0-12">filtercells [0-12]<a class="headerlink" href="#term-filtercells-0-12" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau] Set Filter Cell. Only for chipv1.1. Advanced user Command</div>
</div>
</dd>
<dt id="term-filterresistor-value-Gotthard2-Jungfrau-Set-filter-resistor.-Increasing-values-for-increasing-resistance.">filterresistor [value] [Gotthard2][Jungfrau] Set filter resistor. Increasing values for increasing resistance.<a class="headerlink" href="#term-filterresistor-value-Gotthard2-Jungfrau-Set-filter-resistor.-Increasing-values-for-increasing-resistance." title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard2] Options: [0|1|2|3]. Default is 0.</div>
<div class="line">[Jungfrau] Options: [0|1]. Default is 1.</div>
</div>
</dd>
<dt id="term-findex-n_value">findex [n_value]<a class="headerlink" href="#term-findex-n_value" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">File or Acquisition index.</div>
</div>
</dd>
<dt id="term-firmwaretest">firmwaretest<a class="headerlink" href="#term-firmwaretest" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau][Moench][Gotthard][Mythen3][Gotthard2][Ctb][Xilinx Ctb] Firmware test, ie. reads a read fixed pattern from a register.</div>
</div>
</dd>
<dt id="term-firmwareversion">firmwareversion<a class="headerlink" href="#term-firmwareversion" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Firmware version of detector in format [0xYYMMDD] or an increasing 2 digit number for Eiger.</div>
</div>
</dd>
<dt id="term-fliprows-0-1">fliprows [0, 1]<a class="headerlink" href="#term-fliprows-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger] flips rows paramater sent to slsreceiver to stream as json parameter to flip rows in gui</div>
<div class="line">[Jungfrau][Moench] flips rows in the detector itself. For bottom module and number of interfaces must be set to 2. slsReceiver and slsDetectorGui does not handle.</div>
</div>
</dd>
<dt id="term-flowcontrol10g-0-1">flowcontrol10g [0, 1]<a class="headerlink" href="#term-flowcontrol10g-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger][Jungfrau][Moench] 10GbE Flow Control.</div>
</div>
</dd>
<dt id="term-fmaster-0-1">fmaster [0, 1]<a class="headerlink" href="#term-fmaster-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Enable or disable receiver master file. Default is 1.</div>
</div>
</dd>
<dt id="term-fname-name">fname [name]<a class="headerlink" href="#term-fname-name" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">File name prefix for output data file. Default is run. File name: [file name prefix]_d[detector index]_f[sub file index]_[acquisition/file index].raw.</div>
</div>
</dd>
<dt id="term-foverwrite-0-1">foverwrite [0, 1]<a class="headerlink" href="#term-foverwrite-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Enable or disable file overwriting. Default is 1.</div>
</div>
</dd>
<dt id="term-fpath-path">fpath [path]<a class="headerlink" href="#term-fpath-path" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Directory where output data files are written in receiver. Default is ‘/’.</div>
<div class="line">If path does not exist and fwrite enabled, it will try to create it at start of acquisition.</div>
</div>
</dd>
<dt id="term-framecounter">framecounter<a class="headerlink" href="#term-framecounter" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau][Moench][Mythen3][Gotthard2][Ctb][Xilinx Ctb] Number of frames from start run control.</div>
<div class="line">[Gotthard2] only in continuous mode.</div>
</div>
</dd>
<dt id="term-frames-n_frames">frames [n_frames]<a class="headerlink" href="#term-frames-n_frames" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Number of frames per acquisition. In trigger mode, number of frames per trigger.</div>
<div class="line">Cannot be set in modular level.</div>
<div class="line">In scan mode, number of frames is set to number of steps.</div>
<div class="line">[Gotthard2] Burst mode has a maximum of 2720 frames.</div>
</div>
</dd>
<dt id="term-framesl">framesl<a class="headerlink" href="#term-framesl" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard][Jungfrau][Moench][Mythen3][Gotthard2][Ctb][Xilinx Ctb] Number of frames left in acquisition.</div>
<div class="line">[Gotthard2] only in continuous auto mode.</div>
</div>
</dd>
<dt id="term-frametime-optional-unit-ns-us-ms-s">frametime [(optional unit) ns|us|ms|s]<a class="headerlink" href="#term-frametime-optional-unit-ns-us-ms-s" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau][Moench][Mythen3][Gotthard2][Ctb][Xilinx Ctb] Timestamp at a frame start.</div>
<div class="line">[Gotthard2] not in burst and auto mode.</div>
</div>
</dd>
<dt id="term-free-free">free free<a class="headerlink" href="#term-free-free" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Free detector shared memory</div>
</div>
</dd>
<dt id="term-fwrite-0-1">fwrite [0, 1]<a class="headerlink" href="#term-fwrite-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Enable or disable receiver file write. Default is 0.</div>
</div>
</dd>
<dt id="term-gaincaps-cap1-cap2-...">gaincaps [cap1, cap2, …]<a class="headerlink" href="#term-gaincaps-cap1-cap2-..." title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] gain, options: C10pre, C15sh, C30sh, C50sh, C225ACsh, C15pre</div>
</div>
</dd>
<dt id="term-gainmode-dynamic-forceswitchg1-forceswitchg2-fixg1-fixg2-fixg0">gainmode [dynamic|forceswitchg1|forceswitchg2|fixg1|fixg2|fixg0]<a class="headerlink" href="#term-gainmode-dynamic-forceswitchg1-forceswitchg2-fixg1-fixg2-fixg0" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau] Gain mode.</div>
<div class="line">CAUTION: Do not use fixg0 without caution, you can damage the detector!!!</div>
</div>
</dd>
<dt id="term-gappixels-0-1">gappixels [0, 1]<a class="headerlink" href="#term-gappixels-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger][Jungfrau][Moench] Include Gap pixels in client data call back in Detecor api. Will not be in detector streaming, receiver file or streaming. Default is 0.</div>
</div>
</dd>
<dt id="term-gatedelay-duration-optional-unit-ns-us-ms-s">gatedelay [duration] [(optional unit) ns|us|ms|s]<a class="headerlink" href="#term-gatedelay-duration-optional-unit-ns-us-ms-s" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] Gate Delay of all gate signals in auto and trigger mode (internal gating).</div>
</div>
</dd>
<dt id="term-gatedelay1-duration-optional-unit-ns-us-ms-s">gatedelay1 [duration] [(optional unit) ns|us|ms|s]<a class="headerlink" href="#term-gatedelay1-duration-optional-unit-ns-us-ms-s" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] Gate Delay of gate signal 1 in auto and trigger mode (internal gating).</div>
</div>
</dd>
<dt id="term-gatedelay2-duration-optional-unit-ns-us-ms-s">gatedelay2 [duration] [(optional unit) ns|us|ms|s]<a class="headerlink" href="#term-gatedelay2-duration-optional-unit-ns-us-ms-s" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] Gate Delay of gate signal 2 in auto and trigger mode (internal gating).</div>
</div>
</dd>
<dt id="term-gatedelay3-duration-optional-unit-ns-us-ms-s">gatedelay3 [duration] [(optional unit) ns|us|ms|s]<a class="headerlink" href="#term-gatedelay3-duration-optional-unit-ns-us-ms-s" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] Gate Delay of gate signal 3 in auto and trigger mode (internal gating).</div>
</div>
</dd>
<dt id="term-gates-n_gates">gates [n_gates]<a class="headerlink" href="#term-gates-n_gates" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] Number of external gates in gating or trigger_gating mode (external gating).</div>
</div>
</dd>
<dt id="term-getbit-reg-address-in-hex-bit-index">getbit [reg address in hex] [bit index]<a class="headerlink" href="#term-getbit-reg-address-in-hex-bit-index" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Gets bit in address.</div>
</div>
</dd>
<dt id="term-hardwareversion">hardwareversion<a class="headerlink" href="#term-hardwareversion" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Hardware version of detector.</div>
<div class="line">[Eiger] Hardware version of front FPGA on detector.</div>
</div>
</dd>
<dt id="term-highvoltage-n_value">highvoltage [n_value]<a class="headerlink" href="#term-highvoltage-n_value" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">High voltage to the sensor in Voltage.</div>
<div class="line">[Gotthard] [0|90|110|120|150|180|200]</div>
<div class="line">[Eiger][Mythen3][Gotthard2] 0-200</div>
<div class="line">[Jungfrau][Moench][Ctb] [0|60-200]</div>
</div>
</dd>
<dt id="term-hostname">hostname<a class="headerlink" href="#term-hostname" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Frees shared memory and sets hostname (or IP address) of all modules concatenated by +.</div>
<div class="line-block">
<div class="line">Virtual servers can already use the port in hostname separated by ‘:’ and ports incremented by 2 to accomodate the stop server as well.</div>
</div>
</div>
</dd>
<dt id="term-im_a">im_a<a class="headerlink" href="#term-im_a" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] Measured current of power supply a in mA.</div>
</div>
</dd>
<dt id="term-im_b">im_b<a class="headerlink" href="#term-im_b" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] Measured current of power supply b in mA.</div>
</div>
</dd>
<dt id="term-im_c">im_c<a class="headerlink" href="#term-im_c" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] Measured current of power supply c in mA.</div>
</div>
</dd>
<dt id="term-im_d">im_d<a class="headerlink" href="#term-im_d" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] Measured current of power supply d in mA.</div>
</div>
</dd>
<dt id="term-im_io">im_io<a class="headerlink" href="#term-im_io" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] Measured current of power supply io in mA.</div>
</div>
</dd>
<dt id="term-imagetest-0-1">imagetest [0, 1]<a class="headerlink" href="#term-imagetest-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard] 1 adds channel intensity with precalculated values when taking an acquisition. Default is 0.</div>
<div class="line">[Eiger][Jungfrau][Moench] Only for Virtual servers. If 0, each pixel intensity incremented by 1. If 1, all pixels almost saturated.</div>
</div>
</dd>
<dt id="term-initialchecks-0-1">initialchecks [0, 1]<a class="headerlink" href="#term-initialchecks-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3][Gotthard2] Enable or disable intial compatibility and other checks at detector start up. It is enabled by default. Must come before ‘hostname’ command to take effect. Can be used to reprogram fpga when current firmware is incompatible.</div>
<div class="line">Advanced User function!</div>
</div>
</dd>
<dt id="term-inj_ch-offset-increment">inj_ch [offset] [increment]<a class="headerlink" href="#term-inj_ch-offset-increment" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard2] Inject channels with current source for calibration. Offset is starting channel that is injected, increment determines succeeding channels to be injected.</div>
</div>
</dd>
<dt id="term-interpolation-0-1">interpolation [0, 1]<a class="headerlink" href="#term-interpolation-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] Enables or disables interpolation. Default is disabled. Interpolation mode enables all counters and disables vth3. Disabling sets back counter mask and vth3.</div>
</div>
</dd>
<dt id="term-interruptsubframe-0-1">interruptsubframe [0, 1]<a class="headerlink" href="#term-interruptsubframe-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger] 1 interrupts last subframe at required exposure time. 0 will wait for last sub frame to finish exposing. 0 is default.</div>
</div>
</dd>
<dt id="term-kernelversion">kernelversion<a class="headerlink" href="#term-kernelversion" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Get kernel version on the detector including time and date.</div>
</div>
</dd>
<dt id="term-lastclient">lastclient<a class="headerlink" href="#term-lastclient" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Client IP Address that last communicated with the detector.</div>
</div>
</dd>
<dt id="term-led-0-1">led [0, 1]<a class="headerlink" href="#term-led-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] Switches on/off all LEDs.</div>
</div>
</dd>
<dt id="term-list-deprecated-optional">list [deprecated(optional)]<a class="headerlink" href="#term-list-deprecated-optional" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">lists all available commands, list deprecated - list deprecated commands</div>
</div>
</dd>
<dt id="term-lock-0-1">lock [0, 1]<a class="headerlink" href="#term-lock-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Lock detector to one IP, 1: locks. Default is unlocked</div>
</div>
</dd>
<dt id="term-master-0-1">master [0, 1]<a class="headerlink" href="#term-master-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger][Gotthard2][Jungfrau][Moench] Sets (half) module to master and other(s) to slaves.</div>
<div class="line">[Gotthard][Gotthard2][Mythen3][Eiger][Jungfrau][Moench] Gets if the current (half) module is master.</div>
</div>
</dd>
<dt id="term-maxadcphaseshift">maxadcphaseshift<a class="headerlink" href="#term-maxadcphaseshift" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau][Moench][Ctb] Absolute maximum Phase shift of ADC clock.</div>
</div>
</dd>
<dt id="term-maxclkphaseshift-n_clock">maxclkphaseshift [n_clock]<a class="headerlink" href="#term-maxclkphaseshift-n_clock" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard2][Mythen3] Absolute Maximum Phase shift of clock n_clock.n [Gotthard2] Clock index range: 0-5</div>
<div class="line">[Mythen3] Clock index range: 0</div>
</div>
</dd>
<dt id="term-maxdbitphaseshift">maxdbitphaseshift<a class="headerlink" href="#term-maxdbitphaseshift" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Jungfrau] Absolute maximum Phase shift of of the clock to latch digital bits.</div>
</div>
</dd>
<dt id="term-measuredperiod-optional-unit-ns-us-ms-s">measuredperiod [(optional unit) ns|us|ms|s]<a class="headerlink" href="#term-measuredperiod-optional-unit-ns-us-ms-s" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger] Measured frame period between last frame and previous one. Can be measured with minimum 2 frames in an acquisition.</div>
</div>
</dd>
<dt id="term-measuredsubperiod-optional-unit-ns-us-ms-s">measuredsubperiod [(optional unit) ns|us|ms|s]<a class="headerlink" href="#term-measuredsubperiod-optional-unit-ns-us-ms-s" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger] Measured sub frame period between last sub frame and previous one.</div>
</div>
</dd>
<dt id="term-moduleid">moduleid<a class="headerlink" href="#term-moduleid" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard2][Eiger][Mythen3][Jungfrau][Moench] 16 bit value (ideally unique) that is streamed out in the UDP header of the detector. Picked up from a file on the module.</div>
</div>
</dd>
<dt id="term-nextframenumber-n_value">nextframenumber [n_value]<a class="headerlink" href="#term-nextframenumber-n_value" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger][Jungfrau][Moench][Ctb][Xilinx Ctb][Gotthard2] Next frame number. Stopping acquisition might result in different frame numbers for different modules. So, after stopping, next frame number (max + 1) is set for all the modules afterwards.</div>
</div>
</dd>
<dt id="term-nmod">nmod<a class="headerlink" href="#term-nmod" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Number of modules in shared memory.</div>
</div>
</dd>
<dt id="term-numinterfaces-1-2">numinterfaces [1, 2]<a class="headerlink" href="#term-numinterfaces-1-2" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau][Moench] Number of udp interfaces to stream data from detector. Default: 1.</div>
<div class="line">Also enables second interface in receiver for listening (Writes a file per interface if writing enabled).</div>
<div class="line">Also restarts client and receiver zmq sockets if zmq streaming enabled.</div>
<div class="line">[Eiger] Only gets with result 2.</div>
</div>
</dd>
<dt id="term-overflow-0-1">overflow [0, 1]<a class="headerlink" href="#term-overflow-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger] Enable or disable show overflow flag in 32 bit mode. Default is disabled.</div>
</div>
</dd>
<dt id="term-packageversion">packageversion<a class="headerlink" href="#term-packageversion" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Package version.</div>
</div>
</dd>
<dt id="term-parallel-0-1">parallel [0, 1]<a class="headerlink" href="#term-parallel-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger][Mythen3][Gotthard2][Moench] Enable or disable parallel mode.</div>
<div class="line">[Mythen3] If exptime is too short, the acquisition will return ERROR status and take fewer frames than expected.</div>
<div class="line">[Mythen3][Eiger][Moench] Default: Non parallel.</div>
<div class="line">[Gotthard2] Default: Parallel. Non parallel mode works only in continuous mode.</div>
</div>
</dd>
<dt id="term-parameters">parameters<a class="headerlink" href="#term-parameters" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Sets detector measurement parameters to those contained in fname. Set up per measurement.</div>
</div>
</dd>
<dt id="term-partialreset-0-1">partialreset [0, 1]<a class="headerlink" href="#term-partialreset-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger] Sets up detector to do partial or complete reset at start of acquisition. 0 complete reset, 1 partial reset. Default is complete reset. Advanced function!</div>
</div>
</dd>
<dt id="term-patfname">patfname<a class="headerlink" href="#term-patfname" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Mythen3][Xilinx Ctb] Gets the pattern file name including path of the last pattern uploaded. Returns an empty if nothing was uploaded or via a server default file</div>
</div>
</dd>
<dt id="term-patioctrl-64-bit-mask">patioctrl [64 bit mask]<a class="headerlink" href="#term-patioctrl-64-bit-mask" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] 64 bit mask defining input (0) and output (1) signals.</div>
</div>
</dd>
<dt id="term-patlimits-start-addr-stop-addr">patlimits [start addr] [stop addr]<a class="headerlink" href="#term-patlimits-start-addr-stop-addr" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Mythen3][Xilinx Ctb] Limits of complete pattern</div>
</div>
</dd>
<dt id="term-patloop-0-6-start-addr-stop-addr">patloop [0-6] [start addr] [stop addr]<a class="headerlink" href="#term-patloop-0-6-start-addr-stop-addr" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Mythen3][Xilinx Ctb] Limits of the loop level provided.</div>
<div class="line">[Mythen3] Level options: 0-3 only.</div>
</div>
</dd>
<dt id="term-patloop0">patloop0<a class="headerlink" href="#term-patloop0" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Deprecated command. Use patloop.</div>
</div>
</dd>
<dt id="term-patloop1">patloop1<a class="headerlink" href="#term-patloop1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Deprecated command. Use patloop.</div>
</div>
</dd>
<dt id="term-patloop2">patloop2<a class="headerlink" href="#term-patloop2" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Deprecated command. Use patloop.</div>
</div>
</dd>
<dt id="term-patmask-64-bit-mask">patmask [64 bit mask]<a class="headerlink" href="#term-patmask-64-bit-mask" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Mythen3][Xilinx Ctb] Selects the bits that will have a pattern mask applied to the selected patmask for every pattern.</div>
</div>
</dd>
<dt id="term-patnloop-0-6-n_cycles">patnloop [0-6] [n_cycles]<a class="headerlink" href="#term-patnloop-0-6-n_cycles" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Mythen3][Xilinx Ctb] Number of cycles of the loop level provided.</div>
<div class="line">[Mythen3] Level options: 0-3 only.</div>
</div>
</dd>
<dt id="term-patnloop0">patnloop0<a class="headerlink" href="#term-patnloop0" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Deprecated command. Use patnloop.</div>
</div>
</dd>
<dt id="term-patnloop1">patnloop1<a class="headerlink" href="#term-patnloop1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Deprecated command. Use patnloop.</div>
</div>
</dd>
<dt id="term-patnloop2">patnloop2<a class="headerlink" href="#term-patnloop2" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Deprecated command. Use patnloop.</div>
</div>
</dd>
<dt id="term-patsetbit-64-bit-mask">patsetbit [64 bit mask]<a class="headerlink" href="#term-patsetbit-64-bit-mask" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Mythen3][Xilinx Ctb] Sets the mask applied to every pattern to the selected bits.</div>
</div>
</dd>
<dt id="term-patternX-fname">patternX [fname]<a class="headerlink" href="#term-patternX-fname" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3][Ctb][Xilinx Ctb] Loads ASCII pattern file directly to server (instead of executing line by line)</div>
</div>
</dd>
<dt id="term-patternstart">patternstart<a class="headerlink" href="#term-patternstart" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] Starts Pattern</div>
</div>
</dd>
<dt id="term-patwait-0-6-addr">patwait [0-6] [addr]<a class="headerlink" href="#term-patwait-0-6-addr" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Mythen3][Xilinx Ctb] Wait address for loop level provided.</div>
<div class="line">[Mythen3] Level options: 0-3 only.</div>
</div>
</dd>
<dt id="term-patwait0">patwait0<a class="headerlink" href="#term-patwait0" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Deprecated command. Use patwait.</div>
</div>
</dd>
<dt id="term-patwait1">patwait1<a class="headerlink" href="#term-patwait1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Deprecated command. Use patwait.</div>
</div>
</dd>
<dt id="term-patwait2">patwait2<a class="headerlink" href="#term-patwait2" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Deprecated command. Use patwait.</div>
</div>
</dd>
<dt id="term-patwaittime-0-6-n_clk">patwaittime [0-6] [n_clk]<a class="headerlink" href="#term-patwaittime-0-6-n_clk" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Mythen3][Xilinx Ctb] Wait time in clock cycles for the loop provided.</div>
<div class="line">[Mythen3] Level options: 0-3 only.</div>
</div>
</dd>
<dt id="term-patwaittime0">patwaittime0<a class="headerlink" href="#term-patwaittime0" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Deprecated command. Use patwaittime.</div>
</div>
</dd>
<dt id="term-patwaittime1">patwaittime1<a class="headerlink" href="#term-patwaittime1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Deprecated command. Use patwaittime.</div>
</div>
</dd>
<dt id="term-patwaittime2">patwaittime2<a class="headerlink" href="#term-patwaittime2" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Deprecated command. Use patwaittime.</div>
</div>
</dd>
<dt id="term-patword-step-or-address-64-bit-mask">patword [step or address] [64 bit mask]<a class="headerlink" href="#term-patword-step-or-address-64-bit-mask" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Mythen3][Xilinx Ctb] 64 bit pattern at address of pattern memory.</div>
<div class="line">[Ctb] read is same as executing pattern</div>
</div>
</dd>
<dt id="term-pedestalmode-frames-uint8_t-loops-uint16_t">pedestalmode [frames<uint8_t>] [loops<uint16_t>]<a class="headerlink" href="#term-pedestalmode-frames-uint8_t-loops-uint16_t" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line-block">
<div class="line">[Jungfrau] Enable pedestal mode.</div>
<div class="line">The number of frames or triggers is overwritten by:</div>
<div class="line">(#pedestal_frames x #pedestal_loops x 2).</div>
<div class="line">In auto timing mode or in trigger mode with #frames > 1,</div>
<div class="line">#frames is overwritten and #triggers = 1,</div>
<div class="line">else #triggers is overwritten and #frames = 1.</div>
<div class="line">One cannot set #frames, #triggers or timing mode in pedestal mode (exception thrown).</div>
</div>
<div class="line">pedestalmode [0]</div>
<div class="line-block">
<div class="line">[Jungfrau] Disable pedestal mode.</div>
<div class="line">Disabling pedestal mode will set back the normal mode values of #frames and #triggers.</div>
</div>
</div>
</dd>
<dt id="term-period-duration-optional-unit-ns-us-ms-s">period [duration] [(optional unit) ns|us|ms|s]<a class="headerlink" href="#term-period-duration-optional-unit-ns-us-ms-s" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Period between frames</div>
</div>
</dd>
<dt id="term-periodl">periodl<a class="headerlink" href="#term-periodl" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Gotthard][Jungfrau][Moench][Ctb][Mythen3][Gotthard2][Xilinx Ctb] Period left for current frame.</div>
<div class="line">[Gotthard2] only in continuous mode.</div>
</div>
</dd>
<dt id="term-polarity-pos-neg">polarity [pos|neg]<a class="headerlink" href="#term-polarity-pos-neg" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] Sets negative or positive polarity. Default is positive</div>
</div>
</dd>
<dt id="term-port-n">port [n]<a class="headerlink" href="#term-port-n" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">Port number of the control server on detector for detector-client tcp interface. Default is 1952. Normally unchanged. Set different ports for virtual servers on same pc.</div>
</div>
</dd>
<dt id="term-powerchip-0-1">powerchip [0, 1]<a class="headerlink" href="#term-powerchip-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau][Moench][Mythen3][Gotthard2][Xilinx Ctb] Power the chip.</div>
<div class="line">[Jungfrau][Moench] Default is 0. Get will return power status. Can be off if temperature event occured (temperature over temp_threshold with temp_control enabled. Will configure chip (only chip v1.1)</div>
<div class="line">[Mythen3][Gotthard2] Default is 1. If module not connected or wrong module, powerchip will fail.</div>
<div class="line">[Xilinx Ctb] Default is 0. Also configures the chip if powered on.</div>
</div>
</dd>
<dt id="term-powerindex-name">powerindex [name]<a class="headerlink" href="#term-powerindex-name" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Xilinx_Ctb] Get the power index for the given name.</div>
</div>
</dd>
<dt id="term-powerlist-powername1-powername2-..-powername4">powerlist [powername1 powername2 .. powername4]<a class="headerlink" href="#term-powerlist-powername1-powername2-..-powername4" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Xilinx_Ctb] Set the list of power names for this board.</div>
</div>
</dd>
<dt id="term-powername-0-4-name">powername [0-4][name]<a class="headerlink" href="#term-powername-0-4-name" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Xilinx_Ctb] Set the power at the given position to the given name.</div>
</div>
</dd>
<dt id="term-powervalues-name">powervalues [name]<a class="headerlink" href="#term-powervalues-name" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb][Xilinx_Ctb] Get values of all powers.</div>
</div>
</dd>
<dt id="term-programfpga-fname.pof-fname.rbf-full-path-opitonal-force-delete-normal-file">programfpga [fname.pof | fname.rbf (full path)][(opitonal)–force-delete-normal-file]<a class="headerlink" href="#term-programfpga-fname.pof-fname.rbf-full-path-opitonal-force-delete-normal-file" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau][Moench][Ctb] Programs FPGA from pof file (full path). Then, detector controller is rebooted.</div>
<div class="line-block">
<div class="line">Use –force-delete-normal-file argument, if normal file found in device tree, it must be deleted, a new device drive created and programming continued.</div>
</div>
<div class="line">[Mythen3][Gotthard2] Programs FPGA from rbf file (full path). Then, detector controller is rebooted.</div>
</div>
</dd>
<dt id="term-pulse-n_times-x-y">pulse [n_times] [x] [y]<a class="headerlink" href="#term-pulse-n_times-x-y" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger] Pulse pixel n number of times at coordinates (x, y). Advanced User!</div>
</div>
</dd>
<dt id="term-pulsechip-n_times">pulsechip [n_times]<a class="headerlink" href="#term-pulsechip-n_times" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger] Pulse chip n times. If n is -1, resets to normal mode (reset chip completely at start of acquisition, where partialreset = 0). Advanced User!</div>
</div>
</dd>
<dt id="term-pulsenmove-n_times-x-y">pulsenmove [n_times] [x] [y]<a class="headerlink" href="#term-pulsenmove-n_times-x-y" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger] Pulse pixel n number of times and moves relatively by (x, y). Advanced User!</div>
</div>
</dd>
<dt id="term-pumpprobe-0-1">pumpprobe [0, 1]<a class="headerlink" href="#term-pumpprobe-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] Enables or disables pump probe mode. Default is disabled. Pump probe mode only enables vth2. Disabling sets back to previous value.</div>
</div>
</dd>
<dt id="term-quad-0-1">quad [0, 1]<a class="headerlink" href="#term-quad-0-1" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger] Sets detector size to a quad. 0 (disabled) is default. (Specific hardware required).</div>
</div>
</dd>
<dt id="term-ratecorr-n_rate-in-ns">ratecorr [n_rate (in ns)]<a class="headerlink" href="#term-ratecorr-n_rate-in-ns" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Eiger] Dead time correction constant in ns. -1 will set to default tau of settings from trimbit file. 0 will unset rate correction.</div>
</div>
</dd>
<dt id="term-readnrows">readnrows<a class="headerlink" href="#term-readnrows" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[1-256]</div>
<div class="line-block">
<div class="line">[Eiger] Number of rows to readout per half module starting from the centre. Options: 0 - 256. 256 is default. The permissible values depend on dynamic range and 10Gbe enabled.</div>
</div>
<div class="line">[8-512 (multiple of 8)]</div>
<div class="line-block">
<div class="line">[Jungfrau] Number of rows per module starting from the centre. Options: 8 - 512, must be multiples of 8. Default is 512.</div>
<div class="line">[Moench] Number of rows per module starting from the centre. Options:16 - 400, must be multiples of 16. Default is 400.</div>
</div>
</div>
</dd>
<dt id="term-readout">readout<a class="headerlink" href="#term-readout" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] Starts detector readout. Status changes to TRANSMITTING and automatically returns to idle at the end of readout.</div>
</div>
</dd>
<dt id="term-readoutspeed">readoutspeed<a class="headerlink" href="#term-readoutspeed" title="Permalink to this term"></a></dt><dd><div class="line-block">
<div class="line">[0 or full_speed|1 or half_speed|2 or quarter_speed]</div>
<div class="line">[Eiger][Jungfrau][Moench][Mythen3] Readout speed of chip.</div>
<div class="line">[Eiger][Moench] Default speed is full_speed.</div>
<div class="line">[Jungfrau][Mythen3] Default speed is half_speed.</div>
<div class="line">[Jungfrau] full_speed option only available from v2.0 boards and is recommended to set number of interfaces to 2. Also overwrites adcphase to recommended default.</div>
<div class="line-block">
<div class="line">[144|108]</div>
<div class="line-block">
<div class="line">[Gotthard2] Readout speed of chip in MHz. Default is 108.</div>
</div>