igor-public/doc/html/pearl-scienta-preprocess_8ipf.html
matthias muntwiler fda49c3195 new features: data reduction, angle scan panel
- 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.
2018-02-06 11:39:57 +01:00

537 lines
32 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-scienta-preprocess.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
&#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>
</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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;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&#160;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-scienta-preprocess_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> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">pearl-scienta-preprocess.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>preprocessing functions for Scienta detector images.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;pearl-fitfuncs&quot;</code><br />
</div>
<p><a href="pearl-scienta-preprocess_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_scienta_preprocess"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_pearl_scienta_preprocess.html">PearlScientaPreprocess</a></td></tr>
<tr class="memdesc:namespace_pearl_scienta_preprocess"><td class="mdescLeft">&#160;</td><td class="mdescRight">preprocessing functions for Scienta detector images. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:a145c7275b8809c5e789b932ef46e4811"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-scienta-preprocess_8ipf.html#a145c7275b8809c5e789b932ef46e4811">prompt_int_linbg_reduction</a> (string *param)</td></tr>
<tr class="memdesc:a145c7275b8809c5e789b932ef46e4811"><td class="mdescLeft">&#160;</td><td class="mdescRight">prompt the user for integrate on linear background reduction parameters. <a href="#a145c7275b8809c5e789b932ef46e4811">More...</a><br /></td></tr>
<tr class="separator:a145c7275b8809c5e789b932ef46e4811"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6877c51ad15c2ba8a69c65356cb34b8"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-scienta-preprocess_8ipf.html#ae6877c51ad15c2ba8a69c65356cb34b8">capture_int_linbg_cursors</a> ()</td></tr>
<tr class="memdesc:ae6877c51ad15c2ba8a69c65356cb34b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">this function is for testing only, until we implement a proper interface <a href="#ae6877c51ad15c2ba8a69c65356cb34b8">More...</a><br /></td></tr>
<tr class="separator:ae6877c51ad15c2ba8a69c65356cb34b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95fbd22f52f61d2bff0625b7b8e159d1"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-scienta-preprocess_8ipf.html#a95fbd22f52f61d2bff0625b7b8e159d1">csr_int_linbg_reduction</a> (string win)</td></tr>
<tr class="memdesc:a95fbd22f52f61d2bff0625b7b8e159d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">set reduction parameters from cursors in a graph. <a href="#a95fbd22f52f61d2bff0625b7b8e159d1">More...</a><br /></td></tr>
<tr class="separator:a95fbd22f52f61d2bff0625b7b8e159d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e91197cd7a3581b70bc59a194d3f43b"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-scienta-preprocess_8ipf.html#a1e91197cd7a3581b70bc59a194d3f43b">int_linbg_reduction</a> (wave source, string *param)</td></tr>
<tr class="memdesc:a1e91197cd7a3581b70bc59a194d3f43b"><td class="mdescLeft">&#160;</td><td class="mdescRight">linear-background subtracted integration reduction function. <a href="#a1e91197cd7a3581b70bc59a194d3f43b">More...</a><br /></td></tr>
<tr class="separator:a1e91197cd7a3581b70bc59a194d3f43b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d06ea5a11ba79160efeea7fe673af8c"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-scienta-preprocess_8ipf.html#a6d06ea5a11ba79160efeea7fe673af8c">prompt_int_quadbg_reduction</a> (string *param)</td></tr>
<tr class="separator:a6d06ea5a11ba79160efeea7fe673af8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad626526589efec3f2f72ad001702fe39"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-scienta-preprocess_8ipf.html#ad626526589efec3f2f72ad001702fe39">int_quadbg_reduction</a> (wave source, string *param)</td></tr>
<tr class="memdesc:ad626526589efec3f2f72ad001702fe39"><td class="mdescLeft">&#160;</td><td class="mdescRight">integrate peak area minus a quadratic background <a href="#ad626526589efec3f2f72ad001702fe39">More...</a><br /></td></tr>
<tr class="separator:ad626526589efec3f2f72ad001702fe39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e7de6441bbcba217760448babaca827"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-scienta-preprocess_8ipf.html#a6e7de6441bbcba217760448babaca827">prompt_redim_linbg_reduction</a> (string *param)</td></tr>
<tr class="memdesc:a6e7de6441bbcba217760448babaca827"><td class="mdescLeft">&#160;</td><td class="mdescRight">parameter dialog for the <a class="el" href="pearl-scienta-preprocess_8ipf.html#a8e2aef3e0d5f2b304399a11423661fdc" title="linear background reduction function for incorrectly dimensioned scienta image ">redim_linbg_reduction()</a> function <a href="#a6e7de6441bbcba217760448babaca827">More...</a><br /></td></tr>
<tr class="separator:a6e7de6441bbcba217760448babaca827"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e2aef3e0d5f2b304399a11423661fdc"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-scienta-preprocess_8ipf.html#a8e2aef3e0d5f2b304399a11423661fdc">redim_linbg_reduction</a> (wave source, string *param)</td></tr>
<tr class="memdesc:a8e2aef3e0d5f2b304399a11423661fdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">linear background reduction function for incorrectly dimensioned scienta image <a href="#a8e2aef3e0d5f2b304399a11423661fdc">More...</a><br /></td></tr>
<tr class="separator:a8e2aef3e0d5f2b304399a11423661fdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb78e8b2bbfd9c0faa5eb049b1dcad1c"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-scienta-preprocess_8ipf.html#adb78e8b2bbfd9c0faa5eb049b1dcad1c">test_gauss4_reduction</a> (wave image)</td></tr>
<tr class="memdesc:adb78e8b2bbfd9c0faa5eb049b1dcad1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">apply the gauss4_reduction function to a single image <a href="#adb78e8b2bbfd9c0faa5eb049b1dcad1c">More...</a><br /></td></tr>
<tr class="separator:adb78e8b2bbfd9c0faa5eb049b1dcad1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1514250704b40aa2614d389a2e250d61"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-scienta-preprocess_8ipf.html#a1514250704b40aa2614d389a2e250d61">prompt_gauss4_reduction</a> (string *param)</td></tr>
<tr class="memdesc:a1514250704b40aa2614d389a2e250d61"><td class="mdescLeft">&#160;</td><td class="mdescRight">prompt for the gauss4_reduction parameters <a href="#a1514250704b40aa2614d389a2e250d61">More...</a><br /></td></tr>
<tr class="separator:a1514250704b40aa2614d389a2e250d61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83cdbd96c5b59011914d53118e5ef71c"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-scienta-preprocess_8ipf.html#a83cdbd96c5b59011914d53118e5ef71c">gauss4_reduction</a> (wave source, string *param)</td></tr>
<tr class="memdesc:a83cdbd96c5b59011914d53118e5ef71c"><td class="mdescLeft">&#160;</td><td class="mdescRight">fit horizontal cuts of an image with up to four gaussian peaks on a linear background <a href="#a83cdbd96c5b59011914d53118e5ef71c">More...</a><br /></td></tr>
<tr class="separator:a83cdbd96c5b59011914d53118e5ef71c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>preprocessing functions for Scienta detector images. </p>
<p>this procedure contains functions for data reduction and instrument-specific normalization.</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-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ae6877c51ad15c2ba8a69c65356cb34b8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string capture_int_linbg_cursors </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>this function is for testing only, until we implement a proper interface </p>
<p>Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00067">67</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a95fbd22f52f61d2bff0625b7b8e159d1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string csr_int_linbg_reduction </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>win</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set reduction parameters from cursors in a graph. </p>
<p>PRELIMINARY - function arguments may change</p>
<p>sets reduction parameters from cursors in a graph. an even number of cursors (2 or more) must be set on the image. cursor names and order do not matter, except that the alphabetically first cursor which is attached to an image selects the image. the cursors mark the following positions, from innermost to outermost pair: 1) low and high limits of peak region. 2) peak-side boundary of lower and upper background region. 3) lower and upper cropping region. </p>
<p>Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00089">89</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a83cdbd96c5b59011914d53118e5ef71c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe wave gauss4_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">string *&#160;</td>
<td class="paramname"><em>param</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>fit horizontal cuts of an image with up to four gaussian peaks on a linear background </p>
<p>the function fits each horizontal profile (EDC) with four gaussian peaks on a linear background. the position and width of the peaks is kept fixed according to input parameters. the peak amplitude is constrained to positive value.</p>
<p>the width parameter is defined as in Igor's gauss curve fit function (standard deviation divided by the square root of two). the return value in dest1 is the integrated peak of one of the peaks. dest2 returns the corresponding error estimate.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>source wave. two-dimensional distribution of counts. for correct weighting and error estimation it is important that the source wave contains actual counts (Poisson statistics).</td></tr>
<tr><td class="paramname">param</td><td>(in, out) semicolon-separated key=value list of processing parameters. this is a pass-by-reference argument. the following parameters are required. position, width and limit parameters are on the x (energy) scale. <ul>
<li>rngl low limit of fit interval </li>
<li>rngh high limit of fit interval </li>
<li>pos1 position of peak 1 </li>
<li>wid1 width of peak 1 </li>
<li>pos2 position of peak 2 </li>
<li>wid2 width of peak 2 </li>
<li>pos3 position of peak 3 </li>
<li>wid3 width of peak 3 </li>
<li>pos4 position of peak 4 </li>
<li>wid4 width of peak 4 </li>
<li>npeaks number of peaks to fit: 1...4 the others are held at amplitude 0. </li>
<li>ybox box size of averaging in y direction, must be 1 or 3. other values lead to corrupt data.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>free wave containing references of the result waves. the number of waves is two times the number of peaks that are fit. the first npeaks waves contain the peak integrals, the second npeaks waves the corresponding error estimates. </dd></dl>
<p>Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00672">672</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a1e91197cd7a3581b70bc59a194d3f43b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe wave int_linbg_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">string *&#160;</td>
<td class="paramname"><em>param</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>linear-background subtracted integration reduction function. </p>
<p>data reduction function for adh5_load_reduced_detector. cf. <a class="el" href="pearl-area-import_8ipf.html#ade69cb0f82e0c9cf6082d5fcc29f742f">adh5_default_reduction</a> for an explanation of reduction functions.</p>
<p>this function calculates the average pixel value of each angular slice in one center and two background intervals. a background value is calculated at the center position by linear interpolation from the two background values. returns the center minus linear background in dest1. returns the Poisson one-sigma error in dest2.</p>
<p>typical values (peak centered on detector, FWHM ~ 20 % of image) Lcrop=0.11;Hcrop=0.11;Lsize=0.2;Hsize=0.2;Cpos=0.5;Csize=0.2</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>scienta detector image, energy axis along X, angle axis along Y. two-dimensional intensity distribution (image). the scales are carried over to the result waves.</td></tr>
<tr><td class="paramname">param</td><td>parameters in a key1=value1;key2=value2;... list. all region parameters are relative to the image size (0...1). <ul>
<li>Lcrop = size of the lower cropping region </li>
<li>Hcrop = size of the upper cropping region </li>
<li>Lsize = size of the lower background integration region </li>
<li>Hsize = size of the upper background integration region </li>
<li>Cpos = center position of the of the peak integration region </li>
<li>Csize = size of the peak integration region</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>free wave containing references of the two result waves. the first wave is the integral minus linear background. the second wave is the Poisson one-sigma error. </dd></dl>
<p>Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00214">214</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="ad626526589efec3f2f72ad001702fe39"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe wave int_quadbg_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">string *&#160;</td>
<td class="paramname"><em>param</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>integrate peak area minus a quadratic background </p>
<p>data reduction function for adh5_load_reduced_detector. cf. <a class="el" href="pearl-area-import_8ipf.html#ade69cb0f82e0c9cf6082d5fcc29f742f">adh5_default_reduction</a> for an explanation of reduction functions.</p>
<p>this function calculates the average pixel value of each angular slice in one center and two background intervals. a background value is calculated at the center position by linear interpolation from the two background values. returns the center minus linear background in dest1. returns the Poisson one-sigma error in dest2.</p>
<p>typical values (peak centered on detector, FWHM ~ 20 % of image) Lcrop=0.11;Hcrop=0.11;Lsize=0.2;Hsize=0.2;Cpos=0.5;Csize=0.2</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>scienta detector image, energy axis along X, angle axis along Y. two-dimensional intensity distribution (image). the scales are carried over to the result waves.</td></tr>
<tr><td class="paramname">param</td><td>parameters in a key1=value1;key2=value2;... list. all region parameters are relative to the image size (0...1). <ul>
<li>Lcrop = size of the lower cropping region </li>
<li>Hcrop = size of the upper cropping region </li>
<li>Lsize = size of the lower background integration region </li>
<li>Hsize = size of the upper background integration region </li>
<li>Cpos = center position of the of the peak integration region </li>
<li>Csize = size of the peak integration region</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>free wave containing references of the two result waves. the first wave is the integral minus linear background. the second wave is the Poisson one-sigma error. </dd></dl>
<p>Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00367">367</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a1514250704b40aa2614d389a2e250d61"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable prompt_gauss4_reduction </td>
<td>(</td>
<td class="paramtype">string *&#160;</td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>prompt for the gauss4_reduction parameters </p>
<p>Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00580">580</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a145c7275b8809c5e789b932ef46e4811"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable prompt_int_linbg_reduction </td>
<td>(</td>
<td class="paramtype">string *&#160;</td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>prompt the user for integrate on linear background reduction parameters. </p>
<p>Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00035">35</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a6d06ea5a11ba79160efeea7fe673af8c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable prompt_int_quadbg_reduction </td>
<td>(</td>
<td class="paramtype">string *&#160;</td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00305">305</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a6e7de6441bbcba217760448babaca827"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable prompt_redim_linbg_reduction </td>
<td>(</td>
<td class="paramtype">string *&#160;</td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>parameter dialog for the <a class="el" href="pearl-scienta-preprocess_8ipf.html#a8e2aef3e0d5f2b304399a11423661fdc" title="linear background reduction function for incorrectly dimensioned scienta image ">redim_linbg_reduction()</a> function </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>parameter string in a key1=value1;key2=value2;... list. the parameter string is passed by reference. see <a class="el" href="pearl-scienta-preprocess_8ipf.html#a8e2aef3e0d5f2b304399a11423661fdc" title="linear background reduction function for incorrectly dimensioned scienta image ">redim_linbg_reduction()</a> for a description of parameters.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero if the user clicked OK, non-zero if the user clicked Cancel. </dd></dl>
<p>Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00463">463</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a8e2aef3e0d5f2b304399a11423661fdc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe wave redim_linbg_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">string *&#160;</td>
<td class="paramname"><em>param</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>linear background reduction function for incorrectly dimensioned scienta image </p>
<p>if the energy step size does not divide the energy range to an integer number, the scienta image is exported with the wrong array size. this can be fixed by redimensioning the array.</p>
<p>the current implementation works in the case where dimension 0 needs to be incremented. the function may be generalized to dimension 1 and/or decrementing by additional parameters. it is not known yet whether a generalization is needed or whether it can cover all cases.</p>
<p>background subtraction and peak integration is the same as by the <a class="el" href="pearl-scienta-preprocess_8ipf.html#a1e91197cd7a3581b70bc59a194d3f43b" title="linear-background subtracted integration reduction function. ">int_linbg_reduction()</a> function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>source wave Scienta detector image, energy axis along X, angle axis along Y</td></tr>
<tr><td class="paramname">param</td><td>parameter string in a key1=value1;key2=value2;... list. the parameter string is passed by reference.</td></tr>
</table>
</dd>
</dl>
<p>all region parameters are relative to the image size (0...1). </p><ul>
<li>Lcrop size of the lower cropping region </li>
<li>Hcrop size of the upper cropping region </li>
<li>Lsize size of the lower background integration region </li>
<li>Hsize size of the upper background integration region </li>
<li>Cpos center position of the of the peak integration region </li>
<li>Csize size of the peak integration region</li>
</ul>
<p>typical values (peak centered on detector, FWHM ~ 20 % of image) Lcrop=0.11;Hcrop=0.11;Lsize=0.2;Hsize=0.2;Cpos=0.5;Csize=0.2</p>
<dl class="section return"><dt>Returns</dt><dd>free wave containing references of the two result waves. the first wave is the integral minus linear background. the second wave is the Poisson one-sigma error. </dd></dl>
<p>Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00526">526</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="adb78e8b2bbfd9c0faa5eb049b1dcad1c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable test_gauss4_reduction </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>image</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>apply the gauss4_reduction function to a single image </p>
<p>useful for testing or manual processing. to debug, (temporarily) remove the threadsafe attribute from the gauss2_reduction function. </p>
<p>Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00546">546</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.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-scienta-preprocess_8ipf.html">pearl-scienta-preprocess.ipf</a></li>
<li class="footer">Generated on Tue Feb 6 2018 11:37:56 for PEARL Procedures by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>