aare/docs/html/namespaceexample_1_1read__frame.html
2024-04-11 17:20:34 +02:00

174 lines
8.4 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: example.read_frame Namespace 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&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="namespaceexample.html">example</a></li><li class="navelem"><a class="el" href="namespaceexample_1_1read__frame.html">read_frame</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">example.read_frame Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a8973a6647a4a2ab3b53ae99a3e4a04a1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceexample_1_1read__frame.html#a8973a6647a4a2ab3b53ae99a3e4a04a1">root_dir</a> = Path(os.environ.get(&quot;PROJECT_ROOT_DIR&quot;))</td></tr>
<tr class="separator:a8973a6647a4a2ab3b53ae99a3e4a04a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bce68ed688f80f4b228bdc62e6226f9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceexample_1_1read__frame.html#a9bce68ed688f80f4b228bdc62e6226f9">data_path</a> = str(<a class="el" href="namespaceexample_1_1read__frame.html#a8973a6647a4a2ab3b53ae99a3e4a04a1">root_dir</a> / &quot;data&quot;/&quot;jungfrau_single_master_0.json&quot;)</td></tr>
<tr class="separator:a9bce68ed688f80f4b228bdc62e6226f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f98c9ddad647341ac99a60d74cfbb25"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceexample_1_1read__frame.html#a3f98c9ddad647341ac99a60d74cfbb25">file</a> = <a class="el" href="classaare_1_1File.html">File</a>(<a class="el" href="namespaceexample_1_1read__frame.html#a9bce68ed688f80f4b228bdc62e6226f9">data_path</a>)</td></tr>
<tr class="separator:a3f98c9ddad647341ac99a60d74cfbb25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5947c2ddaf00c3f301023e3a10d3208a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceexample_1_1read__frame.html#a5947c2ddaf00c3f301023e3a10d3208a">frame</a> = file.get_frame(0)</td></tr>
<tr class="separator:a5947c2ddaf00c3f301023e3a10d3208a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98eef01b3d0e577a5c9acc445055e07f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceexample_1_1read__frame.html#a98eef01b3d0e577a5c9acc445055e07f">arr</a> = np.array(frame.get_array())</td></tr>
<tr class="separator:a98eef01b3d0e577a5c9acc445055e07f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a98eef01b3d0e577a5c9acc445055e07f" name="a98eef01b3d0e577a5c9acc445055e07f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98eef01b3d0e577a5c9acc445055e07f">&#9670;&#160;</a></span>arr</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">example.read_frame.arr = np.array(frame.get_array())</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a9bce68ed688f80f4b228bdc62e6226f9" name="a9bce68ed688f80f4b228bdc62e6226f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bce68ed688f80f4b228bdc62e6226f9">&#9670;&#160;</a></span>data_path</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">example.read_frame.data_path = str(<a class="el" href="namespaceexample_1_1read__frame.html#a8973a6647a4a2ab3b53ae99a3e4a04a1">root_dir</a> / &quot;data&quot;/&quot;jungfrau_single_master_0.json&quot;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3f98c9ddad647341ac99a60d74cfbb25" name="a3f98c9ddad647341ac99a60d74cfbb25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f98c9ddad647341ac99a60d74cfbb25">&#9670;&#160;</a></span>file</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">example.read_frame.file = <a class="el" href="classaare_1_1File.html">File</a>(<a class="el" href="namespaceexample_1_1read__frame.html#a9bce68ed688f80f4b228bdc62e6226f9">data_path</a>)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5947c2ddaf00c3f301023e3a10d3208a" name="a5947c2ddaf00c3f301023e3a10d3208a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5947c2ddaf00c3f301023e3a10d3208a">&#9670;&#160;</a></span>frame</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">example.read_frame.frame = file.get_frame(0)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8973a6647a4a2ab3b53ae99a3e4a04a1" name="a8973a6647a4a2ab3b53ae99a3e4a04a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8973a6647a4a2ab3b53ae99a3e4a04a1">&#9670;&#160;</a></span>root_dir</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">example.read_frame.root_dir = Path(os.environ.get(&quot;PROJECT_ROOT_DIR&quot;))</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</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>