matthias muntwiler
fda49c3195
- new data reduction interface for more efficient multi-peak fitting. the new interface breaks compatibility with pre-2.0 data reduction functions. user-defined functions must be adapted to the new interface. - new angle scan processing panel for interactive data analysis.
2175 lines
123 KiB
HTML
2175 lines
123 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
|
<title>PEARL Procedures: pearl-pshell-import.ipf File 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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">PEARL Procedures
|
|
 <span id="projectnumber">rev-distro-1.6.1-0-ge1f1aa9-dirty</span>
|
|
</div>
|
|
<div id="projectbrief">Igor procedures for the analysis of PEARL data</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Packages</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('pearl-pshell-import_8ipf.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">pearl-pshell-import.ipf File Reference<div class="ingroups"><a class="el" href="group___arpes_package.html">ARPES package</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>import data from PShell
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <HDF5 Browser></code><br />
|
|
<code>#include "pearl-gui-tools"</code><br />
|
|
<code>#include "pearl-area-import"</code><br />
|
|
</div>
|
|
<p><a href="pearl-pshell-import_8ipf_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:namespace_pearl_p_shell_import"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_pearl_p_shell_import.html">PearlPShellImport</a></td></tr>
|
|
<tr class="memdesc:namespace_pearl_p_shell_import"><td class="mdescLeft"> </td><td class="mdescRight">import data from PShell <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:accc20b0fc6bda95ba0cd0aea6633086f"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f">psh5_open_file</a> (string ANickName, string APathName, string AFileName)</td></tr>
|
|
<tr class="memdesc:accc20b0fc6bda95ba0cd0aea6633086f"><td class="mdescLeft"> </td><td class="mdescRight">open a HDF5 file created by the PShell data acquisition program and prepare the data folder. <a href="#accc20b0fc6bda95ba0cd0aea6633086f">More...</a><br /></td></tr>
|
|
<tr class="separator:accc20b0fc6bda95ba0cd0aea6633086f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2fc497747287d6fe40c6de997ed4a90d"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a2fc497747287d6fe40c6de997ed4a90d">psh5_close_file</a> (variable fileID)</td></tr>
|
|
<tr class="memdesc:a2fc497747287d6fe40c6de997ed4a90d"><td class="mdescLeft"> </td><td class="mdescRight">close a HDF5 file opened by psh5_open_file. <a href="#a2fc497747287d6fe40c6de997ed4a90d">More...</a><br /></td></tr>
|
|
<tr class="separator:a2fc497747287d6fe40c6de997ed4a90d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a5ce6c2767607de194b4c148ee98c27"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a8a5ce6c2767607de194b4c148ee98c27">psh5_load_complete</a> (string ANickName, string APathName, string AFileName, variable load_data=defaultValue, variable load_attr=defaultValue)</td></tr>
|
|
<tr class="memdesc:a8a5ce6c2767607de194b4c148ee98c27"><td class="mdescLeft"> </td><td class="mdescRight">load everything from a PShell data file. <a href="#a8a5ce6c2767607de194b4c148ee98c27">More...</a><br /></td></tr>
|
|
<tr class="separator:a8a5ce6c2767607de194b4c148ee98c27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1dc6c971120749b378014f1f63cb6668"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a1dc6c971120749b378014f1f63cb6668">psh5_load_preview</a> (string APathName, string AFileName, variable load_data=defaultValue, variable load_attr=defaultValue, string pref_scans=defaultValue, string pref_datasets=defaultValue)</td></tr>
|
|
<tr class="memdesc:a1dc6c971120749b378014f1f63cb6668"><td class="mdescLeft"> </td><td class="mdescRight">load a preview image from a PShell data file. <a href="#a1dc6c971120749b378014f1f63cb6668">More...</a><br /></td></tr>
|
|
<tr class="separator:a1dc6c971120749b378014f1f63cb6668"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0a02f87e19e825964aa17c46ed51df8c"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a0a02f87e19e825964aa17c46ed51df8c">psh5_load_scan_complete</a> (variable fileID, string scanpath, variable load_data=defaultValue, variable load_attr=defaultValue)</td></tr>
|
|
<tr class="memdesc:a0a02f87e19e825964aa17c46ed51df8c"><td class="mdescLeft"> </td><td class="mdescRight">load all data of a selected scan from a PShell data file. <a href="#a0a02f87e19e825964aa17c46ed51df8c">More...</a><br /></td></tr>
|
|
<tr class="separator:a0a02f87e19e825964aa17c46ed51df8c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2152f7c39a187b740cf9890767ffac3f"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a2152f7c39a187b740cf9890767ffac3f">psh5_list_scans</a> (variable fileID)</td></tr>
|
|
<tr class="memdesc:a2152f7c39a187b740cf9890767ffac3f"><td class="mdescLeft"> </td><td class="mdescRight">list scan groups of a PShell data file. <a href="#a2152f7c39a187b740cf9890767ffac3f">More...</a><br /></td></tr>
|
|
<tr class="separator:a2152f7c39a187b740cf9890767ffac3f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4508bd507c4c935bd8463d9b2b84c6fc"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a4508bd507c4c935bd8463d9b2b84c6fc">psh5_list_scan_datasets</a> (variable fileID, string scanpath, variable include_regions=defaultValue)</td></tr>
|
|
<tr class="memdesc:a4508bd507c4c935bd8463d9b2b84c6fc"><td class="mdescLeft"> </td><td class="mdescRight">list datasets of a PShell scan group. <a href="#a4508bd507c4c935bd8463d9b2b84c6fc">More...</a><br /></td></tr>
|
|
<tr class="separator:a4508bd507c4c935bd8463d9b2b84c6fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acb317b57ef137d4d5da5938013dbe442"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#acb317b57ef137d4d5da5938013dbe442">psh5_list_scan_regions</a> (variable fileID, string scanpath)</td></tr>
|
|
<tr class="memdesc:acb317b57ef137d4d5da5938013dbe442"><td class="mdescLeft"> </td><td class="mdescRight">list regions of a PShell scan group. <a href="#acb317b57ef137d4d5da5938013dbe442">More...</a><br /></td></tr>
|
|
<tr class="separator:acb317b57ef137d4d5da5938013dbe442"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad26b0b56d7ccd23547535091c9430569"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#ad26b0b56d7ccd23547535091c9430569">psh5_load_scan_data</a> (variable fileID, string scanpath)</td></tr>
|
|
<tr class="memdesc:ad26b0b56d7ccd23547535091c9430569"><td class="mdescLeft"> </td><td class="mdescRight">load all datasets of a PShell scan group. <a href="#ad26b0b56d7ccd23547535091c9430569">More...</a><br /></td></tr>
|
|
<tr class="separator:ad26b0b56d7ccd23547535091c9430569"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec191d0167bbf606d24396f4658104b5"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#aec191d0167bbf606d24396f4658104b5">psh5_load_scan_attrs</a> (variable fileID, string scanpath, variable attr_sets=defaultValue)</td></tr>
|
|
<tr class="memdesc:aec191d0167bbf606d24396f4658104b5"><td class="mdescLeft"> </td><td class="mdescRight">load attributes of a PShell scan group. <a href="#aec191d0167bbf606d24396f4658104b5">More...</a><br /></td></tr>
|
|
<tr class="separator:aec191d0167bbf606d24396f4658104b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa56c25d64b3e59f74d6dd92a599cce4f"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#aa56c25d64b3e59f74d6dd92a599cce4f">psh5_load_scan_meta</a> (variable fileID, string scanpath)</td></tr>
|
|
<tr class="memdesc:aa56c25d64b3e59f74d6dd92a599cce4f"><td class="mdescLeft"> </td><td class="mdescRight">load metadata of a PShell scan group. <a href="#aa56c25d64b3e59f74d6dd92a599cce4f">More...</a><br /></td></tr>
|
|
<tr class="separator:aa56c25d64b3e59f74d6dd92a599cce4f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac4dfb90b951d29b56501e904f5cc38aa"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#ac4dfb90b951d29b56501e904f5cc38aa">psh5_load_dataset</a> (variable fileID, string scanpath, string datasetname, variable set_scale=defaultValue)</td></tr>
|
|
<tr class="memdesc:ac4dfb90b951d29b56501e904f5cc38aa"><td class="mdescLeft"> </td><td class="mdescRight">load a dataset from an open PShell HDF5 file. <a href="#ac4dfb90b951d29b56501e904f5cc38aa">More...</a><br /></td></tr>
|
|
<tr class="separator:ac4dfb90b951d29b56501e904f5cc38aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb4afdef6ae4476c25a1ff77b17266c3"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#abb4afdef6ae4476c25a1ff77b17266c3">select_dataset</a> (string file_datasets, string pref_datasets)</td></tr>
|
|
<tr class="memdesc:abb4afdef6ae4476c25a1ff77b17266c3"><td class="mdescLeft"> </td><td class="mdescRight">select the preferred dataset from a list of available datasets. <a href="#abb4afdef6ae4476c25a1ff77b17266c3">More...</a><br /></td></tr>
|
|
<tr class="separator:abb4afdef6ae4476c25a1ff77b17266c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3b9354b137ba4f1bc3ed2e74f24dc88"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#ad3b9354b137ba4f1bc3ed2e74f24dc88">psh5_load_scan_preview</a> (variable fileID, string scanpath, variable set_scale=defaultValue, string pref_datasets=defaultValue)</td></tr>
|
|
<tr class="memdesc:ad3b9354b137ba4f1bc3ed2e74f24dc88"><td class="mdescLeft"> </td><td class="mdescRight">load a preview dataset from an open PShell HDF5 file. <a href="#ad3b9354b137ba4f1bc3ed2e74f24dc88">More...</a><br /></td></tr>
|
|
<tr class="separator:ad3b9354b137ba4f1bc3ed2e74f24dc88"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a83804ba9637debed6ef8b13e7b9b19e0"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a83804ba9637debed6ef8b13e7b9b19e0">psh5_load_scan_section</a> (variable fileID, string scanpath, variable dim, variable set_scale=defaultValue, string pref_datasets=defaultValue)</td></tr>
|
|
<tr class="memdesc:a83804ba9637debed6ef8b13e7b9b19e0"><td class="mdescLeft"> </td><td class="mdescRight">load a longitudinal section of a scan from an open PShell HDF5 file. <a href="#a83804ba9637debed6ef8b13e7b9b19e0">More...</a><br /></td></tr>
|
|
<tr class="separator:a83804ba9637debed6ef8b13e7b9b19e0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afde787a00a18dc8c63b100d8ac7d992f"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#afde787a00a18dc8c63b100d8ac7d992f">psh5_load_dataset_meta</a> (variable fileID, string datapath, string datasetname, wave datawave)</td></tr>
|
|
<tr class="memdesc:afde787a00a18dc8c63b100d8ac7d992f"><td class="mdescLeft"> </td><td class="mdescRight">load metadata of a PShell dataset. <a href="#afde787a00a18dc8c63b100d8ac7d992f">More...</a><br /></td></tr>
|
|
<tr class="separator:afde787a00a18dc8c63b100d8ac7d992f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2972587ec82cc2a261b8119a582b4215"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a2972587ec82cc2a261b8119a582b4215">psh5_load_dataset_slabs</a> (variable fileID, string datapath, string datasetname, variable progress=defaultValue)</td></tr>
|
|
<tr class="memdesc:a2972587ec82cc2a261b8119a582b4215"><td class="mdescLeft"> </td><td class="mdescRight">load a dataset slab-wise from the open PShell HDF5 file. <a href="#a2972587ec82cc2a261b8119a582b4215">More...</a><br /></td></tr>
|
|
<tr class="separator:a2972587ec82cc2a261b8119a582b4215"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a035a4df9f4508144149abdb0b46c87d1"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a035a4df9f4508144149abdb0b46c87d1">psh5_load_dataset_slab</a> (variable fileID, string datapath, string datasetname, variable dim2start, variable dim2count, variable dim3start, variable dim3count)</td></tr>
|
|
<tr class="memdesc:a035a4df9f4508144149abdb0b46c87d1"><td class="mdescLeft"> </td><td class="mdescRight">load a single image from the open PShell data file. <a href="#a035a4df9f4508144149abdb0b46c87d1">More...</a><br /></td></tr>
|
|
<tr class="separator:a035a4df9f4508144149abdb0b46c87d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba25eb98e4c6cc9066c46ef6be1cde15"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#aba25eb98e4c6cc9066c46ef6be1cde15">ps_set_dimlabels</a> (wave data)</td></tr>
|
|
<tr class="memdesc:aba25eb98e4c6cc9066c46ef6be1cde15"><td class="mdescLeft"> </td><td class="mdescRight">set dimension labels according to the axis type <a href="#aba25eb98e4c6cc9066c46ef6be1cde15">More...</a><br /></td></tr>
|
|
<tr class="separator:aba25eb98e4c6cc9066c46ef6be1cde15"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8704627410409bcd27a1adeda4082c47"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a8704627410409bcd27a1adeda4082c47">ps_set_dimlabels2</a> (wave data, string name)</td></tr>
|
|
<tr class="memdesc:a8704627410409bcd27a1adeda4082c47"><td class="mdescLeft"> </td><td class="mdescRight">set dimension labels according to the axis type <a href="#a8704627410409bcd27a1adeda4082c47">More...</a><br /></td></tr>
|
|
<tr class="separator:a8704627410409bcd27a1adeda4082c47"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a79b968d7439dfbfbc38c05f933071489"><td class="memItemLeft" align="right" valign="top">static dfr </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a79b968d7439dfbfbc38c05f933071489">find_scan_folder</a> (dfref dataDF)</td></tr>
|
|
<tr class="memdesc:a79b968d7439dfbfbc38c05f933071489"><td class="mdescLeft"> </td><td class="mdescRight">find the scan folder <a href="#a79b968d7439dfbfbc38c05f933071489">More...</a><br /></td></tr>
|
|
<tr class="separator:a79b968d7439dfbfbc38c05f933071489"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41bf534983b0662ec2609b136c395f14"><td class="memItemLeft" align="right" valign="top">static dfr </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a41bf534983b0662ec2609b136c395f14">find_attr_folder</a> (dfref dataDF)</td></tr>
|
|
<tr class="memdesc:a41bf534983b0662ec2609b136c395f14"><td class="mdescLeft"> </td><td class="mdescRight">find the attributes data folder <a href="#a41bf534983b0662ec2609b136c395f14">More...</a><br /></td></tr>
|
|
<tr class="separator:a41bf534983b0662ec2609b136c395f14"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af08a467036c64f70ca3dfe644fcc457c"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#af08a467036c64f70ca3dfe644fcc457c">ps_scale_datasets</a> ()</td></tr>
|
|
<tr class="memdesc:af08a467036c64f70ca3dfe644fcc457c"><td class="mdescLeft"> </td><td class="mdescRight">set the dimension scales of loaded PShell Scienta datasets according to attributes. <a href="#af08a467036c64f70ca3dfe644fcc457c">More...</a><br /></td></tr>
|
|
<tr class="separator:af08a467036c64f70ca3dfe644fcc457c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adc11ea797562b3d99c247f4866618d39"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#adc11ea797562b3d99c247f4866618d39">ps_scale_dataset</a> (wave data)</td></tr>
|
|
<tr class="memdesc:adc11ea797562b3d99c247f4866618d39"><td class="mdescLeft"> </td><td class="mdescRight">set the dimension scales of a loaded PShell Scienta dataset according to attributes. <a href="#adc11ea797562b3d99c247f4866618d39">More...</a><br /></td></tr>
|
|
<tr class="separator:adc11ea797562b3d99c247f4866618d39"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acfb01ee360b66f286225f6e9c7220ba2"><td class="memItemLeft" align="right" valign="top">static wave </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#acfb01ee360b66f286225f6e9c7220ba2">find_scale_wave</a> (string name, dfref dataDF, dfref scanDF, dfref attrDF)</td></tr>
|
|
<tr class="separator:acfb01ee360b66f286225f6e9c7220ba2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acba7f4b98f67cc112c02dfeefe3e5acd"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#acba7f4b98f67cc112c02dfeefe3e5acd">ps_detect_scale</a> (wave ax, wave lo, wave hi, wave un)</td></tr>
|
|
<tr class="memdesc:acba7f4b98f67cc112c02dfeefe3e5acd"><td class="mdescLeft"> </td><td class="mdescRight">detect the dimension scales from attributes. <a href="#acba7f4b98f67cc112c02dfeefe3e5acd">More...</a><br /></td></tr>
|
|
<tr class="separator:acba7f4b98f67cc112c02dfeefe3e5acd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c456397c36d4116bfddca452eff5954"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a2c456397c36d4116bfddca452eff5954">ps_scale_dataset_2</a> (wave data, wave ax, wave lo, wave hi, wave un)</td></tr>
|
|
<tr class="memdesc:a2c456397c36d4116bfddca452eff5954"><td class="mdescLeft"> </td><td class="mdescRight">set the dimension scales of a dataset. <a href="#a2c456397c36d4116bfddca452eff5954">More...</a><br /></td></tr>
|
|
<tr class="separator:a2c456397c36d4116bfddca452eff5954"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3eefc2f84a09f2ce29893c71ef44ae32"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a3eefc2f84a09f2ce29893c71ef44ae32">psh5_load_reduced</a> (string ANickName, string APathName, string AFileName, funcref reduction_func, string reduction_param, variable progress=defaultValue, variable nthreads=defaultValue)</td></tr>
|
|
<tr class="memdesc:a3eefc2f84a09f2ce29893c71ef44ae32"><td class="mdescLeft"> </td><td class="mdescRight">load and reduce the ScientaImage dataset of the first scan of a PShell data file. <a href="#a3eefc2f84a09f2ce29893c71ef44ae32">More...</a><br /></td></tr>
|
|
<tr class="separator:a3eefc2f84a09f2ce29893c71ef44ae32"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a13a45e8618c1ab7406e1aa5e608e21fe"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a13a45e8618c1ab7406e1aa5e608e21fe">psh5_load_dataset_reduced</a> (variable fileID, string scanpath, string datasetname, funcref reduction_func, string reduction_param, variable progress=defaultValue, variable nthreads=defaultValue)</td></tr>
|
|
<tr class="memdesc:a13a45e8618c1ab7406e1aa5e608e21fe"><td class="mdescLeft"> </td><td class="mdescRight">load a reduced dataset from the open PShell HDF5 file. <a href="#a13a45e8618c1ab7406e1aa5e608e21fe">More...</a><br /></td></tr>
|
|
<tr class="separator:a13a45e8618c1ab7406e1aa5e608e21fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a33f8faf117450af1d6dae9ef48786cd6"><td class="memItemLeft" align="right" valign="top">static threadsafe variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a33f8faf117450af1d6dae9ef48786cd6">reduce_slab_worker</a> (funcref reduction_func)</td></tr>
|
|
<tr class="separator:a33f8faf117450af1d6dae9ef48786cd6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a44d495fba0dd2b82dec13760a07fd226"><td class="memItemLeft" align="right" valign="top">static threadsafe wave </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a44d495fba0dd2b82dec13760a07fd226">reduce_slab_image</a> (wave slabdata, wave image, funcref reduction_func, string reduction_param)</td></tr>
|
|
<tr class="separator:a44d495fba0dd2b82dec13760a07fd226"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa14b28120a07a8213e5a692930704a4b"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#aa14b28120a07a8213e5a692930704a4b">psh5_load_info</a> (string APathName, string AFileName)</td></tr>
|
|
<tr class="memdesc:aa14b28120a07a8213e5a692930704a4b"><td class="mdescLeft"> </td><td class="mdescRight">load descriptive info from a PShell data file. <a href="#aa14b28120a07a8213e5a692930704a4b">More...</a><br /></td></tr>
|
|
<tr class="separator:aa14b28120a07a8213e5a692930704a4b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a79ac37bb666b42c3332e9984196ccfe7"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a79ac37bb666b42c3332e9984196ccfe7">psh5_load_scan_info</a> (variable fileID, string scanpath)</td></tr>
|
|
<tr class="memdesc:a79ac37bb666b42c3332e9984196ccfe7"><td class="mdescLeft"> </td><td class="mdescRight">load descriptive info from a PShell scan. <a href="#a79ac37bb666b42c3332e9984196ccfe7">More...</a><br /></td></tr>
|
|
<tr class="separator:a79ac37bb666b42c3332e9984196ccfe7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92a18d6e81c3f521ba3bb240eaf578a9"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a92a18d6e81c3f521ba3bb240eaf578a9">twave2list</a> (wave wt, string sep)</td></tr>
|
|
<tr class="memdesc:a92a18d6e81c3f521ba3bb240eaf578a9"><td class="mdescLeft"> </td><td class="mdescRight">convert text wave to list. <a href="#a92a18d6e81c3f521ba3bb240eaf578a9">More...</a><br /></td></tr>
|
|
<tr class="separator:a92a18d6e81c3f521ba3bb240eaf578a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6dc3e3f7dc1ca4346132635a90fc447"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#aa6dc3e3f7dc1ca4346132635a90fc447">wave2list</a> (wave w, string format, string sep)</td></tr>
|
|
<tr class="memdesc:aa6dc3e3f7dc1ca4346132635a90fc447"><td class="mdescLeft"> </td><td class="mdescRight">convert numeric wave to list. <a href="#aa6dc3e3f7dc1ca4346132635a90fc447">More...</a><br /></td></tr>
|
|
<tr class="separator:aa6dc3e3f7dc1ca4346132635a90fc447"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:a5ad52cb10171572c454f9426d3a9be21"><td class="memItemLeft" align="right" valign="top">const string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a5ad52cb10171572c454f9426d3a9be21">kEnergyDimLabel</a> = "energy"</td></tr>
|
|
<tr class="memdesc:a5ad52cb10171572c454f9426d3a9be21"><td class="mdescLeft"> </td><td class="mdescRight">Dimension label for the energy dispersive dimension of multi-dimensional datasets. <a href="#a5ad52cb10171572c454f9426d3a9be21">More...</a><br /></td></tr>
|
|
<tr class="separator:a5ad52cb10171572c454f9426d3a9be21"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a83930d4384b0238fc8416ba03dbc0386"><td class="memItemLeft" align="right" valign="top">const string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a83930d4384b0238fc8416ba03dbc0386">kAngleDimLabel</a> = "angle"</td></tr>
|
|
<tr class="memdesc:a83930d4384b0238fc8416ba03dbc0386"><td class="mdescLeft"> </td><td class="mdescRight">Dimension label for the angle dispersive dimension of multi-dimensional datasets. <a href="#a83930d4384b0238fc8416ba03dbc0386">More...</a><br /></td></tr>
|
|
<tr class="separator:a83930d4384b0238fc8416ba03dbc0386"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a412b4753ceb753d705a113a26c018b22"><td class="memItemLeft" align="right" valign="top">const string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a412b4753ceb753d705a113a26c018b22">kScanDimLabel</a> = "scan"</td></tr>
|
|
<tr class="memdesc:a412b4753ceb753d705a113a26c018b22"><td class="mdescLeft"> </td><td class="mdescRight">Dimension label for the scan dimension of multi-dimensional datasets. <a href="#a412b4753ceb753d705a113a26c018b22">More...</a><br /></td></tr>
|
|
<tr class="separator:a412b4753ceb753d705a113a26c018b22"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a277cd450cca7832aa44f8097934e6acb"><td class="memItemLeft" align="right" valign="top">const string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a277cd450cca7832aa44f8097934e6acb">kDataDimLabel</a> = "data"</td></tr>
|
|
<tr class="memdesc:a277cd450cca7832aa44f8097934e6acb"><td class="mdescLeft"> </td><td class="mdescRight">Dimension label for the data dimension. <a href="#a277cd450cca7832aa44f8097934e6acb">More...</a><br /></td></tr>
|
|
<tr class="separator:a277cd450cca7832aa44f8097934e6acb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3c72087695969f42ea91c000de47b26e"><td class="memItemLeft" align="right" valign="top">const string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a3c72087695969f42ea91c000de47b26e">kPreviewDatasets</a> = "ScientaImage;ScientaSpectrum;ImageAngleDistribution;ImageEnergyDistribution;Counts;SampleCurrent;"</td></tr>
|
|
<tr class="memdesc:a3c72087695969f42ea91c000de47b26e"><td class="mdescLeft"> </td><td class="mdescRight">List of preferred datasets to load for preview. <a href="#a3c72087695969f42ea91c000de47b26e">More...</a><br /></td></tr>
|
|
<tr class="separator:a3c72087695969f42ea91c000de47b26e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03f00b3299bc3df671fcc239f7dd5418"><td class="memItemLeft" align="right" valign="top">const string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a03f00b3299bc3df671fcc239f7dd5418">kScientaScalingDatasets</a> = "LensMode;ScientaChannelBegin;ScientaChannelEnd;ScientaSliceBegin;ScientaSliceEnd;"</td></tr>
|
|
<tr class="memdesc:a03f00b3299bc3df671fcc239f7dd5418"><td class="mdescLeft"> </td><td class="mdescRight">List of datasets that must be loaded to determine the axis scaling of a Scienta image. <a href="#a03f00b3299bc3df671fcc239f7dd5418">More...</a><br /></td></tr>
|
|
<tr class="separator:a03f00b3299bc3df671fcc239f7dd5418"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f2c168c04d075734edb995361aefb82"><td class="memItemLeft" align="right" valign="top">const string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a0f2c168c04d075734edb995361aefb82">kTransposedDatasets</a> = "ScientaImage;"</td></tr>
|
|
<tr class="memdesc:a0f2c168c04d075734edb995361aefb82"><td class="mdescLeft"> </td><td class="mdescRight">List of datasets that should be transposed upon loading. <a href="#a0f2c168c04d075734edb995361aefb82">More...</a><br /></td></tr>
|
|
<tr class="separator:a0f2c168c04d075734edb995361aefb82"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5745428740b64cd66394a7fcd78b86f1"><td class="memItemLeft" align="right" valign="top">const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a5745428740b64cd66394a7fcd78b86f1">kDetectorSensitivity</a> = 4</td></tr>
|
|
<tr class="memdesc:a5745428740b64cd66394a7fcd78b86f1"><td class="mdescLeft"> </td><td class="mdescRight">multiply scienta detector intensity by this value to get actual counts. <a href="#a5745428740b64cd66394a7fcd78b86f1">More...</a><br /></td></tr>
|
|
<tr class="separator:a5745428740b64cd66394a7fcd78b86f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>import data from PShell </p>
|
|
<p>HDF5 file import from the PShell data acquisition program. the main import functions are:</p>
|
|
<ul>
|
|
<li><a class="el" href="pearl-pshell-import_8ipf.html#a8a5ce6c2767607de194b4c148ee98c27" title="load everything from a PShell data file. ">psh5_load_complete()</a> load all scans and datasets from a file.</li>
|
|
<li><a class="el" href="pearl-pshell-import_8ipf.html#a3eefc2f84a09f2ce29893c71ef44ae32" title="load and reduce the ScientaImage dataset of the first scan of a PShell data file. ...">psh5_load_reduced()</a> load the ScientaImage dataset of the first scan and reduce its dimensionality.</li>
|
|
<li><a class="el" href="pearl-pshell-import_8ipf.html#a0a02f87e19e825964aa17c46ed51df8c" title="load all data of a selected scan from a PShell data file. ">psh5_load_scan_complete()</a> load all datasets of a selected scan.</li>
|
|
<li><a class="el" href="pearl-pshell-import_8ipf.html#ad3b9354b137ba4f1bc3ed2e74f24dc88" title="load a preview dataset from an open PShell HDF5 file. ">psh5_load_scan_preview()</a> load a preview of a selected scan.</li>
|
|
<li><a class="el" href="pearl-pshell-import_8ipf.html#ac4dfb90b951d29b56501e904f5cc38aa" title="load a dataset from an open PShell HDF5 file. ">psh5_load_dataset()</a> load a selected dataset.</li>
|
|
<li><a class="el" href="pearl-pshell-import_8ipf.html#a13a45e8618c1ab7406e1aa5e608e21fe" title="load a reduced dataset from the open PShell HDF5 file. ">psh5_load_dataset_reduced()</a> load a selected dataset and reduce its dimensionality.</li>
|
|
</ul>
|
|
<p>the following helper functions are also needed:</p>
|
|
<ul>
|
|
<li><a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a></li>
|
|
<li><a class="el" href="pearl-pshell-import_8ipf.html#a2fc497747287d6fe40c6de997ed4a90d" title="close a HDF5 file opened by psh5_open_file. ">psh5_close_file()</a></li>
|
|
<li><a class="el" href="pearl-pshell-import_8ipf.html#a2152f7c39a187b740cf9890767ffac3f" title="list scan groups of a PShell data file. ">psh5_list_scans()</a></li>
|
|
<li><a class="el" href="pearl-pshell-import_8ipf.html#a4508bd507c4c935bd8463d9b2b84c6fc" title="list datasets of a PShell scan group. ">psh5_list_scan_datasets()</a></li>
|
|
<li><a class="el" href="pearl-pshell-import_8ipf.html#aa56c25d64b3e59f74d6dd92a599cce4f" title="load metadata of a PShell scan group. ">psh5_load_scan_meta()</a></li>
|
|
<li><a class="el" href="pearl-pshell-import_8ipf.html#aec191d0167bbf606d24396f4658104b5" title="load attributes of a PShell scan group. ">psh5_load_scan_attrs()</a></li>
|
|
</ul>
|
|
<dl class="section author"><dt>Author</dt><dd>matthias muntwiler, <a href="#" onclick="location.href='mai'+'lto:'+'mat'+'th'+'ias'+'.m'+'unt'+'wi'+'ler'+'@p'+'si.'+'ch'; return false;">matth<span style="display: none;">.nosp@m.</span>ias.<span style="display: none;">.nosp@m.</span>muntw<span style="display: none;">.nosp@m.</span>iler<span style="display: none;">.nosp@m.</span>@psi.<span style="display: none;">.nosp@m.</span>ch</a></dd></dl>
|
|
<dl class="section copyright"><dt>Copyright</dt><dd>2013-18 Paul Scherrer Institut <br />
|
|
Licensed under the Apache License, Version 2.0 (the "License"); <br />
|
|
you may not use this file except in compliance with the License. <br />
|
|
You may obtain a copy of the License at <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a> </dd></dl>
|
|
|
|
<p>Definition in file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="a41bf534983b0662ec2609b136c395f14"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static dfr find_attr_folder </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>dataDF</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>find the attributes data folder </p>
|
|
<p>this is the :attr folder. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01458">1458</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acfb01ee360b66f286225f6e9c7220ba2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static wave find_scale_wave </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>dataDF</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>scanDF</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>attrDF</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">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01546">1546</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a79b968d7439dfbfbc38c05f933071489"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static dfr find_scan_folder </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>dataDF</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>find the scan folder </p>
|
|
<p>the scan folder is the one that contains the :attr folder the data and scan folders may refer to the same folder. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01441">1441</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acba7f4b98f67cc112c02dfeefe3e5acd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable ps_detect_scale </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>ax</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>lo</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>hi</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>un</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>detect the dimension scales from attributes. </p>
|
|
<p>the function checks the data , scan and attributes folders for scan parameters. the results are written to the provided waves. the function is normally called by <a class="el" href="pearl-pshell-import_8ipf.html#af08a467036c64f70ca3dfe644fcc457c" title="set the dimension scales of loaded PShell Scienta datasets according to attributes. ">ps_scale_datasets()</a> but can also be used independently.</p>
|
|
<p>the current datafolder must be the data or the scan folder. the data folder contains the waves that are to be scaled. the scan folder contains the scan positions and the :attr folder.</p>
|
|
<p>the provided waves are redimensioned by the function, and dimension labels are set. the scale parameters can then be extracted by keyword, e.g., </p><ul>
|
|
<li><code>lo[%energy]</code> analyser energy dimension. </li>
|
|
<li><code>lo[%angle]</code> analyser angle dimension. </li>
|
|
<li><code>lo[%scan]</code> scan dimension. </li>
|
|
<li><code>lo[%data]</code> data dimension.</li>
|
|
</ul>
|
|
<p>the function tries to read the following waves, in the data, scan, and attributes folders, where the first folder in the list takes precedence. it may fall back to more or less reasonable default values if no data is not found. </p><ul>
|
|
<li><code>LensMode</code> </li>
|
|
<li><code>ScientaChannelBegin</code> </li>
|
|
<li><code>ScientaChannelEnd</code> </li>
|
|
<li><code>ScientaSliceBegin</code> </li>
|
|
<li><code>ScientaSliceEnd</code> </li>
|
|
<li><code>ScanWritables</code> </li>
|
|
<li>wave referenced by <code>ScanWritables[0]</code></li>
|
|
</ul>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ax</td><td>text wave to receive the axis labels.</td></tr>
|
|
<tr><td class="paramname">lo</td><td>wave to receive the lower limits.</td></tr>
|
|
<tr><td class="paramname">hi</td><td>wave to receive the upper limits.</td></tr>
|
|
<tr><td class="paramname">un</td><td>text wave to receive the unit labels.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the function results are written to the lo, hi, un, and ax waves.</dd></dl>
|
|
<dl class="section version"><dt>Version</dt><dd>this function supports regions from version 1.03. check that you're in the correct data folder! </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01603">1603</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adc11ea797562b3d99c247f4866618d39"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable ps_scale_dataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>data</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set the dimension scales of a loaded PShell Scienta dataset according to attributes. </p>
|
|
<p>the current datafolder must contain the :attr folder. the data wave can be in the current folder or a sub-folder.</p>
|
|
<p>the dimension labels of the dataset waves must have been set correctly, e.g. by <a class="el" href="pearl-pshell-import_8ipf.html#aba25eb98e4c6cc9066c46ef6be1cde15" title="set dimension labels according to the axis type ">ps_set_dimlabels()</a>. this is implicitly done by the high-level load functions.</p>
|
|
<p>the function is useful if a single dataset is loaded and scaled. if multiple datasets are loaded, <a class="el" href="pearl-pshell-import_8ipf.html#af08a467036c64f70ca3dfe644fcc457c" title="set the dimension scales of loaded PShell Scienta datasets according to attributes. ">ps_scale_datasets()</a> is slightly more efficient.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>data wave to be scaled. dimension labels (index -1) must be set correctly, cf. <a class="el" href="pearl-pshell-import_8ipf.html#aba25eb98e4c6cc9066c46ef6be1cde15" title="set dimension labels according to the axis type ">ps_set_dimlabels()</a>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section version"><dt>Version</dt><dd>this function supports regions from version 1.03. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01532">1532</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2c456397c36d4116bfddca452eff5954"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable ps_scale_dataset_2 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>ax</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>lo</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>hi</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>un</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set the dimension scales of a dataset. </p>
|
|
<p>the function is normally called by <a class="el" href="pearl-pshell-import_8ipf.html#af08a467036c64f70ca3dfe644fcc457c" title="set the dimension scales of loaded PShell Scienta datasets according to attributes. ">ps_scale_datasets()</a> but can also be used independently. the limits and units must be given as function arguments with proper dimension labels.</p>
|
|
<p>the provided limit and unit waves must have dimension labels matching the -1 index dimension labels of the data wave, such as set by the <a class="el" href="pearl-pshell-import_8ipf.html#acba7f4b98f67cc112c02dfeefe3e5acd" title="detect the dimension scales from attributes. ">ps_detect_scale()</a> function. the scale parameters are extracted by keyword, e.g., </p><ul>
|
|
<li><code>lo[%energy]</code> analyser energy dimension. </li>
|
|
<li><code>lo[%angle]</code> analyser angle dimension. </li>
|
|
<li><code>lo[%scan]</code> scan dimension. </li>
|
|
<li><code>lo[%data]</code> data dimension.</li>
|
|
</ul>
|
|
<p>if the data dimension labels and units are at their defaults ("value" and "arb.", respectively), the function tries to read them from the existing wave note ("AxisLabelD" and "AxisUnitD"), or based on the wave name if the name is one of the known measurement variables: "ScientaImage", "ImageAngleDistribution", "ScientaAngleDistribution", "ScientaSpectrum", "ImageEnergyDistribution", "ScientaEnergyDistribution", "SampleCurrent", "RefCurrent", "AuxCurrent", "MachineCurrent".</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>data wave to be scaled. dimension labels (index -1) must be set to match the limit waves.</td></tr>
|
|
<tr><td class="paramname">ax</td><td>axis labels. the axis labels are written to the wave note in the format <code>AxisLabel%s=%s</code> where <code>X</code>, <code>Y</code>, <code>Z</code>, <code>D</code> is substituted for the first place holder and the label for the second one.</td></tr>
|
|
<tr><td class="paramname">lo</td><td>lower limits. the lower limits are applied using the SetScale operation.</td></tr>
|
|
<tr><td class="paramname">hi</td><td>upper limits. the upper limits are applied using the SetScale operation.</td></tr>
|
|
<tr><td class="paramname">un</td><td>unit labels. the unit labels are applied using the SetScale operation.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section version"><dt>Version</dt><dd>this function supports regions from version 1.03. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01763">1763</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af08a467036c64f70ca3dfe644fcc457c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable ps_scale_datasets </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set the dimension scales of loaded PShell Scienta datasets according to attributes. </p>
|
|
<p>datasets listed in the ScanReadables waves are scaled according to the attribute waves in the data, scan, and attributes folders, whichever is found first.</p>
|
|
<p>the current datafolder must contain the ScanReadables wave and the :attr folder. the ScanReadables text wave contains names of the waves to scale. wave names can include a relative path to a sub-folder. the path separator is "/".</p>
|
|
<p>the dimension labels of the dataset waves must have been set correctly, e.g. by <a class="el" href="pearl-pshell-import_8ipf.html#aba25eb98e4c6cc9066c46ef6be1cde15" title="set dimension labels according to the axis type ">ps_set_dimlabels()</a>. this is implicitly done by the high-level load functions.</p>
|
|
<dl class="section version"><dt>Version</dt><dd>this function supports regions from version 1.03. check that you're in the correct data folder! </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01486">1486</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aba25eb98e4c6cc9066c46ef6be1cde15"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable ps_set_dimlabels </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>data</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set dimension labels according to the axis type </p>
|
|
<p>this function asserts a particular ordering of dimensions types based on the name of the wave for ScientaImage, ScientaSpectrum, ImageAngleDistribution, ImageEnergyDistribution. all other waves must be one-dimensional, and the dimension must be the scan dimension.</p>
|
|
<p>dimension labels are required by scaling functions.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>data wave as loaded from PShell file</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><ul>
|
|
<li>0 all labels set successfully. </li>
|
|
<li>1 unidentified data source. </li>
|
|
<li>2 wave does not contain data. </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01365">1365</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8704627410409bcd27a1adeda4082c47"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable ps_set_dimlabels2 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>name</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set dimension labels according to the axis type </p>
|
|
<p>same as <a class="el" href="pearl-pshell-import_8ipf.html#aba25eb98e4c6cc9066c46ef6be1cde15" title="set dimension labels according to the axis type ">ps_set_dimlabels()</a> except that the dimension labels are set according to a separate name argument instead of the wave name.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>data wave as loaded from PShell file.</td></tr>
|
|
<tr><td class="paramname">name</td><td>original name of the dataset in the PShell file.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><ul>
|
|
<li>0 all labels set successfully. </li>
|
|
<li>1 unidentified data source. </li>
|
|
<li>2 wave does not contain data. </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01384">1384</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2fc497747287d6fe40c6de997ed4a90d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable psh5_close_file </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>close a HDF5 file opened by psh5_open_file. </p>
|
|
<p>this function just closes the HDF5 file. no change is made to the loaded data.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00139">139</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4508bd507c4c935bd8463d9b2b84c6fc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_list_scan_datasets </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>scanpath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>include_regions</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>list datasets of a PShell scan group. </p>
|
|
<p>the function returns a list of all datasets of the selected scan. this does not include datasets from the attributes sub-group.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>in a future version, an option may be introduced to filter datasets by function (<em>Readable</em> and/or <em>Writable</em>).</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a>.</td></tr>
|
|
<tr><td class="paramname">scanpath</td><td>path to the scan group in the HDF5 file, e.g. "/scan 1".</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>semicolon-separated list of dataset paths.</dd></dl>
|
|
<dl class="section version"><dt>Version</dt><dd>since version 1.03 this function returns paths relative to scanpath. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00439">439</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acb317b57ef137d4d5da5938013dbe442"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_list_scan_regions </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>scanpath</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>list regions of a PShell scan group. </p>
|
|
<p>the function returns a list of all region groups of the selected scan.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a>.</td></tr>
|
|
<tr><td class="paramname">scanpath</td><td>path to the scan group in the HDF5 file, e.g. "/scan 1".</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>semicolon-separated list of datagroup paths. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00480">480</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2152f7c39a187b740cf9890767ffac3f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_list_scans </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>list scan groups of a PShell data file. </p>
|
|
<p>the function returns a list of all top-level groups whose name starts with "scan".</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>semicolon-separated list of group paths. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00404">404</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8a5ce6c2767607de194b4c148ee98c27"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_complete </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>ANickName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>APathName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>AFileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>load_data</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>load_attr</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load everything from a PShell data file. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ANickName</td><td>destination folder name (top level under root)</td></tr>
|
|
<tr><td class="paramname">APathName</td><td>igor symbolic path name. can be empty if the path is specified in FileName or a dialog box should be displayed</td></tr>
|
|
<tr><td class="paramname">AFileName</td><td>if empty a dialog box shows up</td></tr>
|
|
<tr><td class="paramname">load_data</td><td>select whether datasets (positioners and detectors) are loaded. <ul>
|
|
<li>1 (default) load data. </li>
|
|
<li>0 do not load data.</li>
|
|
</ul>
|
|
</td></tr>
|
|
<tr><td class="paramname">load_attr</td><td>select whether attributes (auxiliary device readbacks) are loaded. for proper wave scaling, the attributes must be loaded. <ul>
|
|
<li>1 (default) load attributes. </li>
|
|
<li>0 do not load attributes.</li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>complete path of the loaded file if successful. empty string otherwise.</dd>
|
|
<dd>
|
|
global string s_filepath in new data folder contains the full file path on disk.</dd>
|
|
<dd>
|
|
global string s_scanpaths in new data folder contains a list of scan groups inside the file. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00169">169</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac4dfb90b951d29b56501e904f5cc38aa"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_dataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>scanpath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasetname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>set_scale</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load a dataset from an open PShell HDF5 file. </p>
|
|
<p>if the dataset has a maximum of two dimensions, the function loads it at once. if it has more than two dimension, the function calls <a class="el" href="pearl-pshell-import_8ipf.html#a2972587ec82cc2a261b8119a582b4215" title="load a dataset slab-wise from the open PShell HDF5 file. ">psh5_load_dataset_slabs()</a> to load the data slab by slab.</p>
|
|
<ul>
|
|
<li>the metadata (HDF5 attributes) are loaded into the wave note, cf. <a class="el" href="pearl-pshell-import_8ipf.html#afde787a00a18dc8c63b100d8ac7d992f" title="load metadata of a PShell dataset. ">psh5_load_dataset_meta()</a>.</li>
|
|
<li>dimension labels are set according the dataset name, cf. <a class="el" href="pearl-pshell-import_8ipf.html#aba25eb98e4c6cc9066c46ef6be1cde15" title="set dimension labels according to the axis type ">ps_set_dimlabels()</a>.</li>
|
|
<li>wave scaling is set if the necessary scan attributes have been loaded and the <code>set_scale</code> option is selected (default). the attributes must be loaded by <a class="el" href="pearl-pshell-import_8ipf.html#aa56c25d64b3e59f74d6dd92a599cce4f" title="load metadata of a PShell scan group. ">psh5_load_scan_meta()</a> and <a class="el" href="pearl-pshell-import_8ipf.html#aec191d0167bbf606d24396f4658104b5" title="load attributes of a PShell scan group. ">psh5_load_scan_attrs()</a> (attr_sets=2).</li>
|
|
</ul>
|
|
<p>the dataset is loaded into the current data folder unless datasetname contains a region specifier. in the latter case, the dataset is loaded into sub-folder with the name of the region. the function returns from the original data folder.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a>.</td></tr>
|
|
<tr><td class="paramname">scanpath</td><td>path to the scan group in the HDF5 file, e.g. "/scan 1".</td></tr>
|
|
<tr><td class="paramname">datasetname</td><td>name of the dataset. the name of the loaded wave is a cleaned up version of the dataset name. the name can include the region name as a relative path, e.g. "region1/ScientaSpectrum". in this case, the dataset is loaded into a sub-folder named "region1".</td></tr>
|
|
<tr><td class="paramname">set_scale</td><td>by default, the function tries to set the wave scaling if the attributes have been loaded. if multiple datasets are loaded from a file, it is more efficient to set the scaling of all loaded datasets at the end by calling <a class="el" href="pearl-pshell-import_8ipf.html#af08a467036c64f70ca3dfe644fcc457c" title="set the dimension scales of loaded PShell Scienta datasets according to attributes. ">ps_scale_datasets()</a>. <ul>
|
|
<li>1 (default) set the wave scaling. </li>
|
|
<li>0 do not set the wave scaling.</li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>name of loaded wave if successful. empty string otherwise.</dd></dl>
|
|
<dl class="section version"><dt>Version</dt><dd>this function supports regions as of version 1.03. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00688">688</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afde787a00a18dc8c63b100d8ac7d992f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable psh5_load_dataset_meta </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datapath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasetname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>datawave</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load metadata of a PShell dataset. </p>
|
|
<p>"metadata" are the HDF5 attributes attached to the scan dataset.</p>
|
|
<p>data is added to the wave note.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a>.</td></tr>
|
|
<tr><td class="paramname">datapath</td><td>path to the containing group in the HDF5 file. path separator is the slash "/".</td></tr>
|
|
<tr><td class="paramname">datasetname</td><td>name of the dataset. may include relative path.</td></tr>
|
|
<tr><td class="paramname">datawave</td><td>metadata is added to the wave note of this wave.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful, non-zero if an error occurred. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01073">1073</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a13a45e8618c1ab7406e1aa5e608e21fe"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_dataset_reduced </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>scanpath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasetname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">funcref </td>
|
|
<td class="paramname"><em>reduction_func</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>reduction_param</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>progress</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>nthreads</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load a reduced dataset from the open PShell HDF5 file. </p>
|
|
<p>the function loads the dataset image by image using the hyperslab option and applies a custom reduction function to each image. the results from the reduction function are written to the <code>ReducedData1</code>, <code>ReducedData2</code>, etc. waves. the raw data are discarded.</p>
|
|
<p>by default, the reduction function is called in separate threads to reduce the total loading time. (see the global variable psh5_perf_secs which reports the total run time of the function.) the effect varies depending on the balance between file loading (image size) and data processing (complexity of the reduction function). for debugging the reduction function, multi-threading can be disabled.</p>
|
|
<p>if the reduction function requires the image waves to be scaled properly, the attributes must have been loaded by <a class="el" href="pearl-pshell-import_8ipf.html#aec191d0167bbf606d24396f4658104b5" title="load attributes of a PShell scan group. ">psh5_load_scan_attrs()</a> before. in this case, the scales of the result waves are also set by the function. otherwise, the results can also be scaled by <a class="el" href="pearl-pshell-import_8ipf.html#adc11ea797562b3d99c247f4866618d39" title="set the dimension scales of a loaded PShell Scienta dataset according to attributes. ">ps_scale_dataset()</a> later.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a>.</td></tr>
|
|
<tr><td class="paramname">scanpath</td><td>path to scan group in the HDF5 file.</td></tr>
|
|
<tr><td class="paramname">datasetname</td><td>name of the dataset. this must currently be "ScientaImage", other data is not supported. the name of the loaded wave is a cleaned up version of the dataset name. the name can include the region name as a relative path, e.g. "region1/ScientaImage". in this case, the dataset is loaded into a sub-folder named "region1".</td></tr>
|
|
<tr><td class="paramname">reduction_func</td><td>custom data reduction function. this can be any user-defined function which has the same parameters as <a class="el" href="pearl-area-import_8ipf.html#ade69cb0f82e0c9cf6082d5fcc29f742f">adh5_default_reduction</a>. some reduction functions are predefined in the <a class="el" href="namespace_pearl_scienta_preprocess.html">PearlScientaPreprocess</a> module.</td></tr>
|
|
<tr><td class="paramname">reduction_param</td><td>parameter string for the reduction function.</td></tr>
|
|
<tr><td class="paramname">progress</td><td>progress window. <ul>
|
|
<li>1 (default) show progress window </li>
|
|
<li>0 do not show progress window</li>
|
|
</ul>
|
|
</td></tr>
|
|
<tr><td class="paramname">nthreads</td><td><ul>
|
|
<li>-1 (default) use as many threads as there are processor cores (in addition to main thread). </li>
|
|
<li>0 use main thread only (for debugging and profiling). </li>
|
|
<li>>= 1 use a fixed number of (additional) threads.</li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>semicolon-separated list of the loaded dataset <code>ReducedData1</code>, <code>ReducedData2</code>, etc. if successful. auxiliary waves, scan positions, attributes are loaded but not listed in the string. empty string if an error occurred. error messages are printed to the history.</dd></dl>
|
|
<dl class="section version"><dt>Version</dt><dd>this function supports regions as of version 1.03. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02022">2022</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a035a4df9f4508144149abdb0b46c87d1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_dataset_slab </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datapath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasetname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>dim2start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>dim2count</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>dim3start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>dim3count</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load a single image from the open PShell data file. </p>
|
|
<p>the function can average over a region in the extra dimensions.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a>.</td></tr>
|
|
<tr><td class="paramname">datapath</td><td>path to the containing group in the HDF5 file. path separator is the slash "/".</td></tr>
|
|
<tr><td class="paramname">dataset</td><td>name of the dataset. also defines the name of the loaded wave.</td></tr>
|
|
<tr><td class="paramname">dim2start</td><td>2nd dimension coordinate of the first image set to 0 if dimension may not be present</td></tr>
|
|
<tr><td class="paramname">dim2count</td><td>number of subsequent images to average set to 1 if dimension may not be present</td></tr>
|
|
<tr><td class="paramname">dim3start</td><td>3rd dimension coordinate of the first image set to 0 if dimension may not be present</td></tr>
|
|
<tr><td class="paramname">dim3count</td><td>number of subsequent images to average set to 1 if dimension may not be present</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>name of loaded wave if successful. empty string otherwise. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01266">1266</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2972587ec82cc2a261b8119a582b4215"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_dataset_slabs </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datapath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasetname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>progress</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load a dataset slab-wise from the open PShell HDF5 file. </p>
|
|
<p>the function loads the dataset image by image using the hyperslab option.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a>.</td></tr>
|
|
<tr><td class="paramname">datapath</td><td>path to the containing group in the HDF5 file. path separator is the slash "/".</td></tr>
|
|
<tr><td class="paramname">dataset</td><td>name of the dataset. also defines the name of the loaded wave.</td></tr>
|
|
<tr><td class="paramname">progress</td><td>select whether a progress window is displayed during the process. <ul>
|
|
<li>1 (default) show progress window. </li>
|
|
<li>0 do not show progress window.</li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>name of loaded wave if successful. empty string otherwise. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01130">1130</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa14b28120a07a8213e5a692930704a4b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_info </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>APathName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>AFileName</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load descriptive info from a PShell data file. </p>
|
|
<p>the info string lists the following information for each scan contained in the file:</p><ul>
|
|
<li>path of the scan group inside the file.</li>
|
|
<li>number of scan positions.</li>
|
|
<li>dataset names of scan positioners.</li>
|
|
<li>dataset names of detectors.</li>
|
|
</ul>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">APathName</td><td>igor symbolic path name. can be empty if the path is specified in AFileName or a dialog box should be displayed</td></tr>
|
|
<tr><td class="paramname">AFileName</td><td>if empty a dialog box shows up</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>newline terminated string. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02349">2349</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1dc6c971120749b378014f1f63cb6668"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_preview </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>APathName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>AFileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>load_data</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>load_attr</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>pref_scans</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>pref_datasets</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load a preview image from a PShell data file. </p>
|
|
<p>the data wave is loaded into the current data folder. attributes are loaded into the attr subfolder. existing waves in attr are deleted.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">APathName</td><td>igor symbolic path name. can be empty if the path is specified in FileName or a dialog box should be displayed</td></tr>
|
|
<tr><td class="paramname">AFileName</td><td>if empty a dialog box shows up</td></tr>
|
|
<tr><td class="paramname">load_data</td><td>1 (default): load data; 0: do not load data</td></tr>
|
|
<tr><td class="paramname">load_attr</td><td>1 (default): load attributes; 0: do not load attributes note: for correct scaling of the image, the attributes need to be loaded</td></tr>
|
|
<tr><td class="paramname">pref_scans</td><td>semicolon-separated list of preferred scans. the items of the list are match strings for the Igor StringMatch function. the first matching scan (i.e. top-level HDF5 group with a matching name) is loaded from the file. if no match is found, the first scan is loaded.</td></tr>
|
|
<tr><td class="paramname">pref_datasets</td><td>semicolon-separated list of preferred datasets. the items of the list are match strings for the Igor StringMatch function. the first matching dataset is loaded from the file. if no match is found, the first dataset listed in the file is loaded.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>name of loaded preview wave. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00250">250</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3eefc2f84a09f2ce29893c71ef44ae32"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_reduced </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>ANickName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>APathName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>AFileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">funcref </td>
|
|
<td class="paramname"><em>reduction_func</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>reduction_param</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>progress</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>nthreads</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load and reduce the ScientaImage dataset of the first scan of a PShell data file. </p>
|
|
<p>the resulting dataset is reduced in one image dimension by a user-defined reduction function, e.g. by region-of-interest integration, curve fitting, etc. cf. <a class="el" href="pearl-area-import_8ipf.html#ade69cb0f82e0c9cf6082d5fcc29f742f">adh5_default_reduction</a> for further details.</p>
|
|
<p>the function loads the dataset image by image using the hyperslab option and applies a custom reduction function to each image. the results from the reduction function are composed into one result wave. the raw data are discarded.</p>
|
|
<p>if the data is from the electron analyser driver and some special attributes are included, the function will set the scales of the image dimensions.</p>
|
|
<p>by default, the reduction function is called in separate threads to reduce the total loading time. (see the global variable psh5_perf_secs which reports the total run time of the function.) the effect varies depending on the balance between file loading (image size) and data processing (complexity of the reduction function). for debugging the reduction function, multi-threading can be disabled.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ANickName</td><td>destination folder name (top level under root).</td></tr>
|
|
<tr><td class="paramname">APathName</td><td>igor symbolic path name. can be empty if the path is specified in FileName or a dialog box should be displayed.</td></tr>
|
|
<tr><td class="paramname">AFileName</td><td>if empty a dialog box shows up.</td></tr>
|
|
<tr><td class="paramname">reduction_func</td><td>custom data reduction function. this can be any user-defined function which has the same parameters as <a class="el" href="pearl-area-import_8ipf.html#ade69cb0f82e0c9cf6082d5fcc29f742f">adh5_default_reduction</a>. some reduction functions are predefined in the <a class="el" href="namespace_pearl_scienta_preprocess.html">PearlScientaPreprocess</a> module.</td></tr>
|
|
<tr><td class="paramname">reduction_param</td><td>parameter string for the reduction function.</td></tr>
|
|
<tr><td class="paramname">progress</td><td>progress window. <ul>
|
|
<li>1 (default) show progress window </li>
|
|
<li>0 do not show progress window</li>
|
|
</ul>
|
|
</td></tr>
|
|
<tr><td class="paramname">nthreads</td><td><ul>
|
|
<li>-1 (default) use as many threads as there are processor cores (in addition to main thread). </li>
|
|
<li>0 use main thread only (for debugging and profiling). </li>
|
|
<li>>= 1 use a fixed number of (additional) threads.</li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>semicolon-separated list of the loaded dataset <code>ReducedData1</code>, <code>ReducedData2</code>, etc. if successful. auxiliary waves, scan positions, attributes are loaded but not listed in the string. empty string if an error occurred. error messages are printed to the history.</dd>
|
|
<dd>
|
|
global string s_filepath in new data folder contains the full file path on disk.</dd>
|
|
<dd>
|
|
global string s_scanpaths in new data folder contains a list of scan groups inside the file. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01893">1893</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aec191d0167bbf606d24396f4658104b5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_scan_attrs </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>scanpath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>attr_sets</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load attributes of a PShell scan group. </p>
|
|
<p>"attributes" are the auxiliary data inside the attrs group. do not confuse with HDF5 attributes! HDF5 attributes are loaded by the <a class="el" href="pearl-pshell-import_8ipf.html#aa56c25d64b3e59f74d6dd92a599cce4f" title="load metadata of a PShell scan group. ">psh5_load_scan_meta()</a> function.</p>
|
|
<p>data is loaded into the current data folder. this should normally be the <code>:attr</code> folder inside the respective scan folder.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a>.</td></tr>
|
|
<tr><td class="paramname">scanpath</td><td>path to the scan group in the HDF5 file, e.g. "/scan 1".</td></tr>
|
|
<tr><td class="paramname">attr_sets</td><td>specify the attribute sets to be loaded. this value can be an arithmetic OR of the following constants. by default, all attributes are loaded. <ul>
|
|
<li>1 all datasets that are present in the file. </li>
|
|
<li>2 datasets relevant for wave scaling of Scienta data.</li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>semicolon-separated list of the loaded waves. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00553">553</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0a02f87e19e825964aa17c46ed51df8c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_scan_complete </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>scanpath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>load_data</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>load_attr</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load all data of a selected scan from a PShell data file. </p>
|
|
<p>data is loaded into the current data folder. attribute datasets are loaded into sub-folder <code>attr</code>. region datasets are loaded into region sub-folders. existing data, if present, is overwritten.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a>.</td></tr>
|
|
<tr><td class="paramname">scanpath</td><td>path to the scan group in the HDF5 file, e.g. "/scan 1".</td></tr>
|
|
<tr><td class="paramname">load_data</td><td>select whether datasets (positioners and detectors) are loaded. <ul>
|
|
<li>1 (default) load data. </li>
|
|
<li>0 do not load data.</li>
|
|
</ul>
|
|
</td></tr>
|
|
<tr><td class="paramname">load_attr</td><td>select whether attributes (auxiliary device readbacks) are loaded. for proper wave scaling, the attributes must be loaded. <ul>
|
|
<li>1 (default) load attributes. </li>
|
|
<li>0 do not load attributes.</li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>semicolon-separated list of the loaded data waves (excluding attributes). </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00360">360</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad26b0b56d7ccd23547535091c9430569"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_scan_data </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>scanpath</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load all datasets of a PShell scan group. </p>
|
|
<p>data is loaded into the current data folder. region datasets are loaded into the respective region sub-folders.</p>
|
|
<p>this function does not scale the datasets. call <a class="el" href="pearl-pshell-import_8ipf.html#af08a467036c64f70ca3dfe644fcc457c" title="set the dimension scales of loaded PShell Scienta datasets according to attributes. ">ps_scale_datasets()</a> separately.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a>.</td></tr>
|
|
<tr><td class="paramname">scanpath</td><td>path to the scan group in the HDF5 file, e.g. "/scan 1".</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>semicolon-separated list of the loaded waves. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00513">513</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a79ac37bb666b42c3332e9984196ccfe7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_scan_info </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>scanpath</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load descriptive info from a PShell scan. </p>
|
|
<p>the info string contains up to three lines which are made up of the following information:</p><ul>
|
|
<li>number of scan positions.</li>
|
|
<li>dataset names of scan positioners.</li>
|
|
<li>dataset names of detectors (without region names).</li>
|
|
<li>region names</li>
|
|
</ul>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a>.</td></tr>
|
|
<tr><td class="paramname">scanpath</td><td>path to scan group in the HDF5 file.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>newline terminated string. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02396">2396</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa56c25d64b3e59f74d6dd92a599cce4f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_scan_meta </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>scanpath</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load metadata of a PShell scan group. </p>
|
|
<p><em>metadata</em> are the HDF5 attributes attached to the scan group. the following attributes are loaded. the respective wave names under Igor are given in parentheses.</p>
|
|
<ul>
|
|
<li>Dimensions (ScanDimensions)</li>
|
|
<li>Writables (ScanWritables)</li>
|
|
<li>Readables (ScanReadables)</li>
|
|
<li>Steps (ScanSteps)</li>
|
|
</ul>
|
|
<p>if they are missing in the file, <code>ScanDimensions</code> and <code>ScanReadables</code> are set to default values assuming the file contains a single spectrum.</p>
|
|
<p>data is loaded into the current data folder.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a>.</td></tr>
|
|
<tr><td class="paramname">scanpath</td><td>path to the scan group in the HDF5 file, e.g. "/scan 1".</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>semicolon-separated list of the loaded waves. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00621">621</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad3b9354b137ba4f1bc3ed2e74f24dc88"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_scan_preview </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>scanpath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>set_scale</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>pref_datasets</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load a preview dataset from an open PShell HDF5 file. </p>
|
|
<p>if the dataset has a maximum of two dimensions, the function loads it at once. if it has more than two dimension, the function selects and loads one two-dimensional slab.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a>.</td></tr>
|
|
<tr><td class="paramname">scanpath</td><td>path to the scan group in the HDF5 file, e.g. "/scan 1".</td></tr>
|
|
<tr><td class="paramname">set_scale</td><td>by default, the function tries to set the wave scaling if the attributes have been loaded. if multiple datasets are loaded from a file, it is more efficient to set the scaling of all loaded datasets at the end by calling <a class="el" href="pearl-pshell-import_8ipf.html#af08a467036c64f70ca3dfe644fcc457c" title="set the dimension scales of loaded PShell Scienta datasets according to attributes. ">ps_scale_datasets()</a>. <ul>
|
|
<li>1 (default) set the wave scaling. </li>
|
|
<li>0 do not set the wave scaling.</li>
|
|
</ul>
|
|
</td></tr>
|
|
<tr><td class="paramname">pref_datasets</td><td>semicolon-separated list of preferred datasets. the items of the list are match strings for the Igor StringMatch function. the first matching dataset is loaded from the file. if no match is found, the first dataset listed in the file is loaded. if empty, a hard-coded default preference list is used.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>name of loaded wave if successful. empty string otherwise. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00822">822</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a83804ba9637debed6ef8b13e7b9b19e0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_scan_section </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>scanpath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>dim</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>set_scale</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>pref_datasets</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load a longitudinal section of a scan from an open PShell HDF5 file. </p>
|
|
<p>the dataset must have three dimensions.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#accc20b0fc6bda95ba0cd0aea6633086f" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder...">psh5_open_file()</a>.</td></tr>
|
|
<tr><td class="paramname">scanpath</td><td>path to the scan group in the HDF5 file, e.g. "/scan 1".</td></tr>
|
|
<tr><td class="paramname">dim</td><td>reserved, must be 0.</td></tr>
|
|
<tr><td class="paramname">set_scale</td><td>by default, the function tries to set the wave scaling if the attributes have been loaded. if multiple datasets are loaded from a file, it is more efficient to set the scaling of all loaded datasets at the end by calling <a class="el" href="pearl-pshell-import_8ipf.html#af08a467036c64f70ca3dfe644fcc457c" title="set the dimension scales of loaded PShell Scienta datasets according to attributes. ">ps_scale_datasets()</a>. <ul>
|
|
<li>1 (default) set the wave scaling. </li>
|
|
<li>0 do not set the wave scaling.</li>
|
|
</ul>
|
|
</td></tr>
|
|
<tr><td class="paramname">pref_datasets</td><td>semicolon-separated list of preferred datasets. the items of the list are match strings for the Igor StringMatch function. the first matching dataset is loaded from the file. if no match is found, the first dataset listed in the file is loaded. if empty, a hard-coded default preference list is used.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>name of loaded wave if successful. empty string otherwise.</dd></dl>
|
|
<dl class="section warning"><dt>Warning</dt><dd>EXPERIMENTAL: this function is under development. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00935">935</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="accc20b0fc6bda95ba0cd0aea6633086f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable psh5_open_file </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>ANickName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>APathName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>AFileName</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>open a HDF5 file created by the PShell data acquisition program and prepare the data folder. </p>
|
|
<p>the function opens a specified or interactively selected HDF5 file, creates a data folder <code>$ANickName</code> under root, and changes to the new data folder.</p>
|
|
<p>the file must be closed by <a class="el" href="pearl-pshell-import_8ipf.html#a2fc497747287d6fe40c6de997ed4a90d" title="close a HDF5 file opened by psh5_open_file. ">psh5_close_file()</a> after use.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ANickName</td><td>destination folder name (top level under root).</td></tr>
|
|
<tr><td class="paramname">APathName</td><td>igor symbolic path name. can be empty if the path is specified in FileName or a dialog box should be displayed</td></tr>
|
|
<tr><td class="paramname">AFileName</td><td>if empty a dialog box shows up</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>ID of open HDF5 file from HDF5OpenFile. zero if an error occurred.</dd>
|
|
<dd>
|
|
global string s_filepath in new data folder contains the full file path on disk.</dd>
|
|
<dd>
|
|
global string s_scanpaths in new data folder contains a list of scan groups inside the file. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00109">109</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a44d495fba0dd2b82dec13760a07fd226"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static threadsafe wave reduce_slab_image </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>slabdata</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>image</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">funcref </td>
|
|
<td class="paramname"><em>reduction_func</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>reduction_param</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">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02323">2323</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a33f8faf117450af1d6dae9ef48786cd6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static threadsafe variable reduce_slab_worker </td>
|
|
<td>(</td>
|
|
<td class="paramtype">funcref </td>
|
|
<td class="paramname"><em>reduction_func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02284">2284</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abb4afdef6ae4476c25a1ff77b17266c3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string select_dataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>file_datasets</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>pref_datasets</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">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>select the preferred dataset from a list of available datasets. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">file_datasets</td><td>semicolon-separated list of datasets that are available in the file. the items may include a path separated by slashes "/". only the last component of the path is checked.</td></tr>
|
|
<tr><td class="paramname">pref_datasets</td><td>semicolon-separated list of preferred datasets. the items of the list are match strings for the Igor StringMatch function. the first matching dataset is loaded from the file. if no match is found, the first file dataset is selected.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>selected dataset. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00760">760</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a92a18d6e81c3f521ba3bb240eaf578a9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string twave2list </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>wt</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>sep</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">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>convert text wave to list. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02455">2455</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa6dc3e3f7dc1ca4346132635a90fc447"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string wave2list </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>w</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>format</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>sep</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">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>convert numeric wave to list. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02472">2472</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a class="anchor" id="a83930d4384b0238fc8416ba03dbc0386"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string kAngleDimLabel = "angle"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Dimension label for the angle dispersive dimension of multi-dimensional datasets. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00067">67</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a277cd450cca7832aa44f8097934e6acb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string kDataDimLabel = "data"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Dimension label for the data dimension. </p>
|
|
<p>This label may be used to store the parameters for the <code>setscale d</code> operation. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00074">74</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5745428740b64cd66394a7fcd78b86f1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kDetectorSensitivity = 4</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>multiply scienta detector intensity by this value to get actual counts. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00086">86</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5ad52cb10171572c454f9426d3a9be21"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string kEnergyDimLabel = "energy"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Dimension label for the energy dispersive dimension of multi-dimensional datasets. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00064">64</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3c72087695969f42ea91c000de47b26e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string kPreviewDatasets = "ScientaImage;ScientaSpectrum;ImageAngleDistribution;ImageEnergyDistribution;Counts;SampleCurrent;"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>List of preferred datasets to load for preview. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00077">77</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a412b4753ceb753d705a113a26c018b22"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string kScanDimLabel = "scan"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Dimension label for the scan dimension of multi-dimensional datasets. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00070">70</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a03f00b3299bc3df671fcc239f7dd5418"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string kScientaScalingDatasets = "LensMode;ScientaChannelBegin;ScientaChannelEnd;ScientaSliceBegin;ScientaSliceEnd;"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>List of datasets that must be loaded to determine the axis scaling of a Scienta image. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00080">80</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0f2c168c04d075734edb995361aefb82"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string kTransposedDatasets = "ScientaImage;"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>List of datasets that should be transposed upon loading. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00083">83</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_fe5dc42579d4b99403482a3a637d9f7d.html">pearl</a></li><li class="navelem"><a class="el" href="pearl-pshell-import_8ipf.html">pearl-pshell-import.ipf</a></li>
|
|
<li class="footer">Generated on Tue Feb 6 2018 11:37:56 for PEARL Procedures by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|