pearl-public/igor-public
2
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

compile documentation for release 3.0.0

Browse Source
This commit is contained in:
muntwiler_m
2022-03-01 15:33:15 +01:00
parent fa24916aa6
commit 43689ef162
304 changed files with 28296 additions and 7262 deletions
Download Patch File Download Diff File Expand all files Collapse all files

143
doc/html/pearl-area-import_8ipf.html
View File

@@ -1,9 +1,9 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!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">
<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.13"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PEARL Procedures: pearl-area-import.ipf File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -13,9 +13,6 @@
<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);
</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>
@@ -29,7 +26,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PEARL Procedures
&#160;<span id="projectnumber">rev-distro-2.1.1-1-gf419e92-dirty</span>
&#160;<span id="projectnumber">rev-distro-3.0.0-0-gfa24916-dirty</span>
</div>
<div id="projectbrief">Igor procedures for the analysis of PEARL data</div>
</td>
@@ -38,18 +35,21 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -63,7 +63,9 @@ $(function() {
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('pearl-area-import_8ipf.html','');});
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('pearl-area-import_8ipf.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
@@ -106,83 +108,83 @@ Namespaces</h2></td></tr>
<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&#160;</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">&#160;</td><td class="mdescRight">callback function for drag&amp;drop of HDF5 files into Igor. <a href="#ae2cfa1ac6651cfc3fb0dfce03494995b">More...</a><br /></td></tr>
<tr class="memdesc:ae2cfa1ac6651cfc3fb0dfce03494995b"><td class="mdescLeft">&#160;</td><td class="mdescRight">callback function for drag&amp;drop of HDF5 files into Igor. <a href="pearl-area-import_8ipf.html#ae2cfa1ac6651cfc3fb0dfce03494995b">More...</a><br /></td></tr>
<tr class="separator:ae2cfa1ac6651cfc3fb0dfce03494995b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad28dbbba73e553f7b5dcf8baf1c86786"><td class="memItemLeft" align="right" valign="top">string&#160;</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">&#160;</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="memdesc:ad28dbbba73e553f7b5dcf8baf1c86786"><td class="mdescLeft">&#160;</td><td class="mdescRight">generate the name of a data folder based on a file name. <a href="pearl-area-import_8ipf.html#ad28dbbba73e553f7b5dcf8baf1c86786">More...</a><br /></td></tr>
<tr class="separator:ad28dbbba73e553f7b5dcf8baf1c86786"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedff2e67d2e1bac907f2eaf24a6e5c3c"><td class="memItemLeft" align="right" valign="top">variable&#160;</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">&#160;</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="memdesc:aedff2e67d2e1bac907f2eaf24a6e5c3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">load area detector data files selected in a file dialog window <a href="pearl-area-import_8ipf.html#aedff2e67d2e1bac907f2eaf24a6e5c3c">More...</a><br /></td></tr>
<tr class="separator:aedff2e67d2e1bac907f2eaf24a6e5c3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1040bf272c69dc69777b2f91df41fab"><td class="memItemLeft" align="right" valign="top">string&#160;</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">&#160;</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="memdesc:ab1040bf272c69dc69777b2f91df41fab"><td class="mdescLeft">&#160;</td><td class="mdescRight">import everything from a HDF5 file created by the Area Detector software. <a href="pearl-area-import_8ipf.html#ab1040bf272c69dc69777b2f91df41fab">More...</a><br /></td></tr>
<tr class="separator:ab1040bf272c69dc69777b2f91df41fab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98f9339cd2fae80d0d92451df88395aa"><td class="memItemLeft" align="right" valign="top">string&#160;</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">&#160;</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="memdesc:a98f9339cd2fae80d0d92451df88395aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">load and reduce a dataset from a HDF5 file created by the Area Detector software. <a href="pearl-area-import_8ipf.html#a98f9339cd2fae80d0d92451df88395aa">More...</a><br /></td></tr>
<tr class="separator:a98f9339cd2fae80d0d92451df88395aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98f29671bdce6a5981e8865de8b9d483"><td class="memItemLeft" align="right" valign="top">string&#160;</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">&#160;</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="memdesc:a98f29671bdce6a5981e8865de8b9d483"><td class="mdescLeft">&#160;</td><td class="mdescRight">load a single image from a HDF5 file created by the Area Detector software. <a href="pearl-area-import_8ipf.html#a98f29671bdce6a5981e8865de8b9d483">More...</a><br /></td></tr>
<tr class="separator:a98f29671bdce6a5981e8865de8b9d483"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac76d5ba94a3d7c864437420d80c77064"><td class="memItemLeft" align="right" valign="top">string&#160;</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">&#160;</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="memdesc:ac76d5ba94a3d7c864437420d80c77064"><td class="mdescLeft">&#160;</td><td class="mdescRight">load descriptive info from a HDF5 file created by the Area Detector software. <a href="pearl-area-import_8ipf.html#ac76d5ba94a3d7c864437420d80c77064">More...</a><br /></td></tr>
<tr class="separator:ac76d5ba94a3d7c864437420d80c77064"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84dc7f466b42dde5d96c49827b2122cf"><td class="memItemLeft" align="right" valign="top">variable&#160;</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">&#160;</td><td class="mdescRight">load the detector dataset from the open HDF5 file. <a href="#a84dc7f466b42dde5d96c49827b2122cf">More...</a><br /></td></tr>
<tr class="memdesc:a84dc7f466b42dde5d96c49827b2122cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">load the detector dataset from the open HDF5 file. <a href="pearl-area-import_8ipf.html#a84dc7f466b42dde5d96c49827b2122cf">More...</a><br /></td></tr>
<tr class="separator:a84dc7f466b42dde5d96c49827b2122cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acfa6d2675e63f4f686289ef853b262a9"><td class="memItemLeft" align="right" valign="top">variable&#160;</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">&#160;</td><td class="mdescRight">redimension a multi-dimensional area detector array loaded from HDF5. <a href="#acfa6d2675e63f4f686289ef853b262a9">More...</a><br /></td></tr>
<tr class="memdesc:acfa6d2675e63f4f686289ef853b262a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">redimension a multi-dimensional area detector array loaded from HDF5. <a href="pearl-area-import_8ipf.html#acfa6d2675e63f4f686289ef853b262a9">More...</a><br /></td></tr>
<tr class="separator:acfa6d2675e63f4f686289ef853b262a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3cdc56096a6a1bf2a2d80a6245a36d2"><td class="memItemLeft" align="right" valign="top">static dfr&#160;</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">&#160;</td><td class="mdescRight">find the attributes data folder of an area detector dataset. <a href="#aa3cdc56096a6a1bf2a2d80a6245a36d2">More...</a><br /></td></tr>
<tr class="memdesc:aa3cdc56096a6a1bf2a2d80a6245a36d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">find the attributes data folder of an area detector dataset. <a href="pearl-area-import_8ipf.html#aa3cdc56096a6a1bf2a2d80a6245a36d2">More...</a><br /></td></tr>
<tr class="separator:aa3cdc56096a6a1bf2a2d80a6245a36d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a774751d1857ea6946a942448dc913128"><td class="memItemLeft" align="right" valign="top">variable&#160;</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">&#160;</td><td class="mdescRight">set the dimension scales of an area detector dataset. <a href="#a774751d1857ea6946a942448dc913128">More...</a><br /></td></tr>
<tr class="memdesc:a774751d1857ea6946a942448dc913128"><td class="mdescLeft">&#160;</td><td class="mdescRight">set the dimension scales of an area detector dataset. <a href="pearl-area-import_8ipf.html#a774751d1857ea6946a942448dc913128">More...</a><br /></td></tr>
<tr class="separator:a774751d1857ea6946a942448dc913128"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a9741d1c19b10bb98b73bd5163a497b"><td class="memItemLeft" align="right" valign="top">variable&#160;</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">&#160;</td><td class="mdescRight">load the detector dataset from the open HDF5 file. <a href="#a4a9741d1c19b10bb98b73bd5163a497b">More...</a><br /></td></tr>
<tr class="memdesc:a4a9741d1c19b10bb98b73bd5163a497b"><td class="mdescLeft">&#160;</td><td class="mdescRight">load the detector dataset from the open HDF5 file. <a href="pearl-area-import_8ipf.html#a4a9741d1c19b10bb98b73bd5163a497b">More...</a><br /></td></tr>
<tr class="separator:a4a9741d1c19b10bb98b73bd5163a497b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a931a7bfaaf75d308a0ce3c74ffc751bc"><td class="memItemLeft" align="right" valign="top">variable&#160;</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">&#160;</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="memdesc:a931a7bfaaf75d308a0ce3c74ffc751bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">load a single image from the detector dataset of the open HDF5 file <a href="pearl-area-import_8ipf.html#a931a7bfaaf75d308a0ce3c74ffc751bc">More...</a><br /></td></tr>
<tr class="separator:a931a7bfaaf75d308a0ce3c74ffc751bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5e29dc1a380311d00a5f85be867e47b"><td class="memItemLeft" align="right" valign="top">string&#160;</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">&#160;</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="memdesc:aa5e29dc1a380311d00a5f85be867e47b"><td class="mdescLeft">&#160;</td><td class="mdescRight">get a list of functions which can be used as reduction functions. <a href="pearl-area-import_8ipf.html#aa5e29dc1a380311d00a5f85be867e47b">More...</a><br /></td></tr>
<tr class="separator:aa5e29dc1a380311d00a5f85be867e47b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade69cb0f82e0c9cf6082d5fcc29f742f"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#ade69cb0f82e0c9cf6082d5fcc29f742f">adh5_default_reduction</a> (wave source, string *param)</td></tr>
<tr class="memdesc:ade69cb0f82e0c9cf6082d5fcc29f742f"><td class="mdescLeft">&#160;</td><td class="mdescRight">function prototype for adh5_load_reduced_detector <a href="#ade69cb0f82e0c9cf6082d5fcc29f742f">More...</a><br /></td></tr>
<tr class="memdesc:ade69cb0f82e0c9cf6082d5fcc29f742f"><td class="mdescLeft">&#160;</td><td class="mdescRight">function prototype for adh5_load_reduced_detector <a href="pearl-area-import_8ipf.html#ade69cb0f82e0c9cf6082d5fcc29f742f">More...</a><br /></td></tr>
<tr class="separator:ade69cb0f82e0c9cf6082d5fcc29f742f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9439de3b676e686eeca4e6b2588c01a6"><td class="memItemLeft" align="right" valign="top">threadsafe variable&#160;</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">&#160;</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="memdesc:a9439de3b676e686eeca4e6b2588c01a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">set up a one-dimensional wave for a line profile based on a 2D original wave. <a href="pearl-area-import_8ipf.html#a9439de3b676e686eeca4e6b2588c01a6">More...</a><br /></td></tr>
<tr class="separator:a9439de3b676e686eeca4e6b2588c01a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98804ce23a5c2c314ac243baa0824424"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#a98804ce23a5c2c314ac243baa0824424">adh5_test_reduction_func</a> (wave source, funcref reduction_func, string reduction_param, string result_prefix)</td></tr>
<tr class="memdesc:a98804ce23a5c2c314ac243baa0824424"><td class="mdescLeft">&#160;</td><td class="mdescRight">wrapper function for testing reduction functions from the command line. <a href="#a98804ce23a5c2c314ac243baa0824424">More...</a><br /></td></tr>
<tr class="memdesc:a98804ce23a5c2c314ac243baa0824424"><td class="mdescLeft">&#160;</td><td class="mdescRight">wrapper function for testing reduction functions from the command line. <a href="pearl-area-import_8ipf.html#a98804ce23a5c2c314ac243baa0824424">More...</a><br /></td></tr>
<tr class="separator:a98804ce23a5c2c314ac243baa0824424"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae88bc41882fd16c94c04d856f3e062e4"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#ae88bc41882fd16c94c04d856f3e062e4">adh5_reduce_brick</a> (wave source, funcref reduction_func, string reduction_param, string result_prefix, variable progress=defaultValue, variable nthreads=defaultValue)</td></tr>
<tr class="memdesc:ae88bc41882fd16c94c04d856f3e062e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">reduce a three-dimensional intensity distribution <a href="#ae88bc41882fd16c94c04d856f3e062e4">More...</a><br /></td></tr>
<tr class="memdesc:ae88bc41882fd16c94c04d856f3e062e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">reduce a three-dimensional intensity distribution <a href="pearl-area-import_8ipf.html#ae88bc41882fd16c94c04d856f3e062e4">More...</a><br /></td></tr>
<tr class="separator:ae88bc41882fd16c94c04d856f3e062e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4efc9178892310c9e2caf40c61d71bd7"><td class="memItemLeft" align="right" valign="top">static threadsafe variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#a4efc9178892310c9e2caf40c61d71bd7">reduce_brick_worker</a> (funcref reduction_func)</td></tr>
<tr class="memdesc:a4efc9178892310c9e2caf40c61d71bd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">thread worker for adh5_reduce_brick <a href="#a4efc9178892310c9e2caf40c61d71bd7">More...</a><br /></td></tr>
<tr class="memdesc:a4efc9178892310c9e2caf40c61d71bd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">thread worker for adh5_reduce_brick <a href="pearl-area-import_8ipf.html#a4efc9178892310c9e2caf40c61d71bd7">More...</a><br /></td></tr>
<tr class="separator:a4efc9178892310c9e2caf40c61d71bd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27a72a3901a5342ca9dea02e3219631c"><td class="memItemLeft" align="right" valign="top">threadsafe variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#a27a72a3901a5342ca9dea02e3219631c">adh5_get_result_waves</a> (wave results, string result_prefix, variable start_index)</td></tr>
<tr class="memdesc:a27a72a3901a5342ca9dea02e3219631c"><td class="mdescLeft">&#160;</td><td class="mdescRight">copy waves from wave reference wave into current data folder <a href="#a27a72a3901a5342ca9dea02e3219631c">More...</a><br /></td></tr>
<tr class="memdesc:a27a72a3901a5342ca9dea02e3219631c"><td class="mdescLeft">&#160;</td><td class="mdescRight">copy waves from wave reference wave into current data folder <a href="pearl-area-import_8ipf.html#a27a72a3901a5342ca9dea02e3219631c">More...</a><br /></td></tr>
<tr class="separator:a27a72a3901a5342ca9dea02e3219631c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f2ac36f961941e46e80a775de8300e5"><td class="memItemLeft" align="right" valign="top">variable&#160;</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">&#160;</td><td class="mdescRight">load a reduced detector dataset from the open HDF5 file. <a href="#a3f2ac36f961941e46e80a775de8300e5">More...</a><br /></td></tr>
<tr class="memdesc:a3f2ac36f961941e46e80a775de8300e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">load a reduced detector dataset from the open HDF5 file. <a href="pearl-area-import_8ipf.html#a3f2ac36f961941e46e80a775de8300e5">More...</a><br /></td></tr>
<tr class="separator:a3f2ac36f961941e46e80a775de8300e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33f8faf117450af1d6dae9ef48786cd6"><td class="memItemLeft" align="right" valign="top">static threadsafe variable&#160;</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">&#160;</td></tr>
<tr class="memitem:a44d495fba0dd2b82dec13760a07fd226"><td class="memItemLeft" align="right" valign="top">static threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-import_8ipf.html#a44d495fba0dd2b82dec13760a07fd226">reduce_slab_image</a> (wave slabdata, wave image, funcref reduction_func, string reduction_param)</td></tr>
<tr class="separator:a44d495fba0dd2b82dec13760a07fd226"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acde16dc7a393250b17165344f865f7b5"><td class="memItemLeft" align="right" valign="top">variable&#160;</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">&#160;</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="memdesc:acde16dc7a393250b17165344f865f7b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">load an NDAttributes group from an open HDF5 file into the current data folder. <a href="pearl-area-import_8ipf.html#acde16dc7a393250b17165344f865f7b5">More...</a><br /></td></tr>
<tr class="separator:acde16dc7a393250b17165344f865f7b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac98a5f2d12b559aba4e53192c49a7743"><td class="memItemLeft" align="right" valign="top">static variable&#160;</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">&#160;</td><td class="mdescRight">sub-function of adh5_loadattr_all. <a href="#ac98a5f2d12b559aba4e53192c49a7743">More...</a><br /></td></tr>
<tr class="memdesc:ac98a5f2d12b559aba4e53192c49a7743"><td class="mdescLeft">&#160;</td><td class="mdescRight">sub-function of adh5_loadattr_all. <a href="pearl-area-import_8ipf.html#ac98a5f2d12b559aba4e53192c49a7743">More...</a><br /></td></tr>
<tr class="separator:ac98a5f2d12b559aba4e53192c49a7743"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a227e4db1c51a910dcf86d355473fe74e"><td class="memItemLeft" align="right" valign="top">variable&#160;</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">&#160;</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="memdesc:a227e4db1c51a910dcf86d355473fe74e"><td class="mdescLeft">&#160;</td><td class="mdescRight">set the energy and angle scales of an area detector dataset from the Scienta analyser. <a href="pearl-area-import_8ipf.html#a227e4db1c51a910dcf86d355473fe74e">More...</a><br /></td></tr>
<tr class="separator:a227e4db1c51a910dcf86d355473fe74e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fdcc02340375afe8d8cd7537c6e9cfb"><td class="memItemLeft" align="right" valign="top">variable&#160;</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">&#160;</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="memdesc:a1fdcc02340375afe8d8cd7537c6e9cfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">scales the extra dimensions of an area detector dataset according to the EPICS scan <a href="pearl-area-import_8ipf.html#a1fdcc02340375afe8d8cd7537c6e9cfb">More...</a><br /></td></tr>
<tr class="separator:a1fdcc02340375afe8d8cd7537c6e9cfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
@@ -190,9 +192,9 @@ Functions</h2></td></tr>
<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>
<dl class="section author"><dt>Author</dt><dd>matthias muntwiler, <a href="#" onclick="location.href='mai'+'lto:'+'mat'+'th'+'ias'+'.m'+'unt'+'wi'+'ler'+'@p'+'si.'+'ch'; return false;">matth<span style="display: none;">.nosp@m.</span>ias.<span style="display: none;">.nosp@m.</span>muntw<span style="display: none;">.nosp@m.</span>iler<span style="display: none;">.nosp@m.</span>@psi.<span style="display: none;">.nosp@m.</span>ch</a></dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>2013-18 Paul Scherrer Institut <br />
Licensed under the Apache License, Version 2.0 (the "License"); <br />
you may not use this file except in compliance with the License. <br />
<dl class="section copyright"><dt>Copyright</dt><dd>2013-20 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-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
@@ -221,7 +223,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00167">167</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00171">171</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -276,7 +278,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00106">106</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00110">110</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -309,7 +311,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
<p>function prototype for adh5_load_reduced_detector </p>
<p>this is a prototype of custom functions that convert (reduce) a two-dimensional detector image into one or more one-dimensional waves. data processing can be tuned with a set of parameters.</p>
<p>reduction functions have a fixed signature (function arguments) so that the file import functions can call them efficiently on a series of detector images. pearl procedures comes with a number of pre-defined reduction functions but you may as well implement your own functions. if you write your own function, you must use the same declaration and arguments as this function except for the function name. you can do many things in a reduction function, e.g. integration over a region of interest, curve fitting, etc.</p>
<p>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>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 the result waves 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">
@@ -320,7 +322,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</dl>
<dl class="section return"><dt>Returns</dt><dd>a free wave containing references of the result waves. the result waves should as well be free waves. if an error occurred, the reference wave is empty. </dd></dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01111">1111</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01115">1115</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -367,7 +369,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01430">1430</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01463">1463</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -389,7 +391,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
<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 class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01041">1041</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01045">1045</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -450,7 +452,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00207">207</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00211">211</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -490,7 +492,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00581">581</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00585">585</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -558,7 +560,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00945">945</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00949">949</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -606,7 +608,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</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-area-import_8ipf_source.html#l00780">780</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00784">784</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -647,7 +649,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00497">497</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00501">501</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -709,7 +711,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00387">387</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00391">391</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -784,7 +786,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
<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#ade69cb0f82e0c9cf6082d5fcc29f742f" title="function prototype for adh5_load_reduced_detector ">adh5_default_reduction()</a>) </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#ade69cb0f82e0c9cf6082d5fcc29f742f" 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>
@@ -793,7 +795,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00302">302</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00306">306</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -854,7 +856,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
<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#ade69cb0f82e0c9cf6082d5fcc29f742f" title="function prototype for adh5_load_reduced_detector ">adh5_default_reduction()</a>) </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#ade69cb0f82e0c9cf6082d5fcc29f742f" 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) &gt;= 1: use a fixed number of (additional) threads </td></tr>
@@ -862,7 +864,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01466">1466</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01499">1499</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -902,7 +904,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01790">1790</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01823">1823</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -932,7 +934,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00626">626</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00630">630</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -993,12 +995,13 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
<tr><td class="paramname">source</td><td>source wave. three-dimensional intensity distribution (image). the scales are carried over to the result waves.</td></tr>
<tr><td class="paramname">reduction_func</td><td>name of the reduction function to apply to the source data.</td></tr>
<tr><td class="paramname">reduction_param</td><td>string with reduction parameters as required by the specific reduction function.</td></tr>
<tr><td class="paramname">result_prefix</td><td>name prefix of result waves. a numeric index is appended to distinguish the results. the index starts at 1. existing waves are overwritten. </td></tr>
<tr><td class="paramname">result_prefix</td><td>name prefix of result waves. a numeric index is appended to distinguish the results. the index starts at 1. existing waves are overwritten.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>result code: 0 for success, &lt; 0 for error </dd></dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01198">1198</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01203">1203</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1031,7 +1034,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
<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 class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00726">726</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00730">730</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1055,7 +1058,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
<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 class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l02030">2030</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l02063">2063</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1078,7 +1081,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
<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 class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01925">1925</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01958">1958</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1117,7 +1120,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
<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 class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01134">1134</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01138">1138</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1172,7 +1175,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</dl>
<dl class="section return"><dt>Returns</dt><dd>a copy of the reduction_param string, possibly modified by the reduction function. </dd></dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01167">1167</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01171">1171</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1236,7 +1239,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
<p>callback function for drag&amp;drop of HDF5 files into Igor. </p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00042">42</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00046">46</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1274,7 +1277,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</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 class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00707">707</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00711">711</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1329,7 +1332,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01872">1872</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01905">1905</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1360,7 +1363,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
<p>thread worker for adh5_reduce_brick </p>
<p>this function polls job data folders from thread group 0 and calls the reduction function on their contents. the result waves have prefix "redw_" and are saved in the job folder. </p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01377">1377</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01410">1410</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1410,7 +1413,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01757">1757</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01790">1790</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1438,7 +1441,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01718">1718</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
<p class="definition">Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01751">1751</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1448,9 +1451,9 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
<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 Tue Jun 16 2020 14:32:36 for PEARL Procedures by
<li class="footer">Generated on Tue Mar 1 2022 15:31:30 for PEARL Procedures by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>