matthias muntwiler
70207096d5
Some checks failed
build and deploy documentation / build-and-deploy (push) Failing after 0s
2400 lines
142 KiB
HTML
2400 lines
142 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<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>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">PEARL Procedures<span id="projectnumber"> rev-distro-3.1.0-0-gea838b3-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.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</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">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('pearl-pshell-import_8ipf.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div 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-compat"</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 id="namespaces" name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:namespace_pearl_p_shell_import" id="r_namespace_pearl_p_shell_import"><td class="memItemLeft" align="right" valign="top">namespace  </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 id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ab41e955a4ff70f9c78571faad1b43d7b" id="r_ab41e955a4ff70f9c78571faad1b43d7b"><td class="memItemLeft" align="right" valign="top">dfr </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#ab41e955a4ff70f9c78571faad1b43d7b">psh5_load</a> (string path_name, string file_name, string scans, string regions, string datasets, variable classes=defaultValue, variable max_rank=defaultValue, string reduction_func=defaultValue, string reduction_params=defaultValue, dfref dest_df=defaultValue)</td></tr>
|
|
<tr class="memdesc:ab41e955a4ff70f9c78571faad1b43d7b"><td class="mdescLeft"> </td><td class="mdescRight">main data loading function <br /></td></tr>
|
|
<tr class="separator:ab41e955a4ff70f9c78571faad1b43d7b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a24afba76ed5323d8cd0abc3c7b0d9912" id="r_a24afba76ed5323d8cd0abc3c7b0d9912"><td class="memItemLeft" align="right" valign="top">dfr </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a24afba76ed5323d8cd0abc3c7b0d9912">psh5_preview</a> (string path_name, string file_name, dfref dest_df=defaultValue, string preview_datasets=defaultValue)</td></tr>
|
|
<tr class="memdesc:a24afba76ed5323d8cd0abc3c7b0d9912"><td class="mdescLeft"> </td><td class="mdescRight">load preview <br /></td></tr>
|
|
<tr class="separator:a24afba76ed5323d8cd0abc3c7b0d9912"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab684c44d5f0668631e42d9c9c9dfea9e" id="r_ab684c44d5f0668631e42d9c9c9dfea9e"><td class="memItemLeft" align="right" valign="top">dfr </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#ab684c44d5f0668631e42d9c9c9dfea9e">psh5_open_file</a> (string path_name, string file_name, dfref dest_df=defaultValue)</td></tr>
|
|
<tr class="memdesc:ab684c44d5f0668631e42d9c9c9dfea9e"><td class="mdescLeft"> </td><td class="mdescRight">open a HDF5 file created by the PShell data acquisition program and prepare the data folder. <br /></td></tr>
|
|
<tr class="separator:ab684c44d5f0668631e42d9c9c9dfea9e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47513a1db5693f88d64739a5b28926b2" id="r_a47513a1db5693f88d64739a5b28926b2"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a47513a1db5693f88d64739a5b28926b2">psh5_close_file</a> (dfref file_df)</td></tr>
|
|
<tr class="memdesc:a47513a1db5693f88d64739a5b28926b2"><td class="mdescLeft"> </td><td class="mdescRight">close a HDF5 file opened by psh5_open_file. <br /></td></tr>
|
|
<tr class="separator:a47513a1db5693f88d64739a5b28926b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92a18d6e81c3f521ba3bb240eaf578a9" id="r_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. <br /></td></tr>
|
|
<tr class="separator:a92a18d6e81c3f521ba3bb240eaf578a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6dc3e3f7dc1ca4346132635a90fc447" id="r_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. <br /></td></tr>
|
|
<tr class="separator:aa6dc3e3f7dc1ca4346132635a90fc447"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85c1fbd2aefff2028e084ea61314dc67" id="r_a85c1fbd2aefff2028e084ea61314dc67"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a85c1fbd2aefff2028e084ea61314dc67">psh5_list_scans</a> (variable file_id)</td></tr>
|
|
<tr class="memdesc:a85c1fbd2aefff2028e084ea61314dc67"><td class="mdescLeft"> </td><td class="mdescRight">list scan groups of a PShell data file. <br /></td></tr>
|
|
<tr class="separator:a85c1fbd2aefff2028e084ea61314dc67"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a113622ae05611e5051a97d223fae59d0" id="r_a113622ae05611e5051a97d223fae59d0"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a113622ae05611e5051a97d223fae59d0">psh5_list_all_datasets</a> (variable file_id)</td></tr>
|
|
<tr class="memdesc:a113622ae05611e5051a97d223fae59d0"><td class="mdescLeft"> </td><td class="mdescRight">list all datasets in a file <br /></td></tr>
|
|
<tr class="separator:a113622ae05611e5051a97d223fae59d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1889973eeedcef72c2a1c2eb5c28fed3" id="r_a1889973eeedcef72c2a1c2eb5c28fed3"><td class="memItemLeft" align="right" valign="top">variable[string datatypes, string ranks, string dimensions] </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a1889973eeedcef72c2a1c2eb5c28fed3">psh5_list_dataset_info</a> (string variable, string file_id, variable string, sds datasets)</td></tr>
|
|
<tr class="memdesc:a1889973eeedcef72c2a1c2eb5c28fed3"><td class="mdescLeft"> </td><td class="mdescRight">list data types and dimensions of datasets <br /></td></tr>
|
|
<tr class="separator:a1889973eeedcef72c2a1c2eb5c28fed3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c191ea7367f2f328333b9986c7dd538" id="r_a7c191ea7367f2f328333b9986c7dd538"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a7c191ea7367f2f328333b9986c7dd538">psh5_filter_datasets_rank</a> (string datasets, string ranks, variable min_rank, variable max_rank)</td></tr>
|
|
<tr class="memdesc:a7c191ea7367f2f328333b9986c7dd538"><td class="mdescLeft"> </td><td class="mdescRight">filter datasets by rank <br /></td></tr>
|
|
<tr class="separator:a7c191ea7367f2f328333b9986c7dd538"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae2aedcb7028cccdb683c43411cc8f1e2" id="r_ae2aedcb7028cccdb683c43411cc8f1e2"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#ae2aedcb7028cccdb683c43411cc8f1e2">unique_strings</a> (string list)</td></tr>
|
|
<tr class="memdesc:ae2aedcb7028cccdb683c43411cc8f1e2"><td class="mdescLeft"> </td><td class="mdescRight">remove duplicate items from list <br /></td></tr>
|
|
<tr class="separator:ae2aedcb7028cccdb683c43411cc8f1e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab86e42bb6f9ff20f685ad5627b446b77" id="r_ab86e42bb6f9ff20f685ad5627b446b77"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#ab86e42bb6f9ff20f685ad5627b446b77">psh5_extract_scan_paths</a> (string datasets)</td></tr>
|
|
<tr class="memdesc:ab86e42bb6f9ff20f685ad5627b446b77"><td class="mdescLeft"> </td><td class="mdescRight">trim dataset paths to the scan part <br /></td></tr>
|
|
<tr class="separator:ab86e42bb6f9ff20f685ad5627b446b77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f5d11063bd50ded36ca013a2656b539" id="r_a4f5d11063bd50ded36ca013a2656b539"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a4f5d11063bd50ded36ca013a2656b539">psh5_extract_region_paths</a> (string datasets)</td></tr>
|
|
<tr class="memdesc:a4f5d11063bd50ded36ca013a2656b539"><td class="mdescLeft"> </td><td class="mdescRight">trim dataset paths to the scan/region part <br /></td></tr>
|
|
<tr class="separator:a4f5d11063bd50ded36ca013a2656b539"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af3b5005859915f410ec27a31ac9519ca" id="r_af3b5005859915f410ec27a31ac9519ca"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#af3b5005859915f410ec27a31ac9519ca">psh5_match_dataset_classes</a> (string datasets, variable classes, string positioners=defaultValue, string detectors=defaultValue)</td></tr>
|
|
<tr class="memdesc:af3b5005859915f410ec27a31ac9519ca"><td class="mdescLeft"> </td><td class="mdescRight">filter a list of datasets by classification <br /></td></tr>
|
|
<tr class="separator:af3b5005859915f410ec27a31ac9519ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa7a48b65e465abde9aad80377605ae59" id="r_aa7a48b65e465abde9aad80377605ae59"><td class="memItemLeft" align="right" valign="top">dfr </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#aa7a48b65e465abde9aad80377605ae59">psh5_create_folders</a> (string datasetpath)</td></tr>
|
|
<tr class="memdesc:aa7a48b65e465abde9aad80377605ae59"><td class="mdescLeft"> </td><td class="mdescRight">create all data folders along a dataset path <br /></td></tr>
|
|
<tr class="separator:aa7a48b65e465abde9aad80377605ae59"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acda8bf0493a2e8ba1955f12de08e28f2" id="r_acda8bf0493a2e8ba1955f12de08e28f2"><td class="memItemLeft" align="right" valign="top">dfr </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#acda8bf0493a2e8ba1955f12de08e28f2">psh5_dataset_to_folder</a> (dfref parent_df, string datasetpath)</td></tr>
|
|
<tr class="memdesc:acda8bf0493a2e8ba1955f12de08e28f2"><td class="mdescLeft"> </td><td class="mdescRight">map dataset path to datafolder path <br /></td></tr>
|
|
<tr class="separator:acda8bf0493a2e8ba1955f12de08e28f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d7b67c9f983d3446c5c6f274284b82a" id="r_a7d7b67c9f983d3446c5c6f274284b82a"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a7d7b67c9f983d3446c5c6f274284b82a">ps_fix_folder_name</a> (string group_name)</td></tr>
|
|
<tr class="memdesc:a7d7b67c9f983d3446c5c6f274284b82a"><td class="mdescLeft"> </td><td class="mdescRight">convert HDF5 group name to data folder name and fix compatibility issues <br /></td></tr>
|
|
<tr class="separator:a7d7b67c9f983d3446c5c6f274284b82a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae539a7501119cb2349707e2027f0f759" id="r_ae539a7501119cb2349707e2027f0f759"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#ae539a7501119cb2349707e2027f0f759">psh5_load_datasets</a> (dfref file_df, string datasets, variable create_folders=defaultValue, string reduction_func=defaultValue, string reduction_params=defaultValue)</td></tr>
|
|
<tr class="memdesc:ae539a7501119cb2349707e2027f0f759"><td class="mdescLeft"> </td><td class="mdescRight">load multiple datasets from open file <br /></td></tr>
|
|
<tr class="separator:ae539a7501119cb2349707e2027f0f759"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7a6eefbda58d31336c81a3dda6e9a2d" id="r_af7a6eefbda58d31336c81a3dda6e9a2d"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#af7a6eefbda58d31336c81a3dda6e9a2d">psh5_load_dataset</a> (dfref file_df, string datasetpath, variable create_folders=defaultValue, string reduction_func=defaultValue, string reduction_params=defaultValue)</td></tr>
|
|
<tr class="memdesc:af7a6eefbda58d31336c81a3dda6e9a2d"><td class="mdescLeft"> </td><td class="mdescRight">load a dataset from an open PShell HDF5 file. <br /></td></tr>
|
|
<tr class="separator:af7a6eefbda58d31336c81a3dda6e9a2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc4fa60c5fbfdb08c2a9d3072d3e16ce" id="r_afc4fa60c5fbfdb08c2a9d3072d3e16ce"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#afc4fa60c5fbfdb08c2a9d3072d3e16ce">psh5_load_dataset_slabs</a> (dfref file_df, string datasetpath, variable create_folders=defaultValue, variable progress=defaultValue)</td></tr>
|
|
<tr class="memdesc:afc4fa60c5fbfdb08c2a9d3072d3e16ce"><td class="mdescLeft"> </td><td class="mdescRight">load a dataset slab-wise from the open PShell HDF5 file. <br /></td></tr>
|
|
<tr class="separator:afc4fa60c5fbfdb08c2a9d3072d3e16ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af662500c4f992ef7b956f37ed463513d" id="r_af662500c4f992ef7b956f37ed463513d"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#af662500c4f992ef7b956f37ed463513d">psh5_load_dataset_reduced</a> (dfref file_df, string datasetpath, funcref reduction_func, string reduction_params, variable create_folders=defaultValue, variable progress=defaultValue, variable nthreads=defaultValue)</td></tr>
|
|
<tr class="memdesc:af662500c4f992ef7b956f37ed463513d"><td class="mdescLeft"> </td><td class="mdescRight">load a dataset with reduced dimensionality <br /></td></tr>
|
|
<tr class="separator:af662500c4f992ef7b956f37ed463513d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a33f8faf117450af1d6dae9ef48786cd6" id="r_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:a8089a75744ffc3626305406e925d320a" id="r_a8089a75744ffc3626305406e925d320a"><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#a8089a75744ffc3626305406e925d320a">reduce_slab_image</a> (wave slabdata, wave image, funcref reduction_func, string reduction_params)</td></tr>
|
|
<tr class="separator:a8089a75744ffc3626305406e925d320a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac782084655d44d222742e3397051619d" id="r_ac782084655d44d222742e3397051619d"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#ac782084655d44d222742e3397051619d">psh5_load_general_group</a> (dfref file_df)</td></tr>
|
|
<tr class="memdesc:ac782084655d44d222742e3397051619d"><td class="mdescLeft"> </td><td class="mdescRight">load organizational metadata from the general group. <br /></td></tr>
|
|
<tr class="separator:ac782084655d44d222742e3397051619d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a72465006d4e8379fad08d1a1064de2a3" id="r_a72465006d4e8379fad08d1a1064de2a3"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a72465006d4e8379fad08d1a1064de2a3">psh_load_general_string</a> (dfref file_df, string name)</td></tr>
|
|
<tr class="memdesc:a72465006d4e8379fad08d1a1064de2a3"><td class="mdescLeft"> </td><td class="mdescRight">load a string from the general group. <br /></td></tr>
|
|
<tr class="separator:a72465006d4e8379fad08d1a1064de2a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abcf01e205858a512aa713da914eaf966" id="r_abcf01e205858a512aa713da914eaf966"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#abcf01e205858a512aa713da914eaf966">psh5_load_dataset_meta</a> (dfref file_df, string datasetpath, wave datawave)</td></tr>
|
|
<tr class="memdesc:abcf01e205858a512aa713da914eaf966"><td class="mdescLeft"> </td><td class="mdescRight">load metadata of a PShell dataset. <br /></td></tr>
|
|
<tr class="separator:abcf01e205858a512aa713da914eaf966"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a23a2e4cb2dc5364bfdbab4367ed6f234" id="r_a23a2e4cb2dc5364bfdbab4367ed6f234"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a23a2e4cb2dc5364bfdbab4367ed6f234">psh5_load_scan_meta</a> (dfref file_df, string scanpath)</td></tr>
|
|
<tr class="memdesc:a23a2e4cb2dc5364bfdbab4367ed6f234"><td class="mdescLeft"> </td><td class="mdescRight">load metadata of a PShell scan group. <br /></td></tr>
|
|
<tr class="separator:a23a2e4cb2dc5364bfdbab4367ed6f234"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba25eb98e4c6cc9066c46ef6be1cde15" id="r_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 <br /></td></tr>
|
|
<tr class="separator:aba25eb98e4c6cc9066c46ef6be1cde15"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8704627410409bcd27a1adeda4082c47" id="r_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 <br /></td></tr>
|
|
<tr class="separator:a8704627410409bcd27a1adeda4082c47"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a513091ea9a4e23f76765aa37f1d34055" id="r_a513091ea9a4e23f76765aa37f1d34055"><td class="memItemLeft" align="right" valign="top">dfr </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a513091ea9a4e23f76765aa37f1d34055">ps_find_scan_folder</a> (dfref data_df)</td></tr>
|
|
<tr class="memdesc:a513091ea9a4e23f76765aa37f1d34055"><td class="mdescLeft"> </td><td class="mdescRight">find the scan folder of current data <br /></td></tr>
|
|
<tr class="separator:a513091ea9a4e23f76765aa37f1d34055"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a476f19c72d6e54787535ab6989ee778d" id="r_a476f19c72d6e54787535ab6989ee778d"><td class="memItemLeft" align="right" valign="top">dfr </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a476f19c72d6e54787535ab6989ee778d">ps_find_attr_folder</a> (dfref scan_df)</td></tr>
|
|
<tr class="memdesc:a476f19c72d6e54787535ab6989ee778d"><td class="mdescLeft"> </td><td class="mdescRight">find the attributes data folder <br /></td></tr>
|
|
<tr class="separator:a476f19c72d6e54787535ab6989ee778d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f39f9379e66ead0d25c33adfbe05ee9" id="r_a2f39f9379e66ead0d25c33adfbe05ee9"><td class="memItemLeft" align="right" valign="top">wave </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a2f39f9379e66ead0d25c33adfbe05ee9">ps_find_scale_wave</a> (string name, dfref df1, dfref df2, dfref df3)</td></tr>
|
|
<tr class="memdesc:a2f39f9379e66ead0d25c33adfbe05ee9"><td class="mdescLeft"> </td><td class="mdescRight">find a wave in scan and attr data folders <br /></td></tr>
|
|
<tr class="separator:a2f39f9379e66ead0d25c33adfbe05ee9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2275b0b8a0a1ed05afc50ef50564243" id="r_ad2275b0b8a0a1ed05afc50ef50564243"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#ad2275b0b8a0a1ed05afc50ef50564243">ps_detect_scale</a> (dfref data_df, wave ax, wave lo, wave hi, wave un)</td></tr>
|
|
<tr class="memdesc:ad2275b0b8a0a1ed05afc50ef50564243"><td class="mdescLeft"> </td><td class="mdescRight">detect the dimension scales from attributes. <br /></td></tr>
|
|
<tr class="separator:ad2275b0b8a0a1ed05afc50ef50564243"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c456397c36d4116bfddca452eff5954" id="r_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. <br /></td></tr>
|
|
<tr class="separator:a2c456397c36d4116bfddca452eff5954"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a1961e05ea900e72d6a886ac5744f2d" id="r_a5a1961e05ea900e72d6a886ac5744f2d"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a5a1961e05ea900e72d6a886ac5744f2d">ps_scale_datasets</a> (dfref scan_df)</td></tr>
|
|
<tr class="memdesc:a5a1961e05ea900e72d6a886ac5744f2d"><td class="mdescLeft"> </td><td class="mdescRight">set the dimension scales of loaded PShell Scienta datasets according to attributes. <br /></td></tr>
|
|
<tr class="separator:a5a1961e05ea900e72d6a886ac5744f2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adc11ea797562b3d99c247f4866618d39" id="r_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. <br /></td></tr>
|
|
<tr class="separator:adc11ea797562b3d99c247f4866618d39"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a972bf23d6da0bb33e9f12e50c9d7f5e5" id="r_a972bf23d6da0bb33e9f12e50c9d7f5e5"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a972bf23d6da0bb33e9f12e50c9d7f5e5">kill_matching_waves</a> (dfref dfr, string pattern, variable recurse, string killed=defaultValue)</td></tr>
|
|
<tr class="memdesc:a972bf23d6da0bb33e9f12e50c9d7f5e5"><td class="mdescLeft"> </td><td class="mdescRight">kill any waves matching a pattern in the experiment <br /></td></tr>
|
|
<tr class="separator:a972bf23d6da0bb33e9f12e50c9d7f5e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:a5ad52cb10171572c454f9426d3a9be21" id="r_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. <br /></td></tr>
|
|
<tr class="separator:a5ad52cb10171572c454f9426d3a9be21"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a83930d4384b0238fc8416ba03dbc0386" id="r_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. <br /></td></tr>
|
|
<tr class="separator:a83930d4384b0238fc8416ba03dbc0386"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a412b4753ceb753d705a113a26c018b22" id="r_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. <br /></td></tr>
|
|
<tr class="separator:a412b4753ceb753d705a113a26c018b22"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a277cd450cca7832aa44f8097934e6acb" id="r_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. <br /></td></tr>
|
|
<tr class="separator:a277cd450cca7832aa44f8097934e6acb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3c72087695969f42ea91c000de47b26e" id="r_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> = "ImageEnergyDistribution;ScientaSpectrum;ScientaImage;Counts;SampleCurrent;"</td></tr>
|
|
<tr class="memdesc:a3c72087695969f42ea91c000de47b26e"><td class="mdescLeft"> </td><td class="mdescRight">List of preferred datasets to load for preview. <br /></td></tr>
|
|
<tr class="separator:a3c72087695969f42ea91c000de47b26e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03f00b3299bc3df671fcc239f7dd5418" id="r_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;Eph;ScientaHighEnergy;ScientaHighThetaX;ScientaLowEnergy;ScientaLowThetaX;"</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. <br /></td></tr>
|
|
<tr class="separator:a03f00b3299bc3df671fcc239f7dd5418"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0bc752ab76659b492cf88c75935336b" id="r_ab0bc752ab76659b492cf88c75935336b"><td class="memItemLeft" align="right" valign="top">const string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#ab0bc752ab76659b492cf88c75935336b">kEssentialDiagnostics</a> = "ManipulatorX;ManipulatorY;ManipulatorZ;ManipulatorTheta;ManipulatorTilt;ManipulatorPhi;MonoEnergy;"</td></tr>
|
|
<tr class="memdesc:ab0bc752ab76659b492cf88c75935336b"><td class="mdescLeft"> </td><td class="mdescRight">List of diagnostic datasets that are normally loaded with a scan. <br /></td></tr>
|
|
<tr class="separator:ab0bc752ab76659b492cf88c75935336b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f2c168c04d075734edb995361aefb82" id="r_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 must be transposed upon loading. <br /></td></tr>
|
|
<tr class="separator:a0f2c168c04d075734edb995361aefb82"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb9a7f56922ff3c862e8b29b5090c01a" id="r_aeb9a7f56922ff3c862e8b29b5090c01a"><td class="memItemLeft" align="right" valign="top">const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#aeb9a7f56922ff3c862e8b29b5090c01a">kDSCPositioners</a> = 0x0001</td></tr>
|
|
<tr class="separator:aeb9a7f56922ff3c862e8b29b5090c01a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c5aaa2f133862ae16ddd735df1ab73d" id="r_a7c5aaa2f133862ae16ddd735df1ab73d"><td class="memItemLeft" align="right" valign="top">const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a7c5aaa2f133862ae16ddd735df1ab73d">kDSCDetectors</a> = 0x0002</td></tr>
|
|
<tr class="separator:a7c5aaa2f133862ae16ddd735df1ab73d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab7c2cc8687f6d4550ef90c538b938dad" id="r_ab7c2cc8687f6d4550ef90c538b938dad"><td class="memItemLeft" align="right" valign="top">const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#ab7c2cc8687f6d4550ef90c538b938dad">kDSCScientaScaling</a> = 0x0004</td></tr>
|
|
<tr class="separator:ab7c2cc8687f6d4550ef90c538b938dad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a654f0b9fe8770a8bd09a6da4182ca3bc" id="r_a654f0b9fe8770a8bd09a6da4182ca3bc"><td class="memItemLeft" align="right" valign="top">const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a654f0b9fe8770a8bd09a6da4182ca3bc">kDSCPreview</a> = 0x0008</td></tr>
|
|
<tr class="separator:a654f0b9fe8770a8bd09a6da4182ca3bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aebf53e3de392d631b340ee0747b8bbbf" id="r_aebf53e3de392d631b340ee0747b8bbbf"><td class="memItemLeft" align="right" valign="top">const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#aebf53e3de392d631b340ee0747b8bbbf">kDSCEssentialDiags</a> = 0x0010</td></tr>
|
|
<tr class="separator:aebf53e3de392d631b340ee0747b8bbbf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a10224f615973777a43fefae8eb1a39f2" id="r_a10224f615973777a43fefae8eb1a39f2"><td class="memItemLeft" align="right" valign="top">const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a10224f615973777a43fefae8eb1a39f2">kDSCAttrs</a> = 0x0020</td></tr>
|
|
<tr class="separator:a10224f615973777a43fefae8eb1a39f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf778206fa825ab5006bd553c64a8760" id="r_adf778206fa825ab5006bd553c64a8760"><td class="memItemLeft" align="right" valign="top">const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#adf778206fa825ab5006bd553c64a8760">kDSCDiags</a> = 0x0040</td></tr>
|
|
<tr class="separator:adf778206fa825ab5006bd553c64a8760"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3236744797a780eb144a684b0bd41d4a" id="r_a3236744797a780eb144a684b0bd41d4a"><td class="memItemLeft" align="right" valign="top">const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a3236744797a780eb144a684b0bd41d4a">kDSCSnaps</a> = 0x0080</td></tr>
|
|
<tr class="separator:a3236744797a780eb144a684b0bd41d4a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a712ea7a6f18ce4178fd06b07d2d05a9f" id="r_a712ea7a6f18ce4178fd06b07d2d05a9f"><td class="memItemLeft" align="right" valign="top">const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a712ea7a6f18ce4178fd06b07d2d05a9f">kDSCMeta</a> = 0x0100</td></tr>
|
|
<tr class="separator:a712ea7a6f18ce4178fd06b07d2d05a9f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a300847a8e08161a64a199a6e7ef165c8" id="r_a300847a8e08161a64a199a6e7ef165c8"><td class="memItemLeft" align="right" valign="top">const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a300847a8e08161a64a199a6e7ef165c8">kDSCMonitors</a> = 0x0200</td></tr>
|
|
<tr class="separator:a300847a8e08161a64a199a6e7ef165c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48f07030482af8315447ac2c598edd0d" id="r_a48f07030482af8315447ac2c598edd0d"><td class="memItemLeft" align="right" valign="top">const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a48f07030482af8315447ac2c598edd0d">kDSCRegions</a> = 0x0400</td></tr>
|
|
<tr class="separator:a48f07030482af8315447ac2c598edd0d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac81d8f4276cf7bb86a74796cc7199e42" id="r_ac81d8f4276cf7bb86a74796cc7199e42"><td class="memItemLeft" align="right" valign="top">const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#ac81d8f4276cf7bb86a74796cc7199e42">kDSCOther</a> = 0x8000</td></tr>
|
|
<tr class="separator:ac81d8f4276cf7bb86a74796cc7199e42"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a237e95f14b988f58e2d4c37659f17347" id="r_a237e95f14b988f58e2d4c37659f17347"><td class="memItemLeft" align="right" valign="top">const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pshell-import_8ipf.html#a237e95f14b988f58e2d4c37659f17347">kDSCAll</a> = 0xffff</td></tr>
|
|
<tr class="separator:a237e95f14b988f58e2d4c37659f17347"><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.</p>
|
|
<p>the module provides two main entry functions:</p>
|
|
<ul>
|
|
<li><a class="el" href="pearl-pshell-import_8ipf.html#ab41e955a4ff70f9c78571faad1b43d7b" title="main data loading function">psh5_load()</a> for almost all data loading tasks including data reduction.</li>
|
|
<li><a class="el" href="pearl-pshell-import_8ipf.html#a24afba76ed5323d8cd0abc3c7b0d9912" title="load preview">psh5_preview()</a> to load a simple 1d or 2d preview of the first and most relevant dataset in the file.</li>
|
|
</ul>
|
|
<dl class="section version"><dt>Version</dt><dd>up to igor 8, this module requires the HDF5 XOP which must be enabled manually. as of igor 9 and later, HDF5 is built in.</dd>
|
|
<dd>
|
|
in version 2.0, the interface has changed significantly.</dd></dl>
|
|
<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 class="obfuscator">.nosp@m.</span>ias.<span class="obfuscator">.nosp@m.</span>muntw<span class="obfuscator">.nosp@m.</span>iler<span class="obfuscator">.nosp@m.</span>@psi.<span class="obfuscator">.nosp@m.</span>ch</a></dd></dl>
|
|
<dl class="section copyright"><dt>Copyright</dt><dd>2013-22 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 class="definition">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 id="a972bf23d6da0bb33e9f12e50c9d7f5e5" name="a972bf23d6da0bb33e9f12e50c9d7f5e5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a972bf23d6da0bb33e9f12e50c9d7f5e5">◆ </a></span>kill_matching_waves()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string kill_matching_waves </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>dfr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>pattern</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>recurse</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>killed</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>kill any waves matching a pattern in the experiment </p>
|
|
<p>this may be used to kill big waves of original data before saving.</p>
|
|
<p>example: to kill all ScientaImage waves: </p><div class="fragment"><div class="line"><a class="code hl_function" href="pearl-pshell-import_8ipf.html#a972bf23d6da0bb33e9f12e50c9d7f5e5">kill_matching_waves</a>($<span class="stringliteral">"root:"</span>, <span class="stringliteral">"ScientaImage"</span>, 1)</div>
|
|
<div class="ttc" id="apearl-pshell-import_8ipf_html_a972bf23d6da0bb33e9f12e50c9d7f5e5"><div class="ttname"><a href="pearl-pshell-import_8ipf.html#a972bf23d6da0bb33e9f12e50c9d7f5e5">kill_matching_waves</a></div><div class="ttdeci">string kill_matching_waves(dfref dfr, string pattern, variable recurse, string killed=defaultValue)</div><div class="ttdoc">kill any waves matching a pattern in the experiment</div><div class="ttdef"><b>Definition</b> <a href="pearl-pshell-import_8ipf_source.html#l02557">pearl-pshell-import.ipf:2557</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02557">2557</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad2275b0b8a0a1ed05afc50ef50564243" name="ad2275b0b8a0a1ed05afc50ef50564243"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad2275b0b8a0a1ed05afc50ef50564243">◆ </a></span>ps_detect_scale()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable ps_detect_scale </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>data_df</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>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#a5a1961e05ea900e72d6a886ac5744f2d" 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 data folder contains the waves that are to be scaled. the function looks for the scan positions and diagnostics as necessary. if the scaling data is not found, the scales are not changed. the kEssentialDiags flag can be used with <a class="el" href="pearl-pshell-import_8ipf.html#ab41e955a4ff70f9c78571faad1b43d7b" title="main data loading function">psh5_load()</a> to select the necessary datasets.</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/diagnostics 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>ScientaLowEnergy</code> </li>
|
|
<li><code>ScientaHighEnergy</code> </li>
|
|
<li><code>ScientaLowThetaX</code> </li>
|
|
<li><code>ScientaHighThetaX</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">data_df</td><td>data folder which contains the waves to be scaled. this is usually the "scan" or "region" folder.</td></tr>
|
|
<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>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02229">2229</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a476f19c72d6e54787535ab6989ee778d" name="a476f19c72d6e54787535ab6989ee778d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a476f19c72d6e54787535ab6989ee778d">◆ </a></span>ps_find_attr_folder()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">dfr ps_find_attr_folder </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>scan_df</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>find the attributes data folder </p>
|
|
<p>the attributes folder contains diagnostic beamline data at each scan point. the folder can have one of several names due to different pshell versions: "attr", "attrs", or "diags" (from 2022 on). historically, the folder was named "attr" due to the area detector software.</p>
|
|
<p>assuming we are in the scan folder (where the ScanWritables, etc.) are, find the associated attributes folder. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02134">2134</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2f39f9379e66ead0d25c33adfbe05ee9" name="a2f39f9379e66ead0d25c33adfbe05ee9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2f39f9379e66ead0d25c33adfbe05ee9">◆ </a></span>ps_find_scale_wave()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">wave ps_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>df1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>df2</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>df3</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>find a wave in scan and attr data folders </p>
|
|
<p>look up a wave by name in the given three data folders. return the first one found.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">df1</td><td>first data folder to check </td></tr>
|
|
<tr><td class="paramname">df2</td><td>second data folder to check </td></tr>
|
|
<tr><td class="paramname">df3</td><td>third data folder to check </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>wave reference, empty reference if not found </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02161">2161</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a513091ea9a4e23f76765aa37f1d34055" name="a513091ea9a4e23f76765aa37f1d34055"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a513091ea9a4e23f76765aa37f1d34055">◆ </a></span>ps_find_scan_folder()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">dfr ps_find_scan_folder </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>data_df</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>find the scan folder of current data </p>
|
|
<p>assuming we are in the data folder (where the scan results, ScientaSpectrum, etc.) are, find the associated scan folder. this can either be the same (usually) or the parent folder (multi-region scans).</p>
|
|
<p>the scan folder is the one that contains the ScanWritables wave. the data and scan folders may refer to the same folder. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02111">2111</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7d7b67c9f983d3446c5c6f274284b82a" name="a7d7b67c9f983d3446c5c6f274284b82a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7d7b67c9f983d3446c5c6f274284b82a">◆ </a></span>ps_fix_folder_name()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string ps_fix_folder_name </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>group_name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>convert HDF5 group name to data folder name and fix compatibility issues </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01065">1065</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adc11ea797562b3d99c247f4866618d39" name="adc11ea797562b3d99c247f4866618d39"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adc11ea797562b3d99c247f4866618d39">◆ </a></span>ps_scale_dataset()</h2>
|
|
|
|
<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#a5a1961e05ea900e72d6a886ac5744f2d" 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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02531">2531</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2c456397c36d4116bfddca452eff5954" name="a2c456397c36d4116bfddca452eff5954"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2c456397c36d4116bfddca452eff5954">◆ </a></span>ps_scale_dataset_2()</h2>
|
|
|
|
<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#a5a1961e05ea900e72d6a886ac5744f2d" 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#ad2275b0b8a0a1ed05afc50ef50564243" 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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02392">2392</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5a1961e05ea900e72d6a886ac5744f2d" name="a5a1961e05ea900e72d6a886ac5744f2d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5a1961e05ea900e72d6a886ac5744f2d">◆ </a></span>ps_scale_datasets()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable ps_scale_datasets </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>scan_df</em></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 specified 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="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">scan_df</td><td>scan data folder. must contain the ScanReadables wave. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02486">2486</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aba25eb98e4c6cc9066c46ef6be1cde15" name="aba25eb98e4c6cc9066c46ef6be1cde15"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aba25eb98e4c6cc9066c46ef6be1cde15">◆ </a></span>ps_set_dimlabels()</h2>
|
|
|
|
<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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02031">2031</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8704627410409bcd27a1adeda4082c47" name="a8704627410409bcd27a1adeda4082c47"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8704627410409bcd27a1adeda4082c47">◆ </a></span>ps_set_dimlabels2()</h2>
|
|
|
|
<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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l02050">2050</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a47513a1db5693f88d64739a5b28926b2" name="a47513a1db5693f88d64739a5b28926b2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a47513a1db5693f88d64739a5b28926b2">◆ </a></span>psh5_close_file()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable psh5_close_file </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>file_df</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>
|
|
<p>the function requires the specified data folder to contain a variable named <code>file_id</code> that specifies the HDF5 file ID. the variable may also be in a parent folder. the variable is killed after the file has been closed. if the folder or variable can't be found, the function does nothing.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">file_df</td><td>data folder reference of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#ab684c44d5f0668631e42d9c9c9dfea9e" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder.">psh5_open_file()</a>. the reference may also point to a child folder, the function will look for a file_id variable in all parent folders.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>on the command line, data folder references can be specified using the $-notation like <code>$"foldername"</code>. the current folder is written as <code>$":"</code>. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00509">509</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa7a48b65e465abde9aad80377605ae59" name="aa7a48b65e465abde9aad80377605ae59"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa7a48b65e465abde9aad80377605ae59">◆ </a></span>psh5_create_folders()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">dfr psh5_create_folders </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasetpath</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>create all data folders along a dataset path </p>
|
|
<p>if the path ends with a slash, the path is interpreted as a group path, and each part is mapped to a data folder. else, the last part of the path is the name of a dataset and will not produce a folder.</p>
|
|
<p>the path will always be interpreted as starting from the root, regardless whether it starts with a slash or not.</p>
|
|
<p>spaces are removed from folder names, and the names are cleaned up to produce simple names.</p>
|
|
<p>a string variable named "s_hdf5_group" is added to each created folder and contains the incremental path.</p>
|
|
<p>the first child folder is created in the current data folder. at the end, the lowest child folder is selected and returned as the function result.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">datasetpath</td><td>hdf5 group path to dataset, e.g. "/scan 1/region 1/ScientaImage".</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>data folder reference of the lowest child folder. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00990">990</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acda8bf0493a2e8ba1955f12de08e28f2" name="acda8bf0493a2e8ba1955f12de08e28f2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acda8bf0493a2e8ba1955f12de08e28f2">◆ </a></span>psh5_dataset_to_folder()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">dfr psh5_dataset_to_folder </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>parent_df</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasetpath</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>map dataset path to datafolder path </p>
|
|
<p>if the path ends with a slash, the path is interpreted as a group path, and each part maps to a data folder. if the last part of the path is the name of a dataset, it is discarded.</p>
|
|
<p>spaces are removed from folder names, and the names are cleaned up to produce simple names.</p>
|
|
<p>the path is interpreted as relative to the specified parent data folder. regardless whether it starts with a slash or not.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">datasetpath</td><td>hdf5 group path to dataset, e.g. "/scan 1/region 1/ScientaImage".</td></tr>
|
|
<tr><td class="paramname">parent_df</td><td>parent data folder</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>data folder reference </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01034">1034</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4f5d11063bd50ded36ca013a2656b539" name="a4f5d11063bd50ded36ca013a2656b539"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4f5d11063bd50ded36ca013a2656b539">◆ </a></span>psh5_extract_region_paths()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_extract_region_paths </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasets</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>trim dataset paths to the scan/region part </p>
|
|
<p>return dataset paths stripped to the form /scan*‍/region*‍/.</p>
|
|
<p>the function matches each path for scan and region tokens in the first two path elements and strips off the remainder. if there are no region-based datasets, the function returns an empty string.</p>
|
|
<p>the function operates on a single path or a semicolon-separated list of paths. the items of the returned list are unique.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">datasets</td><td>semicolon separated list of dataset paths</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>list of scan/region paths (no duplicates) </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00853">853</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab86e42bb6f9ff20f685ad5627b446b77" name="ab86e42bb6f9ff20f685ad5627b446b77"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab86e42bb6f9ff20f685ad5627b446b77">◆ </a></span>psh5_extract_scan_paths()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_extract_scan_paths </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasets</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>trim dataset paths to the scan part </p>
|
|
<p>return dataset paths stripped to the form /scan*‍/.</p>
|
|
<p>the function matches each path for a scan token in the first path element and strips off the remaining path. if there are no scan-based datasets, the function returns an empty string.</p>
|
|
<p>the function operates on a single path or a semicolon-separated list of paths. the items of the returned list are unique.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">datasets</td><td>semicolon separated list of dataset paths</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>list of scan paths (no duplicates) </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00803">803</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7c191ea7367f2f328333b9986c7dd538" name="a7c191ea7367f2f328333b9986c7dd538"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7c191ea7367f2f328333b9986c7dd538">◆ </a></span>psh5_filter_datasets_rank()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_filter_datasets_rank </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasets</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>ranks</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>min_rank</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>max_rank</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>filter datasets by rank </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">datasets</td><td>semicolon-separated list of datasets to be checked.</td></tr>
|
|
<tr><td class="paramname">ranks</td><td>semicolon-separated list of ranks of each dataset.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>filtered dataset list. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00728">728</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a113622ae05611e5051a97d223fae59d0" name="a113622ae05611e5051a97d223fae59d0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a113622ae05611e5051a97d223fae59d0">◆ </a></span>psh5_list_all_datasets()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_list_all_datasets </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>file_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>list all datasets in a file </p>
|
|
<p>the function returns a list of all datasets in a file. each dataset is listed by its full path like, e.g., "/scan 1/region 1/dataset 1".</p>
|
|
<p>this function wraps a one-line HDF5 operation and is provided just to be more memorable.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">file_id</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#ab684c44d5f0668631e42d9c9c9dfea9e" 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 absolute dataset paths. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00605">605</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1889973eeedcef72c2a1c2eb5c28fed3" name="a1889973eeedcef72c2a1c2eb5c28fed3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1889973eeedcef72c2a1c2eb5c28fed3">◆ </a></span>psh5_list_dataset_info()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable[string datatypes, string ranks, string dimensions] psh5_list_dataset_info </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>variable</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>file_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>string</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">sds </td>
|
|
<td class="paramname"><em>datasets</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>list data types and dimensions of datasets </p>
|
|
<p>this function has multiple returns.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">file_id</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#ab684c44d5f0668631e42d9c9c9dfea9e" 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 (simplified) datatypes. datatypes are marked as "i" (integer), "f" (float), "s" (string) or "?" (unknown).</dd>
|
|
<dd>
|
|
semicolon-separated list of ranks (number of dimensions).</dd>
|
|
<dd>
|
|
semicolon-separated list of dimensions. each item is a comma-separated list of dimension sizes. items do not contain trailing commas. </dd></dl>
|
|
<p>filter a list of datasets by string matching</p>
|
|
<p>this function can be used to extract certain dataset paths from a list of all datasets in a file. the matching is insensitive to spaces and case.</p>
|
|
<p>examples match strings:</p><ul>
|
|
<li><code>"*&zwj;/scan1/region1/*"</code> match all datasets in scan 1, region 1</li>
|
|
<li><code>"!*&zwj;/diags/*"</code> remove diagnostics from list</li>
|
|
</ul>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">datasets</td><td>semicolon separated list of dataset paths </td></tr>
|
|
<tr><td class="paramname">match</td><td>match string for igor's StringMatch function</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>list of matching datasets</dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00631">631</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a85c1fbd2aefff2028e084ea61314dc67" name="a85c1fbd2aefff2028e084ea61314dc67"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a85c1fbd2aefff2028e084ea61314dc67">◆ </a></span>psh5_list_scans()</h2>
|
|
|
|
<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>file_id</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">file_id</td><td>ID of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#ab684c44d5f0668631e42d9c9c9dfea9e" 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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00574">574</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab41e955a4ff70f9c78571faad1b43d7b" name="ab41e955a4ff70f9c78571faad1b43d7b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab41e955a4ff70f9c78571faad1b43d7b">◆ </a></span>psh5_load()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">dfr psh5_load </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>path_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>file_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>scans</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>regions</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasets</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>classes</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>max_rank</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>reduction_func</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>reduction_params</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>dest_df</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>main data loading function </p>
|
|
<p>load the requested elements from the given file.</p>
|
|
<p>scans, regions and datasets are additive. wildcards can be used to select multiple or all datasets.</p>
|
|
<p>classes are subtractive: only datasets of specified classes are loaded. by default, only positioners, detectors, scaling and essential diagnostics are loaded.</p>
|
|
<p>essential diags, scaling, positioners related to requested detectors are always loaded</p>
|
|
<p>data reduction (if specified) applies to 3d data, see <a class="el" href="pearl-pshell-import_8ipf.html#af662500c4f992ef7b956f37ed463513d" title="load a dataset with reduced dimensionality">psh5_load_dataset_reduced()</a> for details.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path_name</td><td>igor symbolic path name. can be empty if the path is specified in file_name or a dialog box should be displayed</td></tr>
|
|
<tr><td class="paramname">file_name</td><td>if empty a dialog box shows up</td></tr>
|
|
<tr><td class="paramname">dest_df</td><td>destination folder reference. if dest_df is specified, data is loaded into this folder. else, a new folder derived from the file name is created under root:</td></tr>
|
|
<tr><td class="paramname">scans</td><td>semicolon-separated list of scan paths to load. scan groups are at the top level, their name consists of "scan", an optional space and a number. all datasets in the group and sub-groups are considered for loading unless excluded by other arguments. if empty, no datasets are loaded based on their relation to a scan. names are matched by Igor's StringMatch function. the matching is insensitive to case and spaces. to load all scans, pass "/scan*". the leading slash before "scan" can be omitted.</td></tr>
|
|
<tr><td class="paramname">regions</td><td>semicolon-separated list of region paths to load. region groups are children of scan groups, their name consists of "region", an optional space and a number. all datasets in the group and sub-groups are considered for loading unless excluded by other arguments. if empty, no datasets are loaded based on their relation to a region. names are matched by Igor's StringMatch function. the matching is insensitive to case and spaces. to load all regions of scan 1, pass "/scan1/region*". to load regions 1 of all scans, pass "/scan*&zwj;/region1". the leading slash before "scan" can be omitted.</td></tr>
|
|
<tr><td class="paramname">datasets</td><td>semicolon-separated list of dataset paths to load. this allows to load individual datasets. names are matched by Igor's StringMatch function against full dataset paths. to load all datasets named "SampleCurrent", pass "*&zwj;/SampleCurrent". the matching is insensitive to case and spaces. additional datasets may be loaded for scaling.</td></tr>
|
|
<tr><td class="paramname">classes</td><td>filter datasets (that were selected by the scans, regions and datasets arguments) by class. this allows, for example, to exclude the diagnostics. note that scaling datasets are always loaded. the value is a bit-wise switch, typically the arithmetic disjunction of kDSCXxxx constants. by default, only positioners, detectors, scaling and essential diagnostics are loaded. to completely load all datasets, specify kDSCAll.</td></tr>
|
|
<tr><td class="paramname">max_rank</td><td>load only datasets with lower or equal rank.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>data folder reference of the file-level data folder. same as dest_df if specified.</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>
|
|
<dd>
|
|
global string s_loaded_datasets in new data folder contains a list of loaded datasets. the items are full group paths of the HDF5 file. dataset paths can be mapped to loaded data folders using the psh5_dataset_to_folder function. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00158">158</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af7a6eefbda58d31336c81a3dda6e9a2d" name="af7a6eefbda58d31336c81a3dda6e9a2d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af7a6eefbda58d31336c81a3dda6e9a2d">◆ </a></span>psh5_load_dataset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_dataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>file_df</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasetpath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>create_folders</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>reduction_func</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>reduction_params</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#afc4fa60c5fbfdb08c2a9d3072d3e16ce" 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#abcf01e205858a512aa713da914eaf966" 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>
|
|
</ul>
|
|
<p>the dataset is loaded into the current data folder or a tree based on the group path given in the datasetpath argument. the function returns from the original data folder.</p>
|
|
<p>only numeric and string data types are supported, string datasets must have rank 1.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">file_df</td><td>data folder reference of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#ab684c44d5f0668631e42d9c9c9dfea9e" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder.">psh5_open_file()</a>. if undefined, the current datafolder is assumed.</td></tr>
|
|
<tr><td class="paramname">datasetpath</td><td>group path and name of the dataset, e.g. "/scan 1/ScientaImage". HDF5 groups map to igor data folders below the current data folder, the wave is placed into the leaf folder. the names of groups and waves are cleaned up to produce simple names, in particular, spaces and other illegal characters are removed.</td></tr>
|
|
<tr><td class="paramname">create_folders</td><td>if 1 (default), data folders according to the group path are created. if 0, the dataset is loaded into the current folder.</td></tr>
|
|
<tr><td class="paramname">reduction_func</td><td>data reduction function. three-dimensional datasets can be reduced in dimensionality by on-the-fly data reduction. by default (or if empty string), no reduction is applied. see <a class="el" href="pearl-pshell-import_8ipf.html#af662500c4f992ef7b956f37ed463513d">psh5_load_dataset_reduced()</a>.</td></tr>
|
|
<tr><td class="paramname">reduction_params</td><td>parameter string for the reduction function.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>semicolon-separated list of loaded wave names. multiple waves are loaded if the dataset has a compound data type. in that case the wave name is a concatenation of the dataset and field names (see HDF5LoadData). </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01176">1176</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abcf01e205858a512aa713da914eaf966" name="abcf01e205858a512aa713da914eaf966"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abcf01e205858a512aa713da914eaf966">◆ </a></span>psh5_load_dataset_meta()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable psh5_load_dataset_meta </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>file_df</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasetpath</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><em>metadata</em> are the HDF5 attributes attached to a dataset. they are mapped to "key=value" pairs and added to the wave note in separate lines. the following attributes are loaded. names and mappings are hard-coded.</p>
|
|
<ul>
|
|
<li>"Writable Dimension" -> "ScanDimension"</li>
|
|
<li>"Writable Index" -> "WriteableIndex"</li>
|
|
<li>"Readable Index" -> "ReadableIndex"</li>
|
|
</ul>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">file_df</td><td>data folder reference of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#ab684c44d5f0668631e42d9c9c9dfea9e" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder.">psh5_open_file()</a>. if undefined, the current datafolder is assumed.</td></tr>
|
|
<tr><td class="paramname">datasetpath</td><td>group path and name of the dataset. path separator is the slash "/".</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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01887">1887</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af662500c4f992ef7b956f37ed463513d" name="af662500c4f992ef7b956f37ed463513d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af662500c4f992ef7b956f37ed463513d">◆ </a></span>psh5_load_dataset_reduced()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_dataset_reduced </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>file_df</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasetpath</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_params</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>create_folders</em> = <code>defaultValue</code>, </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 dataset with reduced dimensionality </p>
|
|
<p>the function loads the dataset image by image using the hyperslab option and applies a custom reduction function like numeric integration, curve fitting, etc. 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>example reduction functions can be found in the <a class="el" href="namespace_pearl_scienta_preprocess.html">PearlScientaPreprocess</a> module. they must implement the <a class="el" href="pearl-area-import_8ipf.html#ade69cb0f82e0c9cf6082d5fcc29f742f">adh5_default_reduction()</a> interface.</p>
|
|
<p>by default, the reduction function is called in separate threads to reduce the total loading time. (<a class="el" href="pearl-pshell-import_8ipf.html#ab41e955a4ff70f9c78571faad1b43d7b" title="main data loading function">psh5_load()</a> reports the total run time in the global variable psh5_perf_secs.) the effect varies depending on the balance between file loading (image size) and data processing (complexity of the reduction function).</p>
|
|
<p>the function loads images (as hyperslabs) one by one and passes them to the reduction function. only a limited number of images are held in the queue at a time to limit memory use. for debugging the reduction function, multi-threading can be disabled (also remove threadsafe attributes from <a class="el" href="pearl-pshell-import_8ipf.html#a8089a75744ffc3626305406e925d320a">reduce_slab_image()</a> and the reduction function!)</p>
|
|
<p>if the reduction function requires the image waves to be scaled properly, the attributes must have been loaded by psh5_load_scan_attrs() 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">file_df</td><td>data folder reference of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#ab684c44d5f0668631e42d9c9c9dfea9e" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder.">psh5_open_file()</a>. if undefined, the current datafolder is assumed.</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_params</td><td>parameter string for the reduction function.</td></tr>
|
|
<tr><td class="paramname">create_folders</td><td>if 1 (default), data folders according to the group path are created. if 0, the dataset is loaded into the current folder.</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>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01472">1472</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afc4fa60c5fbfdb08c2a9d3072d3e16ce" name="afc4fa60c5fbfdb08c2a9d3072d3e16ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afc4fa60c5fbfdb08c2a9d3072d3e16ce">◆ </a></span>psh5_load_dataset_slabs()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_dataset_slabs </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>file_df</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasetpath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>create_folders</em> = <code>defaultValue</code>, </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. the wave is loaded into the current data folder.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">file_df</td><td>data folder reference of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#ab684c44d5f0668631e42d9c9c9dfea9e" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder.">psh5_open_file()</a>. if undefined, the current datafolder is assumed.</td></tr>
|
|
<tr><td class="paramname">datasetpath</td><td>group path and name of the dataset. the dataset name defines the name of the loaded wave (after cleaning up).</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>
|
|
<tr><td class="paramname">create_folders</td><td>if 1 (default), data folders according to the group path are created. if 0, the dataset is loaded into the current folder.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>semicolon-separated list of loaded wave names. in the current version, the function returns zero or one wave, as it does not support compound types. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01289">1289</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae539a7501119cb2349707e2027f0f759" name="ae539a7501119cb2349707e2027f0f759"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae539a7501119cb2349707e2027f0f759">◆ </a></span>psh5_load_datasets()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_datasets </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>file_df</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasets</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>create_folders</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>reduction_func</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>reduction_params</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load multiple datasets from open file </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">file_df</td><td>data folder reference of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#ab684c44d5f0668631e42d9c9c9dfea9e" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder.">psh5_open_file()</a>. if undefined, the current datafolder is assumed.</td></tr>
|
|
<tr><td class="paramname">create_folders</td><td>if 1 (default), data folders according to the group path are created. if 0, the dataset is loaded into the current folder. the latter option should be used with care because datasets with same names may be overwritten.</td></tr>
|
|
<tr><td class="paramname">reduction_func</td><td>data reduction function. three-dimensional datasets can be reduced in dimensionality by on-the-fly data reduction. by default (or if empty string), no reduction is applied. see <a class="el" href="pearl-pshell-import_8ipf.html#af662500c4f992ef7b956f37ed463513d">psh5_load_dataset_reduced()</a>.</td></tr>
|
|
<tr><td class="paramname">reduction_params</td><td>parameter string for the reduction function.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>(string) semicolon-separated list of loaded datasets </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01098">1098</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac782084655d44d222742e3397051619d" name="ac782084655d44d222742e3397051619d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac782084655d44d222742e3397051619d">◆ </a></span>psh5_load_general_group()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_general_group </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>file_df</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load organizational metadata from the general group. </p>
|
|
<p>the general group contains the following datasets: authors, pgroup, proposal, proposer, sample.</p>
|
|
<p>data is loaded into the current data folder. all items are loaded into strings, authors is a comma-separated list. missing items default to empty strings.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">file_df</td><td>data folder reference of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#ab684c44d5f0668631e42d9c9c9dfea9e" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder.">psh5_open_file()</a>. if undefined, the current datafolder is assumed.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>semicolon-separated list of the objects. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01803">1803</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a23a2e4cb2dc5364bfdbab4367ed6f234" name="a23a2e4cb2dc5364bfdbab4367ed6f234"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a23a2e4cb2dc5364bfdbab4367ed6f234">◆ </a></span>psh5_load_scan_meta()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_load_scan_meta </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>file_df</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>
|
|
<li>Iterations (ScanIterations) - if present (XPSSpectrum script)</li>
|
|
<li>Step Size (ScanStepSize) - if present (XPSSpectrum script)</li>
|
|
<li>Step Time (ScanStepTime) - if present (XPSSpectrum script)</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">file_df</td><td>data folder reference of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#ab684c44d5f0668631e42d9c9c9dfea9e" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder.">psh5_open_file()</a>. if undefined, the current datafolder is assumed.</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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01954">1954</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af3b5005859915f410ec27a31ac9519ca" name="af3b5005859915f410ec27a31ac9519ca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af3b5005859915f410ec27a31ac9519ca">◆ </a></span>psh5_match_dataset_classes()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh5_match_dataset_classes </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datasets</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>classes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>positioners</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>detectors</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>filter a list of datasets by classification </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">datasets</td><td>semicolon separated list of dataset paths</td></tr>
|
|
<tr><td class="paramname">classes</td><td>dataset classes. arithmetic OR of the kDSCXxxx constants.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>list of scan/region paths (no duplicates) </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00899">899</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab684c44d5f0668631e42d9c9c9dfea9e" name="ab684c44d5f0668631e42d9c9c9dfea9e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab684c44d5f0668631e42d9c9c9dfea9e">◆ </a></span>psh5_open_file()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">dfr psh5_open_file </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>path_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>file_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>dest_df</em> = <code>defaultValue</code> </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, and loads general information about the file including a list of contained datasets.</p>
|
|
<p>data can be loaded into an existing or new data folder under root.</p>
|
|
<p>the file must be closed by <a class="el" href="pearl-pshell-import_8ipf.html#a47513a1db5693f88d64739a5b28926b2" title="close a HDF5 file opened by psh5_open_file.">psh5_close_file()</a> after use. the HDF5 file ID is stored in the global variable file_id until the file is closed.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path_name</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">file_name</td><td>if empty a dialog box shows up</td></tr>
|
|
<tr><td class="paramname">dest_df</td><td>destination folder reference. if dest_df is specified, data is loaded into this folder. else, by default, a new folder derived from the file name is created in root:</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the return value of the function is a data folder reference of the created data folder.</dd>
|
|
<dd>
|
|
global variable file_id contains ID number 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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00450">450</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a24afba76ed5323d8cd0abc3c7b0d9912" name="a24afba76ed5323d8cd0abc3c7b0d9912"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a24afba76ed5323d8cd0abc3c7b0d9912">◆ </a></span>psh5_preview()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">dfr psh5_preview </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>path_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>file_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>dest_df</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>preview_datasets</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load preview </p>
|
|
<p>load information about the file structure and a preview dataset </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00345">345</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a72465006d4e8379fad08d1a1064de2a3" name="a72465006d4e8379fad08d1a1064de2a3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a72465006d4e8379fad08d1a1064de2a3">◆ </a></span>psh_load_general_string()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string psh_load_general_string </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>file_df</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>load a string from the general group. </p>
|
|
<p>the general group contains the following datasets: authors, pgroup, proposal, proposer, sample.</p>
|
|
<p>data is loaded into a global string in the current data folder. arrays with multiple items are loaded into a comma-separated list. a missing item defaults to the empty string.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">file_df</td><td>data folder reference of open HDF5 file from <a class="el" href="pearl-pshell-import_8ipf.html#ab684c44d5f0668631e42d9c9c9dfea9e" title="open a HDF5 file created by the PShell data acquisition program and prepare the data folder.">psh5_open_file()</a>. if undefined, the current datafolder is assumed.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>comma-separated list of values. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01838">1838</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8089a75744ffc3626305406e925d320a" name="a8089a75744ffc3626305406e925d320a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8089a75744ffc3626305406e925d320a">◆ </a></span>reduce_slab_image()</h2>
|
|
|
|
<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_params</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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01776">1776</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a33f8faf117450af1d6dae9ef48786cd6" name="a33f8faf117450af1d6dae9ef48786cd6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a33f8faf117450af1d6dae9ef48786cd6">◆ </a></span>reduce_slab_worker()</h2>
|
|
|
|
<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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l01737">1737</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a92a18d6e81c3f521ba3bb240eaf578a9" name="a92a18d6e81c3f521ba3bb240eaf578a9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a92a18d6e81c3f521ba3bb240eaf578a9">◆ </a></span>twave2list()</h2>
|
|
|
|
<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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00532">532</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae2aedcb7028cccdb683c43411cc8f1e2" name="ae2aedcb7028cccdb683c43411cc8f1e2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae2aedcb7028cccdb683c43411cc8f1e2">◆ </a></span>unique_strings()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string unique_strings </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>list</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>remove duplicate items from list </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">list</td><td>semicolon-separated list of strings. strings can contain any printable character except the semicolon.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>list of strings with duplicates (second and further instances) removed. all remaining items retain the position of their first occurrence in the original list. the function uses Igor's FindDuplicates operation. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00764">764</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa6dc3e3f7dc1ca4346132635a90fc447" name="aa6dc3e3f7dc1ca4346132635a90fc447"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa6dc3e3f7dc1ca4346132635a90fc447">◆ </a></span>wave2list()</h2>
|
|
|
|
<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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00549">549</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 id="a83930d4384b0238fc8416ba03dbc0386" name="a83930d4384b0238fc8416ba03dbc0386"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a83930d4384b0238fc8416ba03dbc0386">◆ </a></span>kAngleDimLabel</h2>
|
|
|
|
<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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00053">53</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a277cd450cca7832aa44f8097934e6acb" name="a277cd450cca7832aa44f8097934e6acb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a277cd450cca7832aa44f8097934e6acb">◆ </a></span>kDataDimLabel</h2>
|
|
|
|
<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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00060">60</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a237e95f14b988f58e2d4c37659f17347" name="a237e95f14b988f58e2d4c37659f17347"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a237e95f14b988f58e2d4c37659f17347">◆ </a></span>kDSCAll</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kDSCAll = 0xffff</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">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 id="a10224f615973777a43fefae8eb1a39f2" name="a10224f615973777a43fefae8eb1a39f2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a10224f615973777a43fefae8eb1a39f2">◆ </a></span>kDSCAttrs</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kDSCAttrs = 0x0020</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00079">79</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7c5aaa2f133862ae16ddd735df1ab73d" name="a7c5aaa2f133862ae16ddd735df1ab73d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7c5aaa2f133862ae16ddd735df1ab73d">◆ </a></span>kDSCDetectors</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kDSCDetectors = 0x0002</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00075">75</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adf778206fa825ab5006bd553c64a8760" name="adf778206fa825ab5006bd553c64a8760"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adf778206fa825ab5006bd553c64a8760">◆ </a></span>kDSCDiags</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kDSCDiags = 0x0040</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">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 id="aebf53e3de392d631b340ee0747b8bbbf" name="aebf53e3de392d631b340ee0747b8bbbf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aebf53e3de392d631b340ee0747b8bbbf">◆ </a></span>kDSCEssentialDiags</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kDSCEssentialDiags = 0x0010</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00078">78</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a712ea7a6f18ce4178fd06b07d2d05a9f" name="a712ea7a6f18ce4178fd06b07d2d05a9f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a712ea7a6f18ce4178fd06b07d2d05a9f">◆ </a></span>kDSCMeta</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kDSCMeta = 0x0100</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00082">82</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a300847a8e08161a64a199a6e7ef165c8" name="a300847a8e08161a64a199a6e7ef165c8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a300847a8e08161a64a199a6e7ef165c8">◆ </a></span>kDSCMonitors</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kDSCMonitors = 0x0200</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">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>
|
|
<a id="ac81d8f4276cf7bb86a74796cc7199e42" name="ac81d8f4276cf7bb86a74796cc7199e42"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac81d8f4276cf7bb86a74796cc7199e42">◆ </a></span>kDSCOther</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kDSCOther = 0x8000</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00085">85</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeb9a7f56922ff3c862e8b29b5090c01a" name="aeb9a7f56922ff3c862e8b29b5090c01a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeb9a7f56922ff3c862e8b29b5090c01a">◆ </a></span>kDSCPositioners</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kDSCPositioners = 0x0001</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">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 id="a654f0b9fe8770a8bd09a6da4182ca3bc" name="a654f0b9fe8770a8bd09a6da4182ca3bc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a654f0b9fe8770a8bd09a6da4182ca3bc">◆ </a></span>kDSCPreview</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kDSCPreview = 0x0008</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">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 id="a48f07030482af8315447ac2c598edd0d" name="a48f07030482af8315447ac2c598edd0d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a48f07030482af8315447ac2c598edd0d">◆ </a></span>kDSCRegions</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kDSCRegions = 0x0400</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00084">84</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab7c2cc8687f6d4550ef90c538b938dad" name="ab7c2cc8687f6d4550ef90c538b938dad"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab7c2cc8687f6d4550ef90c538b938dad">◆ </a></span>kDSCScientaScaling</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kDSCScientaScaling = 0x0004</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00076">76</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3236744797a780eb144a684b0bd41d4a" name="a3236744797a780eb144a684b0bd41d4a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3236744797a780eb144a684b0bd41d4a">◆ </a></span>kDSCSnaps</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kDSCSnaps = 0x0080</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00081">81</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5ad52cb10171572c454f9426d3a9be21" name="a5ad52cb10171572c454f9426d3a9be21"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5ad52cb10171572c454f9426d3a9be21">◆ </a></span>kEnergyDimLabel</h2>
|
|
|
|
<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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00050">50</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab0bc752ab76659b492cf88c75935336b" name="ab0bc752ab76659b492cf88c75935336b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab0bc752ab76659b492cf88c75935336b">◆ </a></span>kEssentialDiagnostics</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string kEssentialDiagnostics = "ManipulatorX;ManipulatorY;ManipulatorZ;ManipulatorTheta;ManipulatorTilt;ManipulatorPhi;MonoEnergy;"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>List of diagnostic datasets that are normally loaded with a scan. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00069">69</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3c72087695969f42ea91c000de47b26e" name="a3c72087695969f42ea91c000de47b26e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3c72087695969f42ea91c000de47b26e">◆ </a></span>kPreviewDatasets</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string kPreviewDatasets = "ImageEnergyDistribution;ScientaSpectrum;ScientaImage;Counts;SampleCurrent;"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>List of preferred datasets to load for preview. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00063">63</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a412b4753ceb753d705a113a26c018b22" name="a412b4753ceb753d705a113a26c018b22"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a412b4753ceb753d705a113a26c018b22">◆ </a></span>kScanDimLabel</h2>
|
|
|
|
<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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00056">56</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a03f00b3299bc3df671fcc239f7dd5418" name="a03f00b3299bc3df671fcc239f7dd5418"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a03f00b3299bc3df671fcc239f7dd5418">◆ </a></span>kScientaScalingDatasets</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string kScientaScalingDatasets = "LensMode;ScientaChannelBegin;ScientaChannelEnd;ScientaSliceBegin;ScientaSliceEnd;Eph;ScientaHighEnergy;ScientaHighThetaX;ScientaLowEnergy;ScientaLowThetaX;"</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 class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00066">66</a> of file <a class="el" href="pearl-pshell-import_8ipf_source.html">pearl-pshell-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0f2c168c04d075734edb995361aefb82" name="a0f2c168c04d075734edb995361aefb82"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0f2c168c04d075734edb995361aefb82">◆ </a></span>kTransposedDatasets</h2>
|
|
|
|
<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 must be transposed upon loading. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pshell-import_8ipf_source.html#l00072">72</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 Mon Dec 22 2025 17:26:40 for PEARL Procedures by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|