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

223 lines
41 KiB
HTML
Raw 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: file_io/include/aare/file_io/FileInterface.hpp Source File</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_0ce636e8c1612c01b4adc36e9f99479e.html">file_io</a></li><li class="navelem"><a class="el" href="dir_2733b21e9cf715002e4461cf940612ab.html">include</a></li><li class="navelem"><a class="el" href="dir_56c484f2481f20c268fc1a2a400ac49c.html">aare</a></li><li class="navelem"><a class="el" href="dir_a6e413f7e41fd82cd7ee315cdd32e0e9.html">file_io</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">FileInterface.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="FileInterface_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &quot;<a class="code" href="DType_8hpp.html">aare/core/DType.hpp</a>&quot;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &quot;<a class="code" href="Frame_8hpp.html">aare/core/Frame.hpp</a>&quot;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &quot;<a class="code" href="core_2include_2aare_2core_2defs_8hpp.html">aare/core/defs.hpp</a>&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;filesystem&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceaare.html">aare</a> {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="structaare_1_1FileConfig.html"> 17</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structaare_1_1FileConfig.html">FileConfig</a> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="structaare_1_1FileConfig.html#a45520457ebc4d6e918f25e7263b5ee73"> 18</a></span> <a class="code hl_class" href="classaare_1_1DType.html">aare::DType</a> <a class="code hl_variable" href="structaare_1_1FileConfig.html#a45520457ebc4d6e918f25e7263b5ee73">dtype</a> = <a class="code hl_class" href="classaare_1_1DType.html">aare::DType</a>(<span class="keyword">typeid</span>(uint16_t));</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="structaare_1_1FileConfig.html#aa132aaa25c237d8a5e264edaf604f7e5"> 19</a></span> uint64_t <a class="code hl_variable" href="structaare_1_1FileConfig.html#aa132aaa25c237d8a5e264edaf604f7e5">rows</a>;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="structaare_1_1FileConfig.html#a22da62fb09da30e52a555886119f4449"> 20</a></span> uint64_t <a class="code hl_variable" href="structaare_1_1FileConfig.html#a22da62fb09da30e52a555886119f4449">cols</a>;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="structaare_1_1FileConfig.html#a23f634204a24ff0af342412dfea3dd93"> 21</a></span> <a class="code hl_struct" href="structaare_1_1xy.html">xy</a> <a class="code hl_variable" href="structaare_1_1FileConfig.html#a23f634204a24ff0af342412dfea3dd93">geometry</a>{1, 1};</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="structaare_1_1FileConfig.html#ad25cc3e8a6edd711549dcef250a6e378"> 22</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="structaare_1_1FileConfig.html#ad25cc3e8a6edd711549dcef250a6e378">operator==</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structaare_1_1FileConfig.html">FileConfig</a> &amp;other)<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="structaare_1_1FileConfig.html#a45520457ebc4d6e918f25e7263b5ee73">dtype</a> == other.<a class="code hl_variable" href="structaare_1_1FileConfig.html#a45520457ebc4d6e918f25e7263b5ee73">dtype</a> &amp;&amp; <a class="code hl_variable" href="structaare_1_1FileConfig.html#aa132aaa25c237d8a5e264edaf604f7e5">rows</a> == other.<a class="code hl_variable" href="structaare_1_1FileConfig.html#aa132aaa25c237d8a5e264edaf604f7e5">rows</a> &amp;&amp; <a class="code hl_variable" href="structaare_1_1FileConfig.html#a22da62fb09da30e52a555886119f4449">cols</a> == other.<a class="code hl_variable" href="structaare_1_1FileConfig.html#a22da62fb09da30e52a555886119f4449">cols</a> &amp;&amp; <a class="code hl_variable" href="structaare_1_1FileConfig.html#a23f634204a24ff0af342412dfea3dd93">geometry</a> == other.<a class="code hl_variable" href="structaare_1_1FileConfig.html#a23f634204a24ff0af342412dfea3dd93">geometry</a>;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> }</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="structaare_1_1FileConfig.html#ac348b8c97ab8395069f5f9bc9040c67e"> 25</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="structaare_1_1FileConfig.html#ac348b8c97ab8395069f5f9bc9040c67e">operator!=</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structaare_1_1FileConfig.html">FileConfig</a> &amp;other)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !(*<span class="keyword">this</span> == other); }</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>};</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html"> 33</a></span><span class="keyword">class </span><a class="code hl_class" href="classaare_1_1FileInterface.html">FileInterface</a> {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a5d39033c9d218d53d51413b99bf7d1f4"> 41</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#a5d39033c9d218d53d51413b99bf7d1f4">write</a>(<a class="code hl_class" href="classaare_1_1Frame.html">Frame</a> &amp;frame) = 0;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// virtual void write(std::vector&lt;Frame&gt; &amp;frames) = 0;</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a9cb196de2bee8638578e4ba3ce46532e"> 54</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classaare_1_1Frame.html">Frame</a> <a class="code hl_function" href="classaare_1_1FileInterface.html#a9cb196de2bee8638578e4ba3ce46532e">read</a>() = 0;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a1624d72f0feb1c19d507cc91c4cb414a"> 61</a></span> <span class="keyword">virtual</span> std::vector&lt;Frame&gt; <a class="code hl_function" href="classaare_1_1FileInterface.html#a1624d72f0feb1c19d507cc91c4cb414a">read</a>(<span class="keywordtype">size_t</span> n_frames) = 0; <span class="comment">// Is this the right interface?</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a4ac0f4e63ccf90af9f0d5b9b44db856c"> 68</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#a4ac0f4e63ccf90af9f0d5b9b44db856c">read_into</a>(std::byte *image_buf) = 0;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a580c71b3eecf45ce2140cd65103cfd43"> 76</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#a580c71b3eecf45ce2140cd65103cfd43">read_into</a>(std::byte *image_buf, <span class="keywordtype">size_t</span> n_frames) = 0;</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#ac6d10d468f79e855a3334cd1347c1178"> 83</a></span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#ac6d10d468f79e855a3334cd1347c1178">frame_number</a>(<span class="keywordtype">size_t</span> frame_index) = 0;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#aab236d5b808f2acc44266281274ed93a"> 89</a></span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#aab236d5b808f2acc44266281274ed93a">bytes_per_frame</a>() = 0;</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a99da51594609984efe62bb64a88a3fa6"> 95</a></span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#a99da51594609984efe62bb64a88a3fa6">pixels</a>() = 0;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a49510fb96eaa245fd5d2be7f25a40b74"> 102</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#a49510fb96eaa245fd5d2be7f25a40b74">seek</a>(<span class="keywordtype">size_t</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#ac6d10d468f79e855a3334cd1347c1178">frame_number</a>) = 0;</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> </div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#abd01811dcf904625b4dbd78dd9188de4"> 108</a></span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#abd01811dcf904625b4dbd78dd9188de4">tell</a>() = 0;</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#ad4391bafd11f77f807114ba5108071d3"> 114</a></span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#ad4391bafd11f77f807114ba5108071d3">total_frames</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a8a5bc2d9b7b9ec1a9a100bf8a114d909"> 119</a></span> <span class="keyword">virtual</span> ssize_t <a class="code hl_function" href="classaare_1_1FileInterface.html#a8a5bc2d9b7b9ec1a9a100bf8a114d909">rows</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a2927ba0e6a564bcd0da139a552c09b76"> 124</a></span> <span class="keyword">virtual</span> ssize_t <a class="code hl_function" href="classaare_1_1FileInterface.html#a2927ba0e6a564bcd0da139a552c09b76">cols</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a8bfd7abf4271210000b2ef8d1c0d6149"> 129</a></span> <span class="keyword">virtual</span> ssize_t <a class="code hl_function" href="classaare_1_1FileInterface.html#a8bfd7abf4271210000b2ef8d1c0d6149">bitdepth</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#aad0827f2dad4403cebdce417243d842c"> 136</a></span> <a class="code hl_class" href="classaare_1_1Frame.html">Frame</a> <a class="code hl_function" href="classaare_1_1FileInterface.html#aad0827f2dad4403cebdce417243d842c">iread</a>(<span class="keywordtype">size_t</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#ac6d10d468f79e855a3334cd1347c1178">frame_number</a>) {</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="keyword">auto</span> old_pos = <a class="code hl_function" href="classaare_1_1FileInterface.html#abd01811dcf904625b4dbd78dd9188de4">tell</a>();</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#a49510fb96eaa245fd5d2be7f25a40b74">seek</a>(<a class="code hl_function" href="classaare_1_1FileInterface.html#ac6d10d468f79e855a3334cd1347c1178">frame_number</a>);</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <a class="code hl_class" href="classaare_1_1Frame.html">Frame</a> tmp = <a class="code hl_function" href="classaare_1_1FileInterface.html#a9cb196de2bee8638578e4ba3ce46532e">read</a>();</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#a49510fb96eaa245fd5d2be7f25a40b74">seek</a>(old_pos);</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> <span class="keywordflow">return</span> tmp;</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> };</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a1a304e356f3c1d100544d6ceeb35c0fb"> 150</a></span> std::vector&lt;Frame&gt; <a class="code hl_function" href="classaare_1_1FileInterface.html#a1a304e356f3c1d100544d6ceeb35c0fb">iread</a>(<span class="keywordtype">size_t</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#ac6d10d468f79e855a3334cd1347c1178">frame_number</a>, <span class="keywordtype">size_t</span> n_frames) {</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> <span class="keyword">auto</span> old_pos = <a class="code hl_function" href="classaare_1_1FileInterface.html#abd01811dcf904625b4dbd78dd9188de4">tell</a>();</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#a49510fb96eaa245fd5d2be7f25a40b74">seek</a>(<a class="code hl_function" href="classaare_1_1FileInterface.html#ac6d10d468f79e855a3334cd1347c1178">frame_number</a>);</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> std::vector&lt;Frame&gt; tmp = <a class="code hl_function" href="classaare_1_1FileInterface.html#a9cb196de2bee8638578e4ba3ce46532e">read</a>(n_frames);</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#a49510fb96eaa245fd5d2be7f25a40b74">seek</a>(old_pos);</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> <span class="keywordflow">return</span> tmp;</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> }</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> </div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> <span class="comment">// function to query the data type of the file</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> <span class="comment">/*virtual DataType dtype = 0; */</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> </div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a7546e2d2dec365bee91cbf5607278e80"> 161</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classaare_1_1FileInterface.html#a7546e2d2dec365bee91cbf5607278e80">~FileInterface</a>(){</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> </div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> };</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> </div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#ab1d0e6de947affd5af9740eb06888fc6"> 166</a></span> std::string <a class="code hl_variable" href="classaare_1_1FileInterface.html#ab1d0e6de947affd5af9740eb06888fc6">m_mode</a>;</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a325f6603f564fb42f8f28f1136b5e329"> 167</a></span> std::filesystem::path <a class="code hl_variable" href="classaare_1_1FileInterface.html#a325f6603f564fb42f8f28f1136b5e329">m_fname</a>;</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#afdd0a1a75618ad5db2f4794e0900b2f4"> 168</a></span> std::filesystem::path <a class="code hl_variable" href="classaare_1_1FileInterface.html#afdd0a1a75618ad5db2f4794e0900b2f4">m_base_path</a>;</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#adae2b35fc6a3f185e9eb263c97bc024b"> 169</a></span> std::string <a class="code hl_variable" href="classaare_1_1FileInterface.html#adae2b35fc6a3f185e9eb263c97bc024b">m_base_name</a>, <a class="code hl_variable" href="classaare_1_1FileInterface.html#a5fffaf9a7c8ae2b3a2ebe89b9c94ed34">m_ext</a>;</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a30e926a897b534ab9a327d40594ff191"> 170</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="classaare_1_1FileInterface.html#a30e926a897b534ab9a327d40594ff191">m_findex</a>;</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a91551fada444b231294c095f3f5fb768"> 171</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classaare_1_1FileInterface.html#a91551fada444b231294c095f3f5fb768">m_total_frames</a>{};</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#ab0762d7652c9a4e1afe6dbb7d7325ac9"> 172</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classaare_1_1FileInterface.html#ab0762d7652c9a4e1afe6dbb7d7325ac9">max_frames_per_file</a>{};</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a44cbe933bbd2cae1f48213121d15bce2"> 173</a></span> std::string <a class="code hl_variable" href="classaare_1_1FileInterface.html#a44cbe933bbd2cae1f48213121d15bce2">version</a>;</div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a9476a299cea6b4e97605135a28d0cb60"> 174</a></span> <a class="code hl_enumeration" href="namespaceaare.html#a5b95afba95553c1e118e1478c69042f7">DetectorType</a> <a class="code hl_variable" href="classaare_1_1FileInterface.html#a9476a299cea6b4e97605135a28d0cb60">m_type</a>;</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#ae29d98625cf56989e2c5237ace0d0f4c"> 175</a></span> ssize_t <a class="code hl_variable" href="classaare_1_1FileInterface.html#ae29d98625cf56989e2c5237ace0d0f4c">m_rows</a>{};</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#ad4c9991c30a71ba83cbaab283bc756b5"> 176</a></span> ssize_t <a class="code hl_variable" href="classaare_1_1FileInterface.html#ad4c9991c30a71ba83cbaab283bc756b5">m_cols</a>{};</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#a252d27cbbfcdfc528b86925eaac55bb7"> 177</a></span> ssize_t <a class="code hl_variable" href="classaare_1_1FileInterface.html#a252d27cbbfcdfc528b86925eaac55bb7">m_bitdepth</a>{};</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"><a class="line" href="classaare_1_1FileInterface.html#ab96f5dd0c99fb7b5a527da812368d736"> 178</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classaare_1_1FileInterface.html#ab96f5dd0c99fb7b5a527da812368d736">current_frame</a>{};</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span>};</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> </div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span>} <span class="comment">// namespace aare</span></div>
<div class="ttc" id="aDType_8hpp_html"><div class="ttname"><a href="DType_8hpp.html">DType.hpp</a></div></div>
<div class="ttc" id="aFrame_8hpp_html"><div class="ttname"><a href="Frame_8hpp.html">Frame.hpp</a></div></div>
<div class="ttc" id="aclassaare_1_1DType_html"><div class="ttname"><a href="classaare_1_1DType.html">aare::DType</a></div><div class="ttdef"><b>Definition</b> DType.hpp:20</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html"><div class="ttname"><a href="classaare_1_1FileInterface.html">aare::FileInterface</a></div><div class="ttdoc">FileInterface class to define the interface for file operations.</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:33</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a1624d72f0feb1c19d507cc91c4cb414a"><div class="ttname"><a href="classaare_1_1FileInterface.html#a1624d72f0feb1c19d507cc91c4cb414a">aare::FileInterface::read</a></div><div class="ttdeci">virtual std::vector&lt; Frame &gt; read(size_t n_frames)=0</div><div class="ttdoc">read n_frames from the file at the current position</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a1a304e356f3c1d100544d6ceeb35c0fb"><div class="ttname"><a href="classaare_1_1FileInterface.html#a1a304e356f3c1d100544d6ceeb35c0fb">aare::FileInterface::iread</a></div><div class="ttdeci">std::vector&lt; Frame &gt; iread(size_t frame_number, size_t n_frames)</div><div class="ttdoc">read n_frames from the file starting at the given frame number</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:150</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a252d27cbbfcdfc528b86925eaac55bb7"><div class="ttname"><a href="classaare_1_1FileInterface.html#a252d27cbbfcdfc528b86925eaac55bb7">aare::FileInterface::m_bitdepth</a></div><div class="ttdeci">ssize_t m_bitdepth</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:177</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a2927ba0e6a564bcd0da139a552c09b76"><div class="ttname"><a href="classaare_1_1FileInterface.html#a2927ba0e6a564bcd0da139a552c09b76">aare::FileInterface::cols</a></div><div class="ttdeci">virtual ssize_t cols() const =0</div><div class="ttdoc">get the number of columns in the file</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a30e926a897b534ab9a327d40594ff191"><div class="ttname"><a href="classaare_1_1FileInterface.html#a30e926a897b534ab9a327d40594ff191">aare::FileInterface::m_findex</a></div><div class="ttdeci">int m_findex</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:170</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a325f6603f564fb42f8f28f1136b5e329"><div class="ttname"><a href="classaare_1_1FileInterface.html#a325f6603f564fb42f8f28f1136b5e329">aare::FileInterface::m_fname</a></div><div class="ttdeci">std::filesystem::path m_fname</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:167</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a44cbe933bbd2cae1f48213121d15bce2"><div class="ttname"><a href="classaare_1_1FileInterface.html#a44cbe933bbd2cae1f48213121d15bce2">aare::FileInterface::version</a></div><div class="ttdeci">std::string version</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:173</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a49510fb96eaa245fd5d2be7f25a40b74"><div class="ttname"><a href="classaare_1_1FileInterface.html#a49510fb96eaa245fd5d2be7f25a40b74">aare::FileInterface::seek</a></div><div class="ttdeci">virtual void seek(size_t frame_number)=0</div><div class="ttdoc">seek to the given frame number</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a4ac0f4e63ccf90af9f0d5b9b44db856c"><div class="ttname"><a href="classaare_1_1FileInterface.html#a4ac0f4e63ccf90af9f0d5b9b44db856c">aare::FileInterface::read_into</a></div><div class="ttdeci">virtual void read_into(std::byte *image_buf)=0</div><div class="ttdoc">read one frame from the file at the current position and store it in the provided buffer</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a580c71b3eecf45ce2140cd65103cfd43"><div class="ttname"><a href="classaare_1_1FileInterface.html#a580c71b3eecf45ce2140cd65103cfd43">aare::FileInterface::read_into</a></div><div class="ttdeci">virtual void read_into(std::byte *image_buf, size_t n_frames)=0</div><div class="ttdoc">read n_frames from the file at the current position and store them in the provided buffer</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a5d39033c9d218d53d51413b99bf7d1f4"><div class="ttname"><a href="classaare_1_1FileInterface.html#a5d39033c9d218d53d51413b99bf7d1f4">aare::FileInterface::write</a></div><div class="ttdeci">virtual void write(Frame &amp;frame)=0</div><div class="ttdoc">write a frame to the file</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a5fffaf9a7c8ae2b3a2ebe89b9c94ed34"><div class="ttname"><a href="classaare_1_1FileInterface.html#a5fffaf9a7c8ae2b3a2ebe89b9c94ed34">aare::FileInterface::m_ext</a></div><div class="ttdeci">std::string m_ext</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:169</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a7546e2d2dec365bee91cbf5607278e80"><div class="ttname"><a href="classaare_1_1FileInterface.html#a7546e2d2dec365bee91cbf5607278e80">aare::FileInterface::~FileInterface</a></div><div class="ttdeci">virtual ~FileInterface()</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:161</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a8a5bc2d9b7b9ec1a9a100bf8a114d909"><div class="ttname"><a href="classaare_1_1FileInterface.html#a8a5bc2d9b7b9ec1a9a100bf8a114d909">aare::FileInterface::rows</a></div><div class="ttdeci">virtual ssize_t rows() const =0</div><div class="ttdoc">get the number of rows in the file</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a8bfd7abf4271210000b2ef8d1c0d6149"><div class="ttname"><a href="classaare_1_1FileInterface.html#a8bfd7abf4271210000b2ef8d1c0d6149">aare::FileInterface::bitdepth</a></div><div class="ttdeci">virtual ssize_t bitdepth() const =0</div><div class="ttdoc">get the bitdepth of the file</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a91551fada444b231294c095f3f5fb768"><div class="ttname"><a href="classaare_1_1FileInterface.html#a91551fada444b231294c095f3f5fb768">aare::FileInterface::m_total_frames</a></div><div class="ttdeci">size_t m_total_frames</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:171</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a9476a299cea6b4e97605135a28d0cb60"><div class="ttname"><a href="classaare_1_1FileInterface.html#a9476a299cea6b4e97605135a28d0cb60">aare::FileInterface::m_type</a></div><div class="ttdeci">DetectorType m_type</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:174</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a99da51594609984efe62bb64a88a3fa6"><div class="ttname"><a href="classaare_1_1FileInterface.html#a99da51594609984efe62bb64a88a3fa6">aare::FileInterface::pixels</a></div><div class="ttdeci">virtual size_t pixels()=0</div><div class="ttdoc">get the number of pixels in one frame</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_a9cb196de2bee8638578e4ba3ce46532e"><div class="ttname"><a href="classaare_1_1FileInterface.html#a9cb196de2bee8638578e4ba3ce46532e">aare::FileInterface::read</a></div><div class="ttdeci">virtual Frame read()=0</div><div class="ttdoc">write a vector of frames to the file</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_aab236d5b808f2acc44266281274ed93a"><div class="ttname"><a href="classaare_1_1FileInterface.html#aab236d5b808f2acc44266281274ed93a">aare::FileInterface::bytes_per_frame</a></div><div class="ttdeci">virtual size_t bytes_per_frame()=0</div><div class="ttdoc">get the size of one frame in bytes</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_aad0827f2dad4403cebdce417243d842c"><div class="ttname"><a href="classaare_1_1FileInterface.html#aad0827f2dad4403cebdce417243d842c">aare::FileInterface::iread</a></div><div class="ttdeci">Frame iread(size_t frame_number)</div><div class="ttdoc">read one frame from the file at the given frame number</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:136</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_ab0762d7652c9a4e1afe6dbb7d7325ac9"><div class="ttname"><a href="classaare_1_1FileInterface.html#ab0762d7652c9a4e1afe6dbb7d7325ac9">aare::FileInterface::max_frames_per_file</a></div><div class="ttdeci">size_t max_frames_per_file</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:172</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_ab1d0e6de947affd5af9740eb06888fc6"><div class="ttname"><a href="classaare_1_1FileInterface.html#ab1d0e6de947affd5af9740eb06888fc6">aare::FileInterface::m_mode</a></div><div class="ttdeci">std::string m_mode</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:166</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_ab96f5dd0c99fb7b5a527da812368d736"><div class="ttname"><a href="classaare_1_1FileInterface.html#ab96f5dd0c99fb7b5a527da812368d736">aare::FileInterface::current_frame</a></div><div class="ttdeci">size_t current_frame</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:178</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_abd01811dcf904625b4dbd78dd9188de4"><div class="ttname"><a href="classaare_1_1FileInterface.html#abd01811dcf904625b4dbd78dd9188de4">aare::FileInterface::tell</a></div><div class="ttdeci">virtual size_t tell()=0</div><div class="ttdoc">get the current position of the file pointer</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_ac6d10d468f79e855a3334cd1347c1178"><div class="ttname"><a href="classaare_1_1FileInterface.html#ac6d10d468f79e855a3334cd1347c1178">aare::FileInterface::frame_number</a></div><div class="ttdeci">virtual size_t frame_number(size_t frame_index)=0</div><div class="ttdoc">get the frame number at the given frame index</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_ad4391bafd11f77f807114ba5108071d3"><div class="ttname"><a href="classaare_1_1FileInterface.html#ad4391bafd11f77f807114ba5108071d3">aare::FileInterface::total_frames</a></div><div class="ttdeci">virtual size_t total_frames() const =0</div><div class="ttdoc">get the total number of frames in the file</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_ad4c9991c30a71ba83cbaab283bc756b5"><div class="ttname"><a href="classaare_1_1FileInterface.html#ad4c9991c30a71ba83cbaab283bc756b5">aare::FileInterface::m_cols</a></div><div class="ttdeci">ssize_t m_cols</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:176</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_adae2b35fc6a3f185e9eb263c97bc024b"><div class="ttname"><a href="classaare_1_1FileInterface.html#adae2b35fc6a3f185e9eb263c97bc024b">aare::FileInterface::m_base_name</a></div><div class="ttdeci">std::string m_base_name</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:169</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_ae29d98625cf56989e2c5237ace0d0f4c"><div class="ttname"><a href="classaare_1_1FileInterface.html#ae29d98625cf56989e2c5237ace0d0f4c">aare::FileInterface::m_rows</a></div><div class="ttdeci">ssize_t m_rows</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:175</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html_afdd0a1a75618ad5db2f4794e0900b2f4"><div class="ttname"><a href="classaare_1_1FileInterface.html#afdd0a1a75618ad5db2f4794e0900b2f4">aare::FileInterface::m_base_path</a></div><div class="ttdeci">std::filesystem::path m_base_path</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:168</div></div>
<div class="ttc" id="aclassaare_1_1Frame_html"><div class="ttname"><a href="classaare_1_1Frame.html">aare::Frame</a></div><div class="ttdef"><b>Definition</b> Frame.hpp:18</div></div>
<div class="ttc" id="acore_2include_2aare_2core_2defs_8hpp_html"><div class="ttname"><a href="core_2include_2aare_2core_2defs_8hpp.html">defs.hpp</a></div></div>
<div class="ttc" id="anamespaceaare_html"><div class="ttname"><a href="namespaceaare.html">aare</a></div><div class="ttdoc">Frame class to represent a single frame of data model class should be able to work with streams comin...</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:11</div></div>
<div class="ttc" id="anamespaceaare_html_a5b95afba95553c1e118e1478c69042f7"><div class="ttname"><a href="namespaceaare.html#a5b95afba95553c1e118e1478c69042f7">aare::DetectorType</a></div><div class="ttdeci">DetectorType</div><div class="ttdef"><b>Definition</b> defs.hpp:41</div></div>
<div class="ttc" id="astructaare_1_1FileConfig_html"><div class="ttname"><a href="structaare_1_1FileConfig.html">aare::FileConfig</a></div><div class="ttdoc">FileConfig structure to store the configuration of a file dtype: data type of the file rows: number o...</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:17</div></div>
<div class="ttc" id="astructaare_1_1FileConfig_html_a22da62fb09da30e52a555886119f4449"><div class="ttname"><a href="structaare_1_1FileConfig.html#a22da62fb09da30e52a555886119f4449">aare::FileConfig::cols</a></div><div class="ttdeci">uint64_t cols</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:20</div></div>
<div class="ttc" id="astructaare_1_1FileConfig_html_a23f634204a24ff0af342412dfea3dd93"><div class="ttname"><a href="structaare_1_1FileConfig.html#a23f634204a24ff0af342412dfea3dd93">aare::FileConfig::geometry</a></div><div class="ttdeci">xy geometry</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:21</div></div>
<div class="ttc" id="astructaare_1_1FileConfig_html_a45520457ebc4d6e918f25e7263b5ee73"><div class="ttname"><a href="structaare_1_1FileConfig.html#a45520457ebc4d6e918f25e7263b5ee73">aare::FileConfig::dtype</a></div><div class="ttdeci">aare::DType dtype</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:18</div></div>
<div class="ttc" id="astructaare_1_1FileConfig_html_aa132aaa25c237d8a5e264edaf604f7e5"><div class="ttname"><a href="structaare_1_1FileConfig.html#aa132aaa25c237d8a5e264edaf604f7e5">aare::FileConfig::rows</a></div><div class="ttdeci">uint64_t rows</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:19</div></div>
<div class="ttc" id="astructaare_1_1FileConfig_html_ac348b8c97ab8395069f5f9bc9040c67e"><div class="ttname"><a href="structaare_1_1FileConfig.html#ac348b8c97ab8395069f5f9bc9040c67e">aare::FileConfig::operator!=</a></div><div class="ttdeci">bool operator!=(const FileConfig &amp;other) const</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:25</div></div>
<div class="ttc" id="astructaare_1_1FileConfig_html_ad25cc3e8a6edd711549dcef250a6e378"><div class="ttname"><a href="structaare_1_1FileConfig.html#ad25cc3e8a6edd711549dcef250a6e378">aare::FileConfig::operator==</a></div><div class="ttdeci">bool operator==(const FileConfig &amp;other) const</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:22</div></div>
<div class="ttc" id="astructaare_1_1xy_html"><div class="ttname"><a href="structaare_1_1xy.html">aare::xy</a></div><div class="ttdef"><b>Definition</b> defs.hpp:31</div></div>
</div><!-- fragment --></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