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,246 @@ $(document).ready(function(){initNavTree('pearl-polar-coordinates_8ipf.html','')
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">pearl-polar-coordinates.ipf File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="pearl-polar-coordinates_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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aca0a5aaa4854d83ef667c53007312fb8"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-polar-coordinates_8ipf.html#aca0a5aaa4854d83ef667c53007312fb8">cart2polar</a> (variable xx, variable yy, variable zz, variable *radius, variable *theta, variable *phi)</td></tr>
<tr class="separator:aca0a5aaa4854d83ef667c53007312fb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfc1f0b3cddf672b0ccdb6a22b97ba9e"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-polar-coordinates_8ipf.html#adfc1f0b3cddf672b0ccdb6a22b97ba9e">cart2polar_wave</a> (wave in, wave out)</td></tr>
<tr class="separator:adfc1f0b3cddf672b0ccdb6a22b97ba9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94ccfa9cf52c55eb1f66c2704478c396"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-polar-coordinates_8ipf.html#a94ccfa9cf52c55eb1f66c2704478c396">polar2cart</a> (variable radius, variable theta, variable phi, variable *xx, variable *yy, variable *zz)</td></tr>
<tr class="separator:a94ccfa9cf52c55eb1f66c2704478c396"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a0ffb6b9160413d9694b1fd8e10c858"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-polar-coordinates_8ipf.html#a6a0ffb6b9160413d9694b1fd8e10c858">polar2cart_wave</a> (wave in, wave out)</td></tr>
<tr class="separator:a6a0ffb6b9160413d9694b1fd8e10c858"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58139e6ebfba242b6b2ba3533b865a9a"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-polar-coordinates_8ipf.html#a58139e6ebfba242b6b2ba3533b865a9a">polar_distance</a> (variable polar1, variable azim1, variable polar2, variable azim2)</td></tr>
<tr class="separator:a58139e6ebfba242b6b2ba3533b865a9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="aca0a5aaa4854d83ef667c53007312fb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca0a5aaa4854d83ef667c53007312fb8">&#9670;&nbsp;</a></span>cart2polar()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable cart2polar </td>
<td>(</td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>xx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>yy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>zz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable *&#160;</td>
<td class="paramname"><em>radius</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable *&#160;</td>
<td class="paramname"><em>theta</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable *&#160;</td>
<td class="paramname"><em>phi</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pearl-polar-coordinates_8ipf_source.html#l00010">10</a> of file <a class="el" href="pearl-polar-coordinates_8ipf_source.html">pearl-polar-coordinates.ipf</a>.</p>
</div>
</div>
<a id="adfc1f0b3cddf672b0ccdb6a22b97ba9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfc1f0b3cddf672b0ccdb6a22b97ba9e">&#9670;&nbsp;</a></span>cart2polar_wave()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable cart2polar_wave </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pearl-polar-coordinates_8ipf_source.html#l00036">36</a> of file <a class="el" href="pearl-polar-coordinates_8ipf_source.html">pearl-polar-coordinates.ipf</a>.</p>
</div>
</div>
<a id="a94ccfa9cf52c55eb1f66c2704478c396"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94ccfa9cf52c55eb1f66c2704478c396">&#9670;&nbsp;</a></span>polar2cart()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable polar2cart </td>
<td>(</td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>radius</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>theta</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>phi</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable *&#160;</td>
<td class="paramname"><em>xx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable *&#160;</td>
<td class="paramname"><em>yy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable *&#160;</td>
<td class="paramname"><em>zz</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pearl-polar-coordinates_8ipf_source.html#l00048">48</a> of file <a class="el" href="pearl-polar-coordinates_8ipf_source.html">pearl-polar-coordinates.ipf</a>.</p>
</div>
</div>
<a id="a6a0ffb6b9160413d9694b1fd8e10c858"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a0ffb6b9160413d9694b1fd8e10c858">&#9670;&nbsp;</a></span>polar2cart_wave()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable polar2cart_wave </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pearl-polar-coordinates_8ipf_source.html#l00058">58</a> of file <a class="el" href="pearl-polar-coordinates_8ipf_source.html">pearl-polar-coordinates.ipf</a>.</p>
</div>
</div>
<a id="a58139e6ebfba242b6b2ba3533b865a9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58139e6ebfba242b6b2ba3533b865a9a">&#9670;&nbsp;</a></span>polar_distance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable polar_distance </td>
<td>(</td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>polar1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>azim1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>polar2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>azim2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pearl-polar-coordinates_8ipf_source.html#l00069">69</a> of file <a class="el" href="pearl-polar-coordinates_8ipf_source.html">pearl-polar-coordinates.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-polar-coordinates_8ipf.html">pearl-polar-coordinates.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>