update documentation for 2.1.0

This commit is contained in:
2019-08-14 17:57:25 +02:00
parent 6ab1cefec2
commit b7390cb46f
167 changed files with 1230 additions and 8118 deletions

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-0-g0fb0fd9</span>
&#160;<span id="projectnumber">rev-distro-2.0.3-2-g58135e4-dirty</span>
</div>
<div id="projectbrief">Igor procedures for the analysis of PEARL data</div>
</td>
@ -94,7 +94,7 @@ $(document).ready(function(){initNavTree('pearl-anglescan-panel_8ipf_source.html
<div class="ttc" id="pearl-anglescan-panel_8ipf_html_af5435ccaabba78f855b244929dc09ed0"><div class="ttname"><a href="pearl-anglescan-panel_8ipf.html#af5435ccaabba78f855b244929dc09ed0">check_norm_alpha</a></div><div class="ttdeci">static variable check_norm_alpha()</div><div class="ttdef"><b>Definition:</b> <a href="pearl-anglescan-panel_8ipf_source.html#l00758">pearl-anglescan-panel.ipf:758</a></div></div>
<div class="ttc" id="pearl-anglescan-panel_8ipf_html_a21aab19fbcde395df6e1ea8654b3af9a"><div class="ttname"><a href="pearl-anglescan-panel_8ipf.html#a21aab19fbcde395df6e1ea8654b3af9a">asp_import_raw</a></div><div class="ttdeci">variable asp_import_raw(wave raw_data)</div><div class="ttdoc">import raw data </div><div class="ttdef"><b>Definition:</b> <a href="pearl-anglescan-panel_8ipf_source.html#l00197">pearl-anglescan-panel.ipf:197</a></div></div>
<div class="ttc" id="pearl-anglescan-process_8ipf_html_ab65d25af7476ed18f7bf7359614a912b"><div class="ttname"><a href="pearl-anglescan-process_8ipf.html#ab65d25af7476ed18f7bf7359614a912b">crop_strip</a></div><div class="ttdeci">variable crop_strip(wave strip, variable xlo, variable xhi)</div><div class="ttdoc">crop a strip at the sides. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-anglescan-process_8ipf_source.html#l00591">pearl-anglescan-process.ipf:591</a></div></div>
<div class="ttc" id="pearl-area-display_8ipf_html_afa2546f9cb03dfa8bf0cc9966f0b7a45"><div class="ttname"><a href="pearl-area-display_8ipf.html#afa2546f9cb03dfa8bf0cc9966f0b7a45">ad_update_profiles</a></div><div class="ttdeci">variable ad_update_profiles(wave image)</div><div class="ttdoc">update a profiles graph with new data. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-area-display_8ipf_source.html#l00321">pearl-area-display.ipf:321</a></div></div>
<div class="ttc" id="pearl-area-display_8ipf_html_afa2546f9cb03dfa8bf0cc9966f0b7a45"><div class="ttname"><a href="pearl-area-display_8ipf.html#afa2546f9cb03dfa8bf0cc9966f0b7a45">ad_update_profiles</a></div><div class="ttdeci">variable ad_update_profiles(wave image)</div><div class="ttdoc">update a profiles graph with new data. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-area-display_8ipf_source.html#l00322">pearl-area-display.ipf:322</a></div></div>
<div class="ttc" id="pearl-anglescan-panel_8ipf_html_ad8a01428a137278a31d4f1f4f9c634c5"><div class="ttname"><a href="pearl-anglescan-panel_8ipf.html#ad8a01428a137278a31d4f1f4f9c634c5">bp_save_prefs</a></div><div class="ttdeci">static variable bp_save_prefs(WMButtonAction *ba)</div><div class="ttdef"><b>Definition:</b> <a href="pearl-anglescan-panel_8ipf_source.html#l01157">pearl-anglescan-panel.ipf:1157</a></div></div>
<div class="ttc" id="pearl-anglescan-panel_8ipf_html_a0e0f10d125f1cdacffa3bff9b0854aa9"><div class="ttname"><a href="pearl-anglescan-panel_8ipf.html#a0e0f10d125f1cdacffa3bff9b0854aa9">asp_save_output_itx</a></div><div class="ttdeci">variable asp_save_output_itx()</div><div class="ttdoc">save the output diffractogram to an igor text file </div><div class="ttdef"><b>Definition:</b> <a href="pearl-anglescan-panel_8ipf_source.html#l00723">pearl-anglescan-panel.ipf:723</a></div></div>
<div class="ttc" id="pearl-anglescan-process_8ipf_html_ae57302acfc822c4817f2b7eef55efea2"><div class="ttname"><a href="pearl-anglescan-process_8ipf.html#ae57302acfc822c4817f2b7eef55efea2">display_hemi_scan</a></div><div class="ttdeci">string display_hemi_scan(string nickname, variable projection=defaultValue, variable graphtype=defaultValue, variable do_ticks=defaultValue, variable do_grids=defaultValue, string graphname=defaultValue)</div><div class="ttdoc">display a plot of a hemispherical angle scan. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-anglescan-process_8ipf_source.html#l01666">pearl-anglescan-process.ipf:1666</a></div></div>
@ -141,7 +141,7 @@ $(document).ready(function(){initNavTree('pearl-anglescan-panel_8ipf_source.html
<div class="ttc" id="pearl-anglescan-panel_8ipf_html_a0bdc14f90bdc40045200ac23229b225d"><div class="ttname"><a href="pearl-anglescan-panel_8ipf.html#a0bdc14f90bdc40045200ac23229b225d">bp_output_itx</a></div><div class="ttdeci">static variable bp_output_itx(WMButtonAction *ba)</div><div class="ttdef"><b>Definition:</b> <a href="pearl-anglescan-panel_8ipf_source.html#l01402">pearl-anglescan-panel.ipf:1402</a></div></div>
<div class="ttc" id="pearl-anglescan-panel_8ipf_html_aac9d4d0388cbe8e6aa8f47b1c5276d83"><div class="ttname"><a href="pearl-anglescan-panel_8ipf.html#aac9d4d0388cbe8e6aa8f47b1c5276d83">asp_close_graphs</a></div><div class="ttdeci">variable asp_close_graphs()</div><div class="ttdoc">close all graphs created by the angle scan panel </div><div class="ttdef"><b>Definition:</b> <a href="pearl-anglescan-panel_8ipf_source.html#l00650">pearl-anglescan-panel.ipf:650</a></div></div>
<div class="ttc" id="pearl-anglescan-panel_8ipf_html_a8f7266ac2840155dede704fda66fe6b0"><div class="ttname"><a href="pearl-anglescan-panel_8ipf.html#a8f7266ac2840155dede704fda66fe6b0">do_norm_alpha</a></div><div class="ttdeci">static variable do_norm_alpha(variable check, variable force=defaultValue)</div><div class="ttdoc">alpha-normalize the process data. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-anglescan-panel_8ipf_source.html#l00380">pearl-anglescan-panel.ipf:380</a></div></div>
<div class="ttc" id="pearl-area-display_8ipf_html_a8fad5aebaca72887d5898b4c421bcdae"><div class="ttname"><a href="pearl-area-display_8ipf.html#a8fad5aebaca72887d5898b4c421bcdae">ad_display_profiles</a></div><div class="ttdeci">string ad_display_profiles(wave image, string filter=defaultValue)</div><div class="ttdoc">open a new profiles graph window. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-area-display_8ipf_source.html#l00165">pearl-area-display.ipf:165</a></div></div>
<div class="ttc" id="pearl-area-display_8ipf_html_a8fad5aebaca72887d5898b4c421bcdae"><div class="ttname"><a href="pearl-area-display_8ipf.html#a8fad5aebaca72887d5898b4c421bcdae">ad_display_profiles</a></div><div class="ttdeci">string ad_display_profiles(wave image, string filter=defaultValue)</div><div class="ttdoc">open a new profiles graph window. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-area-display_8ipf_source.html#l00166">pearl-area-display.ipf:166</a></div></div>
<div class="ttc" id="pearl-anglescan-panel_8ipf_html_a92c27964d49ab8bcd7afc858ebe214a3"><div class="ttname"><a href="pearl-anglescan-panel_8ipf.html#a92c27964d49ab8bcd7afc858ebe214a3">load_prefs</a></div><div class="ttdeci">static variable load_prefs()</div><div class="ttdoc">load persistent package data from the preferences file. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-anglescan-panel_8ipf_source.html#l00161">pearl-anglescan-panel.ipf:161</a></div></div>
<div class="ttc" id="pearl-anglescan-panel_8ipf_html_addddc12e5b622a3d00756d724e5d05a9"><div class="ttname"><a href="pearl-anglescan-panel_8ipf.html#addddc12e5b622a3d00756d724e5d05a9">check_norm_theta</a></div><div class="ttdeci">static variable check_norm_theta()</div><div class="ttdef"><b>Definition:</b> <a href="pearl-anglescan-panel_8ipf_source.html#l00772">pearl-anglescan-panel.ipf:772</a></div></div>
<div class="ttc" id="pearl-anglescan-process_8ipf_html_a666dab03bb2e97ffef81cea450184d42"><div class="ttname"><a href="pearl-anglescan-process_8ipf.html#a666dab03bb2e97ffef81cea450184d42">set_contrast</a></div><div class="ttdeci">variable set_contrast(variable pcmin, variable pcmax, string graphname=defaultValue, string colortable=defaultValue)</div><div class="ttdoc">set the pseudocolor contrast by percentile. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-anglescan-process_8ipf_source.html#l03129">pearl-anglescan-process.ipf:3129</a></div></div>
@ -168,7 +168,7 @@ $(document).ready(function(){initNavTree('pearl-anglescan-panel_8ipf_source.html
<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-anglescan-panel_8ipf.html">pearl-anglescan-panel.ipf</a></li>
<li class="footer">Generated on Thu Feb 28 2019 18:57:24 for PEARL Procedures by
<li class="footer">Generated on Wed Aug 14 2019 17:52:59 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>