igor-public/doc/html/pearl-tools_8ipf.html
matthias muntwiler 17036e1daa minor bug fixes in angle-scan import and documentation
- find attributes of region scans in angle-scan panel
- more detailed description of reduced import with regions
2018-03-13 12:43:29 +01:00

334 lines
14 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-tools.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-2.0.0-0-gfda49c3-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-tools_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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">pearl-tools.ipf File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;pearl-gui-tools&quot;</code><br />
</div>
<p><a href="pearl-tools_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:a6bdd1c0b269f1d7d99843ce0cb218cc7"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-tools_8ipf.html#a6bdd1c0b269f1d7d99843ce0cb218cc7">DefaultWaveIterator</a> (wave w, string *sdata)</td></tr>
<tr class="separator:a6bdd1c0b269f1d7d99843ce0cb218cc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90c62bdfc186e2482ccb18113a591d5e"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-tools_8ipf.html#a90c62bdfc186e2482ccb18113a591d5e">AppendToGraphIterator</a> (wave w, string *sdata)</td></tr>
<tr class="separator:a90c62bdfc186e2482ccb18113a591d5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea193a1b5fbdbb2a5dec9f25f3c05c45"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-tools_8ipf.html#aea193a1b5fbdbb2a5dec9f25f3c05c45">SumWavesIterator</a> (wave w, string *sdata)</td></tr>
<tr class="separator:aea193a1b5fbdbb2a5dec9f25f3c05c45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabc250f68dd85ca58d7be5077255af99"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-tools_8ipf.html#aabc250f68dd85ca58d7be5077255af99">IterateWaves</a> (string matchStr, funcref iterator, string sdata)</td></tr>
<tr class="separator:aabc250f68dd85ca58d7be5077255af99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fb8c06030dc41a599380150807caeb0"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-tools_8ipf.html#a3fb8c06030dc41a599380150807caeb0">DefaultFolderIterator</a> (dfref df, string *sdata)</td></tr>
<tr class="separator:a3fb8c06030dc41a599380150807caeb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c5307e5e7c0202d2b088fdc11887069"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-tools_8ipf.html#a7c5307e5e7c0202d2b088fdc11887069">IterateDataFolders</a> (string matchStr, funcref iterator, string sdata, string progress_title=defaultValue)</td></tr>
<tr class="separator:a7c5307e5e7c0202d2b088fdc11887069"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a90c62bdfc186e2482ccb18113a591d5e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable AppendToGraphIterator </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string *&#160;</td>
<td class="paramname"><em>sdata</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="pearl-tools_8ipf_source.html#l00026">26</a> of file <a class="el" href="pearl-tools_8ipf_source.html">pearl-tools.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a3fb8c06030dc41a599380150807caeb0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable DefaultFolderIterator </td>
<td>(</td>
<td class="paramtype">dfref&#160;</td>
<td class="paramname"><em>df</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string *&#160;</td>
<td class="paramname"><em>sdata</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="pearl-tools_8ipf_source.html#l00065">65</a> of file <a class="el" href="pearl-tools_8ipf_source.html">pearl-tools.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a6bdd1c0b269f1d7d99843ce0cb218cc7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable DefaultWaveIterator </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string *&#160;</td>
<td class="paramname"><em>sdata</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="pearl-tools_8ipf_source.html#l00018">18</a> of file <a class="el" href="pearl-tools_8ipf_source.html">pearl-tools.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a7c5307e5e7c0202d2b088fdc11887069"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string IterateDataFolders </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>matchStr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">funcref&#160;</td>
<td class="paramname"><em>iterator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>sdata</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>progress_title</em> = <code>defaultValue</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="pearl-tools_8ipf_source.html#l00079">79</a> of file <a class="el" href="pearl-tools_8ipf_source.html">pearl-tools.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="aabc250f68dd85ca58d7be5077255af99"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string IterateWaves </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>matchStr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">funcref&#160;</td>
<td class="paramname"><em>iterator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>sdata</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="pearl-tools_8ipf_source.html#l00045">45</a> of file <a class="el" href="pearl-tools_8ipf_source.html">pearl-tools.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="aea193a1b5fbdbb2a5dec9f25f3c05c45"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable SumWavesIterator </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string *&#160;</td>
<td class="paramname"><em>sdata</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="pearl-tools_8ipf_source.html#l00034">34</a> of file <a class="el" href="pearl-tools_8ipf_source.html">pearl-tools.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-tools_8ipf.html">pearl-tools.ipf</a></li>
<li class="footer">Generated on Tue Mar 13 2018 12:43:01 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>