detectors/aare
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/aare.git synced 2025-06-08 21:40:43 +02:00
Code Issues Actions Packages Releases Activity
aare/docs/html/NumpyFile_8hpp_source.html
Bechir Braham 2ebbd0d7cd
setup doxygen and clang-uml files
2024-04-11 17:20:34 +02:00

192 lines
35 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AARE: file_io/include/aare/file_io/NumpyFile.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">AARE
</div>
<div id="projectbrief">Data analysis library for PSI hybrid detectors</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_0ce636e8c1612c01b4adc36e9f99479e.html">file_io</a></li><li class="navelem"><a class="el" href="dir_2733b21e9cf715002e4461cf940612ab.html">include</a></li><li class="navelem"><a class="el" href="dir_56c484f2481f20c268fc1a2a400ac49c.html">aare</a></li><li class="navelem"><a class="el" href="dir_a6e413f7e41fd82cd7ee315cdd32e0e9.html">file_io</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">NumpyFile.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="NumpyFile_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &quot;<a class="code" href="DType_8hpp.html">aare/core/DType.hpp</a>&quot;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &quot;<a class="code" href="core_2include_2aare_2core_2defs_8hpp.html">aare/core/defs.hpp</a>&quot;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &quot;<a class="code" href="FileInterface_8hpp.html">aare/file_io/FileInterface.hpp</a>&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &quot;<a class="code" href="NumpyHelpers_8hpp.html">aare/file_io/NumpyHelpers.hpp</a>&quot;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;filesystem&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;iostream&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;numeric&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceaare.html">aare</a> {</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html"> 18</a></span><span class="keyword">class </span><a class="code hl_class" href="classaare_1_1NumpyFile.html">NumpyFile</a> : <span class="keyword">public</span> <a class="code hl_class" href="classaare_1_1FileInterface.html">FileInterface</a> {</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <a class="code hl_class" href="classaare_1_1NumpyFile.html">NumpyFile</a>(<span class="keyword">const</span> std::filesystem::path &amp;fname, <span class="keyword">const</span> std::string &amp;mode = <span class="stringliteral">&quot;r&quot;</span>, <a class="code hl_struct" href="structaare_1_1FileConfig.html">FileConfig</a> cfg = {});</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classaare_1_1NumpyFile.html#a12b0ddf6334dfab4ac0993cd9c45f738">write</a>(<a class="code hl_class" href="classaare_1_1Frame.html">Frame</a> &amp;frame) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#a81e1a331ece6681bbfe9437e049d3b3a"> 30</a></span> <a class="code hl_class" href="classaare_1_1Frame.html">Frame</a> <a class="code hl_function" href="classaare_1_1NumpyFile.html#a81e1a331ece6681bbfe9437e049d3b3a">read</a>()<span class="keyword"> override </span>{ <span class="keywordflow">return</span> <a class="code hl_function" href="classaare_1_1NumpyFile.html#ac0e88af0f3793ef18302db5c503bd3d7">get_frame</a>(this-&gt;<a class="code hl_variable" href="classaare_1_1NumpyFile.html#a080973acac90ab8e6d0552b282e2d73c">current_frame</a>++); }</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> std::vector&lt;Frame&gt; <a class="code hl_function" href="classaare_1_1NumpyFile.html#a81e1a331ece6681bbfe9437e049d3b3a">read</a>(<span class="keywordtype">size_t</span> n_frames) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#a8b25fc8fa2e0ab9e38b0388504d60962"> 33</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classaare_1_1NumpyFile.html#a8b25fc8fa2e0ab9e38b0388504d60962">read_into</a>(std::byte *image_buf)<span class="keyword"> override </span>{ <span class="keywordflow">return</span> <a class="code hl_function" href="classaare_1_1NumpyFile.html#add05576e7b9256474c104553f0856c80">get_frame_into</a>(this-&gt;<a class="code hl_variable" href="classaare_1_1NumpyFile.html#a080973acac90ab8e6d0552b282e2d73c">current_frame</a>++, image_buf); }</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classaare_1_1NumpyFile.html#a8b25fc8fa2e0ab9e38b0388504d60962">read_into</a>(std::byte *image_buf, <span class="keywordtype">size_t</span> n_frames) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#abe5817c47fa552b7d6de72a4b59d290a"> 35</a></span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classaare_1_1NumpyFile.html#abe5817c47fa552b7d6de72a4b59d290a">frame_number</a>(<span class="keywordtype">size_t</span> frame_index)<span class="keyword"> override </span>{ <span class="keywordflow">return</span> frame_index; };</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classaare_1_1NumpyFile.html#a35c1b49a469ba8e261d4e675a816b5f2">bytes_per_frame</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classaare_1_1NumpyFile.html#a2a40aebcb9b25ad36f1ecd75699c47d0">pixels</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#ae4f669f86fb614e446540638d8efe1b8"> 38</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classaare_1_1NumpyFile.html#ae4f669f86fb614e446540638d8efe1b8">seek</a>(<span class="keywordtype">size_t</span> <a class="code hl_function" href="classaare_1_1NumpyFile.html#abe5817c47fa552b7d6de72a4b59d290a">frame_number</a>)<span class="keyword"> override </span>{ this-&gt;<a class="code hl_variable" href="classaare_1_1NumpyFile.html#a080973acac90ab8e6d0552b282e2d73c">current_frame</a> = <a class="code hl_function" href="classaare_1_1NumpyFile.html#abe5817c47fa552b7d6de72a4b59d290a">frame_number</a>; }</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#a022af0b9d792abb00a9dc661beb3e9a2"> 39</a></span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classaare_1_1NumpyFile.html#a022af0b9d792abb00a9dc661beb3e9a2">tell</a>()<span class="keyword"> override </span>{ <span class="keywordflow">return</span> this-&gt;<a class="code hl_variable" href="classaare_1_1NumpyFile.html#a080973acac90ab8e6d0552b282e2d73c">current_frame</a>; }</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#afec228003225dcc91b16227d24c58d37"> 40</a></span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classaare_1_1NumpyFile.html#afec228003225dcc91b16227d24c58d37">total_frames</a>()<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classaare_1_1NumpyFile.html#aa2d11ec505dc7c3b4918e194d24d00fe">m_header</a>.<a class="code hl_variable" href="structaare_1_1NumpyHeader.html#a9715508b7135198e1dd6d705ea189b99">shape</a>[0]; }</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#a24c0cad439c52b77886c862b8093b91a"> 41</a></span> ssize_t <a class="code hl_function" href="classaare_1_1NumpyFile.html#a24c0cad439c52b77886c862b8093b91a">rows</a>()<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classaare_1_1NumpyFile.html#aa2d11ec505dc7c3b4918e194d24d00fe">m_header</a>.<a class="code hl_variable" href="structaare_1_1NumpyHeader.html#a9715508b7135198e1dd6d705ea189b99">shape</a>[1]; }</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#ae1558b1ab6fbea54f853cdfad9363d31"> 42</a></span> ssize_t <a class="code hl_function" href="classaare_1_1NumpyFile.html#ae1558b1ab6fbea54f853cdfad9363d31">cols</a>()<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classaare_1_1NumpyFile.html#aa2d11ec505dc7c3b4918e194d24d00fe">m_header</a>.<a class="code hl_variable" href="structaare_1_1NumpyHeader.html#a9715508b7135198e1dd6d705ea189b99">shape</a>[2]; }</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#afcdc40fcc15f5a3a470e23033ad1323c"> 43</a></span> ssize_t <a class="code hl_function" href="classaare_1_1NumpyFile.html#afcdc40fcc15f5a3a470e23033ad1323c">bitdepth</a>()<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classaare_1_1NumpyFile.html#aa2d11ec505dc7c3b4918e194d24d00fe">m_header</a>.<a class="code hl_variable" href="structaare_1_1NumpyHeader.html#a686bc8e00746ae1ea90c1cc64e1553b6">dtype</a>.<a class="code hl_function" href="classaare_1_1DType.html#ab097410b8d43b58061b1d64682ff8ac4">bitdepth</a>(); }</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#ae0f029f5e1c09875533962a9ee957a98"> 49</a></span> <a class="code hl_class" href="classaare_1_1DType.html">DType</a> <a class="code hl_function" href="classaare_1_1NumpyFile.html#ae0f029f5e1c09875533962a9ee957a98">dtype</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classaare_1_1NumpyFile.html#aa2d11ec505dc7c3b4918e194d24d00fe">m_header</a>.<a class="code hl_variable" href="structaare_1_1NumpyHeader.html#a686bc8e00746ae1ea90c1cc64e1553b6">dtype</a>; }</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#a060d3bc922d3a759aabb3716e9c97791"> 55</a></span> std::vector&lt;size_t&gt; <a class="code hl_function" href="classaare_1_1NumpyFile.html#a060d3bc922d3a759aabb3716e9c97791">shape</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classaare_1_1NumpyFile.html#aa2d11ec505dc7c3b4918e194d24d00fe">m_header</a>.<a class="code hl_variable" href="structaare_1_1NumpyHeader.html#a9715508b7135198e1dd6d705ea189b99">shape</a>; }</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#ab16bb0e1a3c4d17b137c9c8708b9031c"> 63</a></span> <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, <span class="keywordtype">size_t</span> NDim&gt; <a class="code hl_class" href="classaare_1_1NDArray.html">NDArray&lt;T, NDim&gt;</a> <a class="code hl_function" href="classaare_1_1NumpyFile.html#ab16bb0e1a3c4d17b137c9c8708b9031c">load</a>() {</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <a class="code hl_class" href="classaare_1_1NDArray.html">NDArray&lt;T, NDim&gt;</a> arr(make_shape&lt;NDim&gt;(<a class="code hl_variable" href="classaare_1_1NumpyFile.html#aa2d11ec505dc7c3b4918e194d24d00fe">m_header</a>.<a class="code hl_variable" href="structaare_1_1NumpyHeader.html#a9715508b7135198e1dd6d705ea189b99">shape</a>));</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> fseek(<a class="code hl_variable" href="classaare_1_1NumpyFile.html#a1b3f50636674e919e54b7d61e11ed03a">fp</a>, <a class="code hl_variable" href="classaare_1_1NumpyFile.html#a5aed02e400e44d7fbc5356365f421c5b">header_size</a>, SEEK_SET);</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> fread(arr.data(), <span class="keyword">sizeof</span>(T), arr.size(), <a class="code hl_variable" href="classaare_1_1NumpyFile.html#a1b3f50636674e919e54b7d61e11ed03a">fp</a>);</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keywordflow">return</span> arr;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> }</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <a class="code hl_function" href="classaare_1_1NumpyFile.html#af8d6ace67f7880e6b2cd12da568fbead">~NumpyFile</a>();</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#a1b3f50636674e919e54b7d61e11ed03a"> 73</a></span> FILE *<a class="code hl_variable" href="classaare_1_1NumpyFile.html#a1b3f50636674e919e54b7d61e11ed03a">fp</a> = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#a85400183bf0f1fdc43fd9a37e3f10a2d"> 74</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classaare_1_1NumpyFile.html#a85400183bf0f1fdc43fd9a37e3f10a2d">initial_header_len</a> = 0;</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#a080973acac90ab8e6d0552b282e2d73c"> 75</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classaare_1_1NumpyFile.html#a080973acac90ab8e6d0552b282e2d73c">current_frame</a>{};</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#aff59772a6f221edd2606e483ef4ed8ee"> 76</a></span> uint32_t <a class="code hl_variable" href="classaare_1_1NumpyFile.html#aff59772a6f221edd2606e483ef4ed8ee">header_len</a>{};</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#a50d19cf61c165c609c1b707abbe13cbd"> 77</a></span> uint8_t <a class="code hl_variable" href="classaare_1_1NumpyFile.html#a50d19cf61c165c609c1b707abbe13cbd">header_len_size</a>{};</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#a5aed02e400e44d7fbc5356365f421c5b"> 78</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classaare_1_1NumpyFile.html#a5aed02e400e44d7fbc5356365f421c5b">header_size</a>{};</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#aa2d11ec505dc7c3b4918e194d24d00fe"> 79</a></span> <a class="code hl_struct" href="structaare_1_1NumpyHeader.html">NumpyHeader</a> <a class="code hl_variable" href="classaare_1_1NumpyFile.html#aa2d11ec505dc7c3b4918e194d24d00fe">m_header</a>;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#a58feea4735fdf9599d810427785266ea"> 80</a></span> uint8_t <a class="code hl_variable" href="classaare_1_1NumpyFile.html#a58feea4735fdf9599d810427785266ea">major_ver_</a>{};</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classaare_1_1NumpyFile.html#a2ca45b371f1c56e6b74eaca1852c5ffc"> 81</a></span> uint8_t <a class="code hl_variable" href="classaare_1_1NumpyFile.html#a2ca45b371f1c56e6b74eaca1852c5ffc">minor_ver_</a>{};</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classaare_1_1NumpyFile.html#a1c4bfd5eefa5ac19ecf2aa96c0dbdae3">load_metadata</a>();</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classaare_1_1NumpyFile.html#add05576e7b9256474c104553f0856c80">get_frame_into</a>(<span class="keywordtype">size_t</span>, std::byte *);</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <a class="code hl_class" href="classaare_1_1Frame.html">Frame</a> <a class="code hl_function" href="classaare_1_1NumpyFile.html#ac0e88af0f3793ef18302db5c503bd3d7">get_frame</a>(<span class="keywordtype">size_t</span> <a class="code hl_function" href="classaare_1_1NumpyFile.html#abe5817c47fa552b7d6de72a4b59d290a">frame_number</a>);</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span>};</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span>} <span class="comment">// namespace aare</span></div>
<div class="ttc" id="aDType_8hpp_html"><div class="ttname"><a href="DType_8hpp.html">DType.hpp</a></div></div>
<div class="ttc" id="aFileInterface_8hpp_html"><div class="ttname"><a href="FileInterface_8hpp.html">FileInterface.hpp</a></div></div>
<div class="ttc" id="aNumpyHelpers_8hpp_html"><div class="ttname"><a href="NumpyHelpers_8hpp.html">NumpyHelpers.hpp</a></div></div>
<div class="ttc" id="aclassaare_1_1DType_html"><div class="ttname"><a href="classaare_1_1DType.html">aare::DType</a></div><div class="ttdef"><b>Definition</b> DType.hpp:20</div></div>
<div class="ttc" id="aclassaare_1_1DType_html_ab097410b8d43b58061b1d64682ff8ac4"><div class="ttname"><a href="classaare_1_1DType.html#ab097410b8d43b58061b1d64682ff8ac4">aare::DType::bitdepth</a></div><div class="ttdeci">uint8_t bitdepth() const</div><div class="ttdef"><b>Definition</b> DType.cpp:36</div></div>
<div class="ttc" id="aclassaare_1_1FileInterface_html"><div class="ttname"><a href="classaare_1_1FileInterface.html">aare::FileInterface</a></div><div class="ttdoc">FileInterface class to define the interface for file operations.</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:33</div></div>
<div class="ttc" id="aclassaare_1_1Frame_html"><div class="ttname"><a href="classaare_1_1Frame.html">aare::Frame</a></div><div class="ttdef"><b>Definition</b> Frame.hpp:18</div></div>
<div class="ttc" id="aclassaare_1_1NDArray_html"><div class="ttname"><a href="classaare_1_1NDArray.html">aare::NDArray</a></div><div class="ttdef"><b>Definition</b> NDArray.hpp:23</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html"><div class="ttname"><a href="classaare_1_1NumpyFile.html">aare::NumpyFile</a></div><div class="ttdoc">NumpyFile class to read and write numpy files.</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:18</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_a022af0b9d792abb00a9dc661beb3e9a2"><div class="ttname"><a href="classaare_1_1NumpyFile.html#a022af0b9d792abb00a9dc661beb3e9a2">aare::NumpyFile::tell</a></div><div class="ttdeci">size_t tell() override</div><div class="ttdoc">get the current position of the file pointer</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:39</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_a060d3bc922d3a759aabb3716e9c97791"><div class="ttname"><a href="classaare_1_1NumpyFile.html#a060d3bc922d3a759aabb3716e9c97791">aare::NumpyFile::shape</a></div><div class="ttdeci">std::vector&lt; size_t &gt; shape() const</div><div class="ttdoc">get the shape of the numpy file</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:55</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_a080973acac90ab8e6d0552b282e2d73c"><div class="ttname"><a href="classaare_1_1NumpyFile.html#a080973acac90ab8e6d0552b282e2d73c">aare::NumpyFile::current_frame</a></div><div class="ttdeci">size_t current_frame</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:75</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_a12b0ddf6334dfab4ac0993cd9c45f738"><div class="ttname"><a href="classaare_1_1NumpyFile.html#a12b0ddf6334dfab4ac0993cd9c45f738">aare::NumpyFile::write</a></div><div class="ttdeci">void write(Frame &amp;frame) override</div><div class="ttdoc">write a frame to the file</div><div class="ttdef"><b>Definition</b> NumpyFile.cpp:31</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_a1b3f50636674e919e54b7d61e11ed03a"><div class="ttname"><a href="classaare_1_1NumpyFile.html#a1b3f50636674e919e54b7d61e11ed03a">aare::NumpyFile::fp</a></div><div class="ttdeci">FILE * fp</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:73</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_a1c4bfd5eefa5ac19ecf2aa96c0dbdae3"><div class="ttname"><a href="classaare_1_1NumpyFile.html#a1c4bfd5eefa5ac19ecf2aa96c0dbdae3">aare::NumpyFile::load_metadata</a></div><div class="ttdeci">void load_metadata()</div><div class="ttdef"><b>Definition</b> NumpyFile.cpp:103</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_a24c0cad439c52b77886c862b8093b91a"><div class="ttname"><a href="classaare_1_1NumpyFile.html#a24c0cad439c52b77886c862b8093b91a">aare::NumpyFile::rows</a></div><div class="ttdeci">ssize_t rows() const override</div><div class="ttdoc">get the number of rows in the file</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:41</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_a2a40aebcb9b25ad36f1ecd75699c47d0"><div class="ttname"><a href="classaare_1_1NumpyFile.html#a2a40aebcb9b25ad36f1ecd75699c47d0">aare::NumpyFile::pixels</a></div><div class="ttdeci">size_t pixels() override</div><div class="ttdoc">get the number of pixels in one frame</div><div class="ttdef"><b>Definition</b> NumpyFile.cpp:58</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_a2ca45b371f1c56e6b74eaca1852c5ffc"><div class="ttname"><a href="classaare_1_1NumpyFile.html#a2ca45b371f1c56e6b74eaca1852c5ffc">aare::NumpyFile::minor_ver_</a></div><div class="ttdeci">uint8_t minor_ver_</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:81</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_a35c1b49a469ba8e261d4e675a816b5f2"><div class="ttname"><a href="classaare_1_1NumpyFile.html#a35c1b49a469ba8e261d4e675a816b5f2">aare::NumpyFile::bytes_per_frame</a></div><div class="ttdeci">size_t bytes_per_frame() override</div><div class="ttdoc">get the size of one frame in bytes</div><div class="ttdef"><b>Definition</b> NumpyFile.cpp:61</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_a50d19cf61c165c609c1b707abbe13cbd"><div class="ttname"><a href="classaare_1_1NumpyFile.html#a50d19cf61c165c609c1b707abbe13cbd">aare::NumpyFile::header_len_size</a></div><div class="ttdeci">uint8_t header_len_size</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:77</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_a58feea4735fdf9599d810427785266ea"><div class="ttname"><a href="classaare_1_1NumpyFile.html#a58feea4735fdf9599d810427785266ea">aare::NumpyFile::major_ver_</a></div><div class="ttdeci">uint8_t major_ver_</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:80</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_a5aed02e400e44d7fbc5356365f421c5b"><div class="ttname"><a href="classaare_1_1NumpyFile.html#a5aed02e400e44d7fbc5356365f421c5b">aare::NumpyFile::header_size</a></div><div class="ttdeci">size_t header_size</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:78</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_a81e1a331ece6681bbfe9437e049d3b3a"><div class="ttname"><a href="classaare_1_1NumpyFile.html#a81e1a331ece6681bbfe9437e049d3b3a">aare::NumpyFile::read</a></div><div class="ttdeci">Frame read() override</div><div class="ttdoc">write a vector of frames to the file</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:30</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_a85400183bf0f1fdc43fd9a37e3f10a2d"><div class="ttname"><a href="classaare_1_1NumpyFile.html#a85400183bf0f1fdc43fd9a37e3f10a2d">aare::NumpyFile::initial_header_len</a></div><div class="ttdeci">size_t initial_header_len</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:74</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_a8b25fc8fa2e0ab9e38b0388504d60962"><div class="ttname"><a href="classaare_1_1NumpyFile.html#a8b25fc8fa2e0ab9e38b0388504d60962">aare::NumpyFile::read_into</a></div><div class="ttdeci">void read_into(std::byte *image_buf) override</div><div class="ttdoc">read one frame from the file at the current position and store it in the provided buffer</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:33</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_aa2d11ec505dc7c3b4918e194d24d00fe"><div class="ttname"><a href="classaare_1_1NumpyFile.html#aa2d11ec505dc7c3b4918e194d24d00fe">aare::NumpyFile::m_header</a></div><div class="ttdeci">NumpyHeader m_header</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:79</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_ab16bb0e1a3c4d17b137c9c8708b9031c"><div class="ttname"><a href="classaare_1_1NumpyFile.html#ab16bb0e1a3c4d17b137c9c8708b9031c">aare::NumpyFile::load</a></div><div class="ttdeci">NDArray&lt; T, NDim &gt; load()</div><div class="ttdoc">load the numpy file into an NDArray</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:63</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_abe5817c47fa552b7d6de72a4b59d290a"><div class="ttname"><a href="classaare_1_1NumpyFile.html#abe5817c47fa552b7d6de72a4b59d290a">aare::NumpyFile::frame_number</a></div><div class="ttdeci">size_t frame_number(size_t frame_index) override</div><div class="ttdoc">get the frame number at the given frame index</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:35</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_ac0e88af0f3793ef18302db5c503bd3d7"><div class="ttname"><a href="classaare_1_1NumpyFile.html#ac0e88af0f3793ef18302db5c503bd3d7">aare::NumpyFile::get_frame</a></div><div class="ttdeci">Frame get_frame(size_t frame_number)</div><div class="ttdef"><b>Definition</b> NumpyFile.cpp:42</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_add05576e7b9256474c104553f0856c80"><div class="ttname"><a href="classaare_1_1NumpyFile.html#add05576e7b9256474c104553f0856c80">aare::NumpyFile::get_frame_into</a></div><div class="ttdeci">void get_frame_into(size_t, std::byte *)</div><div class="ttdef"><b>Definition</b> NumpyFile.cpp:47</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_ae0f029f5e1c09875533962a9ee957a98"><div class="ttname"><a href="classaare_1_1NumpyFile.html#ae0f029f5e1c09875533962a9ee957a98">aare::NumpyFile::dtype</a></div><div class="ttdeci">DType dtype() const</div><div class="ttdoc">get the data type of the numpy file</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:49</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_ae1558b1ab6fbea54f853cdfad9363d31"><div class="ttname"><a href="classaare_1_1NumpyFile.html#ae1558b1ab6fbea54f853cdfad9363d31">aare::NumpyFile::cols</a></div><div class="ttdeci">ssize_t cols() const override</div><div class="ttdoc">get the number of columns in the file</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:42</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_ae4f669f86fb614e446540638d8efe1b8"><div class="ttname"><a href="classaare_1_1NumpyFile.html#ae4f669f86fb614e446540638d8efe1b8">aare::NumpyFile::seek</a></div><div class="ttdeci">void seek(size_t frame_number) override</div><div class="ttdoc">seek to the given frame number</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:38</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_af8d6ace67f7880e6b2cd12da568fbead"><div class="ttname"><a href="classaare_1_1NumpyFile.html#af8d6ace67f7880e6b2cd12da568fbead">aare::NumpyFile::~NumpyFile</a></div><div class="ttdeci">~NumpyFile()</div><div class="ttdef"><b>Definition</b> NumpyFile.cpp:80</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_afcdc40fcc15f5a3a470e23033ad1323c"><div class="ttname"><a href="classaare_1_1NumpyFile.html#afcdc40fcc15f5a3a470e23033ad1323c">aare::NumpyFile::bitdepth</a></div><div class="ttdeci">ssize_t bitdepth() const override</div><div class="ttdoc">get the bitdepth of the file</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:43</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_afec228003225dcc91b16227d24c58d37"><div class="ttname"><a href="classaare_1_1NumpyFile.html#afec228003225dcc91b16227d24c58d37">aare::NumpyFile::total_frames</a></div><div class="ttdeci">size_t total_frames() const override</div><div class="ttdoc">get the total number of frames in the file</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:40</div></div>
<div class="ttc" id="aclassaare_1_1NumpyFile_html_aff59772a6f221edd2606e483ef4ed8ee"><div class="ttname"><a href="classaare_1_1NumpyFile.html#aff59772a6f221edd2606e483ef4ed8ee">aare::NumpyFile::header_len</a></div><div class="ttdeci">uint32_t header_len</div><div class="ttdef"><b>Definition</b> NumpyFile.hpp:76</div></div>
<div class="ttc" id="acore_2include_2aare_2core_2defs_8hpp_html"><div class="ttname"><a href="core_2include_2aare_2core_2defs_8hpp.html">defs.hpp</a></div></div>
<div class="ttc" id="anamespaceaare_html"><div class="ttname"><a href="namespaceaare.html">aare</a></div><div class="ttdoc">Frame class to represent a single frame of data model class should be able to work with streams comin...</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:11</div></div>
<div class="ttc" id="astructaare_1_1FileConfig_html"><div class="ttname"><a href="structaare_1_1FileConfig.html">aare::FileConfig</a></div><div class="ttdoc">FileConfig structure to store the configuration of a file dtype: data type of the file rows: number o...</div><div class="ttdef"><b>Definition</b> FileInterface.hpp:17</div></div>
<div class="ttc" id="astructaare_1_1NumpyHeader_html"><div class="ttname"><a href="structaare_1_1NumpyHeader.html">aare::NumpyHeader</a></div><div class="ttdef"><b>Definition</b> NumpyHelpers.hpp:21</div></div>
<div class="ttc" id="astructaare_1_1NumpyHeader_html_a686bc8e00746ae1ea90c1cc64e1553b6"><div class="ttname"><a href="structaare_1_1NumpyHeader.html#a686bc8e00746ae1ea90c1cc64e1553b6">aare::NumpyHeader::dtype</a></div><div class="ttdeci">DType dtype</div><div class="ttdef"><b>Definition</b> NumpyHelpers.hpp:22</div></div>
<div class="ttc" id="astructaare_1_1NumpyHeader_html_a9715508b7135198e1dd6d705ea189b99"><div class="ttname"><a href="structaare_1_1NumpyHeader.html#a9715508b7135198e1dd6d705ea189b99">aare::NumpyHeader::shape</a></div><div class="ttdeci">shape_t shape</div><div class="ttdef"><b>Definition</b> NumpyHelpers.hpp:24</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>
View Git Blame Copy Permalink