detectors/aare
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/aare.git synced 2025-06-08 05:30:41 +02:00
Code Issues Actions Packages Releases Activity
aare/docs/html/namespaceread__frame.html
Bechir Braham 2ebbd0d7cd
setup doxygen and clang-uml files
2024-04-11 17:20:34 +02:00

284 lines
16 KiB
HTML
Raw Permalink Blame History

<!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: read_frame Namespace Reference</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&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">read_frame Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a9c0443156455ec3307e2ecf33b6f3f64"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceread__frame.html#a9c0443156455ec3307e2ecf33b6f3f64">header_dt</a></td></tr>
<tr class="separator:a9c0443156455ec3307e2ecf33b6f3f64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb577dcd8f857453b243609bd3fe9c6b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceread__frame.html#aeb577dcd8f857453b243609bd3fe9c6b">rows</a> = 512</td></tr>
<tr class="separator:aeb577dcd8f857453b243609bd3fe9c6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad73343f290475167492512cd21ca5eff"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceread__frame.html#ad73343f290475167492512cd21ca5eff">cols</a> = 1024</td></tr>
<tr class="separator:ad73343f290475167492512cd21ca5eff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ee86864b77a2fbd666de97025d3a7b7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceread__frame.html#a1ee86864b77a2fbd666de97025d3a7b7">frames</a> = 10</td></tr>
<tr class="separator:a1ee86864b77a2fbd666de97025d3a7b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4882ed85143715456b91190632b4b11"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceread__frame.html#ae4882ed85143715456b91190632b4b11">data</a> = np.zeros((<a class="el" href="namespaceread__frame.html#a1ee86864b77a2fbd666de97025d3a7b7">frames</a>,<a class="el" href="namespaceread__frame.html#aeb577dcd8f857453b243609bd3fe9c6b">rows</a>,<a class="el" href="namespaceread__frame.html#ad73343f290475167492512cd21ca5eff">cols</a>), <a class="el" href="namespaceread__frame.html#a5e9c5cff309a0730b8df893c3ff3bde4">dtype</a> = np.uint16)</td></tr>
<tr class="separator:ae4882ed85143715456b91190632b4b11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a712f4321b682572ca70910beebf794f2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceread__frame.html#a712f4321b682572ca70910beebf794f2">header</a> = np.zeros(<a class="el" href="namespaceread__frame.html#a1ee86864b77a2fbd666de97025d3a7b7">frames</a>, <a class="el" href="namespaceread__frame.html#a5e9c5cff309a0730b8df893c3ff3bde4">dtype</a> = <a class="el" href="namespaceread__frame.html#a9c0443156455ec3307e2ecf33b6f3f64">header_dt</a>)</td></tr>
<tr class="separator:a712f4321b682572ca70910beebf794f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad23adc485f1714de79813577dcecaf7c"><td class="memItemLeft" align="right" valign="top">str&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceread__frame.html#ad23adc485f1714de79813577dcecaf7c">file_name</a> = 'jungfrau_single_d0_f{}_0.raw'.format(file_id)</td></tr>
<tr class="separator:ad23adc485f1714de79813577dcecaf7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc85620c668618147dfa83334a28a8f1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceread__frame.html#adc85620c668618147dfa83334a28a8f1">f</a></td></tr>
<tr class="separator:adc85620c668618147dfa83334a28a8f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e9c5cff309a0730b8df893c3ff3bde4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceread__frame.html#a5e9c5cff309a0730b8df893c3ff3bde4">dtype</a></td></tr>
<tr class="separator:a5e9c5cff309a0730b8df893c3ff3bde4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a212807e8a4902926048a0d49d3151e15"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceread__frame.html#a212807e8a4902926048a0d49d3151e15">count</a></td></tr>
<tr class="separator:a212807e8a4902926048a0d49d3151e15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a000169c5994988e16048b3cf8e461fe6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceread__frame.html#a000169c5994988e16048b3cf8e461fe6">uint16</a></td></tr>
<tr class="separator:a000169c5994988e16048b3cf8e461fe6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ad73343f290475167492512cd21ca5eff" name="ad73343f290475167492512cd21ca5eff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad73343f290475167492512cd21ca5eff">&#9670;&#160;</a></span>cols</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int read_frame.cols = 1024</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a212807e8a4902926048a0d49d3151e15" name="a212807e8a4902926048a0d49d3151e15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a212807e8a4902926048a0d49d3151e15">&#9670;&#160;</a></span>count</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">read_frame.count</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae4882ed85143715456b91190632b4b11" name="ae4882ed85143715456b91190632b4b11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4882ed85143715456b91190632b4b11">&#9670;&#160;</a></span>data</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">read_frame.data = np.zeros((<a class="el" href="namespaceread__frame.html#a1ee86864b77a2fbd666de97025d3a7b7">frames</a>,<a class="el" href="namespaceread__frame.html#aeb577dcd8f857453b243609bd3fe9c6b">rows</a>,<a class="el" href="namespaceread__frame.html#ad73343f290475167492512cd21ca5eff">cols</a>), <a class="el" href="namespaceread__frame.html#a5e9c5cff309a0730b8df893c3ff3bde4">dtype</a> = np.uint16)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5e9c5cff309a0730b8df893c3ff3bde4" name="a5e9c5cff309a0730b8df893c3ff3bde4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e9c5cff309a0730b8df893c3ff3bde4">&#9670;&#160;</a></span>dtype</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">read_frame.dtype</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="adc85620c668618147dfa83334a28a8f1" name="adc85620c668618147dfa83334a28a8f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc85620c668618147dfa83334a28a8f1">&#9670;&#160;</a></span>f</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">read_frame.f</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad23adc485f1714de79813577dcecaf7c" name="ad23adc485f1714de79813577dcecaf7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad23adc485f1714de79813577dcecaf7c">&#9670;&#160;</a></span>file_name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">str read_frame.file_name = 'jungfrau_single_d0_f{}_0.raw'.format(file_id)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1ee86864b77a2fbd666de97025d3a7b7" name="a1ee86864b77a2fbd666de97025d3a7b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ee86864b77a2fbd666de97025d3a7b7">&#9670;&#160;</a></span>frames</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int read_frame.frames = 10</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a712f4321b682572ca70910beebf794f2" name="a712f4321b682572ca70910beebf794f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a712f4321b682572ca70910beebf794f2">&#9670;&#160;</a></span>header</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">read_frame.header = np.zeros(<a class="el" href="namespaceread__frame.html#a1ee86864b77a2fbd666de97025d3a7b7">frames</a>, <a class="el" href="namespaceread__frame.html#a5e9c5cff309a0730b8df893c3ff3bde4">dtype</a> = <a class="el" href="namespaceread__frame.html#a9c0443156455ec3307e2ecf33b6f3f64">header_dt</a>)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a9c0443156455ec3307e2ecf33b6f3f64" name="a9c0443156455ec3307e2ecf33b6f3f64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c0443156455ec3307e2ecf33b6f3f64">&#9670;&#160;</a></span>header_dt</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">read_frame.header_dt</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line"><span class="lineno"> 1</span>= np.dtype(</div>
<div class="line"><span class="lineno"> 2</span> [</div>
<div class="line"><span class="lineno"> 3</span> (<span class="stringliteral">&quot;Frame Number&quot;</span>, <span class="stringliteral">&quot;u8&quot;</span>),</div>
<div class="line"><span class="lineno"> 4</span> (<span class="stringliteral">&quot;SubFrame Number/ExpLength&quot;</span>, <span class="stringliteral">&quot;u4&quot;</span>),</div>
<div class="line"><span class="lineno"> 5</span> (<span class="stringliteral">&quot;Packet Number&quot;</span>, <span class="stringliteral">&quot;u4&quot;</span>),</div>
<div class="line"><span class="lineno"> 6</span> (<span class="stringliteral">&quot;Bunch ID&quot;</span>, <span class="stringliteral">&quot;u8&quot;</span>),</div>
<div class="line"><span class="lineno"> 7</span> (<span class="stringliteral">&quot;Timestamp&quot;</span>, <span class="stringliteral">&quot;u8&quot;</span>),</div>
<div class="line"><span class="lineno"> 8</span> (<span class="stringliteral">&quot;Module Id&quot;</span>, <span class="stringliteral">&quot;u2&quot;</span>),</div>
<div class="line"><span class="lineno"> 9</span> (<span class="stringliteral">&quot;Row&quot;</span>, <span class="stringliteral">&quot;u2&quot;</span>),</div>
<div class="line"><span class="lineno"> 10</span> (<span class="stringliteral">&quot;Column&quot;</span>, <span class="stringliteral">&quot;u2&quot;</span>),</div>
<div class="line"><span class="lineno"> 11</span> (<span class="stringliteral">&quot;Reserved&quot;</span>, <span class="stringliteral">&quot;u2&quot;</span>),</div>
<div class="line"><span class="lineno"> 12</span> (<span class="stringliteral">&quot;Debug&quot;</span>, <span class="stringliteral">&quot;u4&quot;</span>),</div>
<div class="line"><span class="lineno"> 13</span> (<span class="stringliteral">&quot;Round Robin Number&quot;</span>, <span class="stringliteral">&quot;u2&quot;</span>),</div>
<div class="line"><span class="lineno"> 14</span> (<span class="stringliteral">&quot;Detector Type&quot;</span>, <span class="stringliteral">&quot;u1&quot;</span>),</div>
<div class="line"><span class="lineno"> 15</span> (<span class="stringliteral">&quot;Header Version&quot;</span>, <span class="stringliteral">&quot;u1&quot;</span>),</div>
<div class="line"><span class="lineno"> 16</span> (<span class="stringliteral">&quot;Packets caught mask&quot;</span>, <span class="stringliteral">&quot;8u8&quot;</span>)</div>
<div class="line"><span class="lineno"> 17</span> ]</div>
<div class="line"><span class="lineno"> 18</span>)</div>
</div><!-- fragment -->
</div>
</div>
<a id="aeb577dcd8f857453b243609bd3fe9c6b" name="aeb577dcd8f857453b243609bd3fe9c6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb577dcd8f857453b243609bd3fe9c6b">&#9670;&#160;</a></span>rows</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int read_frame.rows = 512</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a000169c5994988e16048b3cf8e461fe6" name="a000169c5994988e16048b3cf8e461fe6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a000169c5994988e16048b3cf8e461fe6">&#9670;&#160;</a></span>uint16</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">read_frame.uint16</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>
View Git Blame Copy Permalink