igor-public/doc/html/pearl-otf-import_8ipf.html
matthias muntwiler cf1399e59c update pshell explorer and data import, misc. improvements
FEATURES

- pshell: convert scienta data to true counts
- pre-process: add gauss2_reduction data reduction function
- anglescan: add set_contrast and normalize_strip_phi functions
- explorer: show info about multi-region scans
- documentation: add detailed instructions for angle-scan processing

BUGFIXES

- explorer: fix attributes notebook
- pshell: fix progress bar
- elog: increase the number of accepted attachments
2017-09-21 12:36:30 +02:00

479 lines
20 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.11"/>
<title>PEARL Procedures: pearl-otf-import.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.4.0-1-g0a436db-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-otf-import_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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">pearl-otf-import.ipf File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="pearl-otf-import_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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a603b71176ed838713ec555c440082e22"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-otf-import_8ipf.html#a603b71176ed838713ec555c440082e22">otf_load_itx_all</a> (string pathname)</td></tr>
<tr class="separator:a603b71176ed838713ec555c440082e22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa47fc4b956ee84a993b6d285b628fe20"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-otf-import_8ipf.html#aa47fc4b956ee84a993b6d285b628fe20">otf_load_itx_match</a> (string pathname, string matchstr)</td></tr>
<tr class="separator:aa47fc4b956ee84a993b6d285b628fe20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3632f8a5c0ee32a14a3e589b74a0c496"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-otf-import_8ipf.html#a3632f8a5c0ee32a14a3e589b74a0c496">otf_load_itx</a> (string pathname, string filename)</td></tr>
<tr class="separator:a3632f8a5c0ee32a14a3e589b74a0c496"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44078e1d8f26e515539acb96973fc630"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-otf-import_8ipf.html#a44078e1d8f26e515539acb96973fc630">otf_gather_iterator</a> (dfref df, string *sdata)</td></tr>
<tr class="separator:a44078e1d8f26e515539acb96973fc630"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2a83b85030a7d7769d434d6e2e9e557"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-otf-import_8ipf.html#ad2a83b85030a7d7769d434d6e2e9e557">otf_gather_batch</a> (string ywavematch, string xwavematch, string destfolder)</td></tr>
<tr class="separator:ad2a83b85030a7d7769d434d6e2e9e557"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2640256d7d07c11b41621430279cef6"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-otf-import_8ipf.html#ae2640256d7d07c11b41621430279cef6">gather_batch</a> (string foldermatch, string ywavematch, string xwavematch, string destfolder)</td></tr>
<tr class="separator:ae2640256d7d07c11b41621430279cef6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a882da254075e8d89f0117e491af90df0"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-otf-import_8ipf.html#a882da254075e8d89f0117e491af90df0">otf_rename_folders_iterator</a> (dfref df, string *sdata)</td></tr>
<tr class="separator:a882da254075e8d89f0117e491af90df0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a715f9cf2d2b1ffb04f2f9a0e344a80ee"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-otf-import_8ipf.html#a715f9cf2d2b1ffb04f2f9a0e344a80ee">otf_rename_folders</a> (string pattern, variable unique_index=defaultValue, string new_suffix=defaultValue, string match_str=defaultValue)</td></tr>
<tr class="separator:a715f9cf2d2b1ffb04f2f9a0e344a80ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd8897317366046dfb97c6ca53813d18"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-otf-import_8ipf.html#abd8897317366046dfb97c6ca53813d18">otf_interp</a> (variable e1, variable e2, variable npts, variable smo)</td></tr>
<tr class="separator:abd8897317366046dfb97c6ca53813d18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba965b854836658aa00e3ec2b361d7c9"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-otf-import_8ipf.html#aba965b854836658aa00e3ec2b361d7c9">otf_smo_int</a> (wave win, wave wout, wave wpe, variable smo)</td></tr>
<tr class="separator:aba965b854836658aa00e3ec2b361d7c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ae2640256d7d07c11b41621430279cef6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable gather_batch </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>foldermatch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>ywavematch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>xwavematch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>destfolder</em>&#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-otf-import_8ipf_source.html#l00162">162</a> of file <a class="el" href="pearl-otf-import_8ipf_source.html">pearl-otf-import.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="ad2a83b85030a7d7769d434d6e2e9e557"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable otf_gather_batch </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>ywavematch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>xwavematch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>destfolder</em>&#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-otf-import_8ipf_source.html#l00152">152</a> of file <a class="el" href="pearl-otf-import_8ipf_source.html">pearl-otf-import.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a44078e1d8f26e515539acb96973fc630"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable otf_gather_iterator </td>
<td>(</td>
<td class="paramtype">dfref&#160;</td>
<td class="paramname"><em>df</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string *&#160;</td>
<td class="paramname"><em>sdata</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="pearl-otf-import_8ipf_source.html#l00106">106</a> of file <a class="el" href="pearl-otf-import_8ipf_source.html">pearl-otf-import.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="abd8897317366046dfb97c6ca53813d18"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable otf_interp </td>
<td>(</td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>e1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>e2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>npts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>smo</em>&#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-otf-import_8ipf_source.html#l00271">271</a> of file <a class="el" href="pearl-otf-import_8ipf_source.html">pearl-otf-import.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a3632f8a5c0ee32a14a3e589b74a0c496"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable otf_load_itx </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>pathname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>filename</em>&#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-otf-import_8ipf_source.html#l00076">76</a> of file <a class="el" href="pearl-otf-import_8ipf_source.html">pearl-otf-import.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a603b71176ed838713ec555c440082e22"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable otf_load_itx_all </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>pathname</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="pearl-otf-import_8ipf_source.html#l00031">31</a> of file <a class="el" href="pearl-otf-import_8ipf_source.html">pearl-otf-import.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="aa47fc4b956ee84a993b6d285b628fe20"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable otf_load_itx_match </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>pathname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>matchstr</em>&#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-otf-import_8ipf_source.html#l00053">53</a> of file <a class="el" href="pearl-otf-import_8ipf_source.html">pearl-otf-import.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a715f9cf2d2b1ffb04f2f9a0e344a80ee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable otf_rename_folders </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>unique_index</em> = <code>defaultValue</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>new_suffix</em> = <code>defaultValue</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>match_str</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-otf-import_8ipf_source.html#l00231">231</a> of file <a class="el" href="pearl-otf-import_8ipf_source.html">pearl-otf-import.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="a882da254075e8d89f0117e491af90df0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable otf_rename_folders_iterator </td>
<td>(</td>
<td class="paramtype">dfref&#160;</td>
<td class="paramname"><em>df</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string *&#160;</td>
<td class="paramname"><em>sdata</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="pearl-otf-import_8ipf_source.html#l00185">185</a> of file <a class="el" href="pearl-otf-import_8ipf_source.html">pearl-otf-import.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="aba965b854836658aa00e3ec2b361d7c9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable otf_smo_int </td>
<td>(</td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>win</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>wout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wave&#160;</td>
<td class="paramname"><em>wpe</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">variable&#160;</td>
<td class="paramname"><em>smo</em>&#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-otf-import_8ipf_source.html#l00304">304</a> of file <a class="el" href="pearl-otf-import_8ipf_source.html">pearl-otf-import.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-otf-import_8ipf.html">pearl-otf-import.ipf</a></li>
<li class="footer">Generated on Thu Sep 21 2017 12:35:04 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>