mirror of
https://github.com/slsdetectorgroup/aare.git
synced 2025-06-08 21:40:43 +02:00
124 lines
5.8 KiB
HTML
124 lines
5.8 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.7"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>AARE: aare</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">AARE
|
|
</div>
|
|
<div id="projectbrief">Data analysis library for PSI hybrid detectors</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.7 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div><div class="header">
|
|
<div class="headertitle"><div class="title">aare </div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p><a class="anchor" id="md_README"></a>Data analysis library for PSI hybrid detectors</p>
|
|
<h1><a class="anchor" id="autotoc_md1"></a>
|
|
Folder structure</h1>
|
|
<table class="markdownTable">
|
|
<tr class="markdownTableHead">
|
|
<th class="markdownTableHeadNone">Folder </th><th class="markdownTableHeadNone">subfolder </th><th class="markdownTableHeadNone">Content </th></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyNone">include/ </td><td class="markdownTableBodyNone">aare/ </td><td class="markdownTableBodyNone">top level header/s </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyNone">core/ </td><td class="markdownTableBodyNone">include/ </td><td class="markdownTableBodyNone">public headers for core </td></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">src/ </td><td class="markdownTableBodyNone">source files and non public headers </td></tr>
|
|
</table>
|
|
<h1><a class="anchor" id="autotoc_md2"></a>
|
|
file_io class diagram</h1>
|
|
<p><img src="./extra/uml/out/file_io/ClassDiagram.png" alt="file_io class diagram" class="inline"/></p>
|
|
<h1><a class="anchor" id="autotoc_md3"></a>
|
|
Test the zmq socket with a detector simulator</h1>
|
|
<p><b>1. Download and build the slsDetectorPackage</b></p>
|
|
<div class="fragment"><div class="line">git clone https://github.com/slsdetectorgroup/slsDetectorPackage.git --branch=8.0.1 #or the desired branch</div>
|
|
<div class="line">cd slsDetectorPackage</div>
|
|
<div class="line">mkdir build && cd build</div>
|
|
<div class="line">cmake .. -DSLS_USE_SIMULATOR=ON</div>
|
|
<div class="line">make -j8 #or your number of cores</div>
|
|
</div><!-- fragment --><p><b>2. Launch the slsReceiver</b> </p><div class="fragment"><div class="line">bin/slsReceiver</div>
|
|
</div><!-- fragment --><p><b>3. Launch the virtual server</b> </p><div class="fragment"><div class="line">bin/jungfrauDetectorServer_virtual</div>
|
|
</div><!-- fragment --><p><b>4 Configure the detector simulator</b></p>
|
|
<div class="fragment"><div class="line">#sample config file is in etc/ in the aare repo</div>
|
|
<div class="line">sls_detector_put config etc/virtual_jf.config</div>
|
|
<div class="line"> </div>
|
|
<div class="line">#Now you can take images using sls_detector_acquire</div>
|
|
<div class="line">sls_detector_acquire</div>
|
|
</div><!-- fragment --><p><b>5. Run the zmq example</b> </p><div class="fragment"><div class="line">examples/zmq_example</div>
|
|
<div class="line"> </div>
|
|
<div class="line">#Will print the headers fof the frames received</div>
|
|
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md4"></a>
|
|
Test the zmq processing replaying data</h1>
|
|
<p>To be implemented</p>
|
|
<h1><a class="anchor" id="autotoc_md5"></a>
|
|
generate documentation</h1>
|
|
<div class="fragment"></div><!-- fragment --> </div></div><!-- PageDoc -->
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
|
|
</small></address>
|
|
</body>
|
|
</html>
|