mirror of
https://github.com/slsdetectorgroup/aare.git
synced 2025-06-08 05:30:41 +02:00
127 lines
11 KiB
HTML
127 lines
11 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: file_io/include/aare/file_io/File.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&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>
|
|
<!-- 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">File.hpp</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="File_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 "<a class="code" href="FileInterface_8hpp.html">aare/file_io/FileInterface.hpp</a>"</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceaare.html">aare</a> {</div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="classaare_1_1File.html"> 11</a></span><span class="keyword">class </span><a class="code hl_class" href="classaare_1_1File.html">File</a> {</div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="classaare_1_1File.html#ac2c569dfd6c15c1f5b19f5f1a5e38abf"> 13</a></span> <a class="code hl_class" href="classaare_1_1FileInterface.html">FileInterface</a> *<a class="code hl_variable" href="classaare_1_1File.html#ac2c569dfd6c15c1f5b19f5f1a5e38abf">file_impl</a>;</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <a class="code hl_class" href="classaare_1_1File.html">File</a>(std::filesystem::path fname, std::string mode, <a class="code hl_struct" href="structaare_1_1FileConfig.html">FileConfig</a> cfg = {});</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordtype">void</span> write(<a class="code hl_class" href="classaare_1_1Frame.html">Frame</a> &frame);</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <a class="code hl_class" href="classaare_1_1Frame.html">Frame</a> read();</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_class" href="classaare_1_1Frame.html">Frame</a> iread(<span class="keywordtype">size_t</span> frame_number);</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> std::vector<Frame> read(<span class="keywordtype">size_t</span> n_frames);</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keywordtype">void</span> read_into(std::byte *image_buf);</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keywordtype">void</span> read_into(std::byte *image_buf, <span class="keywordtype">size_t</span> n_frames);</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">size_t</span> frame_number(<span class="keywordtype">size_t</span> frame_index);</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">size_t</span> bytes_per_frame();</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">size_t</span> pixels();</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">void</span> seek(<span class="keywordtype">size_t</span> frame_number);</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">size_t</span> tell() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">size_t</span> total_frames() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> ssize_t rows() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> ssize_t cols() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> ssize_t bitdepth() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <a class="code hl_class" href="classaare_1_1File.html">File</a>(<a class="code hl_class" href="classaare_1_1File.html">File</a> &&other);</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <a class="code hl_class" href="classaare_1_1File.html">~File</a>();</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>};</div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>} <span class="comment">// namespace aare</span></div>
|
|
<div class="ttc" id="aFileInterface_8hpp_html"><div class="ttname"><a href="FileInterface_8hpp.html">FileInterface.hpp</a></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_1File_html"><div class="ttname"><a href="classaare_1_1File.html">aare::File</a></div><div class="ttdoc">RAII File class for reading and writing image files in various formats wrapper on a FileInterface to ...</div><div class="ttdef"><b>Definition</b> File.hpp:11</div></div>
|
|
<div class="ttc" id="aclassaare_1_1File_html_ac2c569dfd6c15c1f5b19f5f1a5e38abf"><div class="ttname"><a href="classaare_1_1File.html#ac2c569dfd6c15c1f5b19f5f1a5e38abf">aare::File::file_impl</a></div><div class="ttdeci">FileInterface * file_impl</div><div class="ttdef"><b>Definition</b> File.hpp:13</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="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="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><!-- fragment --></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>
|