igor-public/doc/html/pearl-pmsco-import_8ipf_source.html

104 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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PEARL Procedures: pearl-pmsco-import.ipf Source File</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-pmsco-import_8ipf_source.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="headertitle">
<div class="title">pearl-pmsco-import.ipf</div> </div>
</div><!--header-->
<div class="contents">
<a href="pearl-pmsco-import_8ipf.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma rtGlobals=3 // Use modern global access method and strict wave access.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#pragma IgorVersion = 6.2</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#pragma ModuleName = PearlPmscoImport</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// copyright (c) 2018 Paul Scherrer Institut</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// http:///www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// Please acknowledge the use of this code.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="pearl-pmsco-import_8ipf.html#aa31bbaa2fc77b447e6c6f386b23abdd9"> 88</a></span>&#160;<span class="keyword">function</span> /s <a class="code" href="pearl-pmsco-import_8ipf.html#aa31bbaa2fc77b447e6c6f386b23abdd9">pmsco_save_scan</a>(pathname, filename, energy, theta, phi, alpha, intensity, sigma, [sdfr])</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordtype">string</span> pathname</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordtype">string</span> filename</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordtype">string</span> energy</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordtype">string</span> theta</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordtype">string</span> phi</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordtype">string</span> alpha</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordtype">string</span> intensity</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordtype">string</span> sigma</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; dfref sdfr</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="comment">//string fileext</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="comment">//fileext = StringFromList(ItemsInList(filename, &quot;.&quot;) - 1, filename, &quot;.&quot;)</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; dfref savedf = GetDataFolderDFR()</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; dfref tempdf = NewFreeDataFolder()</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; if (ParamIsDefault(sdfr))</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; dfref sdfr = savedf</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; endif</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; SetDataFolder sdfr</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; wave w_intensity = $intensity</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordtype">string</span> wavenames = &quot;&quot;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; wavenames = <a class="code" href="pearl-pmsco-import_8ipf.html#a0a53a4686b482d62fe1797932a1708db">save_scan_helper</a>(&quot;w_energy&quot;, energy, w_intensity, tempdf, wavenames)</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; wavenames = <a class="code" href="pearl-pmsco-import_8ipf.html#a0a53a4686b482d62fe1797932a1708db">save_scan_helper</a>(&quot;w_theta&quot;, theta, w_intensity, tempdf, wavenames)</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; wavenames = <a class="code" href="pearl-pmsco-import_8ipf.html#a0a53a4686b482d62fe1797932a1708db">save_scan_helper</a>(&quot;w_phi&quot;, phi, w_intensity, tempdf, wavenames)</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; wavenames = <a class="code" href="pearl-pmsco-import_8ipf.html#a0a53a4686b482d62fe1797932a1708db">save_scan_helper</a>(&quot;w_alpha&quot;, alpha, w_intensity, tempdf, wavenames)</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; wavenames = <a class="code" href="pearl-pmsco-import_8ipf.html#a0a53a4686b482d62fe1797932a1708db">save_scan_helper</a>(&quot;w_intensity&quot;, intensity, w_intensity, tempdf, wavenames)</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; wavenames = <a class="code" href="pearl-pmsco-import_8ipf.html#a0a53a4686b482d62fe1797932a1708db">save_scan_helper</a>(&quot;w_sigma&quot;, sigma, w_intensity, tempdf, wavenames)</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; setdatafolder tempdf</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; save /b /g /m=&quot;\n&quot; /p=$pathname wavenames as filename</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; setdatafolder savedf</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;end</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;</div><div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="pearl-pmsco-import_8ipf.html#a0a53a4686b482d62fe1797932a1708db"> 126</a></span>&#160;static function /s <a class="code" href="pearl-pmsco-import_8ipf.html#a0a53a4686b482d62fe1797932a1708db">save_scan_helper</a>(destname, value, template, destdfr, wavenames)</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keywordtype">string</span> destname</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keywordtype">string</span> value</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; wave template</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; dfref destdfr</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keywordtype">string</span> wavenames</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; variable err = 0</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; if (strlen(value) &gt; 0)</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; if (exists(value) == 1)</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; duplicate $value, destdfr:$destname</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; wave /sdfr=destdfr w=$destname</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; else</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; duplicate template, destdfr:$destname</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; wave /sdfr=destdfr w=$destname</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; variable numval = str2num(value)</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <span class="keywordtype">string</span> msg</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; if (numtype(numval) == 0)</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; w = numval</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="comment">//elseif (cmpstr(value[0,0], &quot;%&quot;) == 0)</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; else</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; strswitch(value)</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; case &quot;x&quot;:</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; w = DimOffset(template, 0) + DimDelta(template, 0) * p</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; break</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; case &quot;y&quot;:</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; w = DimOffset(template, 1) + DimDelta(template, 1) * q</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; break</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; case &quot;z&quot;:</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; w = DimOffset(template, 2) + DimDelta(template, 2) * r</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; break</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; case &quot;t&quot;:</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; w = DimOffset(template, 3) + DimDelta(template, 3) * s</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; break</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; default:</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; err = 1</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; sprintf msg, &quot;invalid %s argument&quot;, StringFromList(1, destname, &quot;_&quot;)</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; endswitch</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; endif</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; endif</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; if (err == 0)</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; wavenames = AddListItem(destname, wavenames, &quot;;&quot;, inf)</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; variable npts = DimSize(w, 0) * max(DimSize(w, 1), 1) * max(DimSize(w, 2), 1) * max(DimSize(w, 3), 1)</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; Redimension /n=(npts) w</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; else</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; abort msg </div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; endif</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; endif</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; return wavenames</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;end</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;</div><div class="line"><a name="l00188"></a><span class="lineno"><a class="line" href="pearl-pmsco-import_8ipf.html#ab3421c7f54aa64e5e493b267d700c0c8"> 188</a></span>&#160;function /s <a class="code" href="pearl-pmsco-import_8ipf.html#ab3421c7f54aa64e5e493b267d700c0c8">pmsco_load_xyz</a>(pathname, filename)</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; <span class="keywordtype">string</span> pathname</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; <span class="keywordtype">string</span> filename</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160;</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; <span class="keywordtype">string</span> cis = &quot;N=at;N=xx;N=yy;N=zz;&quot;</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; LoadWave /A /B=cis /J /K=0 /L={0, 2, 0, 0, 0} /V={<span class="stringliteral">&quot; &quot;</span>, <span class="stringliteral">&quot; &quot;</span>, 0, 0} /O /P=$pathname filename</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; wave /t at</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; at = unpadstring(at, 32)</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160;end</div><div class="ttc" id="pearl-pmsco-import_8ipf_html_aa31bbaa2fc77b447e6c6f386b23abdd9"><div class="ttname"><a href="pearl-pmsco-import_8ipf.html#aa31bbaa2fc77b447e6c6f386b23abdd9">pmsco_save_scan</a></div><div class="ttdeci">string pmsco_save_scan(string pathname, string filename, string energy, string theta, string phi, string alpha, string intensity, string sigma, dfref sdfr=defaultValue)</div><div class="ttdoc">save waves in a PMSCO scan data file. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-pmsco-import_8ipf_source.html#l00088">pearl-pmsco-import.ipf:88</a></div></div>
<div class="ttc" id="pearl-pmsco-import_8ipf_html_a0a53a4686b482d62fe1797932a1708db"><div class="ttname"><a href="pearl-pmsco-import_8ipf.html#a0a53a4686b482d62fe1797932a1708db">save_scan_helper</a></div><div class="ttdeci">static string save_scan_helper(string destname, string value, wave template, dfref destdfr, string wavenames)</div><div class="ttdoc">helper function for save_pmsco_scan() </div><div class="ttdef"><b>Definition:</b> <a href="pearl-pmsco-import_8ipf_source.html#l00126">pearl-pmsco-import.ipf:126</a></div></div>
<div class="ttc" id="pearl-pmsco-import_8ipf_html_ab3421c7f54aa64e5e493b267d700c0c8"><div class="ttname"><a href="pearl-pmsco-import_8ipf.html#ab3421c7f54aa64e5e493b267d700c0c8">pmsco_load_xyz</a></div><div class="ttdeci">string pmsco_load_xyz(string pathname, string filename)</div><div class="ttdoc">load an xyz cluster file </div><div class="ttdef"><b>Definition:</b> <a href="pearl-pmsco-import_8ipf_source.html#l00188">pearl-pmsco-import.ipf:188</a></div></div>
</div><!-- fragment --></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>