pearl-public/igor-public
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
igor-public/doc/html/pearl-area-profiles_8ipf.html
matthias muntwiler fda49c3195 new features: data reduction, angle scan panel 
- new data reduction interface for more efficient multi-peak fitting.
  the new interface breaks compatibility with pre-2.0 data reduction
  functions. user-defined functions must be adapted to the new
  interface.
- new angle scan processing panel for interactive data analysis.
2018-02-06 11:39:57 +01:00

977 lines
44 KiB
HTML
Raw Blame History

<!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-area-profiles.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-1.6.1-0-ge1f1aa9-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-area-profiles_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="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">pearl-area-profiles.ipf File Reference<div class="ingroups"><a class="el" href="group___arpes_package.html">ARPES package</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>profile extraction for multi-dimensional datasets acquired from area detectors.
<a href="#details">More...</a></p>
<p><a href="pearl-area-profiles_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_area_profiles"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_pearl_area_profiles.html">PearlAreaProfiles</a></td></tr>
<tr class="memdesc:namespace_pearl_area_profiles"><td class="mdescLeft">&#160;</td><td class="mdescRight">profile extraction for multi-dimensional datasets acquired from area detectors. <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:a8de5d4f1bcca91df5bbff568ab7b582d"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-profiles_8ipf.html#a8de5d4f1bcca91df5bbff568ab7b582d">ad_extract_rod</a> (wave dataset, variable x1, variable x2, variable y1, variable y2, variable z1, variable z2, string destname, variable noavg=defaultValue, variable sdev=defaultValue, variable pscale=defaultValue)</td></tr>
<tr class="memdesc:a8de5d4f1bcca91df5bbff568ab7b582d"><td class="mdescLeft">&#160;</td><td class="mdescRight">1D cut through 3D dataset, integrate in normal dimensions <a href="#a8de5d4f1bcca91df5bbff568ab7b582d">More...</a><br /></td></tr>
<tr class="separator:a8de5d4f1bcca91df5bbff568ab7b582d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83700e2faf844e2480c89b6ca4c66a79"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-profiles_8ipf.html#a83700e2faf844e2480c89b6ca4c66a79">ad_extract_rod_x</a> (wave dataset, variable q1, variable q2, variable r1, variable r2, string destname, variable noavg=defaultValue, variable sdev=defaultValue)</td></tr>
<tr class="memdesc:a83700e2faf844e2480c89b6ca4c66a79"><td class="mdescLeft">&#160;</td><td class="mdescRight">1D cut through 3D dataset along X dimension. <a href="#a83700e2faf844e2480c89b6ca4c66a79">More...</a><br /></td></tr>
<tr class="separator:a83700e2faf844e2480c89b6ca4c66a79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a363af257a04d51fff2a8d5b282f65f21"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-profiles_8ipf.html#a363af257a04d51fff2a8d5b282f65f21">ad_extract_rod_y</a> (wave dataset, variable p1, variable p2, variable r1, variable r2, string destname, variable noavg=defaultValue, variable sdev=defaultValue)</td></tr>
<tr class="memdesc:a363af257a04d51fff2a8d5b282f65f21"><td class="mdescLeft">&#160;</td><td class="mdescRight">1D cut through 3D dataset along Y dimension. <a href="#a363af257a04d51fff2a8d5b282f65f21">More...</a><br /></td></tr>
<tr class="separator:a363af257a04d51fff2a8d5b282f65f21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3483707fbdbfdbaec069591a5d3b07a6"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-profiles_8ipf.html#a3483707fbdbfdbaec069591a5d3b07a6">ad_extract_rod_z</a> (wave dataset, variable p1, variable p2, variable q1, variable q2, string destname, variable noavg=defaultValue, variable sdev=defaultValue)</td></tr>
<tr class="memdesc:a3483707fbdbfdbaec069591a5d3b07a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">1D cut through 3D dataset along Z dimension. <a href="#a3483707fbdbfdbaec069591a5d3b07a6">More...</a><br /></td></tr>
<tr class="separator:a3483707fbdbfdbaec069591a5d3b07a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65bb359c057a9d900c486e186c9974df"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-profiles_8ipf.html#a65bb359c057a9d900c486e186c9974df">ad_extract_slab</a> (wave dataset, variable x1, variable x2, variable y1, variable y2, variable z1, variable z2, string destname, variable noavg=defaultValue, variable pscale=defaultValue)</td></tr>
<tr class="memdesc:a65bb359c057a9d900c486e186c9974df"><td class="mdescLeft">&#160;</td><td class="mdescRight">2D cut through 3D dataset, integrate in normal dimension <a href="#a65bb359c057a9d900c486e186c9974df">More...</a><br /></td></tr>
<tr class="separator:a65bb359c057a9d900c486e186c9974df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af612340d1d132cacda9de7bb77c2e0aa"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-profiles_8ipf.html#af612340d1d132cacda9de7bb77c2e0aa">ad_extract_slab_x</a> (wave dataset, variable p1, variable p2, string destname, variable noavg=defaultValue)</td></tr>
<tr class="separator:af612340d1d132cacda9de7bb77c2e0aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2eb6a0bcced893e827cfa4e1236e8460"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-profiles_8ipf.html#a2eb6a0bcced893e827cfa4e1236e8460">ad_extract_slab_y</a> (wave dataset, variable q1, variable q2, string destname, variable noavg=defaultValue)</td></tr>
<tr class="separator:a2eb6a0bcced893e827cfa4e1236e8460"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71f02613c4a4d21c014493e906dbe922"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-profiles_8ipf.html#a71f02613c4a4d21c014493e906dbe922">ad_extract_slab_z</a> (wave dataset, variable r1, variable r2, string destname, variable noavg=defaultValue)</td></tr>
<tr class="separator:a71f02613c4a4d21c014493e906dbe922"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1a65cf82f6933db3dd7b564582e8ed1"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-profiles_8ipf.html#ab1a65cf82f6933db3dd7b564582e8ed1">ad_profile_x</a> (wave dataset, variable q1, variable q2, string destname, variable noavg=defaultValue)</td></tr>
<tr class="memdesc:ab1a65cf82f6933db3dd7b564582e8ed1"><td class="mdescLeft">&#160;</td><td class="mdescRight">1D cut through 2D dataset along X dimension, new destination wave. <a href="#ab1a65cf82f6933db3dd7b564582e8ed1">More...</a><br /></td></tr>
<tr class="separator:ab1a65cf82f6933db3dd7b564582e8ed1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa40fd5049f993e72fd52a66a6cdde7cc"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-profiles_8ipf.html#aa40fd5049f993e72fd52a66a6cdde7cc">ad_profile_x_w</a> (wave dataset, variable q1, variable q2, wave destwave, variable noavg=defaultValue)</td></tr>
<tr class="memdesc:aa40fd5049f993e72fd52a66a6cdde7cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">1D cut through 2D dataset along X dimension, existing destination wave. <a href="#aa40fd5049f993e72fd52a66a6cdde7cc">More...</a><br /></td></tr>
<tr class="separator:aa40fd5049f993e72fd52a66a6cdde7cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb1eed32a982037ebab00f5c3ea95e62"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-profiles_8ipf.html#abb1eed32a982037ebab00f5c3ea95e62">ad_profile_y</a> (wave dataset, variable p1, variable p2, string destname, variable noavg=defaultValue)</td></tr>
<tr class="memdesc:abb1eed32a982037ebab00f5c3ea95e62"><td class="mdescLeft">&#160;</td><td class="mdescRight">1D cut through 2D dataset along Y dimension, new destination wave. <a href="#abb1eed32a982037ebab00f5c3ea95e62">More...</a><br /></td></tr>
<tr class="separator:abb1eed32a982037ebab00f5c3ea95e62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b09e13162fa47cc076e1e661e80b002"><td class="memItemLeft" align="right" valign="top">threadsafe wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-profiles_8ipf.html#a8b09e13162fa47cc076e1e661e80b002">ad_profile_y_w</a> (wave dataset, variable p1, variable p2, wave destwave, variable noavg=defaultValue)</td></tr>
<tr class="memdesc:a8b09e13162fa47cc076e1e661e80b002"><td class="mdescLeft">&#160;</td><td class="mdescRight">1D cut through 2D dataset along X dimension, existing destination wave. <a href="#a8b09e13162fa47cc076e1e661e80b002">More...</a><br /></td></tr>
<tr class="separator:a8b09e13162fa47cc076e1e661e80b002"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab58b7c0a88743ecbcb0fc8296577a792"><td class="memItemLeft" align="right" valign="top">threadsafe variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-profiles_8ipf.html#ab58b7c0a88743ecbcb0fc8296577a792">calc_y_profile_mins</a> (wave image)</td></tr>
<tr class="separator:ab58b7c0a88743ecbcb0fc8296577a792"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3cadf0b28d1fd84e9922610c20868283"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-profiles_8ipf.html#a3cadf0b28d1fd84e9922610c20868283">ad_collect_multiscan_y</a> (wave dataset, wave positions, wave destwave, variable noavg=defaultValue)</td></tr>
<tr class="memdesc:a3cadf0b28d1fd84e9922610c20868283"><td class="mdescLeft">&#160;</td><td class="mdescRight">collect profiles from a multi-scan. <a href="#a3cadf0b28d1fd84e9922610c20868283">More...</a><br /></td></tr>
<tr class="separator:a3cadf0b28d1fd84e9922610c20868283"><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>profile extraction for multi-dimensional datasets acquired from area detectors. </p>
<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>2013-15 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>Definition in file <a class="el" href="pearl-area-profiles_8ipf_source.html">pearl-area-profiles.ipf</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a3cadf0b28d1fd84e9922610c20868283"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_collect_multiscan_y </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dataset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>positions</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>destwave</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>noavg</em> = <code>defaultValue</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>collect profiles from a multi-scan. </p>
<dl class="section warning"><dt>Warning</dt><dd>experimental: name and interface of this function may change. </dd></dl>
<p>Definition at line <a class="el" href="pearl-area-profiles_8ipf_source.html#l00621">621</a> of file <a class="el" href="pearl-area-profiles_8ipf_source.html">pearl-area-profiles.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a8de5d4f1bcca91df5bbff568ab7b582d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe wave ad_extract_rod </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dataset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>x1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>x2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>y1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>y2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>z1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>z2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>destname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>noavg</em> = <code>defaultValue</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>sdev</em> = <code>defaultValue</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>pscale</em> = <code>defaultValue</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>1D cut through 3D dataset, integrate in normal dimensions </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dataset</td><td></td></tr>
<tr><td class="paramname">x1,x2,y1,y2,z1,z2</td><td>coordinates of integration region by default, the coordinates use wave scaling coordinates of rod dimensions (to be preserved) must be nan coordinate pairs don't have to be ordered, i.e. both x1 &lt;= x2 and x1 &gt;= x2 are allowed. </td></tr>
<tr><td class="paramname">destname</td><td>name of destination wave. to be created in current data folder. if empty, the function returns a free wave </td></tr>
<tr><td class="paramname">noavg</td><td>non-zero = calculate the sum, default = 0 as of version 1.05, this option should rather be called "calc_sum" or similar. it is noavg for compatibility with older code. </td></tr>
<tr><td class="paramname">sdev</td><td>non-zero = calculate the standard deviation, default = 0 by default, the function calculates the average of the integration region set either the noavg or sdev option to select the sum or the standard deviation, respectively. if both options are set, noavg (sum) takes precedence. </td></tr>
<tr><td class="paramname">pscale</td><td>scaling of the slab coordinates x1, x2, ..., z2: zero or default = wave scaling, non-zero = point scaling</td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd><ul>
<li>version 1.02: the specification of the destination coordinates has changed</li>
<li>version 1.04: the function returns an empty wave reference if an error occurred </li>
</ul>
</dd></dl>
<p>Definition at line <a class="el" href="pearl-area-profiles_8ipf_source.html#l00054">54</a> of file <a class="el" href="pearl-area-profiles_8ipf_source.html">pearl-area-profiles.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a83700e2faf844e2480c89b6ca4c66a79"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe wave ad_extract_rod_x </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dataset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>q1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>q2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>r1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>r2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>destname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>noavg</em> = <code>defaultValue</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>sdev</em> = <code>defaultValue</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>1D cut through 3D dataset along X dimension. </p>
<p>see <a class="el" href="pearl-area-profiles_8ipf.html#a8de5d4f1bcca91df5bbff568ab7b582d" title="1D cut through 3D dataset, integrate in normal dimensions ">ad_extract_rod()</a> for descriptions of common parameters. </p>
<p>Definition at line <a class="el" href="pearl-area-profiles_8ipf_source.html#l00106">106</a> of file <a class="el" href="pearl-area-profiles_8ipf_source.html">pearl-area-profiles.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a363af257a04d51fff2a8d5b282f65f21"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe wave ad_extract_rod_y </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dataset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>p1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>p2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>r1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>r2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>destname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>noavg</em> = <code>defaultValue</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>sdev</em> = <code>defaultValue</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>1D cut through 3D dataset along Y dimension. </p>
<p>see <a class="el" href="pearl-area-profiles_8ipf.html#a8de5d4f1bcca91df5bbff568ab7b582d" title="1D cut through 3D dataset, integrate in normal dimensions ">ad_extract_rod()</a> for descriptions of common parameters. </p>
<p>Definition at line <a class="el" href="pearl-area-profiles_8ipf_source.html#l00168">168</a> of file <a class="el" href="pearl-area-profiles_8ipf_source.html">pearl-area-profiles.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a3483707fbdbfdbaec069591a5d3b07a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe wave ad_extract_rod_z </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dataset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>p1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>p2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>q1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>q2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>destname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>noavg</em> = <code>defaultValue</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>sdev</em> = <code>defaultValue</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>1D cut through 3D dataset along Z dimension. </p>
<p>see <a class="el" href="pearl-area-profiles_8ipf.html#a8de5d4f1bcca91df5bbff568ab7b582d" title="1D cut through 3D dataset, integrate in normal dimensions ">ad_extract_rod()</a> for descriptions of common parameters. </p>
<p>Definition at line <a class="el" href="pearl-area-profiles_8ipf_source.html#l00231">231</a> of file <a class="el" href="pearl-area-profiles_8ipf_source.html">pearl-area-profiles.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a65bb359c057a9d900c486e186c9974df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe wave ad_extract_slab </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dataset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>x1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>x2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>y1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>y2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>z1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>z2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>destname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>noavg</em> = <code>defaultValue</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>pscale</em> = <code>defaultValue</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>2D cut through 3D dataset, integrate in normal dimension </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dataset</td><td></td></tr>
<tr><td class="paramname">x1,x2,y1,y2,z1,z2</td><td>coordinates of integration region. by default, the coordinates use wave scaling. coordinates of slab dimensions (to be preserved) must be nan. coordinate pairs don't have to be ordered, i.e. both x1 &lt;= x2 and x1 &gt;= x2 are allowed. coordinates can be out of range (-inf and +inf allowed) to select the whole range. </td></tr>
<tr><td class="paramname">destname</td><td>name of destination wave. to be created in current data folder. if empty, the function returns a free wave. </td></tr>
<tr><td class="paramname">noavg</td><td>zero or default = average, non-zero = sum. </td></tr>
<tr><td class="paramname">pscale</td><td>scaling of the slab coordinates x1, x2, ..., z2: zero or default = wave scaling, non-zero = point scaling.</td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd><ul>
<li>version 1.02: the specification of the destination coordinates has changed</li>
<li>version 1.04: the function returns an empty wave reference if an error occurred </li>
</ul>
</dd></dl>
<p>Definition at line <a class="el" href="pearl-area-profiles_8ipf_source.html#l00313">313</a> of file <a class="el" href="pearl-area-profiles_8ipf_source.html">pearl-area-profiles.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="af612340d1d132cacda9de7bb77c2e0aa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe wave ad_extract_slab_x </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dataset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>p1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>p2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>destname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>noavg</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-area-profiles_8ipf_source.html#l00358">358</a> of file <a class="el" href="pearl-area-profiles_8ipf_source.html">pearl-area-profiles.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a2eb6a0bcced893e827cfa4e1236e8460"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe wave ad_extract_slab_y </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dataset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>q1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>q2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>destname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>noavg</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-area-profiles_8ipf_source.html#l00398">398</a> of file <a class="el" href="pearl-area-profiles_8ipf_source.html">pearl-area-profiles.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a71f02613c4a4d21c014493e906dbe922"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe wave ad_extract_slab_z </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dataset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>r1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>r2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>destname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>noavg</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-area-profiles_8ipf_source.html#l00438">438</a> of file <a class="el" href="pearl-area-profiles_8ipf_source.html">pearl-area-profiles.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="ab1a65cf82f6933db3dd7b564582e8ed1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe wave ad_profile_x </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dataset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>q1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>q2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>destname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>noavg</em> = <code>defaultValue</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>1D cut through 2D dataset along X dimension, new destination wave. </p>
<p>Definition at line <a class="el" href="pearl-area-profiles_8ipf_source.html#l00480">480</a> of file <a class="el" href="pearl-area-profiles_8ipf_source.html">pearl-area-profiles.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="aa40fd5049f993e72fd52a66a6cdde7cc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe wave ad_profile_x_w </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dataset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>q1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>q2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>destwave</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>noavg</em> = <code>defaultValue</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>1D cut through 2D dataset along X dimension, existing destination wave. </p>
<p>Definition at line <a class="el" href="pearl-area-profiles_8ipf_source.html#l00504">504</a> of file <a class="el" href="pearl-area-profiles_8ipf_source.html">pearl-area-profiles.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="abb1eed32a982037ebab00f5c3ea95e62"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe wave ad_profile_y </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dataset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>p1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>p2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>destname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>noavg</em> = <code>defaultValue</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>1D cut through 2D dataset along Y dimension, new destination wave. </p>
<p>Definition at line <a class="el" href="pearl-area-profiles_8ipf_source.html#l00542">542</a> of file <a class="el" href="pearl-area-profiles_8ipf_source.html">pearl-area-profiles.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a8b09e13162fa47cc076e1e661e80b002"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe wave ad_profile_y_w </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>dataset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>p1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>p2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>destwave</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>noavg</em> = <code>defaultValue</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>1D cut through 2D dataset along X dimension, existing destination wave. </p>
<p>Definition at line <a class="el" href="pearl-area-profiles_8ipf_source.html#l00567">567</a> of file <a class="el" href="pearl-area-profiles_8ipf_source.html">pearl-area-profiles.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="ab58b7c0a88743ecbcb0fc8296577a792"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">threadsafe variable calc_y_profile_mins </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>image</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="pearl-area-profiles_8ipf_source.html#l00603">603</a> of file <a class="el" href="pearl-area-profiles_8ipf_source.html">pearl-area-profiles.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-area-profiles_8ipf.html">pearl-area-profiles.ipf</a></li>
<li class="footer">Generated on Tue Feb 6 2018 11:37:56 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>
Reference in New Issue View Git Blame Copy Permalink