mirror of
https://github.com/slsdetectorgroup/aare.git
synced 2025-06-08 13:40:39 +02:00
1880 lines
86 KiB
HTML
1880 lines
86 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::RawFile 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_1RawFile.html">RawFile</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pub-attribs">Data Fields</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> </div>
|
|
<div class="headertitle"><div class="title">aare::RawFile Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classaare_1_1RawFile.html" title="RawFile class to read .raw and .json files.">RawFile</a> class to read .raw and .json files.
|
|
<a href="classaare_1_1RawFile.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="RawFile_8hpp_source.html">RawFile.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for aare::RawFile:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classaare_1_1RawFile.png" usemap="#aare::RawFile_map" alt=""/>
|
|
<map id="aare::RawFile_map" name="aare::RawFile_map">
|
|
<area href="classaare_1_1FileInterface.html" title="FileInterface class to define the interface for file operations." alt="aare::FileInterface" shape="rect" coords="0,0,115,24"/>
|
|
</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:a2ae421cea7baddb96b3abb212f22b621"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#a2ae421cea7baddb96b3abb212f22b621">RawFile</a> (const std::filesystem::path &fname, const std::string &mode="r", const <a class="el" href="structaare_1_1FileConfig.html">FileConfig</a> &<a class="el" href="classaare_1_1RawFile.html#a6a98d519afde63d3b075110e53d244f0">cfg</a>={})</td></tr>
|
|
<tr class="memdesc:a2ae421cea7baddb96b3abb212f22b621"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classaare_1_1RawFile.html" title="RawFile class to read .raw and .json files.">RawFile</a> constructor. <br /></td></tr>
|
|
<tr class="separator:a2ae421cea7baddb96b3abb212f22b621"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9312684dfa014dede39e4c81d62abcd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#ae9312684dfa014dede39e4c81d62abcd">write</a> (<a class="el" href="classaare_1_1Frame.html">Frame</a> &frame) override</td></tr>
|
|
<tr class="memdesc:ae9312684dfa014dede39e4c81d62abcd"><td class="mdescLeft"> </td><td class="mdescRight">write function is not implemented for <a class="el" href="classaare_1_1RawFile.html" title="RawFile class to read .raw and .json files.">RawFile</a> <br /></td></tr>
|
|
<tr class="separator:ae9312684dfa014dede39e4c81d62abcd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc6d881b6d2f246f09a595e637afd58c"><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_1RawFile.html#afc6d881b6d2f246f09a595e637afd58c">read</a> () override</td></tr>
|
|
<tr class="memdesc:afc6d881b6d2f246f09a595e637afd58c"><td class="mdescLeft"> </td><td class="mdescRight">write a vector of frames to the file <br /></td></tr>
|
|
<tr class="separator:afc6d881b6d2f246f09a595e637afd58c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1adf18bc4fd91c620edfc5c9477ad11f"><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_1RawFile.html#a1adf18bc4fd91c620edfc5c9477ad11f">read</a> (size_t n_frames) override</td></tr>
|
|
<tr class="memdesc:a1adf18bc4fd91c620edfc5c9477ad11f"><td class="mdescLeft"> </td><td class="mdescRight">read n_frames from the file at the current position <br /></td></tr>
|
|
<tr class="separator:a1adf18bc4fd91c620edfc5c9477ad11f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afa0228d53554cf5cc192e97474361269"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#afa0228d53554cf5cc192e97474361269">read_into</a> (std::byte *image_buf) override</td></tr>
|
|
<tr class="memdesc:afa0228d53554cf5cc192e97474361269"><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:afa0228d53554cf5cc192e97474361269"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad8dc6726891e1100035631b7365e8d31"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#ad8dc6726891e1100035631b7365e8d31">read_into</a> (std::byte *image_buf, size_t n_frames) override</td></tr>
|
|
<tr class="memdesc:ad8dc6726891e1100035631b7365e8d31"><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:ad8dc6726891e1100035631b7365e8d31"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a42972170354d7d9cde0b9b9509b63fee"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#a42972170354d7d9cde0b9b9509b63fee">frame_number</a> (size_t frame_index) override</td></tr>
|
|
<tr class="memdesc:a42972170354d7d9cde0b9b9509b63fee"><td class="mdescLeft"> </td><td class="mdescRight">get the frame number at the given frame index <br /></td></tr>
|
|
<tr class="separator:a42972170354d7d9cde0b9b9509b63fee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac20d32d75330d179554c2c69292332f0"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#ac20d32d75330d179554c2c69292332f0">bytes_per_frame</a> () override</td></tr>
|
|
<tr class="memdesc:ac20d32d75330d179554c2c69292332f0"><td class="mdescLeft"> </td><td class="mdescRight">get the number of bytess per frame <br /></td></tr>
|
|
<tr class="separator:ac20d32d75330d179554c2c69292332f0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab8935d47a8482c36532ff5cdd91c78da"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#ab8935d47a8482c36532ff5cdd91c78da">pixels</a> () override</td></tr>
|
|
<tr class="memdesc:ab8935d47a8482c36532ff5cdd91c78da"><td class="mdescLeft"> </td><td class="mdescRight">get the number of pixels in the frame <br /></td></tr>
|
|
<tr class="separator:ab8935d47a8482c36532ff5cdd91c78da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5eef29c0377f5af2e18475e9ae66527c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#a5eef29c0377f5af2e18475e9ae66527c">seek</a> (size_t <a class="el" href="classaare_1_1RawFile.html#a42972170354d7d9cde0b9b9509b63fee">frame_number</a>) override</td></tr>
|
|
<tr class="memdesc:a5eef29c0377f5af2e18475e9ae66527c"><td class="mdescLeft"> </td><td class="mdescRight">seek to the given frame number <br /></td></tr>
|
|
<tr class="separator:a5eef29c0377f5af2e18475e9ae66527c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa0773872c1e6dd2ab86df2bfff35dee8"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#aa0773872c1e6dd2ab86df2bfff35dee8">tell</a> () override</td></tr>
|
|
<tr class="memdesc:aa0773872c1e6dd2ab86df2bfff35dee8"><td class="mdescLeft"> </td><td class="mdescRight">get the current position of the file pointer <br /></td></tr>
|
|
<tr class="separator:aa0773872c1e6dd2ab86df2bfff35dee8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeebfe5a324fa2f24c9a3353a668a8323"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#aeebfe5a324fa2f24c9a3353a668a8323">set_config</a> (int row, int col)</td></tr>
|
|
<tr class="memdesc:aeebfe5a324fa2f24c9a3353a668a8323"><td class="mdescLeft"> </td><td class="mdescRight">set the module gap row and column <br /></td></tr>
|
|
<tr class="separator:aeebfe5a324fa2f24c9a3353a668a8323"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1f4fa8c6f909beb31e56a57cb452079"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#ae1f4fa8c6f909beb31e56a57cb452079">find_number_of_subfiles</a> ()</td></tr>
|
|
<tr class="memdesc:ae1f4fa8c6f909beb31e56a57cb452079"><td class="mdescLeft"> </td><td class="mdescRight">get the number of subfiles for the <a class="el" href="classaare_1_1RawFile.html" title="RawFile class to read .raw and .json files.">RawFile</a> <br /></td></tr>
|
|
<tr class="separator:ae1f4fa8c6f909beb31e56a57cb452079"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad310ff7f4ab8f007974755654c268432"><td class="memItemLeft" align="right" valign="top">std::filesystem::path </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#ad310ff7f4ab8f007974755654c268432">master_fname</a> ()</td></tr>
|
|
<tr class="memdesc:ad310ff7f4ab8f007974755654c268432"><td class="mdescLeft"> </td><td class="mdescRight">get the master file name path for the <a class="el" href="classaare_1_1RawFile.html" title="RawFile class to read .raw and .json files.">RawFile</a> <br /></td></tr>
|
|
<tr class="separator:ad310ff7f4ab8f007974755654c268432"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3ceff9543ba1fff7c57513374410fc0c"><td class="memItemLeft" align="right" valign="top">std::filesystem::path </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#a3ceff9543ba1fff7c57513374410fc0c">data_fname</a> (int mod_id, int file_id)</td></tr>
|
|
<tr class="memdesc:a3ceff9543ba1fff7c57513374410fc0c"><td class="mdescLeft"> </td><td class="mdescRight">get the data file name path for the <a class="el" href="classaare_1_1RawFile.html" title="RawFile class to read .raw and .json files.">RawFile</a> with the given module id and file id <br /></td></tr>
|
|
<tr class="separator:a3ceff9543ba1fff7c57513374410fc0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab3b4c559fa8bd4041bb32765f5c364d4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#ab3b4c559fa8bd4041bb32765f5c364d4">~RawFile</a> ()</td></tr>
|
|
<tr class="memdesc:ab3b4c559fa8bd4041bb32765f5c364d4"><td class="mdescLeft"> </td><td class="mdescRight">destructor: will delete the subfiles <br /></td></tr>
|
|
<tr class="separator:ab3b4c559fa8bd4041bb32765f5c364d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88a1e49617855a0984acf2bd70b3d209"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#a88a1e49617855a0984acf2bd70b3d209">total_frames</a> () const override</td></tr>
|
|
<tr class="memdesc:a88a1e49617855a0984acf2bd70b3d209"><td class="mdescLeft"> </td><td class="mdescRight">get the total number of frames in the file <br /></td></tr>
|
|
<tr class="separator:a88a1e49617855a0984acf2bd70b3d209"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a432c1b1f9a922e9951aaed0d221f5ea6"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#a432c1b1f9a922e9951aaed0d221f5ea6">rows</a> () const override</td></tr>
|
|
<tr class="memdesc:a432c1b1f9a922e9951aaed0d221f5ea6"><td class="mdescLeft"> </td><td class="mdescRight">get the number of rows in the file <br /></td></tr>
|
|
<tr class="separator:a432c1b1f9a922e9951aaed0d221f5ea6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b646fd35e7b19740f6358804bba2bce"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#a8b646fd35e7b19740f6358804bba2bce">cols</a> () const override</td></tr>
|
|
<tr class="memdesc:a8b646fd35e7b19740f6358804bba2bce"><td class="mdescLeft"> </td><td class="mdescRight">get the number of columns in the file <br /></td></tr>
|
|
<tr class="separator:a8b646fd35e7b19740f6358804bba2bce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae880a6c07caaca176028936a29162ff2"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#ae880a6c07caaca176028936a29162ff2">bitdepth</a> () const override</td></tr>
|
|
<tr class="memdesc:ae880a6c07caaca176028936a29162ff2"><td class="mdescLeft"> </td><td class="mdescRight">get the bitdepth of the file <br /></td></tr>
|
|
<tr class="separator:ae880a6c07caaca176028936a29162ff2"><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_1RawFile.html#a42972170354d7d9cde0b9b9509b63fee">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_1RawFile.html#a42972170354d7d9cde0b9b9509b63fee">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>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ab01258c2c975668a1924aa4a267df685"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#ab01258c2c975668a1924aa4a267df685">is_master_file</a> (std::filesystem::path fpath)</td></tr>
|
|
<tr class="memdesc:ab01258c2c975668a1924aa4a267df685"><td class="mdescLeft"> </td><td class="mdescRight">check if the file is a master file <br /></td></tr>
|
|
<tr class="separator:ab01258c2c975668a1924aa4a267df685"><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><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
|
|
Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:ac37989a067cd0b9f22e0f9203b6a9a22"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#ac37989a067cd0b9f22e0f9203b6a9a22">get_frame_into</a> (size_t <a class="el" href="classaare_1_1RawFile.html#a42972170354d7d9cde0b9b9509b63fee">frame_number</a>, std::byte *image_buf)</td></tr>
|
|
<tr class="memdesc:ac37989a067cd0b9f22e0f9203b6a9a22"><td class="mdescLeft"> </td><td class="mdescRight">read the frame at the given frame number into the image buffer <br /></td></tr>
|
|
<tr class="separator:ac37989a067cd0b9f22e0f9203b6a9a22"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a035699488278961f601e5d23bd7154"><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_1RawFile.html#a7a035699488278961f601e5d23bd7154">get_frame</a> (size_t <a class="el" href="classaare_1_1RawFile.html#a42972170354d7d9cde0b9b9509b63fee">frame_number</a>)</td></tr>
|
|
<tr class="memdesc:a7a035699488278961f601e5d23bd7154"><td class="mdescLeft"> </td><td class="mdescRight">get the frame at the given frame number <br /></td></tr>
|
|
<tr class="separator:a7a035699488278961f601e5d23bd7154"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a57d281f40683621a40bae3ac78e6489c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#a57d281f40683621a40bae3ac78e6489c">parse_fname</a> ()</td></tr>
|
|
<tr class="memdesc:a57d281f40683621a40bae3ac78e6489c"><td class="mdescLeft"> </td><td class="mdescRight">parse the file name to get the extension, base name and index <br /></td></tr>
|
|
<tr class="separator:a57d281f40683621a40bae3ac78e6489c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2937ce909e9c9a8f3c55c4eebe2e0493"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#a2937ce909e9c9a8f3c55c4eebe2e0493">parse_metadata</a> ()</td></tr>
|
|
<tr class="memdesc:a2937ce909e9c9a8f3c55c4eebe2e0493"><td class="mdescLeft"> </td><td class="mdescRight">parse the metadata from the file <br /></td></tr>
|
|
<tr class="separator:a2937ce909e9c9a8f3c55c4eebe2e0493"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adbe11ff4722d5938bc1f4b7a9808216a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#adbe11ff4722d5938bc1f4b7a9808216a">parse_raw_metadata</a> ()</td></tr>
|
|
<tr class="memdesc:adbe11ff4722d5938bc1f4b7a9808216a"><td class="mdescLeft"> </td><td class="mdescRight">parse the metadata of a .raw file <br /></td></tr>
|
|
<tr class="separator:adbe11ff4722d5938bc1f4b7a9808216a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8a1f274417363cb6c112a065065f395"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#ae8a1f274417363cb6c112a065065f395">parse_json_metadata</a> ()</td></tr>
|
|
<tr class="memdesc:ae8a1f274417363cb6c112a065065f395"><td class="mdescLeft"> </td><td class="mdescRight">parse the metadata of a .json file <br /></td></tr>
|
|
<tr class="separator:ae8a1f274417363cb6c112a065065f395"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aca4db4b540a58dc78f65124f159192b5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#aca4db4b540a58dc78f65124f159192b5">find_geometry</a> ()</td></tr>
|
|
<tr class="memdesc:aca4db4b540a58dc78f65124f159192b5"><td class="mdescLeft"> </td><td class="mdescRight">finds the geometry of the file <br /></td></tr>
|
|
<tr class="separator:aca4db4b540a58dc78f65124f159192b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a87d4af5d79244e7f1d69ab3a66e2bd10"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structaare_1_1sls__detector__header.html">sls_detector_header</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#a87d4af5d79244e7f1d69ab3a66e2bd10">read_header</a> (const std::filesystem::path &fname)</td></tr>
|
|
<tr class="memdesc:a87d4af5d79244e7f1d69ab3a66e2bd10"><td class="mdescLeft"> </td><td class="mdescRight">read the header of the file <br /></td></tr>
|
|
<tr class="separator:a87d4af5d79244e7f1d69ab3a66e2bd10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a778b1fcb1d5fcfdfb57c15642a6775e0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#a778b1fcb1d5fcfdfb57c15642a6775e0">open_subfiles</a> ()</td></tr>
|
|
<tr class="memdesc:a778b1fcb1d5fcfdfb57c15642a6775e0"><td class="mdescLeft"> </td><td class="mdescRight">open the subfiles <br /></td></tr>
|
|
<tr class="separator:a778b1fcb1d5fcfdfb57c15642a6775e0"><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:ad256cf93af5d382fcd9381ad50db6f94"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#ad256cf93af5d382fcd9381ad50db6f94">n_subfiles</a></td></tr>
|
|
<tr class="separator:ad256cf93af5d382fcd9381ad50db6f94"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac1493a619e12568437f95bf1b8ae5c51"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#ac1493a619e12568437f95bf1b8ae5c51">n_subfile_parts</a></td></tr>
|
|
<tr class="separator:ac1493a619e12568437f95bf1b8ae5c51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a310a0a7c3e49e112117ebed8bfdf199d"><td class="memItemLeft" align="right" valign="top">std::vector< std::vector< <a class="el" href="classaare_1_1SubFile.html">SubFile</a> * > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#a310a0a7c3e49e112117ebed8bfdf199d">subfiles</a></td></tr>
|
|
<tr class="separator:a310a0a7c3e49e112117ebed8bfdf199d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1a3902a51ded3c1823937a914c7d458"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#ab1a3902a51ded3c1823937a914c7d458">subfile_rows</a></td></tr>
|
|
<tr class="separator:ab1a3902a51ded3c1823937a914c7d458"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae322f1b62cfa7e4ebeb1ccae51a799f2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#ae322f1b62cfa7e4ebeb1ccae51a799f2">subfile_cols</a></td></tr>
|
|
<tr class="separator:ae322f1b62cfa7e4ebeb1ccae51a799f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a913ff02d0893519b290a121da13ac1e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structaare_1_1xy.html">xy</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#a913ff02d0893519b290a121da13ac1e2">geometry</a></td></tr>
|
|
<tr class="separator:a913ff02d0893519b290a121da13ac1e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8be8d44e86171815bf54031b00fa1610"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="structaare_1_1xy.html">xy</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#a8be8d44e86171815bf54031b00fa1610">positions</a></td></tr>
|
|
<tr class="separator:a8be8d44e86171815bf54031b00fa1610"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a98d519afde63d3b075110e53d244f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structaare_1_1RawFileConfig.html">RawFileConfig</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#a6a98d519afde63d3b075110e53d244f0">cfg</a> {0, 0}</td></tr>
|
|
<tr class="separator:a6a98d519afde63d3b075110e53d244f0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a333f2ee8aec487d0e4cbf7973fafaec4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceaare.html#a180255836568df302c95b5ca87dc5355">TimingMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#a333f2ee8aec487d0e4cbf7973fafaec4">timing_mode</a></td></tr>
|
|
<tr class="separator:a333f2ee8aec487d0e4cbf7973fafaec4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2e86859abde675cab13a68eeaea0e55"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1RawFile.html#ad2e86859abde675cab13a68eeaea0e55">quad</a> {false}</td></tr>
|
|
<tr class="separator:ad2e86859abde675cab13a68eeaea0e55"><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_1RawFile.html" title="RawFile class to read .raw and .json files.">RawFile</a> class to read .raw and .json files. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>derived from <a class="el" href="classaare_1_1FileInterface.html" title="FileInterface class to define the interface for file operations.">FileInterface</a> </dd>
|
|
<dd>
|
|
documentation can also be found 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="a2ae421cea7baddb96b3abb212f22b621" name="a2ae421cea7baddb96b3abb212f22b621"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2ae421cea7baddb96b3abb212f22b621">◆ </a></span>RawFile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">aare::RawFile::RawFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::filesystem::path & </td>
|
|
<td class="paramname"><em>fname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>mode</em> = <code>"r"</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <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><a class="el" href="classaare_1_1RawFile.html" title="RawFile class to read .raw and .json files.">RawFile</a> constructor. </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) </td></tr>
|
|
<tr><td class="paramname">cfg</td><td>file configuration </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab3b4c559fa8bd4041bb32765f5c364d4" name="ab3b4c559fa8bd4041bb32765f5c364d4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab3b4c559fa8bd4041bb32765f5c364d4">◆ </a></span>~RawFile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">aare::RawFile::~RawFile </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>destructor: will delete the subfiles </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ae880a6c07caaca176028936a29162ff2" name="ae880a6c07caaca176028936a29162ff2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae880a6c07caaca176028936a29162ff2">◆ </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">ssize_t aare::RawFile::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>Implements <a class="el" href="classaare_1_1FileInterface.html#a8bfd7abf4271210000b2ef8d1c0d6149">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac20d32d75330d179554c2c69292332f0" name="ac20d32d75330d179554c2c69292332f0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac20d32d75330d179554c2c69292332f0">◆ </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">size_t aare::RawFile::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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the number of bytess per frame </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>size of one frame in bytes </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classaare_1_1FileInterface.html#aab236d5b808f2acc44266281274ed93a">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8b646fd35e7b19740f6358804bba2bce" name="a8b646fd35e7b19740f6358804bba2bce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8b646fd35e7b19740f6358804bba2bce">◆ </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">ssize_t aare::RawFile::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>Implements <a class="el" href="classaare_1_1FileInterface.html#a2927ba0e6a564bcd0da139a552c09b76">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3ceff9543ba1fff7c57513374410fc0c" name="a3ceff9543ba1fff7c57513374410fc0c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3ceff9543ba1fff7c57513374410fc0c">◆ </a></span>data_fname()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::filesystem::path aare::RawFile::data_fname </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>mod_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>file_id</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>get the data file name path for the <a class="el" href="classaare_1_1RawFile.html" title="RawFile class to read .raw and .json files.">RawFile</a> with the given module id and file id </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mod_id</td><td>module id </td></tr>
|
|
<tr><td class="paramname">file_id</td><td>file id </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>path to the data file </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aca4db4b540a58dc78f65124f159192b5" name="aca4db4b540a58dc78f65124f159192b5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aca4db4b540a58dc78f65124f159192b5">◆ </a></span>find_geometry()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void aare::RawFile::find_geometry </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>finds the geometry of the file </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae1f4fa8c6f909beb31e56a57cb452079" name="ae1f4fa8c6f909beb31e56a57cb452079"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae1f4fa8c6f909beb31e56a57cb452079">◆ </a></span>find_number_of_subfiles()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void aare::RawFile::find_number_of_subfiles </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the number of subfiles for the <a class="el" href="classaare_1_1RawFile.html" title="RawFile class to read .raw and .json files.">RawFile</a> </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>number of subfiles </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a42972170354d7d9cde0b9b9509b63fee" name="a42972170354d7d9cde0b9b9509b63fee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a42972170354d7d9cde0b9b9509b63fee">◆ </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">size_t aare::RawFile::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">override</span><span class="mlabel">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>Implements <a class="el" href="classaare_1_1FileInterface.html#ac6d10d468f79e855a3334cd1347c1178">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7a035699488278961f601e5d23bd7154" name="a7a035699488278961f601e5d23bd7154"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7a035699488278961f601e5d23bd7154">◆ </a></span>get_frame()</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::RawFile::get_frame </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">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the frame 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><a class="el" href="classaare_1_1Frame.html">Frame</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac37989a067cd0b9f22e0f9203b6a9a22" name="ac37989a067cd0b9f22e0f9203b6a9a22"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac37989a067cd0b9f22e0f9203b6a9a22">◆ </a></span>get_frame_into()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void aare::RawFile::get_frame_into </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">std::byte * </td>
|
|
<td class="paramname"><em>image_buf</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">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>read the frame at the given frame number into the image buffer </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>
|
|
<tr><td class="paramname">image_buf</td><td>buffer to store the frame </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</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 class="mlabel">inherited</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 class="mlabel">inherited</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="ab01258c2c975668a1924aa4a267df685" name="ab01258c2c975668a1924aa4a267df685"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab01258c2c975668a1924aa4a267df685">◆ </a></span>is_master_file()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool aare::RawFile::is_master_file </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::filesystem::path </td>
|
|
<td class="paramname"><em>fpath</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>check if the file is a master file </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fpath</td><td>path to the file </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad310ff7f4ab8f007974755654c268432" name="ad310ff7f4ab8f007974755654c268432"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad310ff7f4ab8f007974755654c268432">◆ </a></span>master_fname()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::filesystem::path aare::RawFile::master_fname </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the master file name path for the <a class="el" href="classaare_1_1RawFile.html" title="RawFile class to read .raw and .json files.">RawFile</a> </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>path to the master file </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a778b1fcb1d5fcfdfb57c15642a6775e0" name="a778b1fcb1d5fcfdfb57c15642a6775e0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a778b1fcb1d5fcfdfb57c15642a6775e0">◆ </a></span>open_subfiles()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void aare::RawFile::open_subfiles </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>open the subfiles </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a57d281f40683621a40bae3ac78e6489c" name="a57d281f40683621a40bae3ac78e6489c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a57d281f40683621a40bae3ac78e6489c">◆ </a></span>parse_fname()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void aare::RawFile::parse_fname </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>parse the file name to get the extension, base name and index </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae8a1f274417363cb6c112a065065f395" name="ae8a1f274417363cb6c112a065065f395"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae8a1f274417363cb6c112a065065f395">◆ </a></span>parse_json_metadata()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void aare::RawFile::parse_json_metadata </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>parse the metadata of a .json file </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2937ce909e9c9a8f3c55c4eebe2e0493" name="a2937ce909e9c9a8f3c55c4eebe2e0493"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2937ce909e9c9a8f3c55c4eebe2e0493">◆ </a></span>parse_metadata()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void aare::RawFile::parse_metadata </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>parse the metadata from the file </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adbe11ff4722d5938bc1f4b7a9808216a" name="adbe11ff4722d5938bc1f4b7a9808216a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adbe11ff4722d5938bc1f4b7a9808216a">◆ </a></span>parse_raw_metadata()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void aare::RawFile::parse_raw_metadata </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>parse the metadata of a .raw file </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab8935d47a8482c36532ff5cdd91c78da" name="ab8935d47a8482c36532ff5cdd91c78da"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab8935d47a8482c36532ff5cdd91c78da">◆ </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">size_t aare::RawFile::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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the number of pixels in the frame </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>number of pixels </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classaare_1_1FileInterface.html#a99da51594609984efe62bb64a88a3fa6">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afc6d881b6d2f246f09a595e637afd58c" name="afc6d881b6d2f246f09a595e637afd58c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afc6d881b6d2f246f09a595e637afd58c">◆ </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"><a class="el" href="classaare_1_1Frame.html">Frame</a> aare::RawFile::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>Implements <a class="el" href="classaare_1_1FileInterface.html#a9cb196de2bee8638578e4ba3ce46532e">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1adf18bc4fd91c620edfc5c9477ad11f" name="a1adf18bc4fd91c620edfc5c9477ad11f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1adf18bc4fd91c620edfc5c9477ad11f">◆ </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">std::vector< <a class="el" href="classaare_1_1Frame.html">Frame</a> > aare::RawFile::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">override</span><span class="mlabel">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>Implements <a class="el" href="classaare_1_1FileInterface.html#a1624d72f0feb1c19d507cc91c4cb414a">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a87d4af5d79244e7f1d69ab3a66e2bd10" name="a87d4af5d79244e7f1d69ab3a66e2bd10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a87d4af5d79244e7f1d69ab3a66e2bd10">◆ </a></span>read_header()</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="structaare_1_1sls__detector__header.html">sls_detector_header</a> aare::RawFile::read_header </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::filesystem::path & </td>
|
|
<td class="paramname"><em>fname</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>read the header of the file </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fname</td><td>path to the data subfile </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structaare_1_1sls__detector__header.html">sls_detector_header</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afa0228d53554cf5cc192e97474361269" name="afa0228d53554cf5cc192e97474361269"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afa0228d53554cf5cc192e97474361269">◆ </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">void aare::RawFile::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>Implements <a class="el" href="classaare_1_1FileInterface.html#a4ac0f4e63ccf90af9f0d5b9b44db856c">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad8dc6726891e1100035631b7365e8d31" name="ad8dc6726891e1100035631b7365e8d31"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad8dc6726891e1100035631b7365e8d31">◆ </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">void aare::RawFile::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">override</span><span class="mlabel">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>Implements <a class="el" href="classaare_1_1FileInterface.html#a580c71b3eecf45ce2140cd65103cfd43">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a432c1b1f9a922e9951aaed0d221f5ea6" name="a432c1b1f9a922e9951aaed0d221f5ea6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a432c1b1f9a922e9951aaed0d221f5ea6">◆ </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">ssize_t aare::RawFile::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>Implements <a class="el" href="classaare_1_1FileInterface.html#a8a5bc2d9b7b9ec1a9a100bf8a114d909">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5eef29c0377f5af2e18475e9ae66527c" name="a5eef29c0377f5af2e18475e9ae66527c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5eef29c0377f5af2e18475e9ae66527c">◆ </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">void aare::RawFile::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>Implements <a class="el" href="classaare_1_1FileInterface.html#a49510fb96eaa245fd5d2be7f25a40b74">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeebfe5a324fa2f24c9a3353a668a8323" name="aeebfe5a324fa2f24c9a3353a668a8323"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeebfe5a324fa2f24c9a3353a668a8323">◆ </a></span>set_config()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void aare::RawFile::set_config </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>row</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>col</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>set the module gap row and column </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">row</td><td>gap between rows </td></tr>
|
|
<tr><td class="paramname">col</td><td>gap between columns </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa0773872c1e6dd2ab86df2bfff35dee8" name="aa0773872c1e6dd2ab86df2bfff35dee8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa0773872c1e6dd2ab86df2bfff35dee8">◆ </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">size_t aare::RawFile::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>Implements <a class="el" href="classaare_1_1FileInterface.html#abd01811dcf904625b4dbd78dd9188de4">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a88a1e49617855a0984acf2bd70b3d209" name="a88a1e49617855a0984acf2bd70b3d209"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a88a1e49617855a0984acf2bd70b3d209">◆ </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">size_t aare::RawFile::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>Implements <a class="el" href="classaare_1_1FileInterface.html#ad4391bafd11f77f807114ba5108071d3">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae9312684dfa014dede39e4c81d62abcd" name="ae9312684dfa014dede39e4c81d62abcd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae9312684dfa014dede39e4c81d62abcd">◆ </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">void aare::RawFile::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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>write function is not implemented for <a class="el" href="classaare_1_1RawFile.html" title="RawFile class to read .raw and .json files.">RawFile</a> </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>
|
|
|
|
<p>Implements <a class="el" href="classaare_1_1FileInterface.html#a5d39033c9d218d53d51413b99bf7d1f4">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a6a98d519afde63d3b075110e53d244f0" name="a6a98d519afde63d3b075110e53d244f0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6a98d519afde63d3b075110e53d244f0">◆ </a></span>cfg</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="structaare_1_1RawFileConfig.html">RawFileConfig</a> aare::RawFile::cfg {0, 0}</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>
|
|
<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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t aare::FileInterface::current_frame {}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a913ff02d0893519b290a121da13ac1e2" name="a913ff02d0893519b290a121da13ac1e2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a913ff02d0893519b290a121da13ac1e2">◆ </a></span>geometry</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="structaare_1_1xy.html">xy</a> aare::RawFile::geometry</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>
|
|
<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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string aare::FileInterface::m_base_name</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::filesystem::path aare::FileInterface::m_base_path</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ssize_t aare::FileInterface::m_bitdepth {}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ssize_t aare::FileInterface::m_cols {}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string aare::FileInterface::m_ext</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int aare::FileInterface::m_findex</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::filesystem::path aare::FileInterface::m_fname</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string aare::FileInterface::m_mode</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ssize_t aare::FileInterface::m_rows {}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t aare::FileInterface::m_total_frames {}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceaare.html#a5b95afba95553c1e118e1478c69042f7">DetectorType</a> aare::FileInterface::m_type</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t aare::FileInterface::max_frames_per_file {}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac1493a619e12568437f95bf1b8ae5c51" name="ac1493a619e12568437f95bf1b8ae5c51"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac1493a619e12568437f95bf1b8ae5c51">◆ </a></span>n_subfile_parts</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t aare::RawFile::n_subfile_parts</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>
|
|
<a id="ad256cf93af5d382fcd9381ad50db6f94" name="ad256cf93af5d382fcd9381ad50db6f94"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad256cf93af5d382fcd9381ad50db6f94">◆ </a></span>n_subfiles</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t aare::RawFile::n_subfiles</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>
|
|
<a id="a8be8d44e86171815bf54031b00fa1610" name="a8be8d44e86171815bf54031b00fa1610"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8be8d44e86171815bf54031b00fa1610">◆ </a></span>positions</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="structaare_1_1xy.html">xy</a>> aare::RawFile::positions</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>
|
|
<a id="ad2e86859abde675cab13a68eeaea0e55" name="ad2e86859abde675cab13a68eeaea0e55"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad2e86859abde675cab13a68eeaea0e55">◆ </a></span>quad</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool aare::RawFile::quad {false}</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>
|
|
<a id="ae322f1b62cfa7e4ebeb1ccae51a799f2" name="ae322f1b62cfa7e4ebeb1ccae51a799f2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae322f1b62cfa7e4ebeb1ccae51a799f2">◆ </a></span>subfile_cols</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int aare::RawFile::subfile_cols</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>
|
|
<a id="ab1a3902a51ded3c1823937a914c7d458" name="ab1a3902a51ded3c1823937a914c7d458"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab1a3902a51ded3c1823937a914c7d458">◆ </a></span>subfile_rows</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int aare::RawFile::subfile_rows</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>
|
|
<a id="a310a0a7c3e49e112117ebed8bfdf199d" name="a310a0a7c3e49e112117ebed8bfdf199d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a310a0a7c3e49e112117ebed8bfdf199d">◆ </a></span>subfiles</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector<std::vector<<a class="el" href="classaare_1_1SubFile.html">SubFile</a> *> > aare::RawFile::subfiles</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>
|
|
<a id="a333f2ee8aec487d0e4cbf7973fafaec4" name="a333f2ee8aec487d0e4cbf7973fafaec4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a333f2ee8aec487d0e4cbf7973fafaec4">◆ </a></span>timing_mode</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="namespaceaare.html#a180255836568df302c95b5ca87dc5355">TimingMode</a> aare::RawFile::timing_mode</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>
|
|
<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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string aare::FileInterface::version</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</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="RawFile_8hpp_source.html">RawFile.hpp</a></li>
|
|
<li>file_io/src/<a class="el" href="RawFile_8cpp.html">RawFile.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>
|