detectors/slsDetectorPackage
24
1 Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2026-11-10 02:53:53 +01:00
Code Issues Actions Packages Releases Activity

Update Documentation for developer

Browse Source
This commit is contained in:
github-actions committed 2026-11-05 15:20:18 +00:00
1 parent cb2b2cd142
commit e9a1f53fec
17 files changed
+129 -4
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

developer/.doctrees/ToString.doctree
BIN
View File
Binary file not shown.
developer/.doctrees/commandline.doctree
BIN
View File
Binary file not shown.
developer/.doctrees/detector.doctree
BIN
View File
Binary file not shown.
developer/.doctrees/environment.pickle
BIN
View File
Binary file not shown.
developer/.doctrees/pyctb.doctree
BIN
View File
Binary file not shown.
developer/.doctrees/pydetector.doctree
BIN
View File
Binary file not shown.
developer/.doctrees/serverdefaults.doctree
BIN
View File
Binary file not shown.
developer/ToString.html
+6
View File
@@ -123,6 +123,7 @@
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4IEN3sls8StringToEN4defs14collectionModeERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">StringTo()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4IEN3sls8StringToE15RegisterAddressRKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">StringTo()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4IEN3sls8StringToE13RegisterValueRKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">StringTo()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4IEN3sls8StringToEN4defs13operationModeERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">StringTo()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4IEN3sls8StringToE7uint8_tRKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">StringTo()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4IEN3sls8StringToE8uint16_tRKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">StringTo()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4IEN3sls8StringToE8uint32_tRKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">StringTo()</span></code></a></li>
@@ -422,6 +423,11 @@
<span class="k"><span class="pre">template</span></span><span class="p"><span class="pre">&lt;</span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="target" id="namespacesls_1abc6f66643e7b6a76dda95889cec350ae"></span><span class="n"><span class="pre">RegisterValue</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">StringTo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">s</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4IEN3sls8StringToE13RegisterValueRKNSt6stringE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4IEN3sls8StringToEN4defs13operationModeERKNSt6stringE">
<span class="k"><span class="pre">template</span></span><span class="p"><span class="pre">&lt;</span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="target" id="namespacesls_1af3c6a2682938262c9b65ed2134be501e"></span><span class="n"><span class="pre">defs</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">operationMode</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">StringTo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">s</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4IEN3sls8StringToEN4defs13operationModeERKNSt6stringE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4IEN3sls8StringToE7uint8_tRKNSt6stringE">
<span class="k"><span class="pre">template</span></span><span class="p"><span class="pre">&lt;</span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="target" id="namespacesls_1a35e9d0b31d783cd6e42abd5a88f41999"></span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">StringTo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">s</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4IEN3sls8StringToE7uint8_tRKNSt6stringE" title="Link to this definition"></a><br /></dt>
developer/commandline.html
+4
View File
@@ -762,6 +762,10 @@
<div class="line">[Eiger] Hardware version of front FPGA on detector.</div>
</div>
</dd>
<dt id="term-hdr-synchrotron-fel-0">hdr synchrotron|fel|0]<a class="headerlink" href="#term-hdr-synchrotron-fel-0" title="Link to this term"></a></dt><dd><div class="line-block">
<div class="line">[Jungfrau] Enables the high dynamic range in detector in synchrotron or fel mode. 0 disables HDR and is the default. FEL can only be used with chip version ‘1.2 HDR’.</div>
</div>
</dd>
<dt id="term-highvoltage-n_value">highvoltage [n_value]<a class="headerlink" href="#term-highvoltage-n_value" title="Link to this term"></a></dt><dd><div class="line-block">
<div class="line">High voltage to the sensor in Voltage.</div>
<div class="line">[Eiger][Mythen3][Gotthard2] 0-200</div>
developer/detector.html
+14
View File
@@ -380,6 +380,8 @@
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4N3sls8Detector20setTimingInfoDecoderEN4defs17timingInfoDecoderE9Positions"><code class="docutils literal notranslate"><span class="pre">setTimingInfoDecoder()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4NK3sls8Detector17getCollectionModeE9Positions"><code class="docutils literal notranslate"><span class="pre">getCollectionMode()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4N3sls8Detector17setCollectionModeEN4defs14collectionModeE9Positions"><code class="docutils literal notranslate"><span class="pre">setCollectionMode()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4NK3sls8Detector6getHDRE9Positions"><code class="docutils literal notranslate"><span class="pre">getHDR()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4N3sls8Detector6setHDREKN4defs13hdrParametersE9Positions"><code class="docutils literal notranslate"><span class="pre">setHDR()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4NK3sls8Detector17getNumberOfBurstsE9Positions"><code class="docutils literal notranslate"><span class="pre">getNumberOfBursts()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4N3sls8Detector17setNumberOfBurstsE7int64_t"><code class="docutils literal notranslate"><span class="pre">setNumberOfBursts()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4NK3sls8Detector14getBurstPeriodE9Positions"><code class="docutils literal notranslate"><span class="pre">getBurstPeriod()</span></code></a></li>
@@ -2767,6 +2769,18 @@ disabled(comparator enabled throughout). true enables mode. 0 disables mode. </p
<dd><p>[Jungfrau] </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK3sls8Detector6getHDRE9Positions">
<span id="_CPPv3NK3sls8Detector6getHDRE9Positions"></span><span id="_CPPv2NK3sls8Detector6getHDRE9Positions"></span><span id="sls::Detector::getHDR__PositionsC"></span><span class="target" id="classsls_1_1Detector_1a6cb47b5c87795c50d2fab00a1cbac360"></span><a class="reference internal" href="result.html#_CPPv4I00EN3sls6ResultE" title="sls::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">defs</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">hdrParameters</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getHDR</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Positions</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">pos</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK3sls8Detector6getHDRE9Positions" title="Link to this definition"></a><br /></dt>
<dd><p>[Jungfrau] </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3sls8Detector6setHDREKN4defs13hdrParametersE9Positions">
<span id="_CPPv3N3sls8Detector6setHDREKN4defs13hdrParametersE9Positions"></span><span id="_CPPv2N3sls8Detector6setHDREKN4defs13hdrParametersE9Positions"></span><span id="sls::Detector::setHDR__defs::hdrParametersC.Positions"></span><span class="target" id="classsls_1_1Detector_1adf74241311da71e73df88269fbc24a0f"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">setHDR</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">defs</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">hdrParameters</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">par</span></span>, <span class="n"><span class="pre">Positions</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">pos</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3sls8Detector6setHDREKN4defs13hdrParametersE9Positions" title="Link to this definition"></a><br /></dt>
<dd><p>[Jungfrau] Enabling with FEL mode can only be used with chip version ‘1.2 HDR’ </p>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-gotthard2-specific">Gotthard2 Specific</p>
developer/genindex.html
+27 -3
View File
@@ -1543,6 +1543,12 @@
<ul>
<li><a href="pydetector.html#slsdet.Detector.getHardwareVersion">(slsdet.Detector method)</a>
</li>
</ul></li>
<li><a href="pyctb.html#slsdet.Ctb.getHDR">getHDR() (slsdet.Ctb method)</a>
<ul>
<li><a href="pydetector.html#slsdet.Detector.getHDR">(slsdet.Detector method)</a>
</li>
</ul></li>
<li><a href="pyctb.html#slsdet.Ctb.getHighVoltage">getHighVoltage() (slsdet.Ctb method)</a>
@@ -1707,14 +1713,14 @@
<li><a href="pydetector.html#slsdet.Detector.getNumberOfBursts">(slsdet.Detector method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="pyctb.html#slsdet.Ctb.getNumberOfBurstsLeft">getNumberOfBurstsLeft() (slsdet.Ctb method)</a>
<ul>
<li><a href="pydetector.html#slsdet.Detector.getNumberOfBurstsLeft">(slsdet.Detector method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="pyctb.html#slsdet.Ctb.getNumberOfDigitalSamples">getNumberOfDigitalSamples() (slsdet.Ctb method)</a>
<ul>
@@ -2543,10 +2549,18 @@
<ul>
<li><a href="pydetector.html#slsdet.Detector.hasRegisterDefinition">(slsdet.Detector method)</a>
</li>
</ul></li>
<li><a href="pyctb.html#slsdet.Ctb.hdr">hdr (slsdet.Ctb property)</a>
<ul>
<li><a href="pydetector.html#slsdet.Detector.hdr">(slsdet.Detector property)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="commandline.html#term-hdr-synchrotron-fel-0"><strong>hdr synchrotron|fel|0]</strong></a>
</li>
<li><a href="pyctb.html#slsdet.Ctb.highvoltage">highvoltage (slsdet.Ctb property)</a>
<ul>
@@ -4165,6 +4179,12 @@
<ul>
<li><a href="pydetector.html#slsdet.Detector.setGateDelay">(slsdet.Detector method)</a>
</li>
</ul></li>
<li><a href="pyctb.html#slsdet.Ctb.setHDR">setHDR() (slsdet.Ctb method)</a>
<ul>
<li><a href="pydetector.html#slsdet.Detector.setHDR">(slsdet.Detector method)</a>
</li>
</ul></li>
<li><a href="pyctb.html#slsdet.Ctb.setHighVoltage">setHighVoltage() (slsdet.Ctb method)</a>
@@ -5176,6 +5196,8 @@
<li><a href="detector.html#_CPPv4NK3sls8Detector23getGateDelayForAllGatesE9Positions">sls::Detector::getGateDelayForAllGates (C++ function)</a>
</li>
<li><a href="detector.html#_CPPv4NK3sls8Detector18getHardwareVersionE9Positions">sls::Detector::getHardwareVersion (C++ function)</a>
</li>
<li><a href="detector.html#_CPPv4NK3sls8Detector6getHDRE9Positions">sls::Detector::getHDR (C++ function)</a>
</li>
<li><a href="detector.html#_CPPv4NK3sls8Detector14getHighVoltageE9Positions">sls::Detector::getHighVoltage (C++ function)</a>
</li>
@@ -5706,6 +5728,8 @@
<li><a href="detector.html#_CPPv4N3sls8Detector22setGapPixelsinCallbackEKb">sls::Detector::setGapPixelsinCallback (C++ function)</a>
</li>
<li><a href="detector.html#_CPPv4N3sls8Detector12setGateDelayEi2ns9Positions">sls::Detector::setGateDelay (C++ function)</a>
</li>
<li><a href="detector.html#_CPPv4N3sls8Detector6setHDREKN4defs13hdrParametersE9Positions">sls::Detector::setHDR (C++ function)</a>
</li>
<li><a href="detector.html#_CPPv4N3sls8Detector14setHighVoltageEi9Positions">sls::Detector::setHighVoltage (C++ function)</a>
</li>
@@ -6089,7 +6113,7 @@
</li>
<li><a href="container_utils.html#_CPPv4I0EN3sls22stableRemoveDuplicatesENSt9enable_ifIN12is_containerI1TE5valueEbE4typeER1T">sls::stableRemoveDuplicates (C++ function)</a>
</li>
<li><a href="ToString.html#_CPPv4I0EN3sls8StringToENSt6vectorI1TEERKNSt6vectorINSt6stringEEE">sls::StringTo (C++ function)</a>, <a href="ToString.html#_CPPv4I0_NSt11enable_if_tIN3sls11is_durationI1TE5valueEiEEEN3sls8StringToE1TRKNSt6stringERKNSt6stringE">[1]</a>, <a href="ToString.html#_CPPv4I0_NSt11enable_if_tIXntN12is_containerI1TE5valueEEiEEEN3sls8StringToE1TRKNSt6stringE">[2]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToE13RegisterValueRKNSt6stringE">[3]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToE15RegisterAddressRKNSt6stringE">[4]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToE7int64_tRKNSt6stringE">[5]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToE7uint8_tRKNSt6stringE">[6]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToE8uint16_tRKNSt6stringE">[7]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToE8uint32_tRKNSt6stringE">[8]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToE8uint64_tRKNSt6stringE">[9]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs10fileFormatERKNSt6stringE">[10]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs10powerIndexERKNSt6stringE">[11]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs10speedLevelERKNSt6stringE">[12]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs10timingModeERKNSt6stringE">[13]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs11M3_GainCapsERKNSt6stringE">[14]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs11readoutModeERKNSt6stringE">[15]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs12detectorTypeERKNSt6stringE">[16]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs12portPositionERKNSt6stringE">[17]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs13vetoAlgorithmERKNSt6stringE">[18]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs14collectionModeERKNSt6stringE">[19]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs16detectorSettingsERKNSt6stringE">[20]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs16timingSourceTypeERKNSt6stringE">[21]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs17timingInfoDecoderERKNSt6stringE">[22]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs18externalSignalFlagERKNSt6stringE">[23]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs18frameDiscardPolicyERKNSt6stringE">[24]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs18streamingInterfaceERKNSt6stringE">[25]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs8dacIndexERKNSt6stringE">[26]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs8gainModeERKNSt6stringE">[27]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs8polarityERKNSt6stringE">[28]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs9burstModeERKNSt6stringE">[29]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEbRKNSt6stringE">[30]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEiRKNSt6stringE">[31]</a>
<li><a href="ToString.html#_CPPv4I0EN3sls8StringToENSt6vectorI1TEERKNSt6vectorINSt6stringEEE">sls::StringTo (C++ function)</a>, <a href="ToString.html#_CPPv4I0_NSt11enable_if_tIN3sls11is_durationI1TE5valueEiEEEN3sls8StringToE1TRKNSt6stringERKNSt6stringE">[1]</a>, <a href="ToString.html#_CPPv4I0_NSt11enable_if_tIXntN12is_containerI1TE5valueEEiEEEN3sls8StringToE1TRKNSt6stringE">[2]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToE13RegisterValueRKNSt6stringE">[3]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToE15RegisterAddressRKNSt6stringE">[4]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToE7int64_tRKNSt6stringE">[5]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToE7uint8_tRKNSt6stringE">[6]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToE8uint16_tRKNSt6stringE">[7]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToE8uint32_tRKNSt6stringE">[8]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToE8uint64_tRKNSt6stringE">[9]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs10fileFormatERKNSt6stringE">[10]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs10powerIndexERKNSt6stringE">[11]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs10speedLevelERKNSt6stringE">[12]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs10timingModeERKNSt6stringE">[13]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs11M3_GainCapsERKNSt6stringE">[14]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs11readoutModeERKNSt6stringE">[15]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs12detectorTypeERKNSt6stringE">[16]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs12portPositionERKNSt6stringE">[17]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs13operationModeERKNSt6stringE">[18]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs13vetoAlgorithmERKNSt6stringE">[19]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs14collectionModeERKNSt6stringE">[20]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs16detectorSettingsERKNSt6stringE">[21]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs16timingSourceTypeERKNSt6stringE">[22]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs17timingInfoDecoderERKNSt6stringE">[23]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs18externalSignalFlagERKNSt6stringE">[24]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs18frameDiscardPolicyERKNSt6stringE">[25]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs18streamingInterfaceERKNSt6stringE">[26]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs8dacIndexERKNSt6stringE">[27]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs8gainModeERKNSt6stringE">[28]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs8polarityERKNSt6stringE">[29]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEN4defs9burstModeERKNSt6stringE">[30]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEbRKNSt6stringE">[31]</a>, <a href="ToString.html#_CPPv4IEN3sls8StringToEiRKNSt6stringE">[32]</a>
</li>
<li><a href="container_utils.html#_CPPv4I0EN3sls3sumENSt9enable_ifINSt13is_arithmeticI1TE5valueE1TE4typeERKNSt6vectorI1TEE">sls::sum (C++ function)</a>
</li>
developer/index.html
+1
View File
@@ -435,6 +435,7 @@ For further detector specific documentation, visit <a class="reference external"
<li class="toctree-l3"><a class="reference internal" href="ToString.html#_CPPv4IEN3sls8StringToEN4defs14collectionModeERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">StringTo()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ToString.html#_CPPv4IEN3sls8StringToE15RegisterAddressRKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">StringTo()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ToString.html#_CPPv4IEN3sls8StringToE13RegisterValueRKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">StringTo()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ToString.html#_CPPv4IEN3sls8StringToEN4defs13operationModeERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">StringTo()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ToString.html#_CPPv4IEN3sls8StringToE7uint8_tRKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">StringTo()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ToString.html#_CPPv4IEN3sls8StringToE8uint16_tRKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">StringTo()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ToString.html#_CPPv4IEN3sls8StringToE8uint32_tRKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">StringTo()</span></code></a></li>
developer/objects.inv
BIN
View File
Binary file not shown.
developer/pyctb.html
+32
View File
@@ -251,6 +251,7 @@
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.getGapPixelsinCallback"><code class="docutils literal notranslate"><span class="pre">Ctb.getGapPixelsinCallback()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.getGateDelay"><code class="docutils literal notranslate"><span class="pre">Ctb.getGateDelay()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.getGateDelayForAllGates"><code class="docutils literal notranslate"><span class="pre">Ctb.getGateDelayForAllGates()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.getHDR"><code class="docutils literal notranslate"><span class="pre">Ctb.getHDR()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.getHardwareVersion"><code class="docutils literal notranslate"><span class="pre">Ctb.getHardwareVersion()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.getHighVoltage"><code class="docutils literal notranslate"><span class="pre">Ctb.getHighVoltage()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.getHostname"><code class="docutils literal notranslate"><span class="pre">Ctb.getHostname()</span></code></a></li>
@@ -417,6 +418,7 @@
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.hardwareversion"><code class="docutils literal notranslate"><span class="pre">Ctb.hardwareversion</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.hasBitDefinition"><code class="docutils literal notranslate"><span class="pre">Ctb.hasBitDefinition()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.hasRegisterDefinition"><code class="docutils literal notranslate"><span class="pre">Ctb.hasRegisterDefinition()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.hdr"><code class="docutils literal notranslate"><span class="pre">Ctb.hdr</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.highvoltage"><code class="docutils literal notranslate"><span class="pre">Ctb.highvoltage</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.hostname"><code class="docutils literal notranslate"><span class="pre">Ctb.hostname</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.im_a"><code class="docutils literal notranslate"><span class="pre">Ctb.im_a</span></code></a></li>
@@ -628,6 +630,7 @@
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.setGainMode"><code class="docutils literal notranslate"><span class="pre">Ctb.setGainMode()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.setGapPixelsinCallback"><code class="docutils literal notranslate"><span class="pre">Ctb.setGapPixelsinCallback()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.setGateDelay"><code class="docutils literal notranslate"><span class="pre">Ctb.setGateDelay()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.setHDR"><code class="docutils literal notranslate"><span class="pre">Ctb.setHDR()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.setHighVoltage"><code class="docutils literal notranslate"><span class="pre">Ctb.setHighVoltage()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.setHostname"><code class="docutils literal notranslate"><span class="pre">Ctb.setHostname()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Ctb.setImageTestMode"><code class="docutils literal notranslate"><span class="pre">Ctb.setImageTestMode()</span></code></a></li>
@@ -2422,6 +2425,11 @@ d.getBit(mybit)</p>
<span class="sig-name descname"><span class="pre">getGateDelayForAllGates</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">slsdet._slsdet.CppDetectorApi</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Annotated</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">DurationWrapper</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FixedSize</span><span class="p"><span class="pre">(</span></span><span class="m"><span class="pre">3</span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#slsdet.Ctb.getGateDelayForAllGates" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slsdet.Ctb.getHDR">
<span class="sig-name descname"><span class="pre">getHDR</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">slsdet._slsdet.CppDetectorApi</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list[slsDetectorDefs::hdrParameters]</span></span></span><a class="headerlink" href="#slsdet.Ctb.getHDR" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slsdet.Ctb.getHardwareVersion">
<span class="sig-name descname"><span class="pre">getHardwareVersion</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">slsdet._slsdet.CppDetectorApi</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#slsdet.Ctb.getHardwareVersion" title="Link to this definition"></a></dt>
@@ -3264,6 +3272,25 @@ d.getBit(mybit)</p>
</ol>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="slsdet.Ctb.hdr">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">hdr</span></span><a class="headerlink" href="#slsdet.Ctb.hdr" title="Link to this definition"></a></dt>
<dd><p>[Jungfrau] Enables the high dynamic range in detector in synchrotron or fel mode.
Pass in an hdrParameters instance, optionally initialized with the desired operationMode (defs.operationMode.SYNCHOTRON or defs.operationMode.FEL). The default constructor hdrParameters() disables the HDR, which is the default mode of operation. FEL can only be used with chip version ‘1.2 HDR’.</p>
<p class="rubric">Example</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">d</span><span class="o">.</span><span class="n">hdr</span> <span class="o">=</span> <span class="n">hdrParameters</span><span class="p">(</span><span class="n">defs</span><span class="o">.</span><span class="n">SYNCHROTRON</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">d</span><span class="o">.</span><span class="n">hdr</span>
<span class="go">[enabled synchotron]</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">d</span><span class="o">.</span><span class="n">hdr</span> <span class="o">=</span> <span class="n">hdrParameters</span><span class="p">(</span><span class="n">defs</span><span class="o">.</span><span class="n">FEL</span><span class="p">)</span>
<span class="go">&gt;&gt;&gt;d.hdr</span>
<span class="go">[enabled fel]</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">d</span><span class="o">.</span><span class="n">hdr</span> <span class="o">=</span> <span class="n">hdrParameters</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">d</span><span class="o">.</span><span class="n">hdr</span>
<span class="go">[disabled]</span>
</pre></div>
</div>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="slsdet.Ctb.highvoltage">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">highvoltage</span></span><a class="headerlink" href="#slsdet.Ctb.highvoltage" title="Link to this definition"></a></dt>
@@ -5190,6 +5217,11 @@ d.setBit(mybit)</p>
<span class="sig-name descname"><span class="pre">setGateDelay</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">slsdet._slsdet.CppDetectorApi</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg1</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DurationWrapper</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg2</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#slsdet.Ctb.setGateDelay" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slsdet.Ctb.setHDR">
<span class="sig-name descname"><span class="pre">setHDR</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">slsdet._slsdet.CppDetectorApi</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">slsDetectorDefs::hdrParameters</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg1</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#slsdet.Ctb.setHDR" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slsdet.Ctb.setHighVoltage">
<span class="sig-name descname"><span class="pre">setHighVoltage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">slsdet._slsdet.CppDetectorApi</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg1</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#slsdet.Ctb.setHighVoltage" title="Link to this definition"></a></dt>
developer/pydetector.html
+32
View File
@@ -248,6 +248,7 @@
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.getGapPixelsinCallback"><code class="docutils literal notranslate"><span class="pre">Detector.getGapPixelsinCallback()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.getGateDelay"><code class="docutils literal notranslate"><span class="pre">Detector.getGateDelay()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.getGateDelayForAllGates"><code class="docutils literal notranslate"><span class="pre">Detector.getGateDelayForAllGates()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.getHDR"><code class="docutils literal notranslate"><span class="pre">Detector.getHDR()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.getHardwareVersion"><code class="docutils literal notranslate"><span class="pre">Detector.getHardwareVersion()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.getHighVoltage"><code class="docutils literal notranslate"><span class="pre">Detector.getHighVoltage()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.getHostname"><code class="docutils literal notranslate"><span class="pre">Detector.getHostname()</span></code></a></li>
@@ -414,6 +415,7 @@
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.hardwareversion"><code class="docutils literal notranslate"><span class="pre">Detector.hardwareversion</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.hasBitDefinition"><code class="docutils literal notranslate"><span class="pre">Detector.hasBitDefinition()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.hasRegisterDefinition"><code class="docutils literal notranslate"><span class="pre">Detector.hasRegisterDefinition()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.hdr"><code class="docutils literal notranslate"><span class="pre">Detector.hdr</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.highvoltage"><code class="docutils literal notranslate"><span class="pre">Detector.highvoltage</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.hostname"><code class="docutils literal notranslate"><span class="pre">Detector.hostname</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.im_a"><code class="docutils literal notranslate"><span class="pre">Detector.im_a</span></code></a></li>
@@ -623,6 +625,7 @@
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.setGainMode"><code class="docutils literal notranslate"><span class="pre">Detector.setGainMode()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.setGapPixelsinCallback"><code class="docutils literal notranslate"><span class="pre">Detector.setGapPixelsinCallback()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.setGateDelay"><code class="docutils literal notranslate"><span class="pre">Detector.setGateDelay()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.setHDR"><code class="docutils literal notranslate"><span class="pre">Detector.setHDR()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.setHighVoltage"><code class="docutils literal notranslate"><span class="pre">Detector.setHighVoltage()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.setHostname"><code class="docutils literal notranslate"><span class="pre">Detector.setHostname()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#slsdet.Detector.setImageTestMode"><code class="docutils literal notranslate"><span class="pre">Detector.setImageTestMode()</span></code></a></li>
@@ -2408,6 +2411,11 @@ d.getBit(mybit)</p>
<span class="sig-name descname"><span class="pre">getGateDelayForAllGates</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">slsdet._slsdet.CppDetectorApi</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Annotated</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">DurationWrapper</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FixedSize</span><span class="p"><span class="pre">(</span></span><span class="m"><span class="pre">3</span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#slsdet.Detector.getGateDelayForAllGates" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slsdet.Detector.getHDR">
<span class="sig-name descname"><span class="pre">getHDR</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">slsdet._slsdet.CppDetectorApi</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list[slsDetectorDefs::hdrParameters]</span></span></span><a class="headerlink" href="#slsdet.Detector.getHDR" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slsdet.Detector.getHardwareVersion">
<span class="sig-name descname"><span class="pre">getHardwareVersion</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">slsdet._slsdet.CppDetectorApi</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#slsdet.Detector.getHardwareVersion" title="Link to this definition"></a></dt>
@@ -3250,6 +3258,25 @@ d.getBit(mybit)</p>
</ol>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="slsdet.Detector.hdr">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">hdr</span></span><a class="headerlink" href="#slsdet.Detector.hdr" title="Link to this definition"></a></dt>
<dd><p>[Jungfrau] Enables the high dynamic range in detector in synchrotron or fel mode.
Pass in an hdrParameters instance, optionally initialized with the desired operationMode (defs.operationMode.SYNCHOTRON or defs.operationMode.FEL). The default constructor hdrParameters() disables the HDR, which is the default mode of operation. FEL can only be used with chip version ‘1.2 HDR’.</p>
<p class="rubric">Example</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">d</span><span class="o">.</span><span class="n">hdr</span> <span class="o">=</span> <span class="n">hdrParameters</span><span class="p">(</span><span class="n">defs</span><span class="o">.</span><span class="n">SYNCHROTRON</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">d</span><span class="o">.</span><span class="n">hdr</span>
<span class="go">[enabled synchotron]</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">d</span><span class="o">.</span><span class="n">hdr</span> <span class="o">=</span> <span class="n">hdrParameters</span><span class="p">(</span><span class="n">defs</span><span class="o">.</span><span class="n">FEL</span><span class="p">)</span>
<span class="go">&gt;&gt;&gt;d.hdr</span>
<span class="go">[enabled fel]</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">d</span><span class="o">.</span><span class="n">hdr</span> <span class="o">=</span> <span class="n">hdrParameters</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">d</span><span class="o">.</span><span class="n">hdr</span>
<span class="go">[disabled]</span>
</pre></div>
</div>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="slsdet.Detector.highvoltage">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">highvoltage</span></span><a class="headerlink" href="#slsdet.Detector.highvoltage" title="Link to this definition"></a></dt>
@@ -5143,6 +5170,11 @@ d.setBit(mybit)</p>
<span class="sig-name descname"><span class="pre">setGateDelay</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">slsdet._slsdet.CppDetectorApi</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg1</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DurationWrapper</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg2</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#slsdet.Detector.setGateDelay" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slsdet.Detector.setHDR">
<span class="sig-name descname"><span class="pre">setHDR</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">slsdet._slsdet.CppDetectorApi</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">slsDetectorDefs::hdrParameters</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg1</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#slsdet.Detector.setHDR" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="slsdet.Detector.setHighVoltage">
<span class="sig-name descname"><span class="pre">setHighVoltage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">slsdet._slsdet.CppDetectorApi</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg1</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#slsdet.Detector.setHighVoltage" title="Link to this definition"></a></dt>
developer/searchindex.js
+1 -1
View File
@@ -1 +1 @@
Search.setIndex({"alltitles":{"$SLSDETNAME":[[18,"slsdetname"]],"1. Install pre-built binaries using conda (Recommended)":[[16,"install-pre-built-binaries-using-conda-recommended"]],"1. Total Failure of Packet Delivery":[[37,"total-failure-of-packet-delivery"]],"1GbE/ 10GbE Interfaces":[[8,"gbe-10gbe-interfaces"],[8,"id29"]],"2. Partial or Random Packet Loss (Performance)":[[37,"partial-or-random-packet-loss-performance"]],"2. Pip":[[16,"pip"]],"3. Build from source":[[16,"build-from-source"]],"3.1. Download Source Code from github":[[16,"download-source-code-from-github"]],"3.2. Build from Source":[[16,"build-from-source-using-cmake"]],"3.2.1. Build using CMake":[[16,"build-using-cmake"]],"3.2.2. Build using in-built cmk.sh script":[[16,"build-using-in-built-cmk-sh-script"]],"3.2.3. Build RPM packages":[[16,"build-rpm-packages"]],"3.3. Build on old distributions using conda":[[16,"build-on-old-distributions-using-conda"]],"3.4. Build slsDetectorGui (Qt5)":[[16,"build-slsdetectorgui-qt5"]],"3.5. Build this documentation":[[16,"build-this-documentation"]],"4. Pybind and Zeromq":[[16,"pybind-and-zeromq"]],"5.0.0 - 6.1.1":[[33,"id1"]],"6.1.1+ (no tftp required)":[[33,"no-tftp-required"]],"< 5.0.0":[[33,"id2"]],"<\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014- 8 bytes per row \u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014>":[[41,"id2"]],"<\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014- 8 bytes \u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014->":[[41,"id3"],[41,"id4"]],"Accessing individual modules":[[24,"accessing-individual-modules"]],"Arguments":[[32,"arguments"],[42,"arguments"]],"Autocompletion":[[4,"autocompletion"]],"Automatic start":[[32,"automatic-start"]],"Binaries":[[42,"binaries"]],"Binary File Format":[[3,null]],"Building from Source":[[24,"building-from-source"]],"C++ API":[[15,null]],"CATCH2 Tests":[[0,"catch2-tests"]],"CMake: find_package and conda":[[6,"cmake-find-package-and-conda"]],"CMake: find_package(slsDetectorPackage)":[[6,"cmake-find-package-slsdetectorpackage"]],"CMake: slsDetectorPackage as submodule in your project":[[6,"cmake-slsdetectorpackage-as-submodule-in-your-project"]],"Cannot connect to detector":[[37,"cannot-connect-to-detector"]],"Cannot connect to receiver":[[37,"cannot-connect-to-receiver"]],"Cannot get data without a module attached":[[37,"cannot-get-data-without-a-module-attached"]],"Cannot get multi module data":[[37,"cannot-get-multi-module-data"],[37,"jungfrau-troubleshooting-power-supply"]],"Cannot ping module (Nios)":[[37,"cannot-ping-module-nios"]],"Cannot stop slaves in sync mode":[[37,"cannot-stop-slaves-in-sync-mode"]],"Checking for other detectors":[[18,"checking-for-other-detectors"]],"Chip Test Board":[[3,"chip-test-board"],[17,"chip-test-board"]],"Client":[[27,"client"],[36,"client"],[42,"client"]],"Client Commands":[[34,"client-commands"]],"Client to Module":[[5,"client-to-module"]],"Client to Receiver":[[5,"client-to-receiver"]],"Command Execution":[[4,"command-execution"]],"Command line":[[15,null]],"Command line interface":[[4,null]],"Commands":[[4,"commands"]],"Common":[[37,"common"]],"Compilation":[[14,"compilation"],[42,"compilation"]],"Compile examples":[[11,"compile-examples"]],"Config file":[[39,null]],"Consuming slsDetectorPackage":[[6,null]],"ContainerUtils":[[7,null]],"Content":[[12,"content"]],"Converting numbers to hex":[[23,"converting-numbers-to-hex"]],"Core":[[9,"core"]],"Counters":[[8,"counters"]],"Ctb":[[13,"ctb"],[20,null],[31,"ctb"]],"Current Version":[[41,"current-version"]],"Custom Receiver":[[29,null]],"DACS":[[31,"dacs"],[31,"id1"],[31,"id2"],[31,"id3"],[31,"id4"]],"DAQ Info Field":[[40,"id10"]],"Data":[[27,"data"]],"Data File":[[3,"data-file"],[14,"data-file"]],"Default Configuration":[[8,"default-configuration"],[8,"id25"],[8,"id33"]],"Default Values":[[31,null]],"Default values":[[31,"id5"],[31,"id7"],[31,"id9"],[31,"id11"],[31,"id12"],[31,"id14"]],"Dependencies":[[9,null]],"Dependencies to build GUI":[[9,"dependencies-to-build-gui"]],"Dependencies to build Moench and Jungfrau executables":[[9,"dependencies-to-build-moench-and-jungfrau-executables"]],"Dependencies to build Python module":[[9,"dependencies-to-build-python-module"]],"Dependencies to build Tests":[[9,"dependencies-to-build-tests"]],"Dependencies to build documentation":[[9,"dependencies-to-build-documentation"]],"Deprecated commands":[[4,"deprecated-commands"],[4,"id1"]],"Description":[[41,"description"]],"Detector":[[10,null],[21,null],[27,"detector"]],"Detector Enum":[[41,"detector-enum"]],"Detector Image Size and Format":[[8,null]],"Detector Server":[[15,null]],"Detector Specific Field":[[40,"id8"],[40,"id9"],[40,"id11"],[40,"id12"]],"Detector Specific Fields":[[40,null]],"Detector UDP Header":[[15,null]],"Detector index":[[4,"detector-index"],[18,"detectLine truncated
Search.setIndex({"alltitles":{"$SLSDETNAME":[[18,"slsdetname"]],"1. Install pre-built binaries using conda (Recommended)":[[16,"install-pre-built-binaries-using-conda-recommended"]],"1. Total Failure of Packet Delivery":[[37,"total-failure-of-packet-delivery"]],"1GbE/ 10GbE Interfaces":[[8,"gbe-10gbe-interfaces"],[8,"id29"]],"2. Partial or Random Packet Loss (Performance)":[[37,"partial-or-random-packet-loss-performance"]],"2. Pip":[[16,"pip"]],"3. Build from source":[[16,"build-from-source"]],"3.1. Download Source Code from github":[[16,"download-source-code-from-github"]],"3.2. Build from Source":[[16,"build-from-source-using-cmake"]],"3.2.1. Build using CMake":[[16,"build-using-cmake"]],"3.2.2. Build using in-built cmk.sh script":[[16,"build-using-in-built-cmk-sh-script"]],"3.2.3. Build RPM packages":[[16,"build-rpm-packages"]],"3.3. Build on old distributions using conda":[[16,"build-on-old-distributions-using-conda"]],"3.4. Build slsDetectorGui (Qt5)":[[16,"build-slsdetectorgui-qt5"]],"3.5. Build this documentation":[[16,"build-this-documentation"]],"4. Pybind and Zeromq":[[16,"pybind-and-zeromq"]],"5.0.0 - 6.1.1":[[33,"id1"]],"6.1.1+ (no tftp required)":[[33,"no-tftp-required"]],"< 5.0.0":[[33,"id2"]],"<\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014- 8 bytes per row \u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014>":[[41,"id2"]],"<\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014- 8 bytes \u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014->":[[41,"id3"],[41,"id4"]],"Accessing individual modules":[[24,"accessing-individual-modules"]],"Arguments":[[32,"arguments"],[42,"arguments"]],"Autocompletion":[[4,"autocompletion"]],"Automatic start":[[32,"automatic-start"]],"Binaries":[[42,"binaries"]],"Binary File Format":[[3,null]],"Building from Source":[[24,"building-from-source"]],"C++ API":[[15,null]],"CATCH2 Tests":[[0,"catch2-tests"]],"CMake: find_package and conda":[[6,"cmake-find-package-and-conda"]],"CMake: find_package(slsDetectorPackage)":[[6,"cmake-find-package-slsdetectorpackage"]],"CMake: slsDetectorPackage as submodule in your project":[[6,"cmake-slsdetectorpackage-as-submodule-in-your-project"]],"Cannot connect to detector":[[37,"cannot-connect-to-detector"]],"Cannot connect to receiver":[[37,"cannot-connect-to-receiver"]],"Cannot get data without a module attached":[[37,"cannot-get-data-without-a-module-attached"]],"Cannot get multi module data":[[37,"cannot-get-multi-module-data"],[37,"jungfrau-troubleshooting-power-supply"]],"Cannot ping module (Nios)":[[37,"cannot-ping-module-nios"]],"Cannot stop slaves in sync mode":[[37,"cannot-stop-slaves-in-sync-mode"]],"Checking for other detectors":[[18,"checking-for-other-detectors"]],"Chip Test Board":[[3,"chip-test-board"],[17,"chip-test-board"]],"Client":[[27,"client"],[36,"client"],[42,"client"]],"Client Commands":[[34,"client-commands"]],"Client to Module":[[5,"client-to-module"]],"Client to Receiver":[[5,"client-to-receiver"]],"Command Execution":[[4,"command-execution"]],"Command line":[[15,null]],"Command line interface":[[4,null]],"Commands":[[4,"commands"]],"Common":[[37,"common"]],"Compilation":[[14,"compilation"],[42,"compilation"]],"Compile examples":[[11,"compile-examples"]],"Config file":[[39,null]],"Consuming slsDetectorPackage":[[6,null]],"ContainerUtils":[[7,null]],"Content":[[12,"content"]],"Converting numbers to hex":[[23,"converting-numbers-to-hex"]],"Core":[[9,"core"]],"Counters":[[8,"counters"]],"Ctb":[[13,"ctb"],[20,null],[31,"ctb"]],"Current Version":[[41,"current-version"]],"Custom Receiver":[[29,null]],"DACS":[[31,"dacs"],[31,"id1"],[31,"id2"],[31,"id3"],[31,"id4"]],"DAQ Info Field":[[40,"id10"]],"Data":[[27,"data"]],"Data File":[[3,"data-file"],[14,"data-file"]],"Default Configuration":[[8,"default-configuration"],[8,"id25"],[8,"id33"]],"Default Values":[[31,null]],"Default values":[[31,"id5"],[31,"id7"],[31,"id9"],[31,"id11"],[31,"id12"],[31,"id14"]],"Dependencies":[[9,null]],"Dependencies to build GUI":[[9,"dependencies-to-build-gui"]],"Dependencies to build Moench and Jungfrau executables":[[9,"dependencies-to-build-moench-and-jungfrau-executables"]],"Dependencies to build Python module":[[9,"dependencies-to-build-python-module"]],"Dependencies to build Tests":[[9,"dependencies-to-build-tests"]],"Dependencies to build documentation":[[9,"dependencies-to-build-documentation"]],"Deprecated commands":[[4,"deprecated-commands"],[4,"id1"]],"Description":[[41,"description"]],"Detector":[[10,null],[21,null],[27,"detector"]],"Detector Enum":[[41,"detector-enum"]],"Detector Image Size and Format":[[8,null]],"Detector Server":[[15,null]],"Detector Specific Field":[[40,"id8"],[40,"id9"],[40,"id11"],[40,"id12"]],"Detector Specific Fields":[[40,null]],"Detector UDP Header":[[15,null]],"Detector index":[[4,"detector-index"],[18,"detectLine truncated
developer/serverdefaults.html
+12
View File
@@ -1978,6 +1978,18 @@
<tr class="row-even"><td><p>ADC_OFST_QUARTER_SPEED_BOARD2_VAL</p></td>
<td><p>0x08</p></td>
</tr>
<tr class="row-odd"><td><p>HDR_SYNC_TIMEOUT_PERCENT</p></td>
<td><p>8</p></td>
</tr>
<tr class="row-even"><td><p>HDR_SYNC_ACT_TIME_CLK_VAL</p></td>
<td><p>1</p></td>
</tr>
<tr class="row-odd"><td><p>HDR_FEL_TIMEOUT_PERCENT</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-even"><td><p>HDR_FEL_ACT_TIME_CLK_VAL</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-odd"><td><p>IP_HEADER_SIZE</p></td>
<td><p>20</p></td>
</tr>