matthias muntwiler
cf1399e59c
FEATURES - pshell: convert scienta data to true counts - pre-process: add gauss2_reduction data reduction function - anglescan: add set_contrast and normalize_strip_phi functions - explorer: show info about multi-region scans - documentation: add detailed instructions for angle-scan processing BUGFIXES - explorer: fix attributes notebook - pshell: fix progress bar - elog: increase the number of accepted attachments
1295 lines
67 KiB
HTML
1295 lines
67 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
|
<title>PEARL Procedures: pearl-area-import.ipf File Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">PEARL Procedures
|
|
 <span id="projectnumber">rev-distro-1.4.0-1-g0a436db-dirty</span>
|
|
</div>
|
|
<div id="projectbrief">Igor procedures for the analysis of PEARL data</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Packages</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('pearl-area-import_8ipf.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">pearl-area-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>HDF5 file import from EPICS area detectors.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <HDF5 Browser></code><br />
|
|
<code>#include "pearl-gui-tools"</code><br />
|
|
</div>
|
|
<p><a href="pearl-area-import_8ipf_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:namespace_pearl_area_import"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_pearl_area_import.html">PearlAreaImport</a></td></tr>
|
|
<tr class="memdesc:namespace_pearl_area_import"><td class="mdescLeft"> </td><td class="mdescRight">HDF5 file import from EPICS area detectors. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ae2cfa1ac6651cfc3fb0dfce03494995b"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#ae2cfa1ac6651cfc3fb0dfce03494995b">BeforeFileOpenHook</a> (variable refNum, string fileName, string path, string type, string creator, variable kind)</td></tr>
|
|
<tr class="memdesc:ae2cfa1ac6651cfc3fb0dfce03494995b"><td class="mdescLeft"> </td><td class="mdescRight">callback function for drag&drop of HDF5 files into Igor. <a href="#ae2cfa1ac6651cfc3fb0dfce03494995b">More...</a><br /></td></tr>
|
|
<tr class="separator:ae2cfa1ac6651cfc3fb0dfce03494995b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad28dbbba73e553f7b5dcf8baf1c86786"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#ad28dbbba73e553f7b5dcf8baf1c86786">ad_suggest_foldername</a> (string filename, variable ignoredate=defaultValue, string sourcename=defaultValue, variable unique=defaultValue)</td></tr>
|
|
<tr class="memdesc:ad28dbbba73e553f7b5dcf8baf1c86786"><td class="mdescLeft"> </td><td class="mdescRight">generate the name of a data folder based on a file name. <a href="#ad28dbbba73e553f7b5dcf8baf1c86786">More...</a><br /></td></tr>
|
|
<tr class="separator:ad28dbbba73e553f7b5dcf8baf1c86786"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aedff2e67d2e1bac907f2eaf24a6e5c3c"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#aedff2e67d2e1bac907f2eaf24a6e5c3c">ad_load_dialog</a> (string APathName)</td></tr>
|
|
<tr class="memdesc:aedff2e67d2e1bac907f2eaf24a6e5c3c"><td class="mdescLeft"> </td><td class="mdescRight">load area detector data files selected in a file dialog window <a href="#aedff2e67d2e1bac907f2eaf24a6e5c3c">More...</a><br /></td></tr>
|
|
<tr class="separator:aedff2e67d2e1bac907f2eaf24a6e5c3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1040bf272c69dc69777b2f91df41fab"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#ab1040bf272c69dc69777b2f91df41fab">adh5_load_complete</a> (string ANickName, string APathName, string AFileName, variable load_data=defaultValue, variable load_attr=defaultValue)</td></tr>
|
|
<tr class="memdesc:ab1040bf272c69dc69777b2f91df41fab"><td class="mdescLeft"> </td><td class="mdescRight">import everything from a HDF5 file created by the Area Detector software. <a href="#ab1040bf272c69dc69777b2f91df41fab">More...</a><br /></td></tr>
|
|
<tr class="separator:ab1040bf272c69dc69777b2f91df41fab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a98f9339cd2fae80d0d92451df88395aa"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#a98f9339cd2fae80d0d92451df88395aa">adh5_load_reduced</a> (string ANickName, string APathName, string AFileName, funcref reduction_func, string reduction_param, variable load_data=defaultValue, variable load_attr=defaultValue, variable progress=defaultValue)</td></tr>
|
|
<tr class="memdesc:a98f9339cd2fae80d0d92451df88395aa"><td class="mdescLeft"> </td><td class="mdescRight">load and reduce a dataset from a HDF5 file created by the Area Detector software. <a href="#a98f9339cd2fae80d0d92451df88395aa">More...</a><br /></td></tr>
|
|
<tr class="separator:a98f9339cd2fae80d0d92451df88395aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a98f29671bdce6a5981e8865de8b9d483"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#a98f29671bdce6a5981e8865de8b9d483">adh5_load_preview</a> (string ANickName, string APathName, string AFileName, variable load_data=defaultValue, variable load_attr=defaultValue)</td></tr>
|
|
<tr class="memdesc:a98f29671bdce6a5981e8865de8b9d483"><td class="mdescLeft"> </td><td class="mdescRight">load a single image from a HDF5 file created by the Area Detector software. <a href="#a98f29671bdce6a5981e8865de8b9d483">More...</a><br /></td></tr>
|
|
<tr class="separator:a98f29671bdce6a5981e8865de8b9d483"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac76d5ba94a3d7c864437420d80c77064"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#ac76d5ba94a3d7c864437420d80c77064">adh5_load_info</a> (string APathName, string AFileName)</td></tr>
|
|
<tr class="memdesc:ac76d5ba94a3d7c864437420d80c77064"><td class="mdescLeft"> </td><td class="mdescRight">load descriptive info from a HDF5 file created by the Area Detector software. <a href="#ac76d5ba94a3d7c864437420d80c77064">More...</a><br /></td></tr>
|
|
<tr class="separator:ac76d5ba94a3d7c864437420d80c77064"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84dc7f466b42dde5d96c49827b2122cf"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#a84dc7f466b42dde5d96c49827b2122cf">adh5_load_detector</a> (variable fileID, string detectorpath)</td></tr>
|
|
<tr class="memdesc:a84dc7f466b42dde5d96c49827b2122cf"><td class="mdescLeft"> </td><td class="mdescRight">load the detector dataset from the open HDF5 file. <a href="#a84dc7f466b42dde5d96c49827b2122cf">More...</a><br /></td></tr>
|
|
<tr class="separator:a84dc7f466b42dde5d96c49827b2122cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acfa6d2675e63f4f686289ef853b262a9"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#acfa6d2675e63f4f686289ef853b262a9">adh5_redim</a> (wave data)</td></tr>
|
|
<tr class="memdesc:acfa6d2675e63f4f686289ef853b262a9"><td class="mdescLeft"> </td><td class="mdescRight">redimension a multi-dimensional area detector array loaded from HDF5. <a href="#acfa6d2675e63f4f686289ef853b262a9">More...</a><br /></td></tr>
|
|
<tr class="separator:acfa6d2675e63f4f686289ef853b262a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa3cdc56096a6a1bf2a2d80a6245a36d2"><td class="memItemLeft" align="right" valign="top">static dfr </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#aa3cdc56096a6a1bf2a2d80a6245a36d2">GetAttrDataFolderDFR</a> (wave data)</td></tr>
|
|
<tr class="memdesc:aa3cdc56096a6a1bf2a2d80a6245a36d2"><td class="mdescLeft"> </td><td class="mdescRight">find the attributes data folder of an area detector dataset. <a href="#aa3cdc56096a6a1bf2a2d80a6245a36d2">More...</a><br /></td></tr>
|
|
<tr class="separator:aa3cdc56096a6a1bf2a2d80a6245a36d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a774751d1857ea6946a942448dc913128"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#a774751d1857ea6946a942448dc913128">adh5_scale</a> (wave data, string source=defaultValue)</td></tr>
|
|
<tr class="memdesc:a774751d1857ea6946a942448dc913128"><td class="mdescLeft"> </td><td class="mdescRight">set the dimension scales of an area detector dataset. <a href="#a774751d1857ea6946a942448dc913128">More...</a><br /></td></tr>
|
|
<tr class="separator:a774751d1857ea6946a942448dc913128"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a9741d1c19b10bb98b73bd5163a497b"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#a4a9741d1c19b10bb98b73bd5163a497b">adh5_load_detector_slabs</a> (variable fileID, string detectorpath, variable progress=defaultValue)</td></tr>
|
|
<tr class="memdesc:a4a9741d1c19b10bb98b73bd5163a497b"><td class="mdescLeft"> </td><td class="mdescRight">load the detector dataset from the open HDF5 file. <a href="#a4a9741d1c19b10bb98b73bd5163a497b">More...</a><br /></td></tr>
|
|
<tr class="separator:a4a9741d1c19b10bb98b73bd5163a497b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a931a7bfaaf75d308a0ce3c74ffc751bc"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#a931a7bfaaf75d308a0ce3c74ffc751bc">adh5_load_detector_image</a> (variable fileID, string detectorpath, variable dim2start, variable dim2count, variable dim3start, variable dim3count)</td></tr>
|
|
<tr class="memdesc:a931a7bfaaf75d308a0ce3c74ffc751bc"><td class="mdescLeft"> </td><td class="mdescRight">load a single image from the detector dataset of the open HDF5 file <a href="#a931a7bfaaf75d308a0ce3c74ffc751bc">More...</a><br /></td></tr>
|
|
<tr class="separator:a931a7bfaaf75d308a0ce3c74ffc751bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa5e29dc1a380311d00a5f85be867e47b"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#aa5e29dc1a380311d00a5f85be867e47b">adh5_list_reduction_funcs</a> ()</td></tr>
|
|
<tr class="memdesc:aa5e29dc1a380311d00a5f85be867e47b"><td class="mdescLeft"> </td><td class="mdescRight">get a list of functions which can be used as reduction functions. <a href="#aa5e29dc1a380311d00a5f85be867e47b">More...</a><br /></td></tr>
|
|
<tr class="separator:aa5e29dc1a380311d00a5f85be867e47b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a245034d7a94536a24c78a7bfe22725b7"><td class="memItemLeft" align="right" valign="top">threadsafe variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#a245034d7a94536a24c78a7bfe22725b7">adh5_default_reduction</a> (wave source, wave dest1, wave dest2, string *param)</td></tr>
|
|
<tr class="memdesc:a245034d7a94536a24c78a7bfe22725b7"><td class="mdescLeft"> </td><td class="mdescRight">function prototype for adh5_load_reduced_detector <a href="#a245034d7a94536a24c78a7bfe22725b7">More...</a><br /></td></tr>
|
|
<tr class="separator:a245034d7a94536a24c78a7bfe22725b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9439de3b676e686eeca4e6b2588c01a6"><td class="memItemLeft" align="right" valign="top">threadsafe variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#a9439de3b676e686eeca4e6b2588c01a6">adh5_setup_profile</a> (wave image, wave profile, variable dim)</td></tr>
|
|
<tr class="memdesc:a9439de3b676e686eeca4e6b2588c01a6"><td class="mdescLeft"> </td><td class="mdescRight">set up a one-dimensional wave for a line profile based on a 2D original wave. <a href="#a9439de3b676e686eeca4e6b2588c01a6">More...</a><br /></td></tr>
|
|
<tr class="separator:a9439de3b676e686eeca4e6b2588c01a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a706fb32ee79b589366dec1cf9f7e9d02"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#a706fb32ee79b589366dec1cf9f7e9d02">adh5_test_reduction_func</a> (wave source, wave dest1, wave dest2, funcref reduction_func, string reduction_param)</td></tr>
|
|
<tr class="memdesc:a706fb32ee79b589366dec1cf9f7e9d02"><td class="mdescLeft"> </td><td class="mdescRight">wrapper function for testing reduction functions from the command line. <a href="#a706fb32ee79b589366dec1cf9f7e9d02">More...</a><br /></td></tr>
|
|
<tr class="separator:a706fb32ee79b589366dec1cf9f7e9d02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3f2ac36f961941e46e80a775de8300e5"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#a3f2ac36f961941e46e80a775de8300e5">adh5_load_reduced_detector</a> (variable fileID, string detectorpath, funcref reduction_func, string reduction_param, variable progress=defaultValue, variable nthreads=defaultValue)</td></tr>
|
|
<tr class="memdesc:a3f2ac36f961941e46e80a775de8300e5"><td class="mdescLeft"> </td><td class="mdescRight">load a reduced detector dataset from the open HDF5 file. <a href="#a3f2ac36f961941e46e80a775de8300e5">More...</a><br /></td></tr>
|
|
<tr class="separator:a3f2ac36f961941e46e80a775de8300e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a33f8faf117450af1d6dae9ef48786cd6"><td class="memItemLeft" align="right" valign="top">static threadsafe variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-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:acf0315ec8a3e927ef161a35cb05adb8b"><td class="memItemLeft" align="right" valign="top">static threadsafe variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#acf0315ec8a3e927ef161a35cb05adb8b">reduce_slab_image</a> (wave slabdata, wave image, wave profile1, wave profile2, funcref reduction_func, string reduction_param)</td></tr>
|
|
<tr class="separator:acf0315ec8a3e927ef161a35cb05adb8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acde16dc7a393250b17165344f865f7b5"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#acde16dc7a393250b17165344f865f7b5">adh5_loadattr_all</a> (variable fileID, string attributespath)</td></tr>
|
|
<tr class="memdesc:acde16dc7a393250b17165344f865f7b5"><td class="mdescLeft"> </td><td class="mdescRight">load an NDAttributes group from an open HDF5 file into the current data folder. <a href="#acde16dc7a393250b17165344f865f7b5">More...</a><br /></td></tr>
|
|
<tr class="separator:acde16dc7a393250b17165344f865f7b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac98a5f2d12b559aba4e53192c49a7743"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#ac98a5f2d12b559aba4e53192c49a7743">read_attribute_info</a> (string datawavename, string source, variable *idest)</td></tr>
|
|
<tr class="memdesc:ac98a5f2d12b559aba4e53192c49a7743"><td class="mdescLeft"> </td><td class="mdescRight">sub-function of adh5_loadattr_all. <a href="#ac98a5f2d12b559aba4e53192c49a7743">More...</a><br /></td></tr>
|
|
<tr class="separator:ac98a5f2d12b559aba4e53192c49a7743"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a227e4db1c51a910dcf86d355473fe74e"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#a227e4db1c51a910dcf86d355473fe74e">adh5_scale_scienta</a> (wave data)</td></tr>
|
|
<tr class="memdesc:a227e4db1c51a910dcf86d355473fe74e"><td class="mdescLeft"> </td><td class="mdescRight">set the energy and angle scales of an area detector dataset from the Scienta analyser. <a href="#a227e4db1c51a910dcf86d355473fe74e">More...</a><br /></td></tr>
|
|
<tr class="separator:a227e4db1c51a910dcf86d355473fe74e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1fdcc02340375afe8d8cd7537c6e9cfb"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#a1fdcc02340375afe8d8cd7537c6e9cfb">adh5_scale_scan</a> (wave data)</td></tr>
|
|
<tr class="memdesc:a1fdcc02340375afe8d8cd7537c6e9cfb"><td class="mdescLeft"> </td><td class="mdescRight">scales the extra dimensions of an area detector dataset according to the EPICS scan <a href="#a1fdcc02340375afe8d8cd7537c6e9cfb">More...</a><br /></td></tr>
|
|
<tr class="separator:a1fdcc02340375afe8d8cd7537c6e9cfb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>HDF5 file import from EPICS area detectors. </p>
|
|
<p>HDF5 file import from EPICS area detectors such as CCD cameras, 2D electron analysers</p>
|
|
<p>as of Igor 6.3, Igor can open datasets of up to rank 4. i.e. the extra dimension Y of the file plugin cannot be used. the extra dimensions N and X are supported. </p>
|
|
|
|
<p>Definition in file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="aedff2e67d2e1bac907f2eaf24a6e5c3c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable ad_load_dialog </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>APathName</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load area detector data files selected in a file dialog window </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">APathName</td><td>Igor symbolic path name. if empty, Igor will choose a folder on its own </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00159">159</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad28dbbba73e553f7b5dcf8baf1c86786"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string ad_suggest_foldername </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>filename</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>ignoredate</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>sourcename</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>unique</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>generate the name of a data folder based on a file name. </p>
|
|
<p>if the file name follows the naming convention source-date-index.extension, the function tries to generate the nick name as source_date_index. otherwise it's just a cleaned up version of the file name.</p>
|
|
<p>date must be in yyyymmdd or yymmdd format and is clipped to the short yymmdd format. index should be a running numeric index of up to 6 digits, or the time encoded as hhmmss. however, in the current version index can be any string that can be a valid Igor folder name.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">filename</td><td>file name, including extension. can also include a folder path (which is ignored). the extension is currently ignored, but may be used to select the parent folder in a later version. </td></tr>
|
|
<tr><td class="paramname">ignoredate</td><td>if non-zero, the nick name will not include the date part. defaults to zero. </td></tr>
|
|
<tr><td class="paramname">sourcename</td><td>nick name of the data source. by default, the function tries to detect the source from the file name. this option can be used to override auto-detection. the automatic source names are: sci (scienta by area detector), psh (pshell), sl (optics slit camera by area detector), es (end station camera by area detector), xy (unidentified). </td></tr>
|
|
<tr><td class="paramname">unique</td><td>if non-zero, the resulting name is made a unique data folder name in the current data folder defaults to zero. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00098">98</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a245034d7a94536a24c78a7bfe22725b7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">threadsafe variable adh5_default_reduction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>dest1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>dest2</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string * </td>
|
|
<td class="paramname"><em>param</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>function prototype for adh5_load_reduced_detector </p>
|
|
<p>derived functions reduce a two-dimensional dataset to a one-dimensional dataset, e.g. by ROI-integration, curve fitting, etc. each destination wave is a one-dimensional intensity distribution. the function must redimension each of these waves to one of the image dimensions by calling the <a class="el" href="pearl-area-import_8ipf.html#a9439de3b676e686eeca4e6b2588c01a6" title="set up a one-dimensional wave for a line profile based on a 2D original wave. ">adh5_setup_profile()</a> function. this function will also copy the scale information and dimension labels, which is important for the proper scaling of the result.</p>
|
|
<p>the meaning of the data in dest1 and dest2 is up to the particular function, e.g. dest1 could hold the mean value and dest2 the one-sigma error, or dest1 could hold the X-profile, and dest2 the Y-profile.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">source</td><td>source wave two-dimensional intensity distribution (image) </td></tr>
|
|
<tr><td class="paramname">dest1,dest2</td><td>destination waves </td></tr>
|
|
<tr><td class="paramname">param</td><td>string with optional parameters, shared between calls. this is a pass-by-reference argument, the function may modify the string</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>zero if successful, non-zero if an error occurs. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01093">1093</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa5e29dc1a380311d00a5f85be867e47b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string adh5_list_reduction_funcs </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get a list of functions which can be used as reduction functions. </p>
|
|
<p>the function evaluates only the function arguments, it may thus include functions which are not suitable as reduction functions. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01033">1033</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab1040bf272c69dc69777b2f91df41fab"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string adh5_load_complete </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>ANickName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>APathName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>AFileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>load_data</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>load_attr</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>import everything from a HDF5 file created by the Area Detector software. </p>
|
|
<p>if the data is from the electron analyser driver and some special attributes are included, the function will set the scales of the image dimensions.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ANickName</td><td>destination folder name (top level under root) </td></tr>
|
|
<tr><td class="paramname">APathName</td><td>igor symbolic path name. can be empty if the path is specified in FileName or a dialog box should be displayed </td></tr>
|
|
<tr><td class="paramname">AFileName</td><td>if empty a dialog box shows up </td></tr>
|
|
<tr><td class="paramname">load_data</td><td>1 (default): load data; 0: do not load data </td></tr>
|
|
<tr><td class="paramname">load_attr</td><td>1 (default): load attributes; 0: do not load attributes for proper wave scaling, the attributes must be loaded </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00199">199</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a84dc7f466b42dde5d96c49827b2122cf"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable adh5_load_detector </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>detectorpath</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load the detector dataset from the open HDF5 file. </p>
|
|
<p>the function loads the whole dataset at once and redimensions it so that the image dimensions are X and Y</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from HDF5OpenFile </td></tr>
|
|
<tr><td class="paramname">detectorpath</td><td>path to detector group in the HDF5 file </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00573">573</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a931a7bfaaf75d308a0ce3c74ffc751bc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable adh5_load_detector_image </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>detectorpath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>dim2start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>dim2count</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>dim3start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>dim3count</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load a single image from the detector dataset of the open HDF5 file </p>
|
|
<p>the function can average over a region in the extra dimensions.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from HDF5OpenFile </td></tr>
|
|
<tr><td class="paramname">detectorpath</td><td>path to detector group in the HDF5 file </td></tr>
|
|
<tr><td class="paramname">dim2start</td><td>2nd dimension coordinate of the first image note that the order of dimensions is reversed in the file 2nd dimension = N dimension in area detector = dimension 0 of the three-dimensional HDF dataset set to 0 if dimension may not be present </td></tr>
|
|
<tr><td class="paramname">dim2count</td><td>number of subsequent images to average set to 1 if dimension may not be present </td></tr>
|
|
<tr><td class="paramname">dim3start</td><td>3rd dimension coordinate of the first image note that the order of dimensions is reversed in the file 3rd dimension = extra X dimension in area detector = dimension 0 of the four-dimensional HDF dataset set to 0 if dimension may not be present </td></tr>
|
|
<tr><td class="paramname">dim3count</td><td>number of subsequent images to average set to 1 if dimension may not be present </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00937">937</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4a9741d1c19b10bb98b73bd5163a497b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable adh5_load_detector_slabs </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>detectorpath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>progress</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load the detector dataset from the open HDF5 file. </p>
|
|
<p>the function loads the dataset image by image using the hyperslab option. this function gives the same result as adh5_load_detector. it is about 5% slower, and it depends on HDF5 Browser code. but it does not choke on large datasets (as long as the final wave fits into memory).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from HDF5OpenFile. </td></tr>
|
|
<tr><td class="paramname">detectorpath</td><td>path to detector group in the HDF5 file. </td></tr>
|
|
<tr><td class="paramname">progress</td><td>1 (default): show progress window; 0: do not show progress window.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful, non-zero if an error occurred. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00772">772</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac76d5ba94a3d7c864437420d80c77064"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string adh5_load_info </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>APathName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>AFileName</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load descriptive info from a HDF5 file created by the Area Detector software. </p>
|
|
<p>the information returned is the array size and active scans</p>
|
|
<dl class="section attention"><dt>Attention</dt><dd>EXPERIMENTAL this function should be merged with adh5_load_preview</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">APathName</td><td>igor symbolic path name. can be empty if the path is specified in FileName or a dialog box should be displayed </td></tr>
|
|
<tr><td class="paramname">AFileName</td><td>if empty a dialog box shows up </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00489">489</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a98f29671bdce6a5981e8865de8b9d483"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string adh5_load_preview </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>ANickName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>APathName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>AFileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>load_data</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>load_attr</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load a single image from a HDF5 file created by the Area Detector software. </p>
|
|
<p>the data wave is loaded into the current data folder. attributes are loaded into the attr subfolder. existing waves in attr are deleted.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>EXPERIMENTAL this function uses the root:pearl_area:preview data folder. existing data there may be deleted!</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ANickName</td><td>destination wave name. the wave is created in the current data folder. </td></tr>
|
|
<tr><td class="paramname">APathName</td><td>igor symbolic path name. can be empty if the path is specified in FileName or a dialog box should be displayed </td></tr>
|
|
<tr><td class="paramname">AFileName</td><td>if empty a dialog box shows up </td></tr>
|
|
<tr><td class="paramname">load_data</td><td>1 (default): load data; 0: do not load data </td></tr>
|
|
<tr><td class="paramname">load_attr</td><td>1 (default): load attributes; 0: do not load attributes note: for correct scaling of the image, the attributes need to be loaded </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00379">379</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a98f9339cd2fae80d0d92451df88395aa"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string adh5_load_reduced </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>ANickName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>APathName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>AFileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">funcref </td>
|
|
<td class="paramname"><em>reduction_func</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>reduction_param</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>load_data</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>load_attr</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">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 and reduce a dataset from a HDF5 file created by the Area Detector software. </p>
|
|
<p>the resulting dataset is reduced in one image dimension by a user-defined reduction function, e.g. by region-of-interest integration, curve fitting, etc.</p>
|
|
<p>the function loads the dataset image by image using the hyperslab option and applies a custom reduction function to each image. the results from the reduction function are composed into one result wave. the raw data are discarded.</p>
|
|
<p>if the data is from the electron analyser driver and some special attributes are included, the function will set the scales of the image dimensions.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ANickName</td><td>destination folder name (top level under root) </td></tr>
|
|
<tr><td class="paramname">APathName</td><td>igor symbolic path name. can be empty if the path is specified in FileName or a dialog box should be displayed </td></tr>
|
|
<tr><td class="paramname">AFileName</td><td>if empty a dialog box shows up</td></tr>
|
|
<tr><td class="paramname">reduction_func</td><td>custom reduction function (any user-defined function which has the same parameters as <a class="el" href="pearl-area-import_8ipf.html#a245034d7a94536a24c78a7bfe22725b7" title="function prototype for adh5_load_reduced_detector ">adh5_default_reduction()</a>) </td></tr>
|
|
<tr><td class="paramname">reduction_param</td><td>parameter string for the reduction function</td></tr>
|
|
<tr><td class="paramname">load_data</td><td>1 (default): load data; 0: do not load data </td></tr>
|
|
<tr><td class="paramname">load_attr</td><td>1 (default): load attributes; 0: do not load attributes for proper wave scaling, the attributes must be loaded </td></tr>
|
|
<tr><td class="paramname">progress</td><td>1 (default): show progress window; 0: do not show progress window </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00294">294</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3f2ac36f961941e46e80a775de8300e5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable adh5_load_reduced_detector </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>detectorpath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">funcref </td>
|
|
<td class="paramname"><em>reduction_func</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>reduction_param</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>progress</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>nthreads</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load a reduced detector dataset from the open HDF5 file. </p>
|
|
<p>the function loads the dataset image by image using the hyperslab option and applies a custom reduction function to each image. the results from the reduction function are composed into one result wave. the raw data are discarded.</p>
|
|
<p>by default, the reduction function is called in separate threads to reduce the total loading time. (see the global variable adh5_perf_secs which reports the total run time of the function.) the effect varies depending on the balance between file loading (image size) and data processing (complexity of the reduction function). for debugging the reduction function, multi-threading can be disabled.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from HDF5OpenFile </td></tr>
|
|
<tr><td class="paramname">detectorpath</td><td>path to detector group in the HDF5 file </td></tr>
|
|
<tr><td class="paramname">reduction_func</td><td>custom reduction function (any user-defined function which has the same parameters as <a class="el" href="pearl-area-import_8ipf.html#a245034d7a94536a24c78a7bfe22725b7" title="function prototype for adh5_load_reduced_detector ">adh5_default_reduction()</a>) </td></tr>
|
|
<tr><td class="paramname">reduction_param</td><td>parameter string for the reduction function </td></tr>
|
|
<tr><td class="paramname">progress</td><td>1 (default): show progress window; 0: do not show progress window </td></tr>
|
|
<tr><td class="paramname">nthreads</td><td>-1 (default): use as many threads as there are processor cores (in addition to main thread) 0: use main thread only (e.g. for debugging the reduction function) >= 1: use a fixed number of (additional) threads </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01162">1162</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acde16dc7a393250b17165344f865f7b5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable adh5_loadattr_all </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>attributespath</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load an NDAttributes group from an open HDF5 file into the current data folder. </p>
|
|
<p>datasets contained in the group are loaded as waves. if a dataset contains only one data point, it is added to the IN, ID, IV, IU waves, where IN = EPICS channel name, ID = attribute name, IV = value, IU = unit (units are left empty as they are not saved in HDF5). attributes of the NDAttributes group are added to the IN, ID, IV, IU waves, however, IN and IU are left empty as this information is not saved in the HDF5 file.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileID</td><td>ID of open HDF5 file from HDF5OpenFile </td></tr>
|
|
<tr><td class="paramname">attributespath</td><td>path to NDAttributes group in the HDF5 file </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01479">1479</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acfa6d2675e63f4f686289ef853b262a9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable adh5_redim </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>redimension a multi-dimensional area detector array loaded from HDF5. </p>
|
|
<p>so that the image dimensions are X and Y singleton dimensions are removed (most common cases only)</p>
|
|
<p>in the redimensioned array, the original dimension type is noted in the dimension label: AD_Dim0 = first image dimension AD_Dim1 = second image dimension AD_DimN = frame sequence AD_DimX = extra dimension X AD_DimY = extra dimension Y (cannot be loaded in Igor)</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>area detector data loaded from HDF5 to be redimensioned </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00618">618</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a774751d1857ea6946a942448dc913128"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable adh5_scale </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>source</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set the dimension scales of an area detector dataset. </p>
|
|
<p>the intrinsic dimensions 0 and 1 are scaled according to the data source (currently supported: Prosilica cameras, Scienta electron analyser). the extra dimensions are scaled according to the scan. the latter requires that the positioner names and position values are available. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00718">718</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1fdcc02340375afe8d8cd7537c6e9cfb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable adh5_scale_scan </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>scales the extra dimensions of an area detector dataset according to the EPICS scan </p>
|
|
<p>the scan positioner name and its values must be available</p>
|
|
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>incomplete </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01719">1719</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a227e4db1c51a910dcf86d355473fe74e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable adh5_scale_scienta </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 energy and angle scales of an area detector dataset from the Scienta analyser. </p>
|
|
<p>the dimension labels of the energy and angle scales must be set correctly: AD_Dim0 = energy dimension; AD_Dim1 = angle dimension. these dimensions must be the first two dimensions of a multi-dimensional dataset. normally, AD_Dim0 is the X dimension, and AD_Dim1 the Y dimension. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01614">1614</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9439de3b676e686eeca4e6b2588c01a6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">threadsafe variable adh5_setup_profile </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">wave </td>
|
|
<td class="paramname"><em>profile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>dim</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set up a one-dimensional wave for a line profile based on a 2D original wave. </p>
|
|
<p>redimensions the profile wave to the given dimension. copies the scale and dimension label of the given dimension. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01113">1113</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a706fb32ee79b589366dec1cf9f7e9d02"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string adh5_test_reduction_func </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>dest1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>dest2</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">funcref </td>
|
|
<td class="paramname"><em>reduction_func</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>reduction_param</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>wrapper function for testing reduction functions from the command line. </p>
|
|
<p>Igor does not allow global variables as pass-by-reference parameter for reduction_param. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01128">1128</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae2cfa1ac6651cfc3fb0dfce03494995b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable BeforeFileOpenHook </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>refNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>fileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>path</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>creator</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>kind</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>callback function for drag&drop of HDF5 files into Igor. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00034">34</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa3cdc56096a6a1bf2a2d80a6245a36d2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static dfr GetAttrDataFolderDFR </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>data</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>find the attributes data folder of an area detector dataset. </p>
|
|
<p>since version 1.04 attributes should be stored in a subfolder named attr. earlier versions had the attributes in the same data folder as the actual dataset.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>wave containing the main dataset.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>data folder reference of the attributes folder. the reference may be invalid (and default to root) if the folder cannot be found, cf. built-in DataFolderRefStatus function. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00699">699</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac98a5f2d12b559aba4e53192c49a7743"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable read_attribute_info </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>datawavename</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable * </td>
|
|
<td class="paramname"><em>idest</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>sub-function of adh5_loadattr_all. </p>
|
|
<p>reads one attribute from a wave which was loaded from an HDF5 file into the info waves IN, ID, IV, IU. the attribute is read only if the input wave contains exactly one item, i.e. either the measurement is a single image, or the attribute has string type.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">datawavename</td><td>name of the attribute wave in the current folder. can be text or numeric. </td></tr>
|
|
<tr><td class="paramname">source</td><td>source identifier (EPICS name) of the attribute. </td></tr>
|
|
<tr><td class="paramname">idest</td><td>destination index in IN, ID, IV, IU where the results are written. the variable is incremented if data was written, otherwise it is left unchanged. make sure IN, ID, IV, IU have at least idest + 1 elements. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01561">1561</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acf0315ec8a3e927ef161a35cb05adb8b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static threadsafe variable reduce_slab_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">wave </td>
|
|
<td class="paramname"><em>profile1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>profile2</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">funcref </td>
|
|
<td class="paramname"><em>reduction_func</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>reduction_param</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01444">1444</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a33f8faf117450af1d6dae9ef48786cd6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static threadsafe variable reduce_slab_worker </td>
|
|
<td>(</td>
|
|
<td class="paramtype">funcref </td>
|
|
<td class="paramname"><em>reduction_func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01405">1405</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-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-area-import_8ipf.html">pearl-area-import.ipf</a></li>
|
|
<li class="footer">Generated on Thu Sep 21 2017 12:35:04 for PEARL Procedures by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|