mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2026-01-21 08:51:41 +01:00
266 lines
17 KiB
HTML
266 lines
17 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" data-content_root="./">
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Examples — slsDetectorPackage 9.1.0 documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
|
|
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
|
<link rel="stylesheet" type="text/css" href="_static/css/extra.css?v=2be88464" />
|
|
|
|
|
|
<script src="_static/jquery.js?v=5d32c60e"></script>
|
|
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
|
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
|
<script src="_static/doctools.js?v=9bcbadda"></script>
|
|
<script src="_static/sphinx_highlight.js?v=dc90522c"></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="Getting Started" href="pygettingstarted.html" />
|
|
<link rel="prev" title="Receiver" href="receiver_api.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 9.1.0
|
|
</a>
|
|
<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 class="current">
|
|
<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 current"><a class="current reference internal" href="#">Examples</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="#setup">Setup</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#compile-examples">Compile examples</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#running-a-config-file-e1">Running a config file [e1]</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#using-the-return-type-sls-result-e2">Using the return type sls::Result [e2]</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#setting-exposure-time-e3">Setting exposure time [e3]</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Python API</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="pygettingstarted.html">Getting Started</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="pydetector.html">Detector</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="pyenums.html">Enums</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="pyexamples.html">Examples</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Command line</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="commandline.html">Command line interface</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">Quick Start Guide</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Developer</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="container_utils.html">ContainerUtils</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="type_traits.html">TypeTraits</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="ToString.html">ToString</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Firmware</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="firmware.html">Firmware Upgrade</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Detector Server</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="servers.html">Getting Started</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="serverupgrade.html">Upgrade</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="virtualserver.html">Simulators</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="serverdefaults.html">Default Values</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Detector UDP Header</span></p>
|
|
<ul>
|
|
<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 9.1.0</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">Examples</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="_sources/examples.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="examples">
|
|
<span id="cplusplus-api-examples"></span><h1>Examples<a class="headerlink" href="#examples" title="Link to this heading"></a></h1>
|
|
<section id="setup">
|
|
<h2>Setup<a class="headerlink" href="#setup" title="Link to this heading"></a></h2>
|
|
<p>The examples here assume that you have compiled and installed slsDetectorPackage
|
|
to ~/sls/install and that the option for SLS_USE_SIMULATOR was enabled. This also builds
|
|
the virtual detector servers that we will be using for testing.</p>
|
|
<p>We also add ~/sls/detector/install/bin to the path for convenience.</p>
|
|
</section>
|
|
<section id="compile-examples">
|
|
<h2>Compile examples<a class="headerlink" href="#compile-examples" title="Link to this heading"></a></h2>
|
|
<p>The source code of the examples is available at:
|
|
<a class="reference external" href="https://github.com/slsdetectorgroup/api-examples">https://github.com/slsdetectorgroup/api-examples</a></p>
|
|
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/slsdetectorgroup/api-examples.git
|
|
mkdir<span class="w"> </span>build<span class="w"> </span><span class="o">&&</span><span class="w"> </span><span class="nb">cd</span><span class="w"> </span>build
|
|
cmake<span class="w"> </span>../api-examples<span class="w"> </span>-DCMAKE_PREFIX_PATH<span class="o">=</span>~/sls/detector/install
|
|
make
|
|
</pre></div>
|
|
</div>
|
|
<p>Below follows a short description of what is included in the examples.</p>
|
|
</section>
|
|
<section id="running-a-config-file-e1">
|
|
<h2>Running a config file [e1]<a class="headerlink" href="#running-a-config-file-e1" title="Link to this heading"></a></h2>
|
|
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf">"sls/Detector.h"</span>
|
|
<span class="p">...</span>
|
|
<span class="n">sls</span><span class="o">::</span><span class="n">Detector</span><span class="w"> </span><span class="n">det</span><span class="p">;</span>
|
|
<span class="n">det</span><span class="p">.</span><span class="n">loadConfig</span><span class="p">(</span><span class="s">"path/to/config/file.config"</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>To configure the connection between PC and detector the easiest
|
|
is to run a config file. For this example we first launch a virtual Jungfrau server and
|
|
then set up the detector.</p>
|
|
<p><strong>Launch a virtual detector server</strong></p>
|
|
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>jungfrauDetectorServer_virtual
|
|
</pre></div>
|
|
</div>
|
|
<p>This launches a virtual Jungfrau detector server. As default it uses port 1952 and 1953
|
|
for communication over TCP. Most commands go on 1952 and only a few such as stop and status on 1953.</p>
|
|
<p><strong>Run example to configure</strong></p>
|
|
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./e1-config<span class="w"> </span>one_det_no_receiver.config
|
|
-<span class="w"> </span><span class="m">12</span>:01:06.371<span class="w"> </span>INFO:<span class="w"> </span>Shared<span class="w"> </span>memory<span class="w"> </span>deleted<span class="w"> </span>/slsDetectorPackage_multi_0_sls_0
|
|
-<span class="w"> </span><span class="m">12</span>:01:06.371<span class="w"> </span>INFO:<span class="w"> </span>Shared<span class="w"> </span>memory<span class="w"> </span>deleted<span class="w"> </span>/slsDetectorPackage_multi_0
|
|
-<span class="w"> </span><span class="m">12</span>:01:06.372<span class="w"> </span>INFO:<span class="w"> </span>Shared<span class="w"> </span>memory<span class="w"> </span>created<span class="w"> </span>/slsDetectorPackage_multi_0
|
|
-<span class="w"> </span><span class="m">12</span>:01:06.376<span class="w"> </span>INFO:<span class="w"> </span>Loading<span class="w"> </span>configuration<span class="w"> </span>file:<span class="w"> </span>one_det_no_receiver.config
|
|
-<span class="w"> </span><span class="m">12</span>:01:06.376<span class="w"> </span>INFO:<span class="w"> </span>Adding<span class="w"> </span>detector<span class="w"> </span>localhost
|
|
-<span class="w"> </span><span class="m">12</span>:01:06.377<span class="w"> </span>INFO:<span class="w"> </span>Shared<span class="w"> </span>memory<span class="w"> </span>created<span class="w"> </span>/slsDetectorPackage_multi_0_sls_0
|
|
-<span class="w"> </span><span class="m">12</span>:01:06.377<span class="w"> </span>INFO:<span class="w"> </span>Checking<span class="w"> </span>Detector<span class="w"> </span>Version<span class="w"> </span>Compatibility
|
|
-<span class="w"> </span><span class="m">12</span>:01:06.378<span class="w"> </span>INFO:<span class="w"> </span>Detector<span class="w"> </span>connecting<span class="w"> </span>-<span class="w"> </span>updating!
|
|
hostname<span class="w"> </span><span class="o">[</span>localhost<span class="o">]</span>
|
|
|
|
|
|
Jungfrau<span class="w"> </span>detector<span class="w"> </span>with<span class="w"> </span><span class="m">1</span><span class="w"> </span>modules<span class="w"> </span>configured
|
|
</pre></div>
|
|
</div>
|
|
</section>
|
|
<section id="using-the-return-type-sls-result-e2">
|
|
<h2>Using the return type sls::Result [e2]<a class="headerlink" href="#using-the-return-type-sls-result-e2" title="Link to this heading"></a></h2>
|
|
<p>Since many our detectors have multiple modules we cannot return
|
|
a single value when reading from the Detector. Hostname, Ip and also
|
|
for example exposure time can differ between modules.</p>
|
|
<p>Therefore we return Result<T> which is a thin wrapper around
|
|
std::vector.</p>
|
|
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="n">sls</span><span class="o">::</span><span class="n">Result</span><span class="o"><</span><span class="kt">int</span><span class="o">></span><span class="w"> </span><span class="n">res1</span><span class="p">{</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="p">};</span>
|
|
<span class="n">std</span><span class="o">::</span><span class="n">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"res1: "</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">res1</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="sc">'\n'</span><span class="p">;</span>
|
|
<span class="n">res1</span><span class="p">.</span><span class="n">squash</span><span class="p">();</span>
|
|
<span class="cp"># return -1 if different</span>
|
|
<span class="n">res1</span><span class="p">.</span><span class="n">squash</span><span class="p">(</span><span class="mi">-1</span><span class="p">);</span>
|
|
<span class="cp"># throw exception with custom message if different</span>
|
|
<span class="n">res1</span><span class="p">.</span><span class="n">tsquash</span><span class="p">(</span><span class="s">"Values are different);</span>
|
|
</pre></div>
|
|
</div>
|
|
</section>
|
|
<section id="setting-exposure-time-e3">
|
|
<h2>Setting exposure time [e3]<a class="headerlink" href="#setting-exposure-time-e3" title="Link to this heading"></a></h2>
|
|
<p>For setting times, like exposure time, period, delay etc.
|
|
we use std::chrono::duration.</p>
|
|
<p>Example 3 shows how to set and read exposure time as well
|
|
as converting to floating point.</p>
|
|
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf">"sls/Detector.h"</span>
|
|
<span class="cp">#include</span><span class="w"> </span><span class="cpf"><chrono></span>
|
|
<span class="p">...</span>
|
|
<span class="n">std</span><span class="o">::</span><span class="n">chrono</span><span class="o">::</span><span class="n">microseconds</span><span class="w"> </span><span class="n">t0</span><span class="p">{</span><span class="mi">500</span><span class="p">};</span>
|
|
<span class="n">det</span><span class="p">.</span><span class="n">setExptime</span><span class="p">(</span><span class="n">t0</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="receiver_api.html" class="btn btn-neutral float-left" title="Receiver" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="pygettingstarted.html" class="btn btn-neutral float-right" title="Getting Started" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2020, PSD Detector Group.</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |