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

distro release 2.1.1

Browse Source
This commit is contained in:
muntwiler_m
2020-06-09 12:31:05 +02:00
parent b7390cb46f
commit ef9d08e5f5
168 changed files with 3286 additions and 1205 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
doc/html/pearl-scienta-preprocess_8ipf.html
View File

@@ -29,7 +29,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.0.3-2-g58135e4-dirty</span>
&#160;<span id="projectnumber">rev-distro-2.1.0-1-gb7390cb-dirty</span>
</div>
<div id="projectbrief">Igor procedures for the analysis of PEARL data</div>
</td>
@@ -107,10 +107,10 @@ Functions</h2></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="memdesc:ae6877c51ad15c2ba8a69c65356cb34b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">capture linear background reduction parameters from cursors in a graph. <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="memdesc:a95fbd22f52f61d2bff0625b7b8e159d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">calculate linear background 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>
@@ -162,9 +162,18 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</table>
</div><div class="memdoc">
<p>this function is for testing only, until we implement a proper interface </p>
<p>capture linear background reduction parameters from cursors in a graph. </p>
<p>PRELIMINARY - function arguments may change</p>
<p>sets reduction parameters from cursors in a graph. the resulting parameters are copied to the global <code>s_reduction_params</code> string used by the data explorer.</p>
<p>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:</p>
<ol type="1">
<li>low and high limits of peak region. if no cursors are present, the limits are set at 40% and 60% of the x-scale.</li>
<li>peak-side boundary of lower and upper background region. if two or less cursors are present, the default background region applies, which extends from the peak limits up to the default cropping region. the background region extends up to the cropping region defined by the third pair.</li>
<li>lower and upper cropping region. if four or less cursors are present, the default cropping region applies, which is 11% on either side of the image in fixed mode, and 0% otherwise. fixed mode is detected by the number of pixels (&gt;= 992).</li>
</ol>
<dl class="section note"><dt>Note</dt><dd>on profile graphs, the necessary cursors can be configured easily by calling the ad_profile_cursor_mode() function, e.g. <code>ad_profiles_cursor_mode(root:packages:pearl_explorer:preview_image, 1)</code>. </dd></dl>
<p class="definition">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>
<p class="definition">Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00093">93</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
@@ -184,11 +193,25 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</table>
</div><div class="memdoc">
<p>set reduction parameters from cursors in a graph. </p>
<p>calculate linear background 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>calculates reduction parameters from cursors in a graph. the resulting parameters are returned in a string.</p>
<p>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:</p>
<ol type="1">
<li>low and high limits of peak region. if no cursors are present, the limits are set at 40% and 60% of the x-scale.</li>
<li>peak-side boundary of lower and upper background region. if two or less cursors are present, the default background region applies, which extends from the peak limits up to the default cropping region. the background region extends up to the cropping region defined by the third pair.</li>
<li>lower and upper cropping region. if four or less cursors are present, the default cropping region applies, which is 11% on either side of the image in fixed mode, and 0% otherwise. fixed mode is detected by the number of pixels (&gt;= 992).</li>
</ol>
<dl class="section note"><dt>Note</dt><dd>on profile graphs, the necessary cursors can be configured easily by calling the ad_profile_cursor_mode() function, e.g. <code>ad_profiles_cursor_mode(root:packages:pearl_explorer:preview_image, 1)</code>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">win</td><td>graph window name or empty string for top window.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>parameter string for linear background subtraction </dd></dl>
<p class="definition">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>
<p class="definition">Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00133">133</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
@@ -244,7 +267,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</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 class="definition">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>
<p class="definition">Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00718">718</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
@@ -295,7 +318,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</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 class="definition">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>
<p class="definition">Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00260">260</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
@@ -346,7 +369,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</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 class="definition">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>
<p class="definition">Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00413">413</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
@@ -368,7 +391,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
<p>prompt for the gauss4_reduction parameters </p>
<p class="definition">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>
<p class="definition">Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00626">626</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
@@ -410,7 +433,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-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>
<p class="definition">Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00351">351</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
@@ -439,7 +462,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
</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 class="definition">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>
<p class="definition">Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00509">509</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
@@ -491,7 +514,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
<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 class="definition">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>
<p class="definition">Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00572">572</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
@@ -514,7 +537,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); <br />
<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 class="definition">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>
<p class="definition">Definition at line <a class="el" href="pearl-scienta-preprocess_8ipf_source.html#l00592">592</a> of file <a class="el" href="pearl-scienta-preprocess_8ipf_source.html">pearl-scienta-preprocess.ipf</a>.</p>
</div>
</div>
@@ -524,7 +547,7 @@ 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-scienta-preprocess_8ipf.html">pearl-scienta-preprocess.ipf</a></li>
<li class="footer">Generated on Wed Aug 14 2019 17:53:00 for PEARL Procedures by
<li class="footer">Generated on Tue Jun 9 2020 12:30:01 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>
</ul>