igor-public/doc/html/pearl-scienta-countrate_8ipf.html

236 lines
12 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-scienta-countrate.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.1.1-1-gf419e92-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-scienta-countrate_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-scienta-countrate.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>count rate functions for Scienta detector images.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;pearl-area-display&quot;</code><br />
</div>
<p><a href="pearl-scienta-countrate_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_scienta_countrate"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_pearl_scienta_countrate.html">PearlScientaCountrate</a></td></tr>
<tr class="memdesc:namespace_pearl_scienta_countrate"><td class="mdescLeft">&#160;</td><td class="mdescRight">count rate functions for Scienta detector images. <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:a55886895329455b36b64d52ed6a4e228"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-scienta-countrate_8ipf.html#a55886895329455b36b64d52ed6a4e228">ScientaLiveDisplay</a> (string epicsname, string nickname, string wbRGB)</td></tr>
<tr class="memdesc:a55886895329455b36b64d52ed6a4e228"><td class="mdescLeft">&#160;</td><td class="mdescRight">open live display of most recent scienta measurement <a href="#a55886895329455b36b64d52ed6a4e228">More...</a><br /></td></tr>
<tr class="separator:a55886895329455b36b64d52ed6a4e228"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2879284b1d1397447a31733fddd6273"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-scienta-countrate_8ipf.html#af2879284b1d1397447a31733fddd6273">check_exposure_opt</a> (wave image, wave outmask, variable dwelltime, dfref calc_df=defaultValue)</td></tr>
<tr class="memdesc:af2879284b1d1397447a31733fddd6273"><td class="mdescLeft">&#160;</td><td class="mdescRight">optimized check exposure and calculate overexposure indicator mask <a href="#af2879284b1d1397447a31733fddd6273">More...</a><br /></td></tr>
<tr class="separator:af2879284b1d1397447a31733fddd6273"><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>count rate functions for Scienta detector images. </p>
<p>this procedure contains functions for working with true count rates.</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>2019 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 class="definition">Definition in file <a class="el" href="pearl-scienta-countrate_8ipf_source.html">pearl-scienta-countrate.ipf</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="af2879284b1d1397447a31733fddd6273"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2879284b1d1397447a31733fddd6273">&#9670;&nbsp;</a></span>check_exposure_opt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable check_exposure_opt </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">wave&#160;</td>
<td class="paramname"><em>outmask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>dwelltime</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">dfref&#160;</td>
<td class="paramname"><em>calc_df</em> = <code>defaultValue</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>optimized check exposure and calculate overexposure indicator mask </p>
<p>calculate the local count rate density and return a mask to indicate where the maximum count rate is exceeded. the raw image is filtered by FFT with a gaussian kernel.</p>
<p>the raw image must have been acquired in fixed mode. slicing and dwell time are accounted for.</p>
<p>this function does the same as check_exposure() but keeps intermediate waves for time-optimized processing. moreover it is compatible with igor 6.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname"></td><td></td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-scienta-countrate_8ipf_source.html#l00150">150</a> of file <a class="el" href="pearl-scienta-countrate_8ipf_source.html">pearl-scienta-countrate.ipf</a>.</p>
</div>
</div>
<a id="a55886895329455b36b64d52ed6a4e228"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55886895329455b36b64d52ed6a4e228">&#9670;&nbsp;</a></span>ScientaLiveDisplay()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable ScientaLiveDisplay </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>epicsname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>nickname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>wbRGB</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>open live display of most recent scienta measurement </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">epicsname</td><td>base name of the detector, e.g. X03DA-SCIENTA: image1: and cam1: are appended by the function. see ad_connect. </td></tr>
<tr><td class="paramname">nickname</td><td>nick name under which this detector is referred to in Igor. must be a valid data folder name. see ad_connect. </td></tr>
<tr><td class="paramname">wbRGB</td><td>window background color, e.g. "32768,49152,55296" </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="pearl-scienta-countrate_8ipf_source.html#l00043">43</a> of file <a class="el" href="pearl-scienta-countrate_8ipf_source.html">pearl-scienta-countrate.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-scienta-countrate_8ipf.html">pearl-scienta-countrate.ipf</a></li>
<li class="footer">Generated on Tue Jun 16 2020 14:32:36 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>