detectors/slsDetectorPackage
24
1
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2026-01-20 23:18:52 +01:00
Code Issues Actions Packages Releases Activity
Files
2108d3aeefe0cc890be34db5e9c271e4667d11a3
slsDetectorPackage/10.0.0/hdf5fileformat.html

277 lines
15 KiB
HTML
Raw Blame History

<!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>HDF5 File Format &mdash; slsDetectorPackage 10.0.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="ZMQ: Json Header Format" href="zmqjsonheaderformat.html" />
<link rel="prev" title="Binary File Format" href="binaryfileformat.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 10.0.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">how to</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="softwarearchitecture.html">Software Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="configcommands.html">Setup Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">Quick Start Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="dataformat.html">Detector Image Size and Format</a></li>
<li class="toctree-l1"><a class="reference internal" href="multidet.html">Using multiple detectors</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>
<li class="toctree-l1"><a class="reference internal" href="pyPatternGenerator.html">PatternGenerator</a></li>
<li class="toctree-l1"><a class="reference internal" href="pattern.html">Pattern</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>
</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="slsreceiver.html">In-built Receiver</a></li>
<li class="toctree-l1"><a class="reference internal" href="receivers.html">Custom Receiver</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Receiver Files</span></p>
<ul class="current">
<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="dataformat.html">Detector Image Size and 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 current"><a class="current reference internal" href="#">HDF5 File Format</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#compilation">Compilation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="#master-file">Master File</a></li>
<li class="toctree-l2"><a class="reference internal" href="#data-file">Data File</a></li>
<li class="toctree-l2"><a class="reference internal" href="#virtual-data-file">Virtual Data File</a></li>
</ul>
</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 10.0.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">HDF5 File Format</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/hdf5fileformat.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="hdf5-file-format">
<span id="id1"></span><h1>HDF5 File Format<a class="headerlink" href="#hdf5-file-format" title="Link to this heading"></a></h1>
<section id="compilation">
<h2>Compilation<a class="headerlink" href="#compilation" title="Link to this heading"></a></h2>
<ol class="arabic">
<li><p>Compile the package with HDF5 option enabled</p>
<blockquote>
<div><ol class="arabic simple">
<li><p>Using cmk script: ./cmk.sh -hj9 -d [path of hdf5 dir] (-d is optional and for custom installation folder)</p></li>
<li><p>Enable using cmake option <strong>-DSLS_USE_HDF5=ON</strong> and <strong>-DCMAKE_INSTALL_PREFIX=/path/to/custom/hdf/installation</strong> (optional).</p></li>
</ol>
</div></blockquote>
</li>
</ol>
</section>
<section id="setup">
<h2>Setup<a class="headerlink" href="#setup" title="Link to this heading"></a></h2>
<ol class="arabic">
<li><p>Start Receiver process</p></li>
<li><p>Load config file</p></li>
<li><p>Set file format using command <a class="reference external" href="commandline.html#term-fformat-binary-hdf5">fformat</a>.</p>
<blockquote>
<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sls_detector_put<span class="w"> </span>fformat<span class="w"> </span>hdf5
</pre></div>
</div>
</div></blockquote>
</li>
</ol>
</section>
<section id="master-file">
<h2>Master File<a class="headerlink" href="#master-file" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>File Name: [fpath]/[fname]_master_[findex].h5 <a class="reference internal" href="fileformat.html#file-name-format"><span class="std std-ref">Details here</span></a></p></li>
<li><p>It contains <a class="reference internal" href="masterfileattributes.html#master-file-attributes"><span class="std std-ref">attributes</span></a> relevant to the acquisition. This can vary with detector type.</p></li>
</ul>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>/ # Root level
|---&gt; entry # entry group
| |---&gt; data # data group
| |---&gt; column # dataset of each sls_receiver_header member
| |---&gt; data
| |---&gt; detector header version
| |---&gt; detector specific 1
| |---&gt; detector specific 2
| |---&gt; detector specific 3
| |---&gt; detector specific 4
| |---&gt; detector type
| |---&gt; exp length or sub exposure time
| |---&gt; frame number
| |---&gt; mod id
| |---&gt; packets caught
| |---&gt; packets caught bit mask
| |---&gt; row
| |---&gt; timestamp
| |---&gt; instrument # instrument group
| |---&gt; beam # beam group
| |---&gt; detector # detector group
| |---&gt; Master File Attribute 1 # dataset of each master file attribute
| |---&gt; Master File Attribute 2
| |---&gt; Master File Attribute 3
| |---&gt; Master File Attribute ..
| |---&gt; sample # sample group
</pre></div>
</div>
<dl class="simple">
<dt>If more than 1 data file per frame:</dt><dd><ul class="simple">
<li><p>The dataset of each <a class="reference internal" href="slsreceiverheaderformat.html#sls-receiver-header-format"><span class="std std-ref">**SLS Receiver Header**</span></a> member is a virtual dataset.</p></li>
<li><p><strong>data</strong> dataset is a virtual dataset.</p></li>
</ul>
</dd>
</dl>
<p>More details regarding master file attributes can be found <a class="reference internal" href="masterfileattributes.html#master-file-attributes"><span class="std std-ref">here</span></a>.</p>
</section>
<section id="data-file">
<h2>Data File<a class="headerlink" href="#data-file" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>File Name: [fpath]/[fname]_dx_fy_[findex].h5 <a class="reference internal" href="fileformat.html#file-name-format"><span class="std std-ref">Details here</span></a></p></li>
<li><p>More details on <a class="reference internal" href="slsreceiverheaderformat.html#sls-receiver-header-format"><span class="std std-ref">slsReceiverHeader</span></a> and the actual image data is described in the <a class="reference internal" href="dataformat.html#data-format"><span class="std std-ref">Detector Image Size and Format</span></a> section.</p></li>
</ul>
</section>
<section id="virtual-data-file">
<h2>Virtual Data File<a class="headerlink" href="#virtual-data-file" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>File Name: [fpath]/[fname]_virtual_[findex].h5 <a class="reference internal" href="fileformat.html#file-name-format"><span class="std std-ref">Details here</span></a></p></li>
<li><p>For multiple modules, a virtual file linking data from all the modules is created. The individual files are expected to be present.</p></li>
<li><p>It is linked in the master file.</p></li>
</ul>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="binaryfileformat.html" class="btn btn-neutral float-left" title="Binary File Format" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="zmqjsonheaderformat.html" class="btn btn-neutral float-right" title="ZMQ: Json Header Format" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; 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>
View Git Blame Copy Permalink