igor-public/doc/html/pearl-area-display_8ipf.html

1662 lines
84 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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PEARL Procedures: pearl-area-display.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);
</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PEARL Procedures
&#160;<span id="projectnumber">rev-distro-2.0.3-2-g58135e4-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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">
$(document).ready(function(){initNavTree('pearl-area-display_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-display.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>visualization tools for 2D and 3D data.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;pearl-compat&quot;</code><br />
</div>
<p><a href="pearl-area-display_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_display"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_pearl_area_display.html">PearlAreaDisplay</a></td></tr>
<tr class="memdesc:namespace_pearl_area_display"><td class="mdescLeft">&#160;</td><td class="mdescRight">instant visualization of angle scan and manipulator position. <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:a195b12857685c4e535a840c5db324b4a"><td class="memItemLeft" align="right" valign="top">static string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a195b12857685c4e535a840c5db324b4a">graphname_from_dfref</a> (dfref df, string prefix)</td></tr>
<tr class="memdesc:a195b12857685c4e535a840c5db324b4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">compose a valid and unique graph name from a data folder reference <a href="#a195b12857685c4e535a840c5db324b4a">More...</a><br /></td></tr>
<tr class="separator:a195b12857685c4e535a840c5db324b4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2b11295d2715e9af019513923c64570"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#ae2b11295d2715e9af019513923c64570">ad_display</a> (wave image)</td></tr>
<tr class="memdesc:ae2b11295d2715e9af019513923c64570"><td class="mdescLeft">&#160;</td><td class="mdescRight">open a new graph window with a 2D image. <a href="#ae2b11295d2715e9af019513923c64570">More...</a><br /></td></tr>
<tr class="separator:ae2b11295d2715e9af019513923c64570"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8cc3ea3bea4e851e4144140a2da42a03"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a8cc3ea3bea4e851e4144140a2da42a03">ad_display_histogram</a> (wave image)</td></tr>
<tr class="memdesc:a8cc3ea3bea4e851e4144140a2da42a03"><td class="mdescLeft">&#160;</td><td class="mdescRight">display the histogram of a 2D image. <a href="#a8cc3ea3bea4e851e4144140a2da42a03">More...</a><br /></td></tr>
<tr class="separator:a8cc3ea3bea4e851e4144140a2da42a03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fad5aebaca72887d5898b4c421bcdae"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a8fad5aebaca72887d5898b4c421bcdae">ad_display_profiles</a> (wave image, string filter=defaultValue)</td></tr>
<tr class="memdesc:a8fad5aebaca72887d5898b4c421bcdae"><td class="mdescLeft">&#160;</td><td class="mdescRight">open a new profiles graph window. <a href="#a8fad5aebaca72887d5898b4c421bcdae">More...</a><br /></td></tr>
<tr class="separator:a8fad5aebaca72887d5898b4c421bcdae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa2546f9cb03dfa8bf0cc9966f0b7a45"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#afa2546f9cb03dfa8bf0cc9966f0b7a45">ad_update_profiles</a> (wave image)</td></tr>
<tr class="memdesc:afa2546f9cb03dfa8bf0cc9966f0b7a45"><td class="mdescLeft">&#160;</td><td class="mdescRight">update a profiles graph with new data. <a href="#afa2546f9cb03dfa8bf0cc9966f0b7a45">More...</a><br /></td></tr>
<tr class="separator:afa2546f9cb03dfa8bf0cc9966f0b7a45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5657fc4dcd395aef637c19e8df57a418"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a5657fc4dcd395aef637c19e8df57a418">ad_profiles_cursor_mode</a> (wave image, variable mode)</td></tr>
<tr class="memdesc:a5657fc4dcd395aef637c19e8df57a418"><td class="mdescLeft">&#160;</td><td class="mdescRight">switch cursors on a profiles graph <a href="#a5657fc4dcd395aef637c19e8df57a418">More...</a><br /></td></tr>
<tr class="separator:a5657fc4dcd395aef637c19e8df57a418"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2a84495ddac89bc8f4203fca56babfd"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#ad2a84495ddac89bc8f4203fca56babfd">ad_profiles_set_cursor</a> (wave image, string cursorname, variable xa, variable ya, variable pscale=defaultValue)</td></tr>
<tr class="memdesc:ad2a84495ddac89bc8f4203fca56babfd"><td class="mdescLeft">&#160;</td><td class="mdescRight">move a cursor to the specified position in a profiles graph. <a href="#ad2a84495ddac89bc8f4203fca56babfd">More...</a><br /></td></tr>
<tr class="separator:ad2a84495ddac89bc8f4203fca56babfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d20a8c6bf5ed143d375dee71fb3a6d5"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a6d20a8c6bf5ed143d375dee71fb3a6d5">ad_profiles_crosshairs</a> (wave image, variable clear=defaultValue)</td></tr>
<tr class="memdesc:a6d20a8c6bf5ed143d375dee71fb3a6d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">draw permanent crosshairs in a profiles graph. <a href="#a6d20a8c6bf5ed143d375dee71fb3a6d5">More...</a><br /></td></tr>
<tr class="separator:a6d20a8c6bf5ed143d375dee71fb3a6d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b76a98582f5997d3810f969dbb6c4ed"><td class="memItemLeft" align="right" valign="top">static wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a4b76a98582f5997d3810f969dbb6c4ed">get_source_image</a> (wave view)</td></tr>
<tr class="memdesc:a4b76a98582f5997d3810f969dbb6c4ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">find the source image wave corresponding to the given view. <a href="#a4b76a98582f5997d3810f969dbb6c4ed">More...</a><br /></td></tr>
<tr class="separator:a4b76a98582f5997d3810f969dbb6c4ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b183a27ec795b0ec1f8efabe3068369"><td class="memItemLeft" align="right" valign="top">static dfr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a2b183a27ec795b0ec1f8efabe3068369">make_view_folder</a> (wave source)</td></tr>
<tr class="memdesc:a2b183a27ec795b0ec1f8efabe3068369"><td class="mdescLeft">&#160;</td><td class="mdescRight">create a view data folder. <a href="#a2b183a27ec795b0ec1f8efabe3068369">More...</a><br /></td></tr>
<tr class="separator:a2b183a27ec795b0ec1f8efabe3068369"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bf20e37ed3e9c76be8ebe448c68a048"><td class="memItemLeft" align="right" valign="top">static dfr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a1bf20e37ed3e9c76be8ebe448c68a048">get_view_folder</a> (wave source)</td></tr>
<tr class="memdesc:a1bf20e37ed3e9c76be8ebe448c68a048"><td class="mdescLeft">&#160;</td><td class="mdescRight">find the view data folder corresponding to the given source. <a href="#a1bf20e37ed3e9c76be8ebe448c68a048">More...</a><br /></td></tr>
<tr class="separator:a1bf20e37ed3e9c76be8ebe448c68a048"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cc0970b41ca197fa47263556fa2686a"><td class="memItemLeft" align="right" valign="top">static wave&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a6cc0970b41ca197fa47263556fa2686a">get_view_image</a> (wave source)</td></tr>
<tr class="memdesc:a6cc0970b41ca197fa47263556fa2686a"><td class="mdescLeft">&#160;</td><td class="mdescRight">find the view image wave corresponding to the given source. <a href="#a6cc0970b41ca197fa47263556fa2686a">More...</a><br /></td></tr>
<tr class="separator:a6cc0970b41ca197fa47263556fa2686a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24b17f99fafd8043ed3e4502000da316"><td class="memItemLeft" align="right" valign="top">static variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a24b17f99fafd8043ed3e4502000da316">bp_reset_cursors</a> (WMButtonAction *ba)</td></tr>
<tr class="separator:a24b17f99fafd8043ed3e4502000da316"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab10a0d94991b9cd958557dbc48d70624"><td class="memItemLeft" align="right" valign="top">static variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#ab10a0d94991b9cd958557dbc48d70624">svp_smoothing</a> (WMSetVariableAction *sva)</td></tr>
<tr class="separator:ab10a0d94991b9cd958557dbc48d70624"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5c7a25e9a8c0b001a429bae23639da9"><td class="memItemLeft" align="right" valign="top">static variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#ac5c7a25e9a8c0b001a429bae23639da9">pmp_export</a> (WMPopupAction *pa)</td></tr>
<tr class="separator:ac5c7a25e9a8c0b001a429bae23639da9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89a5e3e29a0cd09951dcdf13aa28d941"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a89a5e3e29a0cd09951dcdf13aa28d941">ad_profiles_hook</a> (WMWinHookStruct *s)</td></tr>
<tr class="memdesc:a89a5e3e29a0cd09951dcdf13aa28d941"><td class="mdescLeft">&#160;</td><td class="mdescRight">hook function for user events in the profiles window. <a href="#a89a5e3e29a0cd09951dcdf13aa28d941">More...</a><br /></td></tr>
<tr class="separator:a89a5e3e29a0cd09951dcdf13aa28d941"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72b57037abd27f65986034c0b4cc191e"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a72b57037abd27f65986034c0b4cc191e">ad_calc_cursor_profiles</a> (wave image)</td></tr>
<tr class="memdesc:a72b57037abd27f65986034c0b4cc191e"><td class="mdescLeft">&#160;</td><td class="mdescRight">calculate profiles, statistics, and histogram of a cross-hair delimited region of interest. <a href="#a72b57037abd27f65986034c0b4cc191e">More...</a><br /></td></tr>
<tr class="separator:a72b57037abd27f65986034c0b4cc191e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48044f9ee518d47770e33ee9f381f204"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a48044f9ee518d47770e33ee9f381f204">ad_calc_profiles</a> (wave image, variable pa, variable qa, variable pb, variable qb)</td></tr>
<tr class="memdesc:a48044f9ee518d47770e33ee9f381f204"><td class="mdescLeft">&#160;</td><td class="mdescRight">calculate profiles, statistics, and histogram of a rectangular region of interest. <a href="#a48044f9ee518d47770e33ee9f381f204">More...</a><br /></td></tr>
<tr class="separator:a48044f9ee518d47770e33ee9f381f204"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3e190d1ec1b82ebef00c9f9ac44b50a"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#ad3e190d1ec1b82ebef00c9f9ac44b50a">ad_export_profile</a> (wave view_image, variable dim, variable trace=defaultValue, variable show=defaultValue, variable overwrite=defaultValue)</td></tr>
<tr class="memdesc:ad3e190d1ec1b82ebef00c9f9ac44b50a"><td class="mdescLeft">&#160;</td><td class="mdescRight">export a profile from a profiles graph to the source data folder. <a href="#ad3e190d1ec1b82ebef00c9f9ac44b50a">More...</a><br /></td></tr>
<tr class="separator:ad3e190d1ec1b82ebef00c9f9ac44b50a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abafc4f012b04592724109f4757cbe271"><td class="memItemLeft" align="right" valign="top">static variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#abafc4f012b04592724109f4757cbe271">set_trace_colors</a> (string graphname)</td></tr>
<tr class="separator:abafc4f012b04592724109f4757cbe271"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48b08ab53729d9d0477deaceedef2769"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a48b08ab53729d9d0477deaceedef2769">ad_calc_histogram</a> (wave image)</td></tr>
<tr class="memdesc:a48b08ab53729d9d0477deaceedef2769"><td class="mdescLeft">&#160;</td><td class="mdescRight">calculate the histogram. <a href="#a48b08ab53729d9d0477deaceedef2769">More...</a><br /></td></tr>
<tr class="separator:a48b08ab53729d9d0477deaceedef2769"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6418a1b2d18b82cb71c0fecbd513a934"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a6418a1b2d18b82cb71c0fecbd513a934">ad_default_image_filter</a> (wave image, string options)</td></tr>
<tr class="memdesc:a6418a1b2d18b82cb71c0fecbd513a934"><td class="mdescLeft">&#160;</td><td class="mdescRight">abstract filter function for image display. <a href="#a6418a1b2d18b82cb71c0fecbd513a934">More...</a><br /></td></tr>
<tr class="separator:a6418a1b2d18b82cb71c0fecbd513a934"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27f0957d61f3c2d30a4854911b460c36"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a27f0957d61f3c2d30a4854911b460c36">ad_box_filter</a> (wave image, string options)</td></tr>
<tr class="memdesc:a27f0957d61f3c2d30a4854911b460c36"><td class="mdescLeft">&#160;</td><td class="mdescRight">boxcar smoothing filter. <a href="#a27f0957d61f3c2d30a4854911b460c36">More...</a><br /></td></tr>
<tr class="separator:a27f0957d61f3c2d30a4854911b460c36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8411f0cfec3515f1ae4f0140efc14318"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a8411f0cfec3515f1ae4f0140efc14318">ad_transpose_filter</a> (wave image, string options)</td></tr>
<tr class="memdesc:a8411f0cfec3515f1ae4f0140efc14318"><td class="mdescLeft">&#160;</td><td class="mdescRight">transpose image filter. <a href="#a8411f0cfec3515f1ae4f0140efc14318">More...</a><br /></td></tr>
<tr class="separator:a8411f0cfec3515f1ae4f0140efc14318"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65b07e355df20cfb692dfb32f472b478"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a65b07e355df20cfb692dfb32f472b478">ad_display_brick</a> (wave data)</td></tr>
<tr class="memdesc:a65b07e355df20cfb692dfb32f472b478"><td class="mdescLeft">&#160;</td><td class="mdescRight">open a new "gizmo" window with three-dimensional data. <a href="#a65b07e355df20cfb692dfb32f472b478">More...</a><br /></td></tr>
<tr class="separator:a65b07e355df20cfb692dfb32f472b478"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3b4756cdc12a4a4b15a770ba0069823"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#ae3b4756cdc12a4a4b15a770ba0069823">ad_brick_slicer</a> (wave data)</td></tr>
<tr class="memdesc:ae3b4756cdc12a4a4b15a770ba0069823"><td class="mdescLeft">&#160;</td><td class="mdescRight">open a slicer panel for 3D data. <a href="#ae3b4756cdc12a4a4b15a770ba0069823">More...</a><br /></td></tr>
<tr class="separator:ae3b4756cdc12a4a4b15a770ba0069823"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8d5e003fcff1f750685ed6f94717730"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#af8d5e003fcff1f750685ed6f94717730">ad_display_slice</a> (wave data)</td></tr>
<tr class="memdesc:af8d5e003fcff1f750685ed6f94717730"><td class="mdescLeft">&#160;</td><td class="mdescRight">display three-dimensional data by 2D slice. <a href="#af8d5e003fcff1f750685ed6f94717730">More...</a><br /></td></tr>
<tr class="separator:af8d5e003fcff1f750685ed6f94717730"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2442bc044aaa12ab817a5f9fa300d1f8"><td class="memItemLeft" align="right" valign="top">static variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a2442bc044aaa12ab817a5f9fa300d1f8">update_slice_info</a> ()</td></tr>
<tr class="memdesc:a2442bc044aaa12ab817a5f9fa300d1f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">update controls with data scale limits. <a href="#a2442bc044aaa12ab817a5f9fa300d1f8">More...</a><br /></td></tr>
<tr class="separator:a2442bc044aaa12ab817a5f9fa300d1f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee051acfe6a3c8214118b78dfe4854fd"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#aee051acfe6a3c8214118b78dfe4854fd">ad_gizmo_set_plane</a> (wave brick, variable dim, variable value)</td></tr>
<tr class="memdesc:aee051acfe6a3c8214118b78dfe4854fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">set the position of a slicing plane of a 3D brick in a Gizmo window. <a href="#aee051acfe6a3c8214118b78dfe4854fd">More...</a><br /></td></tr>
<tr class="separator:aee051acfe6a3c8214118b78dfe4854fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abaf229d75d9d579a559295795a6bc2e1"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#abaf229d75d9d579a559295795a6bc2e1">ad_profiles_set_slice</a> (wave brick, variable dim, variable value)</td></tr>
<tr class="memdesc:abaf229d75d9d579a559295795a6bc2e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">set the position of the slicing plane of a 3D brick in a profiles window. <a href="#abaf229d75d9d579a559295795a6bc2e1">More...</a><br /></td></tr>
<tr class="separator:abaf229d75d9d579a559295795a6bc2e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace169e0824e6bddbd646972946edccbe"><td class="memItemLeft" align="right" valign="top">static variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#ace169e0824e6bddbd646972946edccbe">slp_slice_position</a> (WMSliderAction *sa)</td></tr>
<tr class="memdesc:ace169e0824e6bddbd646972946edccbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">set slice coordinate (slider procedure). <a href="#ace169e0824e6bddbd646972946edccbe">More...</a><br /></td></tr>
<tr class="separator:ace169e0824e6bddbd646972946edccbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a174177742fdce7f37027de8fa832b3bd"><td class="memItemLeft" align="right" valign="top">static variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a174177742fdce7f37027de8fa832b3bd">svp_slice_position</a> (WMSetVariableAction *sva)</td></tr>
<tr class="memdesc:a174177742fdce7f37027de8fa832b3bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">set slice coordinate (button procedure). <a href="#a174177742fdce7f37027de8fa832b3bd">More...</a><br /></td></tr>
<tr class="separator:a174177742fdce7f37027de8fa832b3bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8c9979c6f3ab95f983c2a525a69c035"><td class="memItemLeft" align="right" valign="top">static variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#ab8c9979c6f3ab95f983c2a525a69c035">bp_move_slice</a> (WMButtonAction *ba)</td></tr>
<tr class="memdesc:ab8c9979c6f3ab95f983c2a525a69c035"><td class="mdescLeft">&#160;</td><td class="mdescRight">move slice (button procedure). <a href="#ab8c9979c6f3ab95f983c2a525a69c035">More...</a><br /></td></tr>
<tr class="separator:ab8c9979c6f3ab95f983c2a525a69c035"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31461b664ec651a39442e9a46ffd88c9"><td class="memItemLeft" align="right" valign="top">static variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a31461b664ec651a39442e9a46ffd88c9">bp_extract_slice</a> (WMButtonAction *ba)</td></tr>
<tr class="memdesc:a31461b664ec651a39442e9a46ffd88c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">export a slice (button procedure). <a href="#a31461b664ec651a39442e9a46ffd88c9">More...</a><br /></td></tr>
<tr class="separator:a31461b664ec651a39442e9a46ffd88c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe702d40071e3c5e662eb8d47dd6d885"><td class="memItemLeft" align="right" valign="top">static variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#abe702d40071e3c5e662eb8d47dd6d885">bp_move_slice_center</a> (wave brick, variable dim, string posvariable)</td></tr>
<tr class="memdesc:abe702d40071e3c5e662eb8d47dd6d885"><td class="mdescLeft">&#160;</td><td class="mdescRight">move the slice to the center of the dimension (button procedure). <a href="#abe702d40071e3c5e662eb8d47dd6d885">More...</a><br /></td></tr>
<tr class="separator:abe702d40071e3c5e662eb8d47dd6d885"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4af98ec7af48a653c6fac716ea8fa505"><td class="memItemLeft" align="right" valign="top">static variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a4af98ec7af48a653c6fac716ea8fa505">ad_slicer_move_bg</a> (WMBackgroundStruct *s)</td></tr>
<tr class="memdesc:a4af98ec7af48a653c6fac716ea8fa505"><td class="mdescLeft">&#160;</td><td class="mdescRight">move a slice by one step (background task). <a href="#a4af98ec7af48a653c6fac716ea8fa505">More...</a><br /></td></tr>
<tr class="separator:a4af98ec7af48a653c6fac716ea8fa505"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7334815c60e2c11e2754c07489a62f4b"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a7334815c60e2c11e2754c07489a62f4b">ad_slicer_init_bg</a> ()</td></tr>
<tr class="memdesc:a7334815c60e2c11e2754c07489a62f4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">initialize the slice animation background task. <a href="#a7334815c60e2c11e2754c07489a62f4b">More...</a><br /></td></tr>
<tr class="separator:a7334815c60e2c11e2754c07489a62f4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad79b37ab4fcf2cbdad6874813d93d4b1"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#ad79b37ab4fcf2cbdad6874813d93d4b1">ad_slicer_start_bg</a> (wave brick, variable dimension, string posvariable, variable delta)</td></tr>
<tr class="memdesc:ad79b37ab4fcf2cbdad6874813d93d4b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">start the animation. <a href="#ad79b37ab4fcf2cbdad6874813d93d4b1">More...</a><br /></td></tr>
<tr class="separator:ad79b37ab4fcf2cbdad6874813d93d4b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77a71985e716a300e0b61c233cd93f40"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-area-display_8ipf.html#a77a71985e716a300e0b61c233cd93f40">ad_slicer_stop_bg</a> (string posvariable)</td></tr>
<tr class="memdesc:a77a71985e716a300e0b61c233cd93f40"><td class="mdescLeft">&#160;</td><td class="mdescRight">stop the animation. <a href="#a77a71985e716a300e0b61c233cd93f40">More...</a><br /></td></tr>
<tr class="separator:a77a71985e716a300e0b61c233cd93f40"><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>visualization tools for 2D and 3D data. </p>
<p>these tools were initially developed for monitoring output from EPICS area detector software. they are, however, useful for any kind of intensity versus x,y(,z) data.</p>
<h1><a class="anchor" id="sec_2d"></a>
2D data</h1>
<p>TO DO...</p>
<h1><a class="anchor" id="sec_3d"></a>
3D data</h1>
<p class="definition">Definition in file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a27f0957d61f3c2d30a4854911b460c36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27f0957d61f3c2d30a4854911b460c36">&#9670;&nbsp;</a></span>ad_box_filter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_box_filter </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>options</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>boxcar smoothing filter. </p>
<p>filters the image in X and Y directions using Igor's Smooth operation.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>image to be filtered: original data and filter result. </td></tr>
<tr><td class="paramname">options</td><td>smoothing factors in <code>key1=value1;key2=value2;...</code> format.<ul>
<li>SmoothingX</li>
<li>SmoothingY </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01045">1045</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="ae3b4756cdc12a4a4b15a770ba0069823"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3b4756cdc12a4a4b15a770ba0069823">&#9670;&nbsp;</a></span>ad_brick_slicer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_brick_slicer </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>open a slicer panel for 3D data. </p>
<p>if a panel exists, bring it to the front.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>three-dimensional wave. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01198">1198</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a72b57037abd27f65986034c0b4cc191e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72b57037abd27f65986034c0b4cc191e">&#9670;&nbsp;</a></span>ad_calc_cursor_profiles()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_calc_cursor_profiles </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>calculate profiles, statistics, and histogram of a cross-hair delimited region of interest. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>wave which contains the image data from the detector.</td></tr>
</table>
</dd>
</dl>
<p>the function expects further objects as created by <a class="el" href="pearl-area-display_8ipf.html#a8fad5aebaca72887d5898b4c421bcdae" title="open a new profiles graph window. ">ad_display_profiles()</a> in the same data folder as the image wave. the most recent profiles graph of the image must exist, and the cursors A and B must be set on the image. </p>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00727">727</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a48b08ab53729d9d0477deaceedef2769"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48b08ab53729d9d0477deaceedef2769">&#9670;&nbsp;</a></span>ad_calc_histogram()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_calc_histogram </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>calculate the histogram. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>wave which contains the image data from the detector. the function expects further objects as created by <a class="el" href="pearl-area-display_8ipf.html#a8cc3ea3bea4e851e4144140a2da42a03" title="display the histogram of a 2D image. ">ad_display_histogram()</a> in the same data folder as the image wave. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01008">1008</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a48044f9ee518d47770e33ee9f381f204"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48044f9ee518d47770e33ee9f381f204">&#9670;&nbsp;</a></span>ad_calc_profiles()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_calc_profiles </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>pa</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>qa</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>pb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>qb</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>calculate profiles, statistics, and histogram of a rectangular region of interest. </p>
<p>the region of interest a rectangle spanned by the two points A and B. pixels at these coordinates are included.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>wave which contains the image data. </td></tr>
<tr><td class="paramname">pa</td><td>first point coordinate of A. </td></tr>
<tr><td class="paramname">qa</td><td>second point coordinate of A. </td></tr>
<tr><td class="paramname">pb</td><td>first point coordinate of B. </td></tr>
<tr><td class="paramname">qb</td><td>second point coordinate of B.</td></tr>
</table>
</dd>
</dl>
<p>the function expects further objects as created by <a class="el" href="pearl-area-display_8ipf.html#a8fad5aebaca72887d5898b4c421bcdae" title="open a new profiles graph window. ">ad_display_profiles()</a> in the same data folder as the image wave.</p>
<p>this function does not require that the graph exists as long as the data folder is complete. </p>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00774">774</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a6418a1b2d18b82cb71c0fecbd513a934"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6418a1b2d18b82cb71c0fecbd513a934">&#9670;&nbsp;</a></span>ad_default_image_filter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_default_image_filter </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>options</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>abstract filter function for image display. </p>
<p>this is a function prototype for filtering two-dimensional data for preview. to write your own filter, define a new function which has the same signature.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>image to be filtered: original data and filter result. </td></tr>
<tr><td class="paramname">options</td><td>filter options in <code>key1=value1;key2=value2;...</code> format.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the result must be written to the incoming image wave. </dd></dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01031">1031</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="ae2b11295d2715e9af019513923c64570"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2b11295d2715e9af019513923c64570">&#9670;&nbsp;</a></span>ad_display()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string ad_display </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>open a new graph window with a 2D image. </p>
<p>this is essentially <code>display; appendimage</code>. the graph is directly linked to the image wave. it is, thus, updated automatically.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>wave which contains the image data.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>(string) name of the graph window </dd></dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00085">85</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a65b07e355df20cfb692dfb32f472b478"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65b07e355df20cfb692dfb32f472b478">&#9670;&nbsp;</a></span>ad_display_brick()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string ad_display_brick </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>open a new "gizmo" window with three-dimensional data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>three-dimensional wave.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>name of the gizmo window. </dd></dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01083">1083</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a8cc3ea3bea4e851e4144140a2da42a03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8cc3ea3bea4e851e4144140a2da42a03">&#9670;&nbsp;</a></span>ad_display_histogram()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string ad_display_histogram </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>display the histogram of a 2D image. </p>
<p>the function will create additional objects in the same data folder as the image. this objects are displayed in the graph and are updated by calling <a class="el" href="pearl-area-display_8ipf.html#a48044f9ee518d47770e33ee9f381f204" title="calculate profiles, statistics, and histogram of a rectangular region of interest. ">ad_calc_profiles()</a>. see the code.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>wave which contains the image data from the detector.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>(string) name of the graph window </dd></dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00115">115</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a8fad5aebaca72887d5898b4c421bcdae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fad5aebaca72887d5898b4c421bcdae">&#9670;&nbsp;</a></span>ad_display_profiles()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string ad_display_profiles </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>filter</em> = <code>defaultValue</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>open a new profiles graph window. </p>
<p>opens an extended graph window with profiles for the specified image. the function copies/creates all necessary data structures in a subfolder of the one which contains the image wave. the data folder name is derived from the image wave name by prefixing with "view_". there can be at most one profiles window of each image wave. the original wave must not be renamed while the graph window is used. to update the graph after modifying the original wave, call <a class="el" href="pearl-area-display_8ipf.html#afa2546f9cb03dfa8bf0cc9966f0b7a45" title="update a profiles graph with new data. ">ad_update_profiles()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>wave which contains the image data. </td></tr>
<tr><td class="paramname">filter</td><td>name of a filter function which maps the original data to the displayed data. the function must have the same parameters as <a class="el" href="pearl-area-display_8ipf.html#a6418a1b2d18b82cb71c0fecbd513a934" title="abstract filter function for image display. ">ad_default_image_filter()</a>. default: boxcar average (<a class="el" href="pearl-area-display_8ipf.html#a27f0957d61f3c2d30a4854911b460c36" title="boxcar smoothing filter. ">ad_box_filter()</a>) using parameters view_filter_smoothing_x and _y. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>name of the graph window </dd></dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00166">166</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="af8d5e003fcff1f750685ed6f94717730"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8d5e003fcff1f750685ed6f94717730">&#9670;&nbsp;</a></span>ad_display_slice()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string ad_display_slice </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>display three-dimensional data by 2D slice. </p>
<p>to select the slice data to display, call <a class="el" href="pearl-area-display_8ipf.html#abaf229d75d9d579a559295795a6bc2e1" title="set the position of the slicing plane of a 3D brick in a profiles window. ">ad_profiles_set_slice()</a>, or open a <a class="el" href="pearl-area-display_8ipf.html#ae3b4756cdc12a4a4b15a770ba0069823" title="open a slicer panel for 3D data. ">ad_brick_slicer()</a> panel. do not modify the content of the created view_ data folder.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>three-dimensional wave.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>name of the graph window. </dd></dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01346">1346</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="ad3e190d1ec1b82ebef00c9f9ac44b50a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3e190d1ec1b82ebef00c9f9ac44b50a">&#9670;&nbsp;</a></span>ad_export_profile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_export_profile </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>view_image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>dim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>trace</em> = <code>defaultValue</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>show</em> = <code>defaultValue</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>overwrite</em> = <code>defaultValue</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>export a profile from a profiles graph to the source data folder. </p>
<p>this function does not require that the show exists as long as the view data folder is complete.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">view_image</td><td>wave which contains the view image (image wave on display in profiles window). the function expects further objects as created by <a class="el" href="pearl-area-display_8ipf.html#a8fad5aebaca72887d5898b4c421bcdae" title="open a new profiles graph window. ">ad_display_profiles()</a> in the same data folder as the view_image wave. </td></tr>
<tr><td class="paramname">dim</td><td>dimension index (0 = x, 1 = y). </td></tr>
<tr><td class="paramname">trace</td><td>select profile trace:<ul>
<li>0 = cursor A</li>
<li>1 = cursor B</li>
<li>2 = average between cursors (default) </li>
</ul>
</td></tr>
<tr><td class="paramname">show</td><td>display mode:<ul>
<li>0 = do not show (default)</li>
<li>1 = display in new graph, or append to existing graph</li>
<li>2 = collate: common graph for all profiles of a dimension. rename graph manually to detach it from future additions. </li>
</ul>
</td></tr>
<tr><td class="paramname">overwrite</td><td>overwrite mode:<ul>
<li>0 = create new wave (default). wave name may get a suffix to be unique.</li>
<li>1 = overwrite existing wave </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00876">876</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="aee051acfe6a3c8214118b78dfe4854fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee051acfe6a3c8214118b78dfe4854fd">&#9670;&nbsp;</a></span>ad_gizmo_set_plane()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_gizmo_set_plane </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>brick</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>dim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set the position of a slicing plane of a 3D brick in a Gizmo window. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">brick</td><td>original data wave. </td></tr>
<tr><td class="paramname">dim</td><td>dimension index: 0, 1, or 2. </td></tr>
<tr><td class="paramname">value</td><td>new coordinate of the slicing plane (axis scaling).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, non-zero otherwise </dd></dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01423">1423</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a6d20a8c6bf5ed143d375dee71fb3a6d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d20a8c6bf5ed143d375dee71fb3a6d5">&#9670;&nbsp;</a></span>ad_profiles_crosshairs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_profiles_crosshairs </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>clear</em> = <code>defaultValue</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>draw permanent crosshairs in a profiles graph. </p>
<p>adds dash-dotted horizontal and vertical crosshairs to a profiles graph. for each active cursor A and/or B, a pair of lines crossing at the cursor position is added. existing crosshairs are moved to the current cursor positions. optionally, existing crosshairs are removed from the graph.</p>
<p>in contrast to the cursors, these crosshairs will be exported and printed with the graph. they are drawn using Igor's DrawLine operation. all lines drawn by this function are part of the "crosshairs" draw group. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>image displayed in the graph. this is the original image, not the one in the view data folder. </td></tr>
<tr><td class="paramname">clear</td><td>0 (default) = add/update lines. 1 = remove lines. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00482">482</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a5657fc4dcd395aef637c19e8df57a418"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5657fc4dcd395aef637c19e8df57a418">&#9670;&nbsp;</a></span>ad_profiles_cursor_mode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_profiles_cursor_mode </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>mode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>switch cursors on a profiles graph </p>
<p>the standard cursors allow to select the profiles to display in the profiles panes. additional cursors are shown in the profiles panes.</p>
<p>in the background selection mode, additional cursors allow the user to select the limits of the background and peak integration regions. the meaning of the cursors depends on the particular processing function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mode</td><td>cursor mode. <ul>
<li>0 (default) standard profile selection. cursors C-F on profile panes. </li>
<li>1 background selection. cursors A-F on image.</li>
</ul>
</td></tr>
<tr><td class="paramname">image</td><td>image displayed in the graph. this is the original image, not the one in the view data folder. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00369">369</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a89a5e3e29a0cd09951dcdf13aa28d941"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89a5e3e29a0cd09951dcdf13aa28d941">&#9670;&nbsp;</a></span>ad_profiles_hook()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_profiles_hook </td>
<td>(</td>
<td class="paramtype">WMWinHookStruct *&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>hook function for user events in the profiles window. </p>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00687">687</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="ad2a84495ddac89bc8f4203fca56babfd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2a84495ddac89bc8f4203fca56babfd">&#9670;&nbsp;</a></span>ad_profiles_set_cursor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_profiles_set_cursor </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>cursorname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>xa</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>ya</em>, </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>move a cursor to the specified position in a profiles graph. </p>
<p>this function can only set cursors in the image part of the profiles graph.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>image displayed in the graph. this is the original image, not the one in the view data folder. </td></tr>
<tr><td class="paramname">cursorname</td><td>name of the cursor, e.g. "A" or "B". other cursors are allowed but need to be activated separately. </td></tr>
<tr><td class="paramname">xa</td><td>x-coordinate to move the cursor to. the position is coerced to the image scale. +/-inf is allowed. </td></tr>
<tr><td class="paramname">ya</td><td>y-coordinate to move the cursor to. the position is coerced to the image scale. +/-inf is allowed. </td></tr>
<tr><td class="paramname">pscale</td><td>scaling of the position argument <ul>
<li>0 (default) wave scaling </li>
<li>1 point scaling </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00430">430</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="abaf229d75d9d579a559295795a6bc2e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abaf229d75d9d579a559295795a6bc2e1">&#9670;&nbsp;</a></span>ad_profiles_set_slice()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_profiles_set_slice </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>brick</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>dim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set the position of the slicing plane of a 3D brick in a profiles window. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">brick</td><td>original data wave. </td></tr>
<tr><td class="paramname">dim</td><td>dimension index: 0, 1, or 2. </td></tr>
<tr><td class="paramname">value</td><td>new coordinate of the slicing plane (axis scaling).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, non-zero otherwise </dd></dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01459">1459</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a7334815c60e2c11e2754c07489a62f4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7334815c60e2c11e2754c07489a62f4b">&#9670;&nbsp;</a></span>ad_slicer_init_bg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_slicer_init_bg </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>initialize the slice animation background task. </p>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01718">1718</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a4af98ec7af48a653c6fac716ea8fa505"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4af98ec7af48a653c6fac716ea8fa505">&#9670;&nbsp;</a></span>ad_slicer_move_bg()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static variable ad_slicer_move_bg </td>
<td>(</td>
<td class="paramtype">WMBackgroundStruct *&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>move a slice by one step (background task). </p>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01679">1679</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="ad79b37ab4fcf2cbdad6874813d93d4b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad79b37ab4fcf2cbdad6874813d93d4b1">&#9670;&nbsp;</a></span>ad_slicer_start_bg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_slicer_start_bg </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>brick</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>dimension</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>posvariable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>delta</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>start the animation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">brick</td><td>3D data wave </td></tr>
<tr><td class="paramname">dimension</td><td>dimension to animate, 0, 1, or 2. </td></tr>
<tr><td class="paramname">posvariable</td><td>full path to the global position variable. </td></tr>
<tr><td class="paramname">delta</td><td>step increment, should be +/- dimdelta. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01742">1742</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a77a71985e716a300e0b61c233cd93f40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77a71985e716a300e0b61c233cd93f40">&#9670;&nbsp;</a></span>ad_slicer_stop_bg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_slicer_stop_bg </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>posvariable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>stop the animation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">posvariable</td><td>full path to the global position variable. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01784">1784</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a8411f0cfec3515f1ae4f0140efc14318"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8411f0cfec3515f1ae4f0140efc14318">&#9670;&nbsp;</a></span>ad_transpose_filter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_transpose_filter </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>options</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>transpose image filter. </p>
<p>transposes the image.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>image to be transposed: original data and result. </td></tr>
<tr><td class="paramname">options</td><td>not used. should be empty. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01067">1067</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="afa2546f9cb03dfa8bf0cc9966f0b7a45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa2546f9cb03dfa8bf0cc9966f0b7a45">&#9670;&nbsp;</a></span>ad_update_profiles()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ad_update_profiles </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>update a profiles graph with new data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>wave which contains the image data. must be the same (by data folder and name) wave used with <a class="el" href="pearl-area-display_8ipf.html#a8fad5aebaca72887d5898b4c421bcdae" title="open a new profiles graph window. ">ad_display_profiles()</a>. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00322">322</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a31461b664ec651a39442e9a46ffd88c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31461b664ec651a39442e9a46ffd88c9">&#9670;&nbsp;</a></span>bp_extract_slice()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static variable bp_extract_slice </td>
<td>(</td>
<td class="paramtype">WMButtonAction *&#160;</td>
<td class="paramname"><em>ba</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>export a slice (button procedure). </p>
<p>extract a slice and saves it in a separate wave. </p>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01613">1613</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="ab8c9979c6f3ab95f983c2a525a69c035"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8c9979c6f3ab95f983c2a525a69c035">&#9670;&nbsp;</a></span>bp_move_slice()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static variable bp_move_slice </td>
<td>(</td>
<td class="paramtype">WMButtonAction *&#160;</td>
<td class="paramname"><em>ba</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>move slice (button procedure). </p>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01564">1564</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="abe702d40071e3c5e662eb8d47dd6d885"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe702d40071e3c5e662eb8d47dd6d885">&#9670;&nbsp;</a></span>bp_move_slice_center()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static variable bp_move_slice_center </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>brick</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>dim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>posvariable</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>move the slice to the center of the dimension (button procedure). </p>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01667">1667</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a24b17f99fafd8043ed3e4502000da316"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24b17f99fafd8043ed3e4502000da316">&#9670;&nbsp;</a></span>bp_reset_cursors()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static variable bp_reset_cursors </td>
<td>(</td>
<td class="paramtype">WMButtonAction *&#160;</td>
<td class="paramname"><em>ba</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00619">619</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a4b76a98582f5997d3810f969dbb6c4ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b76a98582f5997d3810f969dbb6c4ed">&#9670;&nbsp;</a></span>get_source_image()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static wave get_source_image </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>view</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>find the source image wave corresponding to the given view. </p>
<dl class="section return"><dt>Returns</dt><dd>wave reference of the original data wave. the reference may be invalid if the source wave cannot be found. </dd></dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00548">548</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a1bf20e37ed3e9c76be8ebe448c68a048"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bf20e37ed3e9c76be8ebe448c68a048">&#9670;&nbsp;</a></span>get_view_folder()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static dfr get_view_folder </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>find the view data folder corresponding to the given source. </p>
<p>the result data folder reference may be invalid if no view is currently open. use the built-in DataFolderRefStatus function to check for validity.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>wave which contains the image data. must be the same (by data folder and name) wave used with <a class="el" href="pearl-area-display_8ipf.html#a8fad5aebaca72887d5898b4c421bcdae" title="open a new profiles graph window. ">ad_display_profiles()</a>. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00586">586</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a6cc0970b41ca197fa47263556fa2686a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cc0970b41ca197fa47263556fa2686a">&#9670;&nbsp;</a></span>get_view_image()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static wave get_view_image </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>find the view image wave corresponding to the given source. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>wave which contains the image data. must be the same (by data folder and name) wave used with <a class="el" href="pearl-area-display_8ipf.html#a8fad5aebaca72887d5898b4c421bcdae" title="open a new profiles graph window. ">ad_display_profiles()</a>. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00609">609</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a195b12857685c4e535a840c5db324b4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a195b12857685c4e535a840c5db324b4a">&#9670;&nbsp;</a></span>graphname_from_dfref()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static string graphname_from_dfref </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>prefix</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>compose a valid and unique graph name from a data folder reference </p>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00057">57</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a2b183a27ec795b0ec1f8efabe3068369"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b183a27ec795b0ec1f8efabe3068369">&#9670;&nbsp;</a></span>make_view_folder()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static dfr make_view_folder </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>create a view data folder. </p>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00562">562</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="ac5c7a25e9a8c0b001a429bae23639da9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5c7a25e9a8c0b001a429bae23639da9">&#9670;&nbsp;</a></span>pmp_export()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static variable pmp_export </td>
<td>(</td>
<td class="paramtype">WMPopupAction *&#160;</td>
<td class="paramname"><em>pa</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00663">663</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="abafc4f012b04592724109f4757cbe271"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abafc4f012b04592724109f4757cbe271">&#9670;&nbsp;</a></span>set_trace_colors()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static variable set_trace_colors </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>graphname</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00987">987</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="ace169e0824e6bddbd646972946edccbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace169e0824e6bddbd646972946edccbe">&#9670;&nbsp;</a></span>slp_slice_position()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static variable slp_slice_position </td>
<td>(</td>
<td class="paramtype">WMSliderAction *&#160;</td>
<td class="paramname"><em>sa</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>set slice coordinate (slider procedure). </p>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01500">1500</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a174177742fdce7f37027de8fa832b3bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a174177742fdce7f37027de8fa832b3bd">&#9670;&nbsp;</a></span>svp_slice_position()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static variable svp_slice_position </td>
<td>(</td>
<td class="paramtype">WMSetVariableAction *&#160;</td>
<td class="paramname"><em>sva</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>set slice coordinate (button procedure). </p>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01532">1532</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="ab10a0d94991b9cd958557dbc48d70624"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab10a0d94991b9cd958557dbc48d70624">&#9670;&nbsp;</a></span>svp_smoothing()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static variable svp_smoothing </td>
<td>(</td>
<td class="paramtype">WMSetVariableAction *&#160;</td>
<td class="paramname"><em>sva</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l00638">638</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.ipf</a>.</p>
</div>
</div>
<a id="a2442bc044aaa12ab817a5f9fa300d1f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2442bc044aaa12ab817a5f9fa300d1f8">&#9670;&nbsp;</a></span>update_slice_info()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static variable update_slice_info </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>update controls with data scale limits. </p>
<p>current folder must be slicer info </p>
<p class="definition">Definition at line <a class="el" href="pearl-area-display_8ipf_source.html#l01387">1387</a> of file <a class="el" href="pearl-area-display_8ipf_source.html">pearl-area-display.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-display_8ipf.html">pearl-area-display.ipf</a></li>
<li class="footer">Generated on Wed Aug 14 2019 17:53:00 for PEARL Procedures by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>