mirror of
https://github.com/slsdetectorgroup/aare.git
synced 2025-06-08 13:40:39 +02:00
1538 lines
70 KiB
HTML
1538 lines
70 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::NumpyFile 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_1NumpyFile.html">NumpyFile</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> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> </div>
|
|
<div class="headertitle"><div class="title">aare::NumpyFile Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classaare_1_1NumpyFile.html" title="NumpyFile class to read and write numpy files.">NumpyFile</a> class to read and write numpy files.
|
|
<a href="classaare_1_1NumpyFile.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="NumpyFile_8hpp_source.html">NumpyFile.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for aare::NumpyFile:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classaare_1_1NumpyFile.png" usemap="#aare::NumpyFile_map" alt=""/>
|
|
<map id="aare::NumpyFile_map" name="aare::NumpyFile_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:a4764fdd2679c4c9a5671aa29a9b06899"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a4764fdd2679c4c9a5671aa29a9b06899">NumpyFile</a> (const std::filesystem::path &fname, const std::string &mode="r", <a class="el" href="structaare_1_1FileConfig.html">FileConfig</a> cfg={})</td></tr>
|
|
<tr class="memdesc:a4764fdd2679c4c9a5671aa29a9b06899"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classaare_1_1NumpyFile.html" title="NumpyFile class to read and write numpy files.">NumpyFile</a> constructor. <br /></td></tr>
|
|
<tr class="separator:a4764fdd2679c4c9a5671aa29a9b06899"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12b0ddf6334dfab4ac0993cd9c45f738"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a12b0ddf6334dfab4ac0993cd9c45f738">write</a> (<a class="el" href="classaare_1_1Frame.html">Frame</a> &frame) override</td></tr>
|
|
<tr class="memdesc:a12b0ddf6334dfab4ac0993cd9c45f738"><td class="mdescLeft"> </td><td class="mdescRight">write a frame to the file <br /></td></tr>
|
|
<tr class="separator:a12b0ddf6334dfab4ac0993cd9c45f738"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a81e1a331ece6681bbfe9437e049d3b3a"><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_1NumpyFile.html#a81e1a331ece6681bbfe9437e049d3b3a">read</a> () override</td></tr>
|
|
<tr class="memdesc:a81e1a331ece6681bbfe9437e049d3b3a"><td class="mdescLeft"> </td><td class="mdescRight">write a vector of frames to the file <br /></td></tr>
|
|
<tr class="separator:a81e1a331ece6681bbfe9437e049d3b3a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4cc861469a9dd388a937c318d3b6a13b"><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_1NumpyFile.html#a4cc861469a9dd388a937c318d3b6a13b">read</a> (size_t n_frames) override</td></tr>
|
|
<tr class="memdesc:a4cc861469a9dd388a937c318d3b6a13b"><td class="mdescLeft"> </td><td class="mdescRight">read n_frames from the file at the current position <br /></td></tr>
|
|
<tr class="separator:a4cc861469a9dd388a937c318d3b6a13b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b25fc8fa2e0ab9e38b0388504d60962"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a8b25fc8fa2e0ab9e38b0388504d60962">read_into</a> (std::byte *image_buf) override</td></tr>
|
|
<tr class="memdesc:a8b25fc8fa2e0ab9e38b0388504d60962"><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:a8b25fc8fa2e0ab9e38b0388504d60962"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88f0fbdd9cf61f517d925a37854d82f8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a88f0fbdd9cf61f517d925a37854d82f8">read_into</a> (std::byte *image_buf, size_t n_frames) override</td></tr>
|
|
<tr class="memdesc:a88f0fbdd9cf61f517d925a37854d82f8"><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:a88f0fbdd9cf61f517d925a37854d82f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe5817c47fa552b7d6de72a4b59d290a"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#abe5817c47fa552b7d6de72a4b59d290a">frame_number</a> (size_t frame_index) override</td></tr>
|
|
<tr class="memdesc:abe5817c47fa552b7d6de72a4b59d290a"><td class="mdescLeft"> </td><td class="mdescRight">get the frame number at the given frame index <br /></td></tr>
|
|
<tr class="separator:abe5817c47fa552b7d6de72a4b59d290a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a35c1b49a469ba8e261d4e675a816b5f2"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a35c1b49a469ba8e261d4e675a816b5f2">bytes_per_frame</a> () override</td></tr>
|
|
<tr class="memdesc:a35c1b49a469ba8e261d4e675a816b5f2"><td class="mdescLeft"> </td><td class="mdescRight">get the size of one frame in bytes <br /></td></tr>
|
|
<tr class="separator:a35c1b49a469ba8e261d4e675a816b5f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2a40aebcb9b25ad36f1ecd75699c47d0"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a2a40aebcb9b25ad36f1ecd75699c47d0">pixels</a> () override</td></tr>
|
|
<tr class="memdesc:a2a40aebcb9b25ad36f1ecd75699c47d0"><td class="mdescLeft"> </td><td class="mdescRight">get the number of pixels in one frame <br /></td></tr>
|
|
<tr class="separator:a2a40aebcb9b25ad36f1ecd75699c47d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae4f669f86fb614e446540638d8efe1b8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#ae4f669f86fb614e446540638d8efe1b8">seek</a> (size_t <a class="el" href="classaare_1_1NumpyFile.html#abe5817c47fa552b7d6de72a4b59d290a">frame_number</a>) override</td></tr>
|
|
<tr class="memdesc:ae4f669f86fb614e446540638d8efe1b8"><td class="mdescLeft"> </td><td class="mdescRight">seek to the given frame number <br /></td></tr>
|
|
<tr class="separator:ae4f669f86fb614e446540638d8efe1b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a022af0b9d792abb00a9dc661beb3e9a2"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a022af0b9d792abb00a9dc661beb3e9a2">tell</a> () override</td></tr>
|
|
<tr class="memdesc:a022af0b9d792abb00a9dc661beb3e9a2"><td class="mdescLeft"> </td><td class="mdescRight">get the current position of the file pointer <br /></td></tr>
|
|
<tr class="separator:a022af0b9d792abb00a9dc661beb3e9a2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afec228003225dcc91b16227d24c58d37"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#afec228003225dcc91b16227d24c58d37">total_frames</a> () const override</td></tr>
|
|
<tr class="memdesc:afec228003225dcc91b16227d24c58d37"><td class="mdescLeft"> </td><td class="mdescRight">get the total number of frames in the file <br /></td></tr>
|
|
<tr class="separator:afec228003225dcc91b16227d24c58d37"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a24c0cad439c52b77886c862b8093b91a"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a24c0cad439c52b77886c862b8093b91a">rows</a> () const override</td></tr>
|
|
<tr class="memdesc:a24c0cad439c52b77886c862b8093b91a"><td class="mdescLeft"> </td><td class="mdescRight">get the number of rows in the file <br /></td></tr>
|
|
<tr class="separator:a24c0cad439c52b77886c862b8093b91a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1558b1ab6fbea54f853cdfad9363d31"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#ae1558b1ab6fbea54f853cdfad9363d31">cols</a> () const override</td></tr>
|
|
<tr class="memdesc:ae1558b1ab6fbea54f853cdfad9363d31"><td class="mdescLeft"> </td><td class="mdescRight">get the number of columns in the file <br /></td></tr>
|
|
<tr class="separator:ae1558b1ab6fbea54f853cdfad9363d31"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afcdc40fcc15f5a3a470e23033ad1323c"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#afcdc40fcc15f5a3a470e23033ad1323c">bitdepth</a> () const override</td></tr>
|
|
<tr class="memdesc:afcdc40fcc15f5a3a470e23033ad1323c"><td class="mdescLeft"> </td><td class="mdescRight">get the bitdepth of the file <br /></td></tr>
|
|
<tr class="separator:afcdc40fcc15f5a3a470e23033ad1323c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0f029f5e1c09875533962a9ee957a98"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classaare_1_1DType.html">DType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#ae0f029f5e1c09875533962a9ee957a98">dtype</a> () const</td></tr>
|
|
<tr class="memdesc:ae0f029f5e1c09875533962a9ee957a98"><td class="mdescLeft"> </td><td class="mdescRight">get the data type of the numpy file <br /></td></tr>
|
|
<tr class="separator:ae0f029f5e1c09875533962a9ee957a98"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a060d3bc922d3a759aabb3716e9c97791"><td class="memItemLeft" align="right" valign="top">std::vector< size_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a060d3bc922d3a759aabb3716e9c97791">shape</a> () const</td></tr>
|
|
<tr class="memdesc:a060d3bc922d3a759aabb3716e9c97791"><td class="mdescLeft"> </td><td class="mdescRight">get the shape of the numpy file <br /></td></tr>
|
|
<tr class="separator:a060d3bc922d3a759aabb3716e9c97791"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab16bb0e1a3c4d17b137c9c8708b9031c"><td class="memTemplParams" colspan="2">template<typename T , size_t NDim> </td></tr>
|
|
<tr class="memitem:ab16bb0e1a3c4d17b137c9c8708b9031c"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classaare_1_1NDArray.html">NDArray</a>< T, NDim > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#ab16bb0e1a3c4d17b137c9c8708b9031c">load</a> ()</td></tr>
|
|
<tr class="memdesc:ab16bb0e1a3c4d17b137c9c8708b9031c"><td class="mdescLeft"> </td><td class="mdescRight">load the numpy file into an <a class="el" href="classaare_1_1NDArray.html">NDArray</a> <br /></td></tr>
|
|
<tr class="separator:ab16bb0e1a3c4d17b137c9c8708b9031c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8d6ace67f7880e6b2cd12da568fbead"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#af8d6ace67f7880e6b2cd12da568fbead">~NumpyFile</a> ()</td></tr>
|
|
<tr class="separator:af8d6ace67f7880e6b2cd12da568fbead"><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_1NumpyFile.html#abe5817c47fa552b7d6de72a4b59d290a">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_1NumpyFile.html#abe5817c47fa552b7d6de72a4b59d290a">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-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>
|
|
</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:a1c4bfd5eefa5ac19ecf2aa96c0dbdae3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a1c4bfd5eefa5ac19ecf2aa96c0dbdae3">load_metadata</a> ()</td></tr>
|
|
<tr class="separator:a1c4bfd5eefa5ac19ecf2aa96c0dbdae3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add05576e7b9256474c104553f0856c80"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#add05576e7b9256474c104553f0856c80">get_frame_into</a> (size_t, std::byte *)</td></tr>
|
|
<tr class="separator:add05576e7b9256474c104553f0856c80"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac0e88af0f3793ef18302db5c503bd3d7"><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_1NumpyFile.html#ac0e88af0f3793ef18302db5c503bd3d7">get_frame</a> (size_t <a class="el" href="classaare_1_1NumpyFile.html#abe5817c47fa552b7d6de72a4b59d290a">frame_number</a>)</td></tr>
|
|
<tr class="separator:ac0e88af0f3793ef18302db5c503bd3d7"><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:a1b3f50636674e919e54b7d61e11ed03a"><td class="memItemLeft" align="right" valign="top">FILE * </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a1b3f50636674e919e54b7d61e11ed03a">fp</a> = nullptr</td></tr>
|
|
<tr class="separator:a1b3f50636674e919e54b7d61e11ed03a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85400183bf0f1fdc43fd9a37e3f10a2d"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a85400183bf0f1fdc43fd9a37e3f10a2d">initial_header_len</a> = 0</td></tr>
|
|
<tr class="separator:a85400183bf0f1fdc43fd9a37e3f10a2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a080973acac90ab8e6d0552b282e2d73c"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a080973acac90ab8e6d0552b282e2d73c">current_frame</a> {}</td></tr>
|
|
<tr class="separator:a080973acac90ab8e6d0552b282e2d73c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff59772a6f221edd2606e483ef4ed8ee"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#aff59772a6f221edd2606e483ef4ed8ee">header_len</a> {}</td></tr>
|
|
<tr class="separator:aff59772a6f221edd2606e483ef4ed8ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50d19cf61c165c609c1b707abbe13cbd"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a50d19cf61c165c609c1b707abbe13cbd">header_len_size</a> {}</td></tr>
|
|
<tr class="separator:a50d19cf61c165c609c1b707abbe13cbd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5aed02e400e44d7fbc5356365f421c5b"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a5aed02e400e44d7fbc5356365f421c5b">header_size</a> {}</td></tr>
|
|
<tr class="separator:a5aed02e400e44d7fbc5356365f421c5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa2d11ec505dc7c3b4918e194d24d00fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structaare_1_1NumpyHeader.html">NumpyHeader</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#aa2d11ec505dc7c3b4918e194d24d00fe">m_header</a></td></tr>
|
|
<tr class="separator:aa2d11ec505dc7c3b4918e194d24d00fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58feea4735fdf9599d810427785266ea"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a58feea4735fdf9599d810427785266ea">major_ver_</a> {}</td></tr>
|
|
<tr class="separator:a58feea4735fdf9599d810427785266ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ca45b371f1c56e6b74eaca1852c5ffc"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1NumpyFile.html#a2ca45b371f1c56e6b74eaca1852c5ffc">minor_ver_</a> {}</td></tr>
|
|
<tr class="separator:a2ca45b371f1c56e6b74eaca1852c5ffc"><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_1NumpyFile.html" title="NumpyFile class to read and write numpy files.">NumpyFile</a> class to read and write numpy 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>
|
|
implements all the pure virtual functions from <a class="el" href="classaare_1_1FileInterface.html" title="FileInterface class to define the interface for file operations.">FileInterface</a> </dd>
|
|
<dd>
|
|
documentation for the functions 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="a4764fdd2679c4c9a5671aa29a9b06899" name="a4764fdd2679c4c9a5671aa29a9b06899"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4764fdd2679c4c9a5671aa29a9b06899">◆ </a></span>NumpyFile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">aare::NumpyFile::NumpyFile </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"><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_1NumpyFile.html" title="NumpyFile class to read and write numpy files.">NumpyFile</a> constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fname</td><td>path to the numpy 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="af8d6ace67f7880e6b2cd12da568fbead" name="af8d6ace67f7880e6b2cd12da568fbead"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af8d6ace67f7880e6b2cd12da568fbead">◆ </a></span>~NumpyFile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">aare::NumpyFile::~NumpyFile </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="afcdc40fcc15f5a3a470e23033ad1323c" name="afcdc40fcc15f5a3a470e23033ad1323c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afcdc40fcc15f5a3a470e23033ad1323c">◆ </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::NumpyFile::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="a35c1b49a469ba8e261d4e675a816b5f2" name="a35c1b49a469ba8e261d4e675a816b5f2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a35c1b49a469ba8e261d4e675a816b5f2">◆ </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::NumpyFile::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">override</span><span class="mlabel">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>Implements <a class="el" href="classaare_1_1FileInterface.html#aab236d5b808f2acc44266281274ed93a">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae1558b1ab6fbea54f853cdfad9363d31" name="ae1558b1ab6fbea54f853cdfad9363d31"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae1558b1ab6fbea54f853cdfad9363d31">◆ </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::NumpyFile::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="ae0f029f5e1c09875533962a9ee957a98" name="ae0f029f5e1c09875533962a9ee957a98"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae0f029f5e1c09875533962a9ee957a98">◆ </a></span>dtype()</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_1DType.html">DType</a> aare::NumpyFile::dtype </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the data type of the numpy file </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classaare_1_1DType.html">DType</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abe5817c47fa552b7d6de72a4b59d290a" name="abe5817c47fa552b7d6de72a4b59d290a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abe5817c47fa552b7d6de72a4b59d290a">◆ </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::NumpyFile::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">inline</span><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="ac0e88af0f3793ef18302db5c503bd3d7" name="ac0e88af0f3793ef18302db5c503bd3d7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac0e88af0f3793ef18302db5c503bd3d7">◆ </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::NumpyFile::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">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="add05576e7b9256474c104553f0856c80" name="add05576e7b9256474c104553f0856c80"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#add05576e7b9256474c104553f0856c80">◆ </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::NumpyFile::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">
|
|
|
|
</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="ab16bb0e1a3c4d17b137c9c8708b9031c" name="ab16bb0e1a3c4d17b137c9c8708b9031c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab16bb0e1a3c4d17b137c9c8708b9031c">◆ </a></span>load()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T , size_t NDim> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classaare_1_1NDArray.html">NDArray</a>< T, NDim > aare::NumpyFile::load </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>load the numpy file into an <a class="el" href="classaare_1_1NDArray.html">NDArray</a> </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>data type of the <a class="el" href="classaare_1_1NDArray.html">NDArray</a> </td></tr>
|
|
<tr><td class="paramname">NDim</td><td>number of dimensions of the <a class="el" href="classaare_1_1NDArray.html">NDArray</a> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>NDArray<T, NDim> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1c4bfd5eefa5ac19ecf2aa96c0dbdae3" name="a1c4bfd5eefa5ac19ecf2aa96c0dbdae3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1c4bfd5eefa5ac19ecf2aa96c0dbdae3">◆ </a></span>load_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::NumpyFile::load_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">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2a40aebcb9b25ad36f1ecd75699c47d0" name="a2a40aebcb9b25ad36f1ecd75699c47d0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2a40aebcb9b25ad36f1ecd75699c47d0">◆ </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::NumpyFile::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">override</span><span class="mlabel">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>Implements <a class="el" href="classaare_1_1FileInterface.html#a99da51594609984efe62bb64a88a3fa6">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a81e1a331ece6681bbfe9437e049d3b3a" name="a81e1a331ece6681bbfe9437e049d3b3a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a81e1a331ece6681bbfe9437e049d3b3a">◆ </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::NumpyFile::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="a4cc861469a9dd388a937c318d3b6a13b" name="a4cc861469a9dd388a937c318d3b6a13b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4cc861469a9dd388a937c318d3b6a13b">◆ </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::NumpyFile::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="a8b25fc8fa2e0ab9e38b0388504d60962" name="a8b25fc8fa2e0ab9e38b0388504d60962"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8b25fc8fa2e0ab9e38b0388504d60962">◆ </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::NumpyFile::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="a88f0fbdd9cf61f517d925a37854d82f8" name="a88f0fbdd9cf61f517d925a37854d82f8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a88f0fbdd9cf61f517d925a37854d82f8">◆ </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::NumpyFile::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="a24c0cad439c52b77886c862b8093b91a" name="a24c0cad439c52b77886c862b8093b91a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a24c0cad439c52b77886c862b8093b91a">◆ </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::NumpyFile::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="ae4f669f86fb614e446540638d8efe1b8" name="ae4f669f86fb614e446540638d8efe1b8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae4f669f86fb614e446540638d8efe1b8">◆ </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::NumpyFile::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="a060d3bc922d3a759aabb3716e9c97791" name="a060d3bc922d3a759aabb3716e9c97791"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a060d3bc922d3a759aabb3716e9c97791">◆ </a></span>shape()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector< size_t > aare::NumpyFile::shape </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the shape of the numpy file </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>vector of type size_t </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a022af0b9d792abb00a9dc661beb3e9a2" name="a022af0b9d792abb00a9dc661beb3e9a2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a022af0b9d792abb00a9dc661beb3e9a2">◆ </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::NumpyFile::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="afec228003225dcc91b16227d24c58d37" name="afec228003225dcc91b16227d24c58d37"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afec228003225dcc91b16227d24c58d37">◆ </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::NumpyFile::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="a12b0ddf6334dfab4ac0993cd9c45f738" name="a12b0ddf6334dfab4ac0993cd9c45f738"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a12b0ddf6334dfab4ac0993cd9c45f738">◆ </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::NumpyFile::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">override</span><span class="mlabel">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>Implements <a class="el" href="classaare_1_1FileInterface.html#a5d39033c9d218d53d51413b99bf7d1f4">aare::FileInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a080973acac90ab8e6d0552b282e2d73c" name="a080973acac90ab8e6d0552b282e2d73c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a080973acac90ab8e6d0552b282e2d73c">◆ </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::NumpyFile::current_frame {}</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="a1b3f50636674e919e54b7d61e11ed03a" name="a1b3f50636674e919e54b7d61e11ed03a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1b3f50636674e919e54b7d61e11ed03a">◆ </a></span>fp</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">FILE* aare::NumpyFile::fp = nullptr</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="aff59772a6f221edd2606e483ef4ed8ee" name="aff59772a6f221edd2606e483ef4ed8ee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aff59772a6f221edd2606e483ef4ed8ee">◆ </a></span>header_len</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t aare::NumpyFile::header_len {}</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="a50d19cf61c165c609c1b707abbe13cbd" name="a50d19cf61c165c609c1b707abbe13cbd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a50d19cf61c165c609c1b707abbe13cbd">◆ </a></span>header_len_size</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t aare::NumpyFile::header_len_size {}</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="a5aed02e400e44d7fbc5356365f421c5b" name="a5aed02e400e44d7fbc5356365f421c5b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5aed02e400e44d7fbc5356365f421c5b">◆ </a></span>header_size</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::NumpyFile::header_size {}</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="a85400183bf0f1fdc43fd9a37e3f10a2d" name="a85400183bf0f1fdc43fd9a37e3f10a2d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a85400183bf0f1fdc43fd9a37e3f10a2d">◆ </a></span>initial_header_len</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::NumpyFile::initial_header_len = 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="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="aa2d11ec505dc7c3b4918e194d24d00fe" name="aa2d11ec505dc7c3b4918e194d24d00fe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa2d11ec505dc7c3b4918e194d24d00fe">◆ </a></span>m_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_1NumpyHeader.html">NumpyHeader</a> aare::NumpyFile::m_header</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="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="a58feea4735fdf9599d810427785266ea" name="a58feea4735fdf9599d810427785266ea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a58feea4735fdf9599d810427785266ea">◆ </a></span>major_ver_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t aare::NumpyFile::major_ver_ {}</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="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="a2ca45b371f1c56e6b74eaca1852c5ffc" name="a2ca45b371f1c56e6b74eaca1852c5ffc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2ca45b371f1c56e6b74eaca1852c5ffc">◆ </a></span>minor_ver_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t aare::NumpyFile::minor_ver_ {}</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="NumpyFile_8hpp_source.html">NumpyFile.hpp</a></li>
|
|
<li>file_io/src/<a class="el" href="NumpyFile_8cpp.html">NumpyFile.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>
|