pearl-public/igor-public
2
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
distro
igor-public/doc/html/pearl-tools_8ipf_source.html
T

269 lines
29 KiB
HTML
Raw Permalink Normal View History

compile documentation for release 3.0.0
2022-03-01 15:33:15 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
documentation for 3.1.0
2025-12-22 17:29:05 +01:00
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
include documentation in public distribution
2017-07-04 11:24:41 +02:00
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
documentation for 3.1.0
2025-12-22 17:29:05 +01:00
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
make documentation for release 2.0.2
2019-02-10 14:39:57 +01:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
include documentation in public distribution
2017-07-04 11:24:41 +02:00
<title>PEARL Procedures: pearl-tools.ipf Source File</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>
documentation for 3.1.0
2025-12-22 17:29:05 +01:00
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">PEARL Procedures<span id="projectnumber">&#160;rev-distro-3.1.0-0-gea838b3-dirty</span>
include documentation in public distribution
2017-07-04 11:24:41 +02:00
</div>
<div id="projectbrief">Igor procedures for the analysis of PEARL data</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
documentation for 3.1.0
2025-12-22 17:29:05 +01:00
<!-- Generated by Doxygen 1.9.8 -->
include documentation in public distribution
2017-07-04 11:24:41 +02:00
<script type="text/javascript">
documentation for 3.1.0
2025-12-22 17:29:05 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
compile documentation for release 3.0.0
2022-03-01 15:33:15 +01:00
/* @license-end */
include documentation in public distribution
2017-07-04 11:24:41 +02:00
</script>
make documentation for release 2.0.2
2019-02-10 14:39:57 +01:00
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
documentation for 3.1.0
2025-12-22 17:29:05 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
make documentation for release 2.0.2
2019-02-10 14:39:57 +01:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
documentation for 3.1.0
2025-12-22 17:29:05 +01:00
/* @license-end */
</script>
make documentation for release 2.0.2
2019-02-10 14:39:57 +01:00
<div id="main-nav"></div>
documentation for 3.1.0
2025-12-22 17:29:05 +01:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
include documentation in public distribution
2017-07-04 11:24:41 +02:00
</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">
documentation for 3.1.0
2025-12-22 17:29:05 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
compile documentation for release 3.0.0
2022-03-01 15:33:15 +01:00
$(document).ready(function(){initNavTree('pearl-tools_8ipf_source.html',''); initResizable(); });
/* @license-end */
include documentation in public distribution
2017-07-04 11:24:41 +02:00
</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">
documentation for 3.1.0
2025-12-22 17:29:05 +01:00
<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>
include documentation in public distribution
2017-07-04 11:24:41 +02:00
</div>
<div class="header">
documentation for 3.1.0
2025-12-22 17:29:05 +01:00
<div class="headertitle"><div class="title">pearl-tools.ipf</div></div>
include documentation in public distribution
2017-07-04 11:24:41 +02:00
</div><!--header-->
<div class="contents">
documentation for 3.1.0
2025-12-22 17:29:05 +01:00
<a href="pearl-tools_8ipf.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma TextEncoding = &quot;UTF-8&quot;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#pragma rtGlobals=3 </span><span class="comment">// Use modern global access method and strict wave access.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#pragma version = 1.00</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#pragma IgorVersion = 6.2</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#pragma ModuleName = PearlTools</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &quot;pearl-gui-tools&quot;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">// general programming tools for Igor</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">// $Id$</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// author: matthias.muntwiler@psi.ch</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// Copyright (c) 2009-14 Paul Scherrer Institut</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="foldopen" id="foldopen00019" data-start="{" data-end="}">
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="pearl-tools_8ipf.html#a6bdd1c0b269f1d7d99843ce0cb218cc7"> 19</a></span>function <a class="code hl_function" href="pearl-tools_8ipf.html#a6bdd1c0b269f1d7d99843ce0cb218cc7">DefaultWaveIterator</a>(w, sdata)</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">// function prototype for IterateWaves</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> wave w <span class="comment">// wave which the iterator is supposed to work on</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keywordtype">string</span> &amp;sdata <span class="comment">// string with additional data, shared between calls</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// this is a pass-by-reference argument,</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// the function may modify the string</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span>end</div>
</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="foldopen" id="foldopen00027" data-start="{" data-end="}">
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="pearl-tools_8ipf.html#a90c62bdfc186e2482ccb18113a591d5e"> 27</a></span>function <a class="code hl_function" href="pearl-tools_8ipf.html#a90c62bdfc186e2482ccb18113a591d5e">AppendToGraphIterator</a>(w, sdata)</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">// append iterated waves to the current graph</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> wave w <span class="comment">// wave to be displayed</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keywordtype">string</span> &amp;sdata <span class="comment">// not used</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> appendtograph w</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>end</div>
</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="foldopen" id="foldopen00035" data-start="{" data-end="}">
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="pearl-tools_8ipf.html#aea193a1b5fbdbb2a5dec9f25f3c05c45"> 35</a></span>function <a class="code hl_function" href="pearl-tools_8ipf.html#aea193a1b5fbdbb2a5dec9f25f3c05c45">SumWavesIterator</a>(w, sdata)</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment">// sum waves into one result wave</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> wave w <span class="comment">// wave which the iterator is supposed to work on</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordtype">string</span> &amp;sdata <span class="comment">// name of the result wave, can include absolute path</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// the wave must exist and compatible with the summands</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// the caller is responsible for initialization of the wave</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> wave result = $sdata</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> result += w</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span>end</div>
</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="foldopen" id="foldopen00046" data-start="{" data-end="}">
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="pearl-tools_8ipf.html#aabc250f68dd85ca58d7be5077255af99"> 46</a></span>function/s <a class="code hl_function" href="pearl-tools_8ipf.html#aabc250f68dd85ca58d7be5077255af99">IterateWaves</a>(matchStr, iterator, sdata)</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment">// iterate over all waves matching a specified pattern (see built-in WaveList function),</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment">// passing each wave to a user-defined iterator function</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">string</span> matchStr <span class="comment">// matchStr as for WaveList</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> funcref <a class="code hl_function" href="pearl-tools_8ipf.html#a6bdd1c0b269f1d7d99843ce0cb218cc7">DefaultWaveIterator</a> iterator <span class="comment">// iterator function</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// use the DefaultWaveIterator function as a template</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">string</span> sdata <span class="comment">// data string passed to iterator function</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// the iterator may modify the string</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// the function returns the string at the end</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">string</span> wlist = WaveList(matchStr, <span class="stringliteral">&quot;;&quot;</span>, <span class="stringliteral">&quot;&quot;</span>)</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> variable n = ItemsInList(wlist, &quot;;&quot;)</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> variable i</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> for (i = 0; i &lt; n; i += 1)</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> wave w = $(StringFromList(i, wlist, &quot;;&quot;))</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> iterator(w, sdata)</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> endfor</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> return sdata</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span>end</div>
</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="foldopen" id="foldopen00066" data-start="{" data-end="}">
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="pearl-tools_8ipf.html#a3fb8c06030dc41a599380150807caeb0"> 66</a></span>function <a class="code hl_function" href="pearl-tools_8ipf.html#a3fb8c06030dc41a599380150807caeb0">DefaultFolderIterator</a>(df, sdata)</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment">// function prototype for IterateWaves</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> dfref df <span class="comment">// data folder reference which the iterator is supposed to work on</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordtype">string</span> &amp;sdata <span class="comment">// string with additional data, shared between calls</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// this is a pass-by-reference argument,</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="comment">// the function may modify the string</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// switch to requested data folder</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> setdatafolder df</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// for testing</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> print getdatafolder(1)</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="comment">// no need to switch back to original folder</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span>end</div>
</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="foldopen" id="foldopen00080" data-start="{" data-end="}">
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="pearl-tools_8ipf.html#a7c5307e5e7c0202d2b088fdc11887069"> 80</a></span>function/s <a class="code hl_function" href="pearl-tools_8ipf.html#a7c5307e5e7c0202d2b088fdc11887069">IterateDataFolders</a>(matchStr, iterator, sdata, [progress_title])</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment">// iterate over all data folders matching a specified pattern in the current data folder,</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment">// passing each folder to a user-defined iterator function</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keywordtype">string</span> matchStr <span class="comment">// matchStr as for the built-in stringmatch function</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> funcref <a class="code hl_function" href="pearl-tools_8ipf.html#a3fb8c06030dc41a599380150807caeb0">DefaultFolderIterator</a> iterator <span class="comment">// iterator function</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// use the DefaultFolderIterator function as a template</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordtype">string</span> sdata <span class="comment">// data string passed to iterator function</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="comment">// the iterator may modify the string</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="comment">// the function returns the string at the end</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordtype">string</span> progress_title <span class="comment">// title of the progress window (optional)</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="comment">// if not specified or empty, the progress window will not be shown.</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="comment">// if the progress window is show, the user can abort the iteration.</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="comment">// the function result does not indicate whether the iteration was completed or aborted.</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="comment">// the iterator and caller must take care of leaving the data in a consistent state.</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> if (ParamIsDefault(progress_title))</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> progress_title = &quot;&quot;</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> endif</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> variable show_progress = strlen(progress_title) &gt; 0</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> dfref origdf = GetDataFolderDFR()</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> dfref curdf</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> variable index = 0</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> variable abort_req = 0</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keywordtype">string</span> objName</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> variable ndf = CountObjectsDFR(origdf, 4)</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> if (show_progress)</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <a class="code hl_function" href="pearl-gui-tools_8ipf.html#aaf29d090c81e00cf44af295193b24c5a">display_progress_panel</a>(progress_title, &quot;&quot;, ndf)</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> endif</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> do</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> objName = GetIndexedObjNameDFR(origdf, 4, index)</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> if (strlen(objName) == 0)</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> break</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> endif</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> if (stringmatch(objname, matchstr))</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> if (show_progress)</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> abort_req = <a class="code hl_function" href="pearl-gui-tools_8ipf.html#a97ad19d83cf0007c4bcf97a32164610f">update_progress_panel</a>(index, message=objName)</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> if (abort_req)</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> break</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> endif</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> endif</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> setdatafolder origdf</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> curdf = $(&quot;:&quot; + objname)</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> iterator(curdf, sdata)</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> endif</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> index += 1</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> while(1)</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> if (show_progress)</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> <a class="code hl_function" href="pearl-gui-tools_8ipf.html#aca0a41a0f28a35ac7535df30ddbd79fe">kill_progress_panel</a>()</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> endif</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> </div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> setdatafolder origdf</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> return sdata</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span>end</div>
</div>
<div class="ttc" id="apearl-gui-tools_8ipf_html_a97ad19d83cf0007c4bcf97a32164610f"><div class="ttname"><a href="pearl-gui-tools_8ipf.html#a97ad19d83cf0007c4bcf97a32164610f">update_progress_panel</a></div><div class="ttdeci">variable update_progress_panel(variable progress, string message=defaultValue, variable progress_max=defaultValue)</div><div class="ttdef"><b>Definition</b> <a href="pearl-gui-tools_8ipf_source.html#l00033">pearl-gui-tools.ipf:33</a></div></div>
<div class="ttc" id="apearl-gui-tools_8ipf_html_aaf29d090c81e00cf44af295193b24c5a"><div class="ttname"><a href="pearl-gui-tools_8ipf.html#aaf29d090c81e00cf44af295193b24c5a">display_progress_panel</a></div><div class="ttdeci">variable display_progress_panel(string title, string message, variable progress_max)</div><div class="ttdef"><b>Definition</b> <a href="pearl-gui-tools_8ipf_source.html#l00019">pearl-gui-tools.ipf:19</a></div></div>
<div class="ttc" id="apearl-gui-tools_8ipf_html_aca0a41a0f28a35ac7535df30ddbd79fe"><div class="ttname"><a href="pearl-gui-tools_8ipf.html#aca0a41a0f28a35ac7535df30ddbd79fe">kill_progress_panel</a></div><div class="ttdeci">variable kill_progress_panel()</div><div class="ttdef"><b>Definition</b> <a href="pearl-gui-tools_8ipf_source.html#l00051">pearl-gui-tools.ipf:51</a></div></div>
<div class="ttc" id="apearl-tools_8ipf_html_a3fb8c06030dc41a599380150807caeb0"><div class="ttname"><a href="pearl-tools_8ipf.html#a3fb8c06030dc41a599380150807caeb0">DefaultFolderIterator</a></div><div class="ttdeci">variable DefaultFolderIterator(dfref df, string *sdata)</div><div class="ttdef"><b>Definition</b> <a href="pearl-tools_8ipf_source.html#l00066">pearl-tools.ipf:66</a></div></div>
<div class="ttc" id="apearl-tools_8ipf_html_a6bdd1c0b269f1d7d99843ce0cb218cc7"><div class="ttname"><a href="pearl-tools_8ipf.html#a6bdd1c0b269f1d7d99843ce0cb218cc7">DefaultWaveIterator</a></div><div class="ttdeci">variable DefaultWaveIterator(wave w, string *sdata)</div><div class="ttdef"><b>Definition</b> <a href="pearl-tools_8ipf_source.html#l00019">pearl-tools.ipf:19</a></div></div>
<div class="ttc" id="apearl-tools_8ipf_html_a7c5307e5e7c0202d2b088fdc11887069"><div class="ttname"><a href="pearl-tools_8ipf.html#a7c5307e5e7c0202d2b088fdc11887069">IterateDataFolders</a></div><div class="ttdeci">string IterateDataFolders(string matchStr, funcref iterator, string sdata, string progress_title=defaultValue)</div><div class="ttdef"><b>Definition</b> <a href="pearl-tools_8ipf_source.html#l00080">pearl-tools.ipf:80</a></div></div>
<div class="ttc" id="apearl-tools_8ipf_html_a90c62bdfc186e2482ccb18113a591d5e"><div class="ttname"><a href="pearl-tools_8ipf.html#a90c62bdfc186e2482ccb18113a591d5e">AppendToGraphIterator</a></div><div class="ttdeci">variable AppendToGraphIterator(wave w, string *sdata)</div><div class="ttdef"><b>Definition</b> <a href="pearl-tools_8ipf_source.html#l00027">pearl-tools.ipf:27</a></div></div>
<div class="ttc" id="apearl-tools_8ipf_html_aabc250f68dd85ca58d7be5077255af99"><div class="ttname"><a href="pearl-tools_8ipf.html#aabc250f68dd85ca58d7be5077255af99">IterateWaves</a></div><div class="ttdeci">string IterateWaves(string matchStr, funcref iterator, string sdata)</div><div class="ttdef"><b>Definition</b> <a href="pearl-tools_8ipf_source.html#l00046">pearl-tools.ipf:46</a></div></div>
<div class="ttc" id="apearl-tools_8ipf_html_aea193a1b5fbdbb2a5dec9f25f3c05c45"><div class="ttname"><a href="pearl-tools_8ipf.html#aea193a1b5fbdbb2a5dec9f25f3c05c45">SumWavesIterator</a></div><div class="ttdeci">variable SumWavesIterator(wave w, string *sdata)</div><div class="ttdef"><b>Definition</b> <a href="pearl-tools_8ipf_source.html#l00035">pearl-tools.ipf:35</a></div></div>
make documentation for version 2.0.3
2019-02-28 18:57:56 +01:00
</div><!-- fragment --></div><!-- contents -->
include documentation in public distribution
2017-07-04 11:24:41 +02:00
</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>
documentation for 3.1.0
2025-12-22 17:29:05 +01:00
<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>
include documentation in public distribution
2017-07-04 11:24:41 +02:00
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink