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

new features: data reduction, angle scan panel

Browse Source 
- new data reduction interface for more efficient multi-peak fitting.
  the new interface breaks compatibility with pre-2.0 data reduction
  functions. user-defined functions must be adapted to the new
  interface.
- new angle scan processing panel for interactive data analysis.
This commit is contained in:
muntwiler_m
2018-02-06 11:39:57 +01:00
parent e1f1aa9636
commit fda49c3195
171 changed files with 7539 additions and 2554 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -32,7 +32,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PEARL Procedures
&#160;<span id="projectnumber">rev-distro-1.6.0-0-gcf1399e-dirty</span>
&#160;<span id="projectnumber">rev-distro-1.6.1-0-ge1f1aa9-dirty</span>
</div>
<div id="projectbrief">Igor procedures for the analysis of PEARL data</div>
</td>
@@ -171,22 +171,25 @@ Functions</h2></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="separator:aa5e29dc1a380311d00a5f85be867e47b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a245034d7a94536a24c78a7bfe22725b7"><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#a245034d7a94536a24c78a7bfe22725b7">adh5_default_reduction</a> (wave source, wave dest1, wave dest2, string *param)</td></tr>
<tr class="memdesc:a245034d7a94536a24c78a7bfe22725b7"><td class="mdescLeft">&#160;</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">&#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="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="separator:a9439de3b676e686eeca4e6b2588c01a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a706fb32ee79b589366dec1cf9f7e9d02"><td class="memItemLeft" align="right" valign="top">string&#160;</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">&#160;</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">&#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="separator:a98804ce23a5c2c314ac243baa0824424"><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="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="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:acf0315ec8a3e927ef161a35cb05adb8b"><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#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">&#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="separator:acde16dc7a393250b17165344f865f7b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -203,7 +206,12 @@ Functions</h2></td></tr>
<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>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 />
You may obtain a copy of the License at <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a> </dd></dl>
<p>Definition in file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
@@ -229,7 +237,7 @@ Functions</h2></td></tr>
</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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00166">166</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -282,32 +290,20 @@ Functions</h2></td></tr>
</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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00105">105</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>
<a class="anchor" id="ade69cb0f82e0c9cf6082d5fcc29f742f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe variable adh5_default_reduction </td>
<td class="memname">threadsafe wave adh5_default_reduction </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dest1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dest2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
@@ -323,19 +319,65 @@ Functions</h2></td></tr>
</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>
<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>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">
<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>
<tr><td class="paramname">source</td><td>source wave. two-dimensional intensity distribution (image). the scales are carried over to the result 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>
<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>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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01110">1110</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="a27a72a3901a5342ca9dea02e3219631c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe variable adh5_get_result_waves </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>results</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>result_prefix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>start_index</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>copy waves from wave reference wave into current data folder </p>
<p>this function copies waves that are referenced in a wave reference wave into the current data folder. the destination waves get new names consisting of a prefix and a numeric index. the index is the array index of the wave in results plus a chosen offset.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">results</td><td>a wave reference wave pointing to result waves from data reduction. the waves can be free or regular waves. results can be a free or regular wave.</td></tr>
<tr><td class="paramname">result_prefix</td><td>name prefix of the copied waves.</td></tr>
<tr><td class="paramname">start_index</td><td>start index (offset) of the copied waves. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01192">1192</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -355,7 +397,7 @@ Functions</h2></td></tr>
<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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01040">1040</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -414,7 +456,7 @@ Functions</h2></td></tr>
</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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00206">206</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -452,7 +494,7 @@ Functions</h2></td></tr>
</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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00580">580</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -518,7 +560,7 @@ Functions</h2></td></tr>
</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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00944">944</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -564,7 +606,7 @@ Functions</h2></td></tr>
</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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00779">779</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -603,7 +645,7 @@ Functions</h2></td></tr>
</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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00496">496</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -663,7 +705,7 @@ Functions</h2></td></tr>
</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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00386">386</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -736,7 +778,7 @@ Functions</h2></td></tr>
<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_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>
@@ -745,7 +787,7 @@ Functions</h2></td></tr>
</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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00301">301</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -804,7 +846,7 @@ Functions</h2></td></tr>
<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_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>
@@ -812,7 +854,7 @@ Functions</h2></td></tr>
</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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01228">1228</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -850,7 +892,7 @@ Functions</h2></td></tr>
</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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01552">1552</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -878,7 +920,7 @@ Functions</h2></td></tr>
</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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00625">625</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -909,7 +951,7 @@ Functions</h2></td></tr>
<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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00725">725</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -931,7 +973,7 @@ Functions</h2></td></tr>
<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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01792">1792</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -952,7 +994,7 @@ Functions</h2></td></tr>
<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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01687">1687</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -989,11 +1031,11 @@ Functions</h2></td></tr>
<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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01133">1133</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>
<a class="anchor" id="a98804ce23a5c2c314ac243baa0824424"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -1003,18 +1045,6 @@ Functions</h2></td></tr>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dest1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dest2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
@@ -1025,7 +1055,13 @@ Functions</h2></td></tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>reduction_param</em>&#160;</td>
<td class="paramname"><em>reduction_param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>result_prefix</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -1036,9 +1072,19 @@ Functions</h2></td></tr>
</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>reduction functions cannot be used on the command line because they require a pass-by-reference argument and return free waves. this function expects the reduction parameters in a normal string and copies the results into the current data folder. the prefix of the result names can be specified.</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). 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>
</table>
</dd>
</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>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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01166">1166</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1100,7 +1146,7 @@ Functions</h2></td></tr>
<p>callback function for drag&amp;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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00041">41</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1136,7 +1182,7 @@ Functions</h2></td></tr>
</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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l00706">706</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1189,11 +1235,11 @@ Functions</h2></td></tr>
</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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01634">1634</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>
<a class="anchor" id="a44d495fba0dd2b82dec13760a07fd226"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
@@ -1201,7 +1247,7 @@ Functions</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static threadsafe variable reduce_slab_image </td>
<td class="memname">static threadsafe wave reduce_slab_image </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>slabdata</em>, </td>
@@ -1212,18 +1258,6 @@ Functions</h2></td></tr>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>profile1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>profile2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
@@ -1249,7 +1283,7 @@ Functions</h2></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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01519">1519</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1275,7 +1309,7 @@ Functions</h2></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>
<p>Definition at line <a class="el" href="pearl-area-import_8ipf_source.html#l01480">1480</a> of file <a class="el" href="pearl-area-import_8ipf_source.html">pearl-area-import.ipf</a>.</p>
</div>
</div>
@@ -1285,7 +1319,7 @@ Functions</h2></td></tr>
<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 Wed Sep 27 2017 15:47:49 for PEARL Procedures by
<li class="footer">Generated on Tue Feb 6 2018 11:37:56 for PEARL Procedures by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>