Files
igor-public/doc/html/pearl-tools_8ipf.html
matthias muntwiler 70207096d5
Some checks failed
build and deploy documentation / build-and-deploy (push) Failing after 0s
documentation for 3.1.0
2025-12-22 17:29:05 +01:00

327 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<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>
<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>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">PEARL Procedures<span id="projectnumber">&#160;rev-distro-3.1.0-0-gea838b3-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.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('pearl-tools_8ipf.html',''); initResizable(); });
/* @license-end */
</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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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 id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a6bdd1c0b269f1d7d99843ce0cb218cc7" id="r_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" id="r_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" id="r_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" id="r_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" id="r_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" id="r_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 id="a90c62bdfc186e2482ccb18113a591d5e" name="a90c62bdfc186e2482ccb18113a591d5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90c62bdfc186e2482ccb18113a591d5e">&#9670;&#160;</a></span>AppendToGraphIterator()</h2>
<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 class="definition">Definition at line <a class="el" href="pearl-tools_8ipf_source.html#l00027">27</a> of file <a class="el" href="pearl-tools_8ipf_source.html">pearl-tools.ipf</a>.</p>
</div>
</div>
<a id="a3fb8c06030dc41a599380150807caeb0" name="a3fb8c06030dc41a599380150807caeb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fb8c06030dc41a599380150807caeb0">&#9670;&#160;</a></span>DefaultFolderIterator()</h2>
<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 class="definition">Definition at line <a class="el" href="pearl-tools_8ipf_source.html#l00066">66</a> of file <a class="el" href="pearl-tools_8ipf_source.html">pearl-tools.ipf</a>.</p>
</div>
</div>
<a id="a6bdd1c0b269f1d7d99843ce0cb218cc7" name="a6bdd1c0b269f1d7d99843ce0cb218cc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bdd1c0b269f1d7d99843ce0cb218cc7">&#9670;&#160;</a></span>DefaultWaveIterator()</h2>
<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 class="definition">Definition at line <a class="el" href="pearl-tools_8ipf_source.html#l00019">19</a> of file <a class="el" href="pearl-tools_8ipf_source.html">pearl-tools.ipf</a>.</p>
</div>
</div>
<a id="a7c5307e5e7c0202d2b088fdc11887069" name="a7c5307e5e7c0202d2b088fdc11887069"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c5307e5e7c0202d2b088fdc11887069">&#9670;&#160;</a></span>IterateDataFolders()</h2>
<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 class="definition">Definition at line <a class="el" href="pearl-tools_8ipf_source.html#l00080">80</a> of file <a class="el" href="pearl-tools_8ipf_source.html">pearl-tools.ipf</a>.</p>
</div>
</div>
<a id="aabc250f68dd85ca58d7be5077255af99" name="aabc250f68dd85ca58d7be5077255af99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aabc250f68dd85ca58d7be5077255af99">&#9670;&#160;</a></span>IterateWaves()</h2>
<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 class="definition">Definition at line <a class="el" href="pearl-tools_8ipf_source.html#l00046">46</a> of file <a class="el" href="pearl-tools_8ipf_source.html">pearl-tools.ipf</a>.</p>
</div>
</div>
<a id="aea193a1b5fbdbb2a5dec9f25f3c05c45" name="aea193a1b5fbdbb2a5dec9f25f3c05c45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea193a1b5fbdbb2a5dec9f25f3c05c45">&#9670;&#160;</a></span>SumWavesIterator()</h2>
<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 class="definition">Definition at line <a class="el" href="pearl-tools_8ipf_source.html#l00035">35</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 Mon Dec 22 2025 17:26:40 for PEARL Procedures by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>