matthias muntwiler
cf1399e59c
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
1094 lines
56 KiB
HTML
1094 lines
56 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-matrix-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
|
|
 <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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related 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 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-matrix-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="#nested-classes">Data Structures</a> |
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">pearl-matrix-import.ipf File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>data file import for omicron matrix (STM) files
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><a href="pearl-matrix-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="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structerror_code.html">errorCode</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">from matrixfilereader help <a href="structerror_code.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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_matrix_import"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_pearl_matrix_import.html">PearlMatrixImport</a></td></tr>
|
|
<tr class="memdesc:namespace_pearl_matrix_import"><td class="mdescLeft"> </td><td class="mdescRight">data file import for omicron matrix (STM) files <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </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:a45e930b8eadd7cf6a5f664befd87d725"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#a45e930b8eadd7cf6a5f664befd87d725">init_package</a> ()</td></tr>
|
|
<tr class="memdesc:a45e930b8eadd7cf6a5f664befd87d725"><td class="mdescLeft"> </td><td class="mdescRight">initialize the package data folder. <a href="#a45e930b8eadd7cf6a5f664befd87d725">More...</a><br /></td></tr>
|
|
<tr class="separator:a45e930b8eadd7cf6a5f664befd87d725"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7790f06151821678a65ab0065a5323e"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#ac7790f06151821678a65ab0065a5323e">check_package_folder</a> ()</td></tr>
|
|
<tr class="memdesc:ac7790f06151821678a65ab0065a5323e"><td class="mdescLeft"> </td><td class="mdescRight">check that the package data folder exists <a href="#ac7790f06151821678a65ab0065a5323e">More...</a><br /></td></tr>
|
|
<tr class="separator:ac7790f06151821678a65ab0065a5323e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3f524f5190341d2accc8cb8c3ed2ceb5"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#a3f524f5190341d2accc8cb8c3ed2ceb5">AfterFileOpenHook</a> (variable refNum, string file, string pathName, string type, string creator, variable kind)</td></tr>
|
|
<tr class="memdesc:a3f524f5190341d2accc8cb8c3ed2ceb5"><td class="mdescLeft"> </td><td class="mdescRight">initialize the package and reload preferences after an experiment is loaded. <a href="#a3f524f5190341d2accc8cb8c3ed2ceb5">More...</a><br /></td></tr>
|
|
<tr class="separator:a3f524f5190341d2accc8cb8c3ed2ceb5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae2cfa1ac6651cfc3fb0dfce03494995b"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#ae2cfa1ac6651cfc3fb0dfce03494995b">BeforeFileOpenHook</a> (variable refNum, string fileName, string path, string type, string creator, variable kind)</td></tr>
|
|
<tr class="memdesc:ae2cfa1ac6651cfc3fb0dfce03494995b"><td class="mdescLeft"> </td><td class="mdescRight">open a matrix file that was dropped into Igor. <a href="#ae2cfa1ac6651cfc3fb0dfce03494995b">More...</a><br /></td></tr>
|
|
<tr class="separator:ae2cfa1ac6651cfc3fb0dfce03494995b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a81b1d81261a32d0ed4cf79b81487f1b4"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#a81b1d81261a32d0ed4cf79b81487f1b4">matrix_format_elog_message</a> (wave metadata)</td></tr>
|
|
<tr class="memdesc:a81b1d81261a32d0ed4cf79b81487f1b4"><td class="mdescLeft"> </td><td class="mdescRight">generate elog message from bricklet metadata <a href="#a81b1d81261a32d0ed4cf79b81487f1b4">More...</a><br /></td></tr>
|
|
<tr class="separator:a81b1d81261a32d0ed4cf79b81487f1b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a856478705a78e8105ea5d91a2228975b"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#a856478705a78e8105ea5d91a2228975b">matrix_preview_2d</a> (wave data, wave metadata)</td></tr>
|
|
<tr class="separator:a856478705a78e8105ea5d91a2228975b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8acd2b03343ef9bdfecaa75e831392d1"><td class="memItemLeft" align="right" valign="top">static wave </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#a8acd2b03343ef9bdfecaa75e831392d1">preview_matrix_file</a> (string filename)</td></tr>
|
|
<tr class="memdesc:a8acd2b03343ef9bdfecaa75e831392d1"><td class="mdescLeft"> </td><td class="mdescRight">load the preview of a Matrix data file <a href="#a8acd2b03343ef9bdfecaa75e831392d1">More...</a><br /></td></tr>
|
|
<tr class="separator:a8acd2b03343ef9bdfecaa75e831392d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af0eaec901e06ce59250eb434539a0f6c"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#af0eaec901e06ce59250eb434539a0f6c">initStruct</a> (<a class="el" href="structerror_code.html">errorCode</a> *<a class="el" href="structerror_code.html">errorCode</a>)</td></tr>
|
|
<tr class="memdesc:af0eaec901e06ce59250eb434539a0f6c"><td class="mdescLeft"> </td><td class="mdescRight">from matrixfilereader help <a href="#af0eaec901e06ce59250eb434539a0f6c">More...</a><br /></td></tr>
|
|
<tr class="separator:af0eaec901e06ce59250eb434539a0f6c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ac0c685976b0e0c1944fb616a4f3a3c"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#a6ac0c685976b0e0c1944fb616a4f3a3c">mtrx_load_all</a> ()</td></tr>
|
|
<tr class="memdesc:a6ac0c685976b0e0c1944fb616a4f3a3c"><td class="mdescLeft"> </td><td class="mdescRight">load all data from a Matrix data file. <a href="#a6ac0c685976b0e0c1944fb616a4f3a3c">More...</a><br /></td></tr>
|
|
<tr class="separator:a6ac0c685976b0e0c1944fb616a4f3a3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4bfeaf81ac483df0a38b26b6a8cf74a6"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#a4bfeaf81ac483df0a38b26b6a8cf74a6">mtrx_parse_filename</a> (string fileName, string *resultFile, variable *runCycle, variable *scanCycle, string *channel)</td></tr>
|
|
<tr class="memdesc:a4bfeaf81ac483df0a38b26b6a8cf74a6"><td class="mdescLeft"> </td><td class="mdescRight">parse matrix file names <a href="#a4bfeaf81ac483df0a38b26b6a8cf74a6">More...</a><br /></td></tr>
|
|
<tr class="separator:a4bfeaf81ac483df0a38b26b6a8cf74a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0dc1efa23739e10b7558543b166e95b9"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#a0dc1efa23739e10b7558543b166e95b9">mtrx_split_filename</a> (string fileName, string *prefix, string *datepart, string *timepart)</td></tr>
|
|
<tr class="memdesc:a0dc1efa23739e10b7558543b166e95b9"><td class="mdescLeft"> </td><td class="mdescRight">split a matrix filename and return the first three parts <a href="#a0dc1efa23739e10b7558543b166e95b9">More...</a><br /></td></tr>
|
|
<tr class="separator:a0dc1efa23739e10b7558543b166e95b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a893405a122fdf70429f4f75b8877ed7d"><td class="memItemLeft" align="right" valign="top">dfr </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#a893405a122fdf70429f4f75b8877ed7d">mtrx_create_folder</a> (string fileName, dfref df_base=defaultValue)</td></tr>
|
|
<tr class="memdesc:a893405a122fdf70429f4f75b8877ed7d"><td class="mdescLeft"> </td><td class="mdescRight">create or look up a data folder based on a matrix file name. <a href="#a893405a122fdf70429f4f75b8877ed7d">More...</a><br /></td></tr>
|
|
<tr class="separator:a893405a122fdf70429f4f75b8877ed7d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a46b042e41daffee61706ab2cf54351"><td class="memItemLeft" align="right" valign="top">dfr </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#a1a46b042e41daffee61706ab2cf54351">mtrx_get_cycle_folder</a> (dfref df_base=defaultValue, variable runCycle=defaultValue, variable scanCycle=defaultValue)</td></tr>
|
|
<tr class="memdesc:a1a46b042e41daffee61706ab2cf54351"><td class="mdescLeft"> </td><td class="mdescRight">create a data folder for bricklet data. <a href="#a1a46b042e41daffee61706ab2cf54351">More...</a><br /></td></tr>
|
|
<tr class="separator:a1a46b042e41daffee61706ab2cf54351"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad74d5afa71179728a9237d1ec5884482"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#ad74d5afa71179728a9237d1ec5884482">mtrx_file_brickletID</a> (string resultFile, variable runCycle, variable scanCycle, string channel)</td></tr>
|
|
<tr class="memdesc:ad74d5afa71179728a9237d1ec5884482"><td class="mdescLeft"> </td><td class="mdescRight">find out bricklet ID of a file <a href="#ad74d5afa71179728a9237d1ec5884482">More...</a><br /></td></tr>
|
|
<tr class="separator:ad74d5afa71179728a9237d1ec5884482"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59e72c849f4314aaa8339fd899665d85"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#a59e72c849f4314aaa8339fd899665d85">mtrx_open_file</a> (string pathName, string fileNameOrPath)</td></tr>
|
|
<tr class="memdesc:a59e72c849f4314aaa8339fd899665d85"><td class="mdescLeft"> </td><td class="mdescRight">open a matrix result or data file <a href="#a59e72c849f4314aaa8339fd899665d85">More...</a><br /></td></tr>
|
|
<tr class="separator:a59e72c849f4314aaa8339fd899665d85"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd09594d22038853e1e8021e0f36363d"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#abd09594d22038853e1e8021e0f36363d">mtrx_load_preview</a> (string destName, string pathName, string fileName, string traces=defaultValue)</td></tr>
|
|
<tr class="memdesc:abd09594d22038853e1e8021e0f36363d"><td class="mdescLeft"> </td><td class="mdescRight">load a preview image from a Matrix data file. <a href="#abd09594d22038853e1e8021e0f36363d">More...</a><br /></td></tr>
|
|
<tr class="separator:abd09594d22038853e1e8021e0f36363d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6aeef317fd468c88c99a274338c70ae3"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#a6aeef317fd468c88c99a274338c70ae3">mtrx_load_file</a> (string pathName, string fileName, string traces=defaultValue)</td></tr>
|
|
<tr class="memdesc:a6aeef317fd468c88c99a274338c70ae3"><td class="mdescLeft"> </td><td class="mdescRight">load all data from a Matrix data file. <a href="#a6aeef317fd468c88c99a274338c70ae3">More...</a><br /></td></tr>
|
|
<tr class="separator:a6aeef317fd468c88c99a274338c70ae3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad8532f1473f92539fe88217d5d6e3368"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#ad8532f1473f92539fe88217d5d6e3368">mtrx_scale_dataset</a> (wave data)</td></tr>
|
|
<tr class="separator:ad8532f1473f92539fe88217d5d6e3368"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3a0ba4a7ad64739303b705d92be53267"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#a3a0ba4a7ad64739303b705d92be53267">mtrx_load_info</a> (string APathName, string AFileName)</td></tr>
|
|
<tr class="memdesc:a3a0ba4a7ad64739303b705d92be53267"><td class="mdescLeft"> </td><td class="mdescRight">load descriptive info from a Matrix data file. <a href="#a3a0ba4a7ad64739303b705d92be53267">More...</a><br /></td></tr>
|
|
<tr class="separator:a3a0ba4a7ad64739303b705d92be53267"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab80101bc780dcbe94200e2446bce51d9"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#ab80101bc780dcbe94200e2446bce51d9">subtract_line_bg</a> (wave img)</td></tr>
|
|
<tr class="memdesc:ab80101bc780dcbe94200e2446bce51d9"><td class="mdescLeft"> </td><td class="mdescRight">remove linear background line-by-line <a href="#ab80101bc780dcbe94200e2446bce51d9">More...</a><br /></td></tr>
|
|
<tr class="separator:ab80101bc780dcbe94200e2446bce51d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:aca457d1f4414d20a911254b1de13ebbb"><td class="memItemLeft" align="right" valign="top">static const string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#aca457d1f4414d20a911254b1de13ebbb">package_name</a> = "pearl_matrix_import"</td></tr>
|
|
<tr class="separator:aca457d1f4414d20a911254b1de13ebbb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a75bb92ef5f80843e66a7243bd958ef8b"><td class="memItemLeft" align="right" valign="top">static const string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#a75bb92ef5f80843e66a7243bd958ef8b">package_path</a> = "root:packages:pearl_matrix_import:"</td></tr>
|
|
<tr class="separator:a75bb92ef5f80843e66a7243bd958ef8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad720655ff881ddecae2e1b8afed58fa0"><td class="memItemLeft" align="right" valign="top">static const string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-matrix-import_8ipf.html#ad720655ff881ddecae2e1b8afed58fa0">ks_filematch_mtrx</a> = "*_mtrx"</td></tr>
|
|
<tr class="separator:ad720655ff881ddecae2e1b8afed58fa0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>data file import for omicron matrix (STM) files </p>
|
|
<p>the matrix file import requires the matrix file reader XOP by thomas braun (<a href="http://www.igorexchange.com/project/matrixFileReader">http://www.igorexchange.com/project/matrixFileReader</a>) which in turn requires an installation of vernissage by omicron nanotechnology.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>EXPERIMENTAL the matrix import module and its interface may change radically in future revisions!</dd></dl>
|
|
<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>2016 Paul Scherrer Institut <br />
|
|
Licensed under the Apache License, Version 2.0 (the "License"); <br />
|
|
you may not use this file except in compliance with the License. <br />
|
|
You may obtain a copy of the License at <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a> </dd></dl>
|
|
|
|
<p>Definition in file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="a3f524f5190341d2accc8cb8c3ed2ceb5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable AfterFileOpenHook </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>refNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>file</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>pathName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>creator</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>kind</em> </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>initialize the package and reload preferences after an experiment is loaded. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00085">85</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae2cfa1ac6651cfc3fb0dfce03494995b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable BeforeFileOpenHook </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>refNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>fileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>path</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>creator</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>kind</em> </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>open a matrix file that was dropped into Igor. </p>
|
|
<p>preliminary implementation. this should rather load the entire file and display a preview. graph windows should be reused by subsequent loads. also decide on a data saving location. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00102">102</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac7790f06151821678a65ab0065a5323e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable check_package_folder </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>check that the package data folder exists </p>
|
|
<p>initialize the package if the folder does not exist. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00072">72</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a45e930b8eadd7cf6a5f664befd87d725"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable init_package </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>initialize the package data folder. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00045">45</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af0eaec901e06ce59250eb434539a0f6c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable initStruct </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structerror_code.html">errorCode</a> * </td>
|
|
<td class="paramname"><em>errorCode</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>from matrixfilereader help </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00212">212</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a81b1d81261a32d0ed4cf79b81487f1b4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string matrix_format_elog_message </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>metadata</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>generate elog message from bricklet metadata </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">metadata</td><td>two-column text wave </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00120">120</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a856478705a78e8105ea5d91a2228975b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable matrix_preview_2d </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>metadata</em> </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-matrix-import_8ipf_source.html#l00145">145</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a893405a122fdf70429f4f75b8877ed7d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">dfr mtrx_create_folder </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>fileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>df_base</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>create or look up a data folder based on a matrix file name. </p>
|
|
<p>the name of the folder is mtrx_date_time, where date and time are parsed from the file name. for this to work, the file name must consist of at least three parts that are separated by dash or underscore. the second (third) part contains the date (time). date and time are copied as strings.</p>
|
|
<p>if the data folder exists, a reference to the existing folder is returned.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileName</td><td>name of the result or data file.</td></tr>
|
|
<tr><td class="paramname">df_base</td><td>(optional) base data folder. default: current folder.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>reference of the newly created or existing data folder. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00360">360</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad74d5afa71179728a9237d1ec5884482"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable mtrx_file_brickletID </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>resultFile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>runCycle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>scanCycle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>channel</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>find out bricklet ID of a file </p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>EXPERIMENTAL the code of this function is inefficient. the function may be removed in a later version.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">resultFile</td><td>base name of result file without chain link number and extension. as returned by mtrx_parse_filename.</td></tr>
|
|
<tr><td class="paramname">runCycle</td><td>requested run cycle. 0 = first available.</td></tr>
|
|
<tr><td class="paramname">scanCycle</td><td>requested scan cycle. 0 = first available.</td></tr>
|
|
<tr><td class="paramname">channel</td><td>channel name. for example: "I", "Z", "Aux(V)", etc. empty string: first available.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>bricklet ID, or -1 if an error occurred. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00461">461</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1a46b042e41daffee61706ab2cf54351"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">dfr mtrx_get_cycle_folder </td>
|
|
<td>(</td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>df_base</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>runCycle</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>scanCycle</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>create a data folder for bricklet data. </p>
|
|
<p>the name of the folder is, for example "r23s2" where the first (second) number is the run (scan) cycle. run cycle and scan cycle numbers are taken from the open matrix file unless overridden by optional arguments.</p>
|
|
<p>if the data folder exists, a reference to the existing folder is returned. if one of the run or scan cycle numbers is lower than 1, the base folder is returned.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">df_base</td><td>(optional) base data folder. default: current folder.</td></tr>
|
|
<tr><td class="paramname">runCycle</td><td>(optional) run cycle number. must be >= 1. default: from last mtrx_open_file call.</td></tr>
|
|
<tr><td class="paramname">scanCycle</td><td>(optional) scan cycle number. must be >= 1. default: from last mtrx_open_file call.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>reference of the newly created or existing data folder. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00405">405</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6ac0c685976b0e0c1944fb616a4f3a3c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable mtrx_load_all </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load all data from a Matrix data file. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00231">231</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6aeef317fd468c88c99a274338c70ae3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string mtrx_load_file </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>pathName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>fileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>traces</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load all data from a Matrix data file. </p>
|
|
<p>the data wave is loaded into a sub-subfolder the current data folder. the relative path has the format ":mtrx_{date}_{time}:r{run_cycle}s{scan_cycle}", where the parameters {date}, {time}, {run_cycle} and {scan_cycle} are copied from the file name. the file name must be formatted according to the specifications set out below.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pathName</td><td>igor symbolic path name. can be empty if the path is specified in FileName or a dialog box should be displayed</td></tr>
|
|
<tr><td class="paramname">fileName</td><td>if empty a dialog box shows up the file name must adhere to the format "{prefix}-{date}-{time}-{anything}--{run_cycle}_{scan_cycle}.{extension}". the first three seperators can alternatively be underscores. it may be necessary to change the configuration of the Matrix application.</td></tr>
|
|
<tr><td class="paramname">traces</td><td>(currently not used) semicolon-separated list of preferred traces. the items of the list are match strings for the Igor StringMatch function. only matching traces are loaded from the file. default: "*Up;*Down;*ReUp;*ReDown;"</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>semicolon-separated list of loaded waves including partial path from current data folder. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00767">767</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3a0ba4a7ad64739303b705d92be53267"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string mtrx_load_info </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>APathName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>AFileName</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load descriptive info from a Matrix data file. </p>
|
|
<p>the info string lists the following information for each scan contained in the file:</p><ul>
|
|
<li>path of the scan group inside the file.</li>
|
|
<li>number of scan positions.</li>
|
|
<li>dataset names of scan positioners.</li>
|
|
<li>dataset names of detectors.</li>
|
|
</ul>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">APathName</td><td>igor symbolic path name. can be empty if the path is specified in AFileName or a dialog box should be displayed</td></tr>
|
|
<tr><td class="paramname">AFileName</td><td>if empty a dialog box shows up</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>newline terminated string. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00863">863</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abd09594d22038853e1e8021e0f36363d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string mtrx_load_preview </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>destName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>pathName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>fileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>traces</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load a preview image from a Matrix data file. </p>
|
|
<p>the data wave is loaded into the current data folder.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">destName</td><td>destination wave name. the wave is created in the current data folder.</td></tr>
|
|
<tr><td class="paramname">pathName</td><td>igor symbolic path name. can be empty if the path is specified in FileName or a dialog box should be displayed</td></tr>
|
|
<tr><td class="paramname">fileName</td><td>if empty a dialog box shows up the file name must adhere to the format "{prefix}-{date}-{time}-{anything}--{run_cycle}_{scan_cycle}.{extension}". the first three seperators can alternatively be underscores. it may be necessary to change the configuration of the Matrix application.</td></tr>
|
|
<tr><td class="paramname">traces</td><td>(currently not used) semicolon-separated list of preferred traces. the items of the list are match strings for the Igor StringMatch function. only the first matching trace is loaded from the file. default: "*Up;*Down;*ReUp;*ReDown;"</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>semicolon-separated list of loaded waves including partial path from current data folder. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00682">682</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a59e72c849f4314aaa8339fd899665d85"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable mtrx_open_file </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>pathName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>fileNameOrPath</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>open a matrix result or data file </p>
|
|
<p>this function opens a matrix result file (.mtrx) or data file (.*_mtrx).</p>
|
|
<p>if a data file is selected, the function locates the corresponding result file, opens it, and looks up the bricklet ID of the data file. if a result file is selected, the function opens it but does not look up bricklet IDs.</p>
|
|
<p>the result file remains open and can be accessed using the mtrx_ functions or MFR_ operations. once a result file is open, you can easily access any bricklets linked to it, i.e., any run cycle, scan cycle, and channel.</p>
|
|
<p>the function stores information about the opened file in a global package data folder. if the same result file is opened again later, the information is reused and the file not read again. this may cause problems if the file has been modified in the meantime, or if the cached data become corrupt for some reason. the function detects if a data file is not linked in the open result file, and updates the cache. in other situations it may be necessary to force a reload.</p>
|
|
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000005">Todo:</a></b></dt><dd>fix possible cache issues, add an option to override the cache.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pathName</td><td>igor path name or empty string.</td></tr>
|
|
<tr><td class="paramname">fileName</td><td>file name, with or without path, or empty string.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>file type <ul>
|
|
<li>0 result file (logbook) </li>
|
|
<li>1 result data file (bricklet) </li>
|
|
<li>-1 error, no data loaded </li>
|
|
<li>-2 matrixfilereader.xop not installed </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00545">545</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4bfeaf81ac483df0a38b26b6a8cf74a6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable mtrx_parse_filename </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>fileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string * </td>
|
|
<td class="paramname"><em>resultFile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable * </td>
|
|
<td class="paramname"><em>runCycle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable * </td>
|
|
<td class="paramname"><em>scanCycle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string * </td>
|
|
<td class="paramname"><em>channel</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>parse matrix file names </p>
|
|
<p>parse matrix file names for result name, run cycle, scan cycle, and channel.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fileName</td><td>matrix result or data file name (without path).</td></tr>
|
|
<tr><td class="paramname">resultFile</td><td>(out) base name of the result file. append "_%04u.mtrx" to get the actual result file. we do not know the chain link number at this stage.</td></tr>
|
|
<tr><td class="paramname">runCycle</td><td>(out) run cycle number. necessary to look up the bricklet ID.</td></tr>
|
|
<tr><td class="paramname">scanCycle</td><td>(out) scan cycle number. necessary to look up the bricklet ID.</td></tr>
|
|
<tr><td class="paramname">channel</td><td>(out) channel name.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>file type <ul>
|
|
<li>0 result file (logbook) </li>
|
|
<li>1 result data file (bricklet)</li>
|
|
</ul>
|
|
result file names look like: default_2015Apr20-124353_STM-STM_AtomManipulation_0001.mtrx, default_2015Apr20-124353_STM-STM_AtomManipulation_0002.mtrx, etc. the function returns the first part up to the experiment name ("AtomManipulation" in the examples). all other return values set to defaults and must not be regarded.</dd></dl>
|
|
<p>result data files look like: default_2015Apr20-124353_STM-STM_AtomManipulation–136_1.Aux1(V)_mtrx, default_2015Apr20-124353_STM-STM_AtomManipulation–136_1.I(V)_mtrx, default_2015Apr20-124353_STM-STM_AtomManipulation–14_1.I_mtrx, default_2015Apr20-124353_STM-STM_AtomManipulation–14_1.Z_mtrx, etc. the function returns all results as described in the parameter list. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00294">294</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad8532f1473f92539fe88217d5d6e3368"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable mtrx_scale_dataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>data</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00829">829</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0dc1efa23739e10b7558543b166e95b9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string mtrx_split_filename </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>fileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string * </td>
|
|
<td class="paramname"><em>prefix</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string * </td>
|
|
<td class="paramname"><em>datepart</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string * </td>
|
|
<td class="paramname"><em>timepart</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>split a matrix filename and return the first three parts </p>
|
|
<p>we assume that the second (third) part contains the date (time). the parts are separated by dash or underscore. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00332">332</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8acd2b03343ef9bdfecaa75e831392d1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static wave preview_matrix_file </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>filename</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>load the preview of a Matrix data file </p>
|
|
<p>the preview is loaded to the preview_image wave in the pearl_explorer data folder.</p>
|
|
<p>the s_file_info string is updated with information about the scan dimensions.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">filename</td><td>name of a file in the directory specified by the pearl_explorer_filepath path object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>wave reference of the preview image </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00170">170</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab80101bc780dcbe94200e2446bce51d9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable subtract_line_bg </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>img</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>remove linear background line-by-line </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00886">886</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a class="anchor" id="ad720655ff881ddecae2e1b8afed58fa0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string ks_filematch_mtrx = "*_mtrx"</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>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00040">40</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aca457d1f4414d20a911254b1de13ebbb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string package_name = "pearl_matrix_import"</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>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00037">37</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a75bb92ef5f80843e66a7243bd958ef8b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string package_path = "root:packages:pearl_matrix_import:"</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>Definition at line <a class="el" href="pearl-matrix-import_8ipf_source.html#l00038">38</a> of file <a class="el" href="pearl-matrix-import_8ipf_source.html">pearl-matrix-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-matrix-import_8ipf.html">pearl-matrix-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>
|