mirror of
https://github.com/slsdetectorgroup/aare.git
synced 2025-06-08 21:40:43 +02:00
989 lines
49 KiB
HTML
989 lines
49 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::FileInterface 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_1FileInterface.html">FileInterface</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle"><div class="title">aare::FileInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classaare_1_1FileInterface.html" title="FileInterface class to define the interface for file operations.">FileInterface</a> class to define the interface for file operations.
|
|
<a href="classaare_1_1FileInterface.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="FileInterface_8hpp_source.html">FileInterface.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for aare::FileInterface:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classaare_1_1FileInterface.png" usemap="#aare::FileInterface_map" alt=""/>
|
|
<map id="aare::FileInterface_map" name="aare::FileInterface_map">
|
|
<area href="classaare_1_1NumpyFile.html" title="NumpyFile class to read and write numpy files." alt="aare::NumpyFile" shape="rect" coords="0,56,115,80"/>
|
|
<area href="classaare_1_1RawFile.html" title="RawFile class to read .raw and .json files." alt="aare::RawFile" shape="rect" coords="125,56,240,80"/>
|
|
</map>
|
|
</div></div>
|
|
<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:a5d39033c9d218d53d51413b99bf7d1f4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a5d39033c9d218d53d51413b99bf7d1f4">write</a> (<a class="el" href="classaare_1_1Frame.html">Frame</a> &frame)=0</td></tr>
|
|
<tr class="memdesc:a5d39033c9d218d53d51413b99bf7d1f4"><td class="mdescLeft"> </td><td class="mdescRight">write a frame to the file <br /></td></tr>
|
|
<tr class="separator:a5d39033c9d218d53d51413b99bf7d1f4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9cb196de2bee8638578e4ba3ce46532e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classaare_1_1Frame.html">Frame</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a9cb196de2bee8638578e4ba3ce46532e">read</a> ()=0</td></tr>
|
|
<tr class="memdesc:a9cb196de2bee8638578e4ba3ce46532e"><td class="mdescLeft"> </td><td class="mdescRight">write a vector of frames to the file <br /></td></tr>
|
|
<tr class="separator:a9cb196de2bee8638578e4ba3ce46532e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1624d72f0feb1c19d507cc91c4cb414a"><td class="memItemLeft" align="right" valign="top">virtual std::vector< <a class="el" href="classaare_1_1Frame.html">Frame</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a1624d72f0feb1c19d507cc91c4cb414a">read</a> (size_t n_frames)=0</td></tr>
|
|
<tr class="memdesc:a1624d72f0feb1c19d507cc91c4cb414a"><td class="mdescLeft"> </td><td class="mdescRight">read n_frames from the file at the current position <br /></td></tr>
|
|
<tr class="separator:a1624d72f0feb1c19d507cc91c4cb414a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ac0f4e63ccf90af9f0d5b9b44db856c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a4ac0f4e63ccf90af9f0d5b9b44db856c">read_into</a> (std::byte *image_buf)=0</td></tr>
|
|
<tr class="memdesc:a4ac0f4e63ccf90af9f0d5b9b44db856c"><td class="mdescLeft"> </td><td class="mdescRight">read one frame from the file at the current position and store it in the provided buffer <br /></td></tr>
|
|
<tr class="separator:a4ac0f4e63ccf90af9f0d5b9b44db856c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a580c71b3eecf45ce2140cd65103cfd43"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a580c71b3eecf45ce2140cd65103cfd43">read_into</a> (std::byte *image_buf, size_t n_frames)=0</td></tr>
|
|
<tr class="memdesc:a580c71b3eecf45ce2140cd65103cfd43"><td class="mdescLeft"> </td><td class="mdescRight">read n_frames from the file at the current position and store them in the provided buffer <br /></td></tr>
|
|
<tr class="separator:a580c71b3eecf45ce2140cd65103cfd43"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac6d10d468f79e855a3334cd1347c1178"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#ac6d10d468f79e855a3334cd1347c1178">frame_number</a> (size_t frame_index)=0</td></tr>
|
|
<tr class="memdesc:ac6d10d468f79e855a3334cd1347c1178"><td class="mdescLeft"> </td><td class="mdescRight">get the frame number at the given frame index <br /></td></tr>
|
|
<tr class="separator:ac6d10d468f79e855a3334cd1347c1178"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aab236d5b808f2acc44266281274ed93a"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#aab236d5b808f2acc44266281274ed93a">bytes_per_frame</a> ()=0</td></tr>
|
|
<tr class="memdesc:aab236d5b808f2acc44266281274ed93a"><td class="mdescLeft"> </td><td class="mdescRight">get the size of one frame in bytes <br /></td></tr>
|
|
<tr class="separator:aab236d5b808f2acc44266281274ed93a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99da51594609984efe62bb64a88a3fa6"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a99da51594609984efe62bb64a88a3fa6">pixels</a> ()=0</td></tr>
|
|
<tr class="memdesc:a99da51594609984efe62bb64a88a3fa6"><td class="mdescLeft"> </td><td class="mdescRight">get the number of pixels in one frame <br /></td></tr>
|
|
<tr class="separator:a99da51594609984efe62bb64a88a3fa6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49510fb96eaa245fd5d2be7f25a40b74"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a49510fb96eaa245fd5d2be7f25a40b74">seek</a> (size_t <a class="el" href="classaare_1_1FileInterface.html#ac6d10d468f79e855a3334cd1347c1178">frame_number</a>)=0</td></tr>
|
|
<tr class="memdesc:a49510fb96eaa245fd5d2be7f25a40b74"><td class="mdescLeft"> </td><td class="mdescRight">seek to the given frame number <br /></td></tr>
|
|
<tr class="separator:a49510fb96eaa245fd5d2be7f25a40b74"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd01811dcf904625b4dbd78dd9188de4"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#abd01811dcf904625b4dbd78dd9188de4">tell</a> ()=0</td></tr>
|
|
<tr class="memdesc:abd01811dcf904625b4dbd78dd9188de4"><td class="mdescLeft"> </td><td class="mdescRight">get the current position of the file pointer <br /></td></tr>
|
|
<tr class="separator:abd01811dcf904625b4dbd78dd9188de4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad4391bafd11f77f807114ba5108071d3"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#ad4391bafd11f77f807114ba5108071d3">total_frames</a> () const =0</td></tr>
|
|
<tr class="memdesc:ad4391bafd11f77f807114ba5108071d3"><td class="mdescLeft"> </td><td class="mdescRight">get the total number of frames in the file <br /></td></tr>
|
|
<tr class="separator:ad4391bafd11f77f807114ba5108071d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a5bc2d9b7b9ec1a9a100bf8a114d909"><td class="memItemLeft" align="right" valign="top">virtual ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a8a5bc2d9b7b9ec1a9a100bf8a114d909">rows</a> () const =0</td></tr>
|
|
<tr class="memdesc:a8a5bc2d9b7b9ec1a9a100bf8a114d909"><td class="mdescLeft"> </td><td class="mdescRight">get the number of rows in the file <br /></td></tr>
|
|
<tr class="separator:a8a5bc2d9b7b9ec1a9a100bf8a114d909"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2927ba0e6a564bcd0da139a552c09b76"><td class="memItemLeft" align="right" valign="top">virtual ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a2927ba0e6a564bcd0da139a552c09b76">cols</a> () const =0</td></tr>
|
|
<tr class="memdesc:a2927ba0e6a564bcd0da139a552c09b76"><td class="mdescLeft"> </td><td class="mdescRight">get the number of columns in the file <br /></td></tr>
|
|
<tr class="separator:a2927ba0e6a564bcd0da139a552c09b76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8bfd7abf4271210000b2ef8d1c0d6149"><td class="memItemLeft" align="right" valign="top">virtual ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a8bfd7abf4271210000b2ef8d1c0d6149">bitdepth</a> () const =0</td></tr>
|
|
<tr class="memdesc:a8bfd7abf4271210000b2ef8d1c0d6149"><td class="mdescLeft"> </td><td class="mdescRight">get the bitdepth of the file <br /></td></tr>
|
|
<tr class="separator:a8bfd7abf4271210000b2ef8d1c0d6149"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad0827f2dad4403cebdce417243d842c"><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_1FileInterface.html#aad0827f2dad4403cebdce417243d842c">iread</a> (size_t <a class="el" href="classaare_1_1FileInterface.html#ac6d10d468f79e855a3334cd1347c1178">frame_number</a>)</td></tr>
|
|
<tr class="memdesc:aad0827f2dad4403cebdce417243d842c"><td class="mdescLeft"> </td><td class="mdescRight">read one frame from the file at the given frame number <br /></td></tr>
|
|
<tr class="separator:aad0827f2dad4403cebdce417243d842c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a304e356f3c1d100544d6ceeb35c0fb"><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_1FileInterface.html#a1a304e356f3c1d100544d6ceeb35c0fb">iread</a> (size_t <a class="el" href="classaare_1_1FileInterface.html#ac6d10d468f79e855a3334cd1347c1178">frame_number</a>, size_t n_frames)</td></tr>
|
|
<tr class="memdesc:a1a304e356f3c1d100544d6ceeb35c0fb"><td class="mdescLeft"> </td><td class="mdescRight">read n_frames from the file starting at the given frame number <br /></td></tr>
|
|
<tr class="separator:a1a304e356f3c1d100544d6ceeb35c0fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7546e2d2dec365bee91cbf5607278e80"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a7546e2d2dec365bee91cbf5607278e80">~FileInterface</a> ()</td></tr>
|
|
<tr class="separator:a7546e2d2dec365bee91cbf5607278e80"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:ab1d0e6de947affd5af9740eb06888fc6"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#ab1d0e6de947affd5af9740eb06888fc6">m_mode</a></td></tr>
|
|
<tr class="separator:ab1d0e6de947affd5af9740eb06888fc6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a325f6603f564fb42f8f28f1136b5e329"><td class="memItemLeft" align="right" valign="top">std::filesystem::path </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a325f6603f564fb42f8f28f1136b5e329">m_fname</a></td></tr>
|
|
<tr class="separator:a325f6603f564fb42f8f28f1136b5e329"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afdd0a1a75618ad5db2f4794e0900b2f4"><td class="memItemLeft" align="right" valign="top">std::filesystem::path </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#afdd0a1a75618ad5db2f4794e0900b2f4">m_base_path</a></td></tr>
|
|
<tr class="separator:afdd0a1a75618ad5db2f4794e0900b2f4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adae2b35fc6a3f185e9eb263c97bc024b"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#adae2b35fc6a3f185e9eb263c97bc024b">m_base_name</a></td></tr>
|
|
<tr class="separator:adae2b35fc6a3f185e9eb263c97bc024b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5fffaf9a7c8ae2b3a2ebe89b9c94ed34"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a5fffaf9a7c8ae2b3a2ebe89b9c94ed34">m_ext</a></td></tr>
|
|
<tr class="separator:a5fffaf9a7c8ae2b3a2ebe89b9c94ed34"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a30e926a897b534ab9a327d40594ff191"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a30e926a897b534ab9a327d40594ff191">m_findex</a></td></tr>
|
|
<tr class="separator:a30e926a897b534ab9a327d40594ff191"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91551fada444b231294c095f3f5fb768"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a91551fada444b231294c095f3f5fb768">m_total_frames</a> {}</td></tr>
|
|
<tr class="separator:a91551fada444b231294c095f3f5fb768"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0762d7652c9a4e1afe6dbb7d7325ac9"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#ab0762d7652c9a4e1afe6dbb7d7325ac9">max_frames_per_file</a> {}</td></tr>
|
|
<tr class="separator:ab0762d7652c9a4e1afe6dbb7d7325ac9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a44cbe933bbd2cae1f48213121d15bce2"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a44cbe933bbd2cae1f48213121d15bce2">version</a></td></tr>
|
|
<tr class="separator:a44cbe933bbd2cae1f48213121d15bce2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9476a299cea6b4e97605135a28d0cb60"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceaare.html#a5b95afba95553c1e118e1478c69042f7">DetectorType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a9476a299cea6b4e97605135a28d0cb60">m_type</a></td></tr>
|
|
<tr class="separator:a9476a299cea6b4e97605135a28d0cb60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae29d98625cf56989e2c5237ace0d0f4c"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#ae29d98625cf56989e2c5237ace0d0f4c">m_rows</a> {}</td></tr>
|
|
<tr class="separator:ae29d98625cf56989e2c5237ace0d0f4c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad4c9991c30a71ba83cbaab283bc756b5"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#ad4c9991c30a71ba83cbaab283bc756b5">m_cols</a> {}</td></tr>
|
|
<tr class="separator:ad4c9991c30a71ba83cbaab283bc756b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a252d27cbbfcdfc528b86925eaac55bb7"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#a252d27cbbfcdfc528b86925eaac55bb7">m_bitdepth</a> {}</td></tr>
|
|
<tr class="separator:a252d27cbbfcdfc528b86925eaac55bb7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab96f5dd0c99fb7b5a527da812368d736"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1FileInterface.html#ab96f5dd0c99fb7b5a527da812368d736">current_frame</a> {}</td></tr>
|
|
<tr class="separator:ab96f5dd0c99fb7b5a527da812368d736"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="classaare_1_1FileInterface.html" title="FileInterface class to define the interface for file operations.">FileInterface</a> class to define the interface for file operations. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>parent class for <a class="el" href="classaare_1_1NumpyFile.html" title="NumpyFile class to read and write numpy files.">NumpyFile</a> and <a class="el" href="classaare_1_1RawFile.html" title="RawFile class to read .raw and .json files.">RawFile</a> </dd>
|
|
<dd>
|
|
all functions are pure virtual and must be implemented by the derived classes </dd></dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a7546e2d2dec365bee91cbf5607278e80" name="a7546e2d2dec365bee91cbf5607278e80"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7546e2d2dec365bee91cbf5607278e80">◆ </a></span>~FileInterface()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual aare::FileInterface::~FileInterface </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a8bfd7abf4271210000b2ef8d1c0d6149" name="a8bfd7abf4271210000b2ef8d1c0d6149"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8bfd7abf4271210000b2ef8d1c0d6149">◆ </a></span>bitdepth()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual ssize_t aare::FileInterface::bitdepth </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the bitdepth of the file </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>bitdepth of the file </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classaare_1_1NumpyFile.html#afcdc40fcc15f5a3a470e23033ad1323c">aare::NumpyFile</a>, and <a class="el" href="classaare_1_1RawFile.html#ae880a6c07caaca176028936a29162ff2">aare::RawFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aab236d5b808f2acc44266281274ed93a" name="aab236d5b808f2acc44266281274ed93a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aab236d5b808f2acc44266281274ed93a">◆ </a></span>bytes_per_frame()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual size_t aare::FileInterface::bytes_per_frame </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the size of one frame in bytes </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>size of one frame </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classaare_1_1NumpyFile.html#a35c1b49a469ba8e261d4e675a816b5f2">aare::NumpyFile</a>, and <a class="el" href="classaare_1_1RawFile.html#ac20d32d75330d179554c2c69292332f0">aare::RawFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2927ba0e6a564bcd0da139a552c09b76" name="a2927ba0e6a564bcd0da139a552c09b76"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2927ba0e6a564bcd0da139a552c09b76">◆ </a></span>cols()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual ssize_t aare::FileInterface::cols </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the number of columns in the file </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>number of columns in the file </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classaare_1_1NumpyFile.html#ae1558b1ab6fbea54f853cdfad9363d31">aare::NumpyFile</a>, and <a class="el" href="classaare_1_1RawFile.html#a8b646fd35e7b19740f6358804bba2bce">aare::RawFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac6d10d468f79e855a3334cd1347c1178" name="ac6d10d468f79e855a3334cd1347c1178"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac6d10d468f79e855a3334cd1347c1178">◆ </a></span>frame_number()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual size_t aare::FileInterface::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>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the frame number at the given frame index </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">frame_index</td><td>index of the frame </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>frame number </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classaare_1_1NumpyFile.html#abe5817c47fa552b7d6de72a4b59d290a">aare::NumpyFile</a>, and <a class="el" href="classaare_1_1RawFile.html#a42972170354d7d9cde0b9b9509b63fee">aare::RawFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aad0827f2dad4403cebdce417243d842c" name="aad0827f2dad4403cebdce417243d842c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aad0827f2dad4403cebdce417243d842c">◆ </a></span>iread() <span class="overload">[1/2]</span></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_1Frame.html">Frame</a> aare::FileInterface::iread </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>frame_number</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>read one frame from the file at the given frame number </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">frame_number</td><td>frame number to read </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>frame </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1a304e356f3c1d100544d6ceeb35c0fb" name="a1a304e356f3c1d100544d6ceeb35c0fb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1a304e356f3c1d100544d6ceeb35c0fb">◆ </a></span>iread() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector< <a class="el" href="classaare_1_1Frame.html">Frame</a> > aare::FileInterface::iread </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>frame_number</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>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>read n_frames from the file starting at the given frame number </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">frame_number</td><td>frame number to start reading from </td></tr>
|
|
<tr><td class="paramname">n_frames</td><td>number of frames to read </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>vector of frames </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a99da51594609984efe62bb64a88a3fa6" name="a99da51594609984efe62bb64a88a3fa6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a99da51594609984efe62bb64a88a3fa6">◆ </a></span>pixels()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual size_t aare::FileInterface::pixels </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the number of pixels in one frame </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>number of pixels in one frame </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classaare_1_1NumpyFile.html#a2a40aebcb9b25ad36f1ecd75699c47d0">aare::NumpyFile</a>, and <a class="el" href="classaare_1_1RawFile.html#ab8935d47a8482c36532ff5cdd91c78da">aare::RawFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9cb196de2bee8638578e4ba3ce46532e" name="a9cb196de2bee8638578e4ba3ce46532e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9cb196de2bee8638578e4ba3ce46532e">◆ </a></span>read() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classaare_1_1Frame.html">Frame</a> aare::FileInterface::read </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>write a vector of frames to the file </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">frames</td><td>vector of frames to write </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>void</dd></dl>
|
|
<p>read one frame from the file at the current position </p><dl class="section return"><dt>Returns</dt><dd><a class="el" href="classaare_1_1Frame.html">Frame</a> </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classaare_1_1NumpyFile.html#a81e1a331ece6681bbfe9437e049d3b3a">aare::NumpyFile</a>, and <a class="el" href="classaare_1_1RawFile.html#afc6d881b6d2f246f09a595e637afd58c">aare::RawFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1624d72f0feb1c19d507cc91c4cb414a" name="a1624d72f0feb1c19d507cc91c4cb414a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1624d72f0feb1c19d507cc91c4cb414a">◆ </a></span>read() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual std::vector< <a class="el" href="classaare_1_1Frame.html">Frame</a> > aare::FileInterface::read </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>n_frames</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>read n_frames from the file at the current position </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">n_frames</td><td>number of frames to read </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>vector of frames </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classaare_1_1NumpyFile.html#a4cc861469a9dd388a937c318d3b6a13b">aare::NumpyFile</a>, and <a class="el" href="classaare_1_1RawFile.html#a1adf18bc4fd91c620edfc5c9477ad11f">aare::RawFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4ac0f4e63ccf90af9f0d5b9b44db856c" name="a4ac0f4e63ccf90af9f0d5b9b44db856c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ac0f4e63ccf90af9f0d5b9b44db856c">◆ </a></span>read_into() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void aare::FileInterface::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>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>read one frame from the file at the current position and store it in the provided buffer </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">image_buf</td><td>buffer to store the frame </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classaare_1_1NumpyFile.html#a8b25fc8fa2e0ab9e38b0388504d60962">aare::NumpyFile</a>, and <a class="el" href="classaare_1_1RawFile.html#afa0228d53554cf5cc192e97474361269">aare::RawFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a580c71b3eecf45ce2140cd65103cfd43" name="a580c71b3eecf45ce2140cd65103cfd43"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a580c71b3eecf45ce2140cd65103cfd43">◆ </a></span>read_into() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void aare::FileInterface::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>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>read n_frames from the file at the current position and store them in the provided buffer </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">image_buf</td><td>buffer to store the frames </td></tr>
|
|
<tr><td class="paramname">n_frames</td><td>number of frames to read </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classaare_1_1NumpyFile.html#a88f0fbdd9cf61f517d925a37854d82f8">aare::NumpyFile</a>, and <a class="el" href="classaare_1_1RawFile.html#ad8dc6726891e1100035631b7365e8d31">aare::RawFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8a5bc2d9b7b9ec1a9a100bf8a114d909" name="a8a5bc2d9b7b9ec1a9a100bf8a114d909"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8a5bc2d9b7b9ec1a9a100bf8a114d909">◆ </a></span>rows()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual ssize_t aare::FileInterface::rows </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the number of rows in the file </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>number of rows in the file </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classaare_1_1NumpyFile.html#a24c0cad439c52b77886c862b8093b91a">aare::NumpyFile</a>, and <a class="el" href="classaare_1_1RawFile.html#a432c1b1f9a922e9951aaed0d221f5ea6">aare::RawFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a49510fb96eaa245fd5d2be7f25a40b74" name="a49510fb96eaa245fd5d2be7f25a40b74"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a49510fb96eaa245fd5d2be7f25a40b74">◆ </a></span>seek()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void aare::FileInterface::seek </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>frame_number</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>seek to the given frame number </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">frame_number</td><td>frame number to seek to </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classaare_1_1NumpyFile.html#ae4f669f86fb614e446540638d8efe1b8">aare::NumpyFile</a>, and <a class="el" href="classaare_1_1RawFile.html#a5eef29c0377f5af2e18475e9ae66527c">aare::RawFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abd01811dcf904625b4dbd78dd9188de4" name="abd01811dcf904625b4dbd78dd9188de4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd01811dcf904625b4dbd78dd9188de4">◆ </a></span>tell()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual size_t aare::FileInterface::tell </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the current position of the file pointer </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>current position of the file pointer </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classaare_1_1NumpyFile.html#a022af0b9d792abb00a9dc661beb3e9a2">aare::NumpyFile</a>, and <a class="el" href="classaare_1_1RawFile.html#aa0773872c1e6dd2ab86df2bfff35dee8">aare::RawFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad4391bafd11f77f807114ba5108071d3" name="ad4391bafd11f77f807114ba5108071d3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad4391bafd11f77f807114ba5108071d3">◆ </a></span>total_frames()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual size_t aare::FileInterface::total_frames </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the total number of frames in the file </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>total number of frames in the file </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classaare_1_1NumpyFile.html#afec228003225dcc91b16227d24c58d37">aare::NumpyFile</a>, and <a class="el" href="classaare_1_1RawFile.html#a88a1e49617855a0984acf2bd70b3d209">aare::RawFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5d39033c9d218d53d51413b99bf7d1f4" name="a5d39033c9d218d53d51413b99bf7d1f4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5d39033c9d218d53d51413b99bf7d1f4">◆ </a></span>write()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void aare::FileInterface::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>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>write a frame to the file </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">frame</td><td>frame to write </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if the function is not implemented </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Implemented in <a class="el" href="classaare_1_1NumpyFile.html#a12b0ddf6334dfab4ac0993cd9c45f738">aare::NumpyFile</a>, and <a class="el" href="classaare_1_1RawFile.html#ae9312684dfa014dede39e4c81d62abcd">aare::RawFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="ab96f5dd0c99fb7b5a527da812368d736" name="ab96f5dd0c99fb7b5a527da812368d736"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab96f5dd0c99fb7b5a527da812368d736">◆ </a></span>current_frame</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t aare::FileInterface::current_frame {}</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adae2b35fc6a3f185e9eb263c97bc024b" name="adae2b35fc6a3f185e9eb263c97bc024b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adae2b35fc6a3f185e9eb263c97bc024b">◆ </a></span>m_base_name</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string aare::FileInterface::m_base_name</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afdd0a1a75618ad5db2f4794e0900b2f4" name="afdd0a1a75618ad5db2f4794e0900b2f4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afdd0a1a75618ad5db2f4794e0900b2f4">◆ </a></span>m_base_path</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::filesystem::path aare::FileInterface::m_base_path</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a252d27cbbfcdfc528b86925eaac55bb7" name="a252d27cbbfcdfc528b86925eaac55bb7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a252d27cbbfcdfc528b86925eaac55bb7">◆ </a></span>m_bitdepth</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ssize_t aare::FileInterface::m_bitdepth {}</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad4c9991c30a71ba83cbaab283bc756b5" name="ad4c9991c30a71ba83cbaab283bc756b5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad4c9991c30a71ba83cbaab283bc756b5">◆ </a></span>m_cols</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ssize_t aare::FileInterface::m_cols {}</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5fffaf9a7c8ae2b3a2ebe89b9c94ed34" name="a5fffaf9a7c8ae2b3a2ebe89b9c94ed34"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5fffaf9a7c8ae2b3a2ebe89b9c94ed34">◆ </a></span>m_ext</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string aare::FileInterface::m_ext</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a30e926a897b534ab9a327d40594ff191" name="a30e926a897b534ab9a327d40594ff191"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a30e926a897b534ab9a327d40594ff191">◆ </a></span>m_findex</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int aare::FileInterface::m_findex</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a325f6603f564fb42f8f28f1136b5e329" name="a325f6603f564fb42f8f28f1136b5e329"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a325f6603f564fb42f8f28f1136b5e329">◆ </a></span>m_fname</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::filesystem::path aare::FileInterface::m_fname</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab1d0e6de947affd5af9740eb06888fc6" name="ab1d0e6de947affd5af9740eb06888fc6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab1d0e6de947affd5af9740eb06888fc6">◆ </a></span>m_mode</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string aare::FileInterface::m_mode</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae29d98625cf56989e2c5237ace0d0f4c" name="ae29d98625cf56989e2c5237ace0d0f4c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae29d98625cf56989e2c5237ace0d0f4c">◆ </a></span>m_rows</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ssize_t aare::FileInterface::m_rows {}</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a91551fada444b231294c095f3f5fb768" name="a91551fada444b231294c095f3f5fb768"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a91551fada444b231294c095f3f5fb768">◆ </a></span>m_total_frames</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t aare::FileInterface::m_total_frames {}</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9476a299cea6b4e97605135a28d0cb60" name="a9476a299cea6b4e97605135a28d0cb60"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9476a299cea6b4e97605135a28d0cb60">◆ </a></span>m_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceaare.html#a5b95afba95553c1e118e1478c69042f7">DetectorType</a> aare::FileInterface::m_type</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab0762d7652c9a4e1afe6dbb7d7325ac9" name="ab0762d7652c9a4e1afe6dbb7d7325ac9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab0762d7652c9a4e1afe6dbb7d7325ac9">◆ </a></span>max_frames_per_file</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t aare::FileInterface::max_frames_per_file {}</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a44cbe933bbd2cae1f48213121d15bce2" name="a44cbe933bbd2cae1f48213121d15bce2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a44cbe933bbd2cae1f48213121d15bce2">◆ </a></span>version</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string aare::FileInterface::version</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>file_io/include/aare/file_io/<a class="el" href="FileInterface_8hpp_source.html">FileInterface.hpp</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>
|