347 lines
16 KiB
HTML
347 lines
16 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-pmsco-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);
|
|
</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
|
|
 <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-pmsco-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="#namespaces">Namespaces</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">pearl-pmsco-import.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>data import/export procedures for multiple scattering calculations.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><a href="pearl-pmsco-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="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:namespace_pearl_pmsco_import"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_pearl_pmsco_import.html">PearlPmscoImport</a></td></tr>
|
|
<tr class="memdesc:namespace_pearl_pmsco_import"><td class="mdescLeft"> </td><td class="mdescRight">data import/export procedures for multiple scattering calculations. <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:aa31bbaa2fc77b447e6c6f386b23abdd9"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pmsco-import_8ipf.html#aa31bbaa2fc77b447e6c6f386b23abdd9">pmsco_save_scan</a> (string pathname, string filename, string energy, string theta, string phi, string alpha, string intensity, string sigma, dfref sdfr=defaultValue)</td></tr>
|
|
<tr class="memdesc:aa31bbaa2fc77b447e6c6f386b23abdd9"><td class="mdescLeft"> </td><td class="mdescRight">save waves in a PMSCO scan data file. <a href="#aa31bbaa2fc77b447e6c6f386b23abdd9">More...</a><br /></td></tr>
|
|
<tr class="separator:aa31bbaa2fc77b447e6c6f386b23abdd9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0a53a4686b482d62fe1797932a1708db"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pmsco-import_8ipf.html#a0a53a4686b482d62fe1797932a1708db">save_scan_helper</a> (string destname, string value, wave template, dfref destdfr, string wavenames)</td></tr>
|
|
<tr class="memdesc:a0a53a4686b482d62fe1797932a1708db"><td class="mdescLeft"> </td><td class="mdescRight">helper function for save_pmsco_scan() <a href="#a0a53a4686b482d62fe1797932a1708db">More...</a><br /></td></tr>
|
|
<tr class="separator:a0a53a4686b482d62fe1797932a1708db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab3421c7f54aa64e5e493b267d700c0c8"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-pmsco-import_8ipf.html#ab3421c7f54aa64e5e493b267d700c0c8">pmsco_load_xyz</a> (string pathname, string filename)</td></tr>
|
|
<tr class="memdesc:ab3421c7f54aa64e5e493b267d700c0c8"><td class="mdescLeft"> </td><td class="mdescRight">load an xyz cluster file <a href="#ab3421c7f54aa64e5e493b267d700c0c8">More...</a><br /></td></tr>
|
|
<tr class="separator:ab3421c7f54aa64e5e493b267d700c0c8"><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 import/export procedures for multiple scattering calculations. </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>2018 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-pmsco-import_8ipf_source.html">pearl-pmsco-import.ipf</a>.</p>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ab3421c7f54aa64e5e493b267d700c0c8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab3421c7f54aa64e5e493b267d700c0c8">◆ </a></span>pmsco_load_xyz()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string pmsco_load_xyz </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></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>load an xyz cluster file </p>
|
|
<p>load an xyz cluster file into the current data folder the wave names are at (atom types), xx, yy, and zz. at is a text wave containing chemical symbols. existing waves are overwritten.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pathname</td><td>name of igor symbolic path. can be empty (path is taken from filename argument).</td></tr>
|
|
<tr><td class="paramname">filename</td><td>file system path. can be empty (will open dialog). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pmsco-import_8ipf_source.html#l00188">188</a> of file <a class="el" href="pearl-pmsco-import_8ipf_source.html">pearl-pmsco-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa31bbaa2fc77b447e6c6f386b23abdd9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa31bbaa2fc77b447e6c6f386b23abdd9">◆ </a></span>pmsco_save_scan()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string pmsco_save_scan </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>energy</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>theta</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>phi</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>alpha</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>intensity</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>sigma</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>sdfr</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>save waves in a PMSCO scan data file. </p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>experimental. this function is work in progress.</dd></dl>
|
|
<p>cases</p><ul>
|
|
<li>phd scan: separate energy, theta, phi, alpha, intensity waves</li>
|
|
<li>hemi scan: separate energy, theta, phi, intensity waves</li>
|
|
<li>polar/azi scan: intensity wave, angle is in x scale</li>
|
|
</ul>
|
|
<p>options</p><ul>
|
|
<li>sigma wave</li>
|
|
</ul>
|
|
<p>the data arguments are strings and can be </p><ul>
|
|
<li>the name of an existing wave (optionally including a path relative to the specified source folder), </li>
|
|
<li>the string representation of a constant numeric value, </li>
|
|
<li>a dimension specifier ("x", "y", "z" or "t") referring to the dimension scale of the intensity wave, or </li>
|
|
<li>an empty string if the corresponding axis should not be saved.</li>
|
|
</ul>
|
|
<p>wave names can include a path relative to the specified source data folder. by default, the function looks in the folder specified by the sdfr argument.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pathname</td><td>name of igor symbolic path to destination folder. prompt user if empty.</td></tr>
|
|
<tr><td class="paramname">filename</td><td>requested file name. prompt user if empty. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>the extension should include the symbols of the included parameters in the order "etpais". if the intensity wave contains a modulation function, ".modf" should be inserted before the extension. in interactive mode, igor tends to override the file extension with a standard one like ".txt".</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">energy</td><td>energy specification. see description above.</td></tr>
|
|
<tr><td class="paramname">theta</td><td>theta specification. see description above.</td></tr>
|
|
<tr><td class="paramname">phi</td><td>phi specification. see description above.</td></tr>
|
|
<tr><td class="paramname">alpha</td><td>alpha specification. see description above.</td></tr>
|
|
<tr><td class="paramname">intensity</td><td>name of intensity (or modulation) wave. this parameter is mandatory and must refer to an existing wave.</td></tr>
|
|
<tr><td class="paramname">sigma</td><td>sigma specification. see description above.</td></tr>
|
|
<tr><td class="paramname">sdfr</td><td>source data folder reference. default: current data folder.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>file name </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pmsco-import_8ipf_source.html#l00088">88</a> of file <a class="el" href="pearl-pmsco-import_8ipf_source.html">pearl-pmsco-import.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0a53a4686b482d62fe1797932a1708db"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0a53a4686b482d62fe1797932a1708db">◆ </a></span>save_scan_helper()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string save_scan_helper </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>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>template</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">dfref </td>
|
|
<td class="paramname"><em>destdfr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>wavenames</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>helper function for save_pmsco_scan() </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-pmsco-import_8ipf_source.html#l00126">126</a> of file <a class="el" href="pearl-pmsco-import_8ipf_source.html">pearl-pmsco-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-pmsco-import_8ipf.html">pearl-pmsco-import.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>
|