make documentation for version 2.0.3

This commit is contained in:
2019-02-28 18:57:56 +01:00
parent 0fb0fd92c8
commit 259f537a22
212 changed files with 24595 additions and 4912 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.2-0-g3235d52</span>
&#160;<span id="projectnumber">rev-distro-2.0.3-0-g0fb0fd9</span>
</div>
<div id="projectbrief">Igor procedures for the analysis of PEARL data</div>
</td>
@@ -81,19 +81,114 @@ $(document).ready(function(){initNavTree('pearl-arpes_8ipf.html','');});
</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-arpes.ipf File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>data acquisition and analysis package for ARPES at PEARL.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;pearl-area-display&quot;</code><br />
<code>#include &quot;pearl-area-profiles&quot;</code><br />
<code>#include &quot;pearl-area-import&quot;</code><br />
<code>#include &quot;pearl-pshell-import&quot;</code><br />
<code>#include &quot;pearl-data-explorer&quot;</code><br />
<code>#include &quot;pearl-anglescan-process&quot;</code><br />
<code>#include &quot;pearl-anglescan-panel&quot;</code><br />
<code>#include &quot;pearl-anglescan-tracker&quot;</code><br />
<code>#include &quot;pearl-scienta-preprocess&quot;</code><br />
<code>#include &quot;pearl-elog&quot;</code><br />
</div>
<p><a href="pearl-arpes_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_arpes"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_pearl_arpes.html">PearlArpes</a></td></tr>
<tr class="memdesc:namespace_pearl_arpes"><td class="mdescLeft">&#160;</td><td class="mdescRight">data acquisition and analysis package for ARPES at PEARL. <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:a8e4eacc6efacf2c65615c1ea72d722ed"><td class="memItemLeft" align="right" valign="top">static variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-arpes_8ipf.html#a8e4eacc6efacf2c65615c1ea72d722ed">AfterCompiledHook</a> ()</td></tr>
<tr class="memdesc:a8e4eacc6efacf2c65615c1ea72d722ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">initializes package data once when the procedure is first loaded <a href="#a8e4eacc6efacf2c65615c1ea72d722ed">More...</a><br /></td></tr>
<tr class="separator:a8e4eacc6efacf2c65615c1ea72d722ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac41f24572943dac2b40c255797a6c7a8"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-arpes_8ipf.html#ac41f24572943dac2b40c255797a6c7a8">UnloadPearlArpesPackage</a> ()</td></tr>
<tr class="separator:ac41f24572943dac2b40c255797a6c7a8"><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>data acquisition and analysis package for ARPES at PEARL. </p>
<p>this procedure defines the PEARL ARPES package the main purpose of this file is to load the necessary dependent procedures (see the include statements at the top)</p>
<dl class="section pre"><dt>Precondition</dt><dd><ul>
<li>HDF5 XOP must be loaded.</li>
<li>on-line data acquisition functionality requires the EPICS XOP to be loaded</li>
</ul>
</dd></dl>
<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>2012-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 class="definition">Definition in file <a class="el" href="pearl-arpes_8ipf_source.html">pearl-arpes.ipf</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a8e4eacc6efacf2c65615c1ea72d722ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e4eacc6efacf2c65615c1ea72d722ed">&#9670;&nbsp;</a></span>AfterCompiledHook()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static variable AfterCompiledHook </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>initializes package data once when the procedure is first loaded </p>
<p class="definition">Definition at line <a class="el" href="pearl-arpes_8ipf_source.html#l00083">83</a> of file <a class="el" href="pearl-arpes_8ipf_source.html">pearl-arpes.ipf</a>.</p>
</div>
</div>
<a id="ac41f24572943dac2b40c255797a6c7a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac41f24572943dac2b40c255797a6c7a8">&#9670;&nbsp;</a></span>UnloadPearlArpesPackage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable UnloadPearlArpesPackage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pearl-arpes_8ipf_source.html#l00090">90</a> of file <a class="el" href="pearl-arpes_8ipf_source.html">pearl-arpes.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-arpes_8ipf.html">pearl-arpes.ipf</a></li>
<li class="footer">Generated on Sun Feb 10 2019 14:39:17 for PEARL Procedures by
<li class="footer">Generated on Thu Feb 28 2019 18:57:24 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>