mirror of
https://github.com/slsdetectorgroup/aare.git
synced 2025-06-08 05:30:41 +02:00
543 lines
26 KiB
HTML
543 lines
26 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::File Class 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&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="namespaceaare.html">aare</a></li><li class="navelem"><a class="el" href="classaare_1_1File.html">File</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> </div>
|
|
<div class="headertitle"><div class="title">aare::File Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>RAII <a class="el" href="classaare_1_1File_1_1File.html">File</a> class for reading and writing image files in various formats wrapper on a <a class="el" href="classaare_1_1FileInterface.html" title="FileInterface class to define the interface for file operations.">FileInterface</a> to abstract the underlying file format.
|
|
<a href="classaare_1_1File.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="File_8hpp_source.html">File.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a9bdd1ad48e0eb476d8ff44e8d113ed0e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#a9bdd1ad48e0eb476d8ff44e8d113ed0e">File</a> (std::filesystem::path fname, std::string mode, <a class="el" href="structaare_1_1FileConfig.html">FileConfig</a> cfg={})</td></tr>
|
|
<tr class="memdesc:a9bdd1ad48e0eb476d8ff44e8d113ed0e"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="classaare_1_1File_1_1File.html">File</a> object. <br /></td></tr>
|
|
<tr class="separator:a9bdd1ad48e0eb476d8ff44e8d113ed0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a53d2397c69b01f8aaf972b68f470b781"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#a53d2397c69b01f8aaf972b68f470b781">write</a> (<a class="el" href="classaare_1_1Frame.html">Frame</a> &frame)</td></tr>
|
|
<tr class="separator:a53d2397c69b01f8aaf972b68f470b781"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3a10c5eb34627b0badddd43121eb1d83"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classaare_1_1Frame.html">Frame</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#a3a10c5eb34627b0badddd43121eb1d83">read</a> ()</td></tr>
|
|
<tr class="separator:a3a10c5eb34627b0badddd43121eb1d83"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27dd0920d959676a8936f42998d9aebc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classaare_1_1Frame.html">Frame</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#a27dd0920d959676a8936f42998d9aebc">iread</a> (size_t frame_number)</td></tr>
|
|
<tr class="separator:a27dd0920d959676a8936f42998d9aebc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f1e7f601e748a5bfd99497c948f47ee"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="classaare_1_1Frame.html">Frame</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#a7f1e7f601e748a5bfd99497c948f47ee">read</a> (size_t n_frames)</td></tr>
|
|
<tr class="separator:a7f1e7f601e748a5bfd99497c948f47ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66ee1d36d4d2f6683aa46ca93768d07d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#a66ee1d36d4d2f6683aa46ca93768d07d">read_into</a> (std::byte *image_buf)</td></tr>
|
|
<tr class="separator:a66ee1d36d4d2f6683aa46ca93768d07d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aabea27aefdae51a29dcc86433bec9fdb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#aabea27aefdae51a29dcc86433bec9fdb">read_into</a> (std::byte *image_buf, size_t n_frames)</td></tr>
|
|
<tr class="separator:aabea27aefdae51a29dcc86433bec9fdb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a207aae034a1794ea2b1092afcc17756f"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#a207aae034a1794ea2b1092afcc17756f">frame_number</a> (size_t frame_index)</td></tr>
|
|
<tr class="separator:a207aae034a1794ea2b1092afcc17756f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a32a13788fc0a1cadd2ebc8ed2aaa4ac9"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#a32a13788fc0a1cadd2ebc8ed2aaa4ac9">bytes_per_frame</a> ()</td></tr>
|
|
<tr class="separator:a32a13788fc0a1cadd2ebc8ed2aaa4ac9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b527f5d8cef1cee5ed9297e36fee8c6"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#a5b527f5d8cef1cee5ed9297e36fee8c6">pixels</a> ()</td></tr>
|
|
<tr class="separator:a5b527f5d8cef1cee5ed9297e36fee8c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac6a40444bb5124484bafcd522f3ff49e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#ac6a40444bb5124484bafcd522f3ff49e">seek</a> (size_t frame_number)</td></tr>
|
|
<tr class="separator:ac6a40444bb5124484bafcd522f3ff49e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a79bb952679193b02ee83a622c15a599c"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#a79bb952679193b02ee83a622c15a599c">tell</a> () const</td></tr>
|
|
<tr class="separator:a79bb952679193b02ee83a622c15a599c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a706409a694455040034b431fedff9172"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#a706409a694455040034b431fedff9172">total_frames</a> () const</td></tr>
|
|
<tr class="separator:a706409a694455040034b431fedff9172"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a79cf93d8fc08366dedf9e52a25a23010"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#a79cf93d8fc08366dedf9e52a25a23010">rows</a> () const</td></tr>
|
|
<tr class="separator:a79cf93d8fc08366dedf9e52a25a23010"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4da675b97939fba070cfe42a17936a66"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#a4da675b97939fba070cfe42a17936a66">cols</a> () const</td></tr>
|
|
<tr class="separator:a4da675b97939fba070cfe42a17936a66"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a344c27c3dba3e4bd24dad2c29de9dae1"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#a344c27c3dba3e4bd24dad2c29de9dae1">bitdepth</a> () const</td></tr>
|
|
<tr class="separator:a344c27c3dba3e4bd24dad2c29de9dae1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba1a27e7fa3fcfd62564925583b70ae6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#aba1a27e7fa3fcfd62564925583b70ae6">File</a> (<a class="el" href="classaare_1_1File.html">File</a> &&other)</td></tr>
|
|
<tr class="memdesc:aba1a27e7fa3fcfd62564925583b70ae6"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <br /></td></tr>
|
|
<tr class="separator:aba1a27e7fa3fcfd62564925583b70ae6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad53f1dda26609290e30fcaba9d2020dc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#ad53f1dda26609290e30fcaba9d2020dc">~File</a> ()</td></tr>
|
|
<tr class="memdesc:ad53f1dda26609290e30fcaba9d2020dc"><td class="mdescLeft"> </td><td class="mdescRight">destructor: will only delete the <a class="el" href="classaare_1_1FileInterface.html" title="FileInterface class to define the interface for file operations.">FileInterface</a> object <br /></td></tr>
|
|
<tr class="separator:ad53f1dda26609290e30fcaba9d2020dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:ac2c569dfd6c15c1f5b19f5f1a5e38abf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classaare_1_1FileInterface.html">FileInterface</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File.html#ac2c569dfd6c15c1f5b19f5f1a5e38abf">file_impl</a></td></tr>
|
|
<tr class="separator:ac2c569dfd6c15c1f5b19f5f1a5e38abf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>RAII <a class="el" href="classaare_1_1File_1_1File.html">File</a> class for reading and writing image files in various formats wrapper on a <a class="el" href="classaare_1_1FileInterface.html" title="FileInterface class to define the interface for file operations.">FileInterface</a> to abstract the underlying file format. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>documentation for each function is in the <a class="el" href="classaare_1_1FileInterface.html" title="FileInterface class to define the interface for file operations.">FileInterface</a> class </dd></dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a9bdd1ad48e0eb476d8ff44e8d113ed0e" name="a9bdd1ad48e0eb476d8ff44e8d113ed0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9bdd1ad48e0eb476d8ff44e8d113ed0e">◆ </a></span>File() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classaare_1_1File_1_1File.html">aare::File::File</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::filesystem::path </td>
|
|
<td class="paramname"><em>fname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::string </td>
|
|
<td class="paramname"><em>mode</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structaare_1_1FileConfig.html">FileConfig</a> </td>
|
|
<td class="paramname"><em>cfg</em> = <code>{}</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct a new <a class="el" href="classaare_1_1File_1_1File.html">File</a> object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fname</td><td>path to the file </td></tr>
|
|
<tr><td class="paramname">mode</td><td>file mode (r, w, a) </td></tr>
|
|
<tr><td class="paramname">cfg</td><td>file configuration </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if the file cannot be opened </td></tr>
|
|
<tr><td class="paramname">std::invalid_argument</td><td>if the file mode is not supported </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aba1a27e7fa3fcfd62564925583b70ae6" name="aba1a27e7fa3fcfd62564925583b70ae6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aba1a27e7fa3fcfd62564925583b70ae6">◆ </a></span>File() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classaare_1_1File_1_1File.html">aare::File::File</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classaare_1_1File.html">File</a> && </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td><a class="el" href="classaare_1_1File_1_1File.html">File</a> object to move from </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad53f1dda26609290e30fcaba9d2020dc" name="ad53f1dda26609290e30fcaba9d2020dc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad53f1dda26609290e30fcaba9d2020dc">◆ </a></span>~File()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">aare::File::~File </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>destructor: will only delete the <a class="el" href="classaare_1_1FileInterface.html" title="FileInterface class to define the interface for file operations.">FileInterface</a> object </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a344c27c3dba3e4bd24dad2c29de9dae1" name="a344c27c3dba3e4bd24dad2c29de9dae1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a344c27c3dba3e4bd24dad2c29de9dae1">◆ </a></span>bitdepth()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ssize_t aare::File::bitdepth </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a32a13788fc0a1cadd2ebc8ed2aaa4ac9" name="a32a13788fc0a1cadd2ebc8ed2aaa4ac9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a32a13788fc0a1cadd2ebc8ed2aaa4ac9">◆ </a></span>bytes_per_frame()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t aare::File::bytes_per_frame </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4da675b97939fba070cfe42a17936a66" name="a4da675b97939fba070cfe42a17936a66"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4da675b97939fba070cfe42a17936a66">◆ </a></span>cols()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ssize_t aare::File::cols </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a207aae034a1794ea2b1092afcc17756f" name="a207aae034a1794ea2b1092afcc17756f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a207aae034a1794ea2b1092afcc17756f">◆ </a></span>frame_number()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t aare::File::frame_number </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>frame_index</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a27dd0920d959676a8936f42998d9aebc" name="a27dd0920d959676a8936f42998d9aebc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a27dd0920d959676a8936f42998d9aebc">◆ </a></span>iread()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classaare_1_1Frame.html">Frame</a> aare::File::iread </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>frame_number</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5b527f5d8cef1cee5ed9297e36fee8c6" name="a5b527f5d8cef1cee5ed9297e36fee8c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5b527f5d8cef1cee5ed9297e36fee8c6">◆ </a></span>pixels()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t aare::File::pixels </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3a10c5eb34627b0badddd43121eb1d83" name="a3a10c5eb34627b0badddd43121eb1d83"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3a10c5eb34627b0badddd43121eb1d83">◆ </a></span>read() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classaare_1_1Frame.html">Frame</a> aare::File::read </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7f1e7f601e748a5bfd99497c948f47ee" name="a7f1e7f601e748a5bfd99497c948f47ee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7f1e7f601e748a5bfd99497c948f47ee">◆ </a></span>read() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector< <a class="el" href="classaare_1_1Frame.html">Frame</a> > aare::File::read </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>n_frames</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a66ee1d36d4d2f6683aa46ca93768d07d" name="a66ee1d36d4d2f6683aa46ca93768d07d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a66ee1d36d4d2f6683aa46ca93768d07d">◆ </a></span>read_into() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void aare::File::read_into </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::byte * </td>
|
|
<td class="paramname"><em>image_buf</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aabea27aefdae51a29dcc86433bec9fdb" name="aabea27aefdae51a29dcc86433bec9fdb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aabea27aefdae51a29dcc86433bec9fdb">◆ </a></span>read_into() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void aare::File::read_into </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::byte * </td>
|
|
<td class="paramname"><em>image_buf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>n_frames</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a79cf93d8fc08366dedf9e52a25a23010" name="a79cf93d8fc08366dedf9e52a25a23010"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a79cf93d8fc08366dedf9e52a25a23010">◆ </a></span>rows()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ssize_t aare::File::rows </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac6a40444bb5124484bafcd522f3ff49e" name="ac6a40444bb5124484bafcd522f3ff49e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac6a40444bb5124484bafcd522f3ff49e">◆ </a></span>seek()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void aare::File::seek </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>frame_number</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a79bb952679193b02ee83a622c15a599c" name="a79bb952679193b02ee83a622c15a599c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a79bb952679193b02ee83a622c15a599c">◆ </a></span>tell()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t aare::File::tell </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a706409a694455040034b431fedff9172" name="a706409a694455040034b431fedff9172"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a706409a694455040034b431fedff9172">◆ </a></span>total_frames()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t aare::File::total_frames </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a53d2397c69b01f8aaf972b68f470b781" name="a53d2397c69b01f8aaf972b68f470b781"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a53d2397c69b01f8aaf972b68f470b781">◆ </a></span>write()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void aare::File::write </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classaare_1_1Frame.html">Frame</a> & </td>
|
|
<td class="paramname"><em>frame</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="ac2c569dfd6c15c1f5b19f5f1a5e38abf" name="ac2c569dfd6c15c1f5b19f5f1a5e38abf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac2c569dfd6c15c1f5b19f5f1a5e38abf">◆ </a></span>file_impl</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classaare_1_1FileInterface.html">FileInterface</a>* aare::File::file_impl</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>file_io/include/aare/file_io/<a class="el" href="File_8hpp_source.html">File.hpp</a></li>
|
|
<li>file_io/src/<a class="el" href="File_8cpp.html">File.cpp</a></li>
|
|
</ul>
|
|
</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>
|