185 lines
8.8 KiB
HTML
185 lines
8.8 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<!-- CS2DSscan.qml -->
|
|
<title>CS2DSscan QML Type | CSDataQuick Documentation 1.2</title>
|
|
<link rel="stylesheet" type="text/css" href="style/online.css" />
|
|
<script type="text/javascript">
|
|
(function (i, s, o, g, r, a, m) {
|
|
i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
|
|
(i[r].q = i[r].q || []).push(arguments)
|
|
}, i[r].l = 1 * new Date(); a = s.createElement(o),
|
|
m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
|
|
})(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');
|
|
|
|
ga('create', 'UA-24645639-4', 'qt.io');
|
|
ga('set', 'forceSSL', true);
|
|
ga('send', 'pageview');
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<div class="header" id="header">
|
|
<header id="navbar" class="">
|
|
</header>
|
|
</div>
|
|
<div class="main">
|
|
<div class="main-rounded">
|
|
<div class="navigationbar">
|
|
<ul class="sub-navigation">
|
|
<li><a href="../../CSDataQuick.html">Home</a></li>
|
|
<li><a href="../docs.html" class="active">Documentation</a></li>
|
|
<li><a href="http://github.com/xiaoqiangwang/CSDataQuick/">Code</a></li>
|
|
<li><a href="https://github.com/xiaoqiangwang/CSDataQuick/issues/">Bug Reports</a></li>
|
|
</ul>
|
|
<div id="main_title_bar">
|
|
<h1>CSDataQuick Documentation</h1>
|
|
<div class="search_bar">
|
|
<script>
|
|
(function() {
|
|
var cx = '001693341472456439948:u9v0snkru3q';
|
|
var gcse = document.createElement('script');
|
|
gcse.type = 'text/javascript';
|
|
gcse.async = true;
|
|
gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + '//www.google.com/cse/cse.js?cx=' + cx;
|
|
var s = document.getElementsByTagName('script')[0];
|
|
s.parentNode.insertBefore(gcse, s);
|
|
})();
|
|
</script>
|
|
<gcse:searchbox-only resultsUrl="search-results.html"></gcse:searchbox-only>
|
|
</div></div>
|
|
<ul>
|
|
<li><a href="index.html">CSDataQuick Documentation</a></li>
|
|
<li><a href="csdataquick-qmlmodules.html">QML Types</a></li>
|
|
<li>CS2DSscan QML Type</li>
|
|
</ul>
|
|
</div>
|
|
<div class="content">
|
|
<div class="line">
|
|
<div class="content mainContent">
|
|
<div class="sidebar">
|
|
<div class="toc">
|
|
<h3><a name="toc">Contents</a></h3>
|
|
<ul>
|
|
<li class="level1"><a href="qml-csdataquick-components-cs2dsscan.html#properties">Properties</a></li>
|
|
<li class="level1"><a href="qml-csdataquick-components-cs2dsscan.html#details">Detailed Description</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sidebar-content" id="sidebar-content"></div></div>
|
|
<div class="context">
|
|
<h1 class="title">CS2DSscan QML Type</h1>
|
|
<span class="subtitle"></span>
|
|
<!-- $$$CS2DSscan-brief -->
|
|
<p>Display 2D sscan. <a href="qml-csdataquick-components-cs2dsscan.html#details">More...</a></p>
|
|
<!-- @@@CS2DSscan -->
|
|
<div class="table"><table class="alignedsummary">
|
|
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import CSDataQuick.Components 1.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-csdataquick-components-baseitem.html">BaseItem</a></p>
|
|
</td></tr></table></div><ul>
|
|
<li><a href="qml-csdataquick-components-cs2dsscan-members.html">List of all members, including inherited members</a></li>
|
|
</ul>
|
|
<a name="properties"></a>
|
|
<h2 id="properties">Properties</h2>
|
|
<ul>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-cs2dsscan.html#detX-prop">detX</a></b></b> : int</li>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-cs2dsscan.html#posX-prop">posX</a></b></b> : int</li>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-cs2dsscan.html#posY-prop">posY</a></b></b> : int</li>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-cs2dsscan.html#scanX-prop">scanX</a></b></b> : string</li>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-cs2dsscan.html#scanY-prop">scanY</a></b></b> : string</li>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-cs2dsscan.html#title-prop">title</a></b></b> : string</li>
|
|
</ul>
|
|
<!-- $$$CS2DSscan-description -->
|
|
<a name="details"></a>
|
|
<h2 id="details">Detailed Description</h2>
|
|
<p><a href="http://www.aps.anl.gov/bcda/synApps/sscan/sscan.html">sscan</a> is a flexible way to move positioners through a series of positions and record detector data at each of the positions.</p>
|
|
<p>The following PVs are relavent:</p>
|
|
<div class="table"><table class="generic">
|
|
<thead><tr class="qt-style"><th >SSCAN PV</th><th >Description</th></tr></thead>
|
|
<tr valign="top" class="odd"><td >$(X)CPT</td><td >Current point of X dimension</td></tr>
|
|
<tr valign="top" class="even"><td >$(X)NPTS</td><td >Number of points of X dimension</td></tr>
|
|
<tr valign="top" class="odd"><td >$(X)PnSP</td><td >Start point of positioner n of X dimension</td></tr>
|
|
<tr valign="top" class="even"><td >$(X)PnEP</td><td >End point of positioner n of X dimension</td></tr>
|
|
<tr valign="top" class="odd"><td >$(X)EXSC</td><td >Execute scan flag of X dimension</td></tr>
|
|
<tr valign="top" class="even"><td >$(Y)CPT</td><td >Current point of Y dimension</td></tr>
|
|
<tr valign="top" class="odd"><td >$(Y)NPTS</td><td >Number of points of Y dimension</td></tr>
|
|
<tr valign="top" class="even"><td >$(Y)PnSP</td><td >Start point of positioner n of Y dimension</td></tr>
|
|
<tr valign="top" class="odd"><td >$(Y)PnEP</td><td >End point of positioner n of Y dimension</td></tr>
|
|
<tr valign="top" class="even"><td >$(Y)EXSC</td><td >Execute scan flag of Y dimension</td></tr>
|
|
<tr valign="top" class="odd"><td >$(X)DnnDA</td><td >End of scan detector array of X dimension</td></tr>
|
|
<tr valign="top" class="even"><td >$(X)DnnCV</td><td >Current detector value of X dimension</td></tr>
|
|
</table></div>
|
|
<pre class="qml"><span class="type"><a href="qml-csdataquick-components-cs2dsscan.html">CS2DSscan</a></span> {
|
|
<span class="name">scanX</span>: <span class="string">'MTEST:scan1'</span>
|
|
<span class="name">scanY</span>: <span class="string">'MTEST:scan2'</span>
|
|
}</pre>
|
|
<p class="centerAlign"><img src="images/sscan.png" alt="" /></p><!-- @@@CS2DSscan -->
|
|
<h2>Property Documentation</h2>
|
|
<!-- $$$detX -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="detX-prop">
|
|
<td class="tblQmlPropNode"><p>
|
|
<a name="detX-prop"></a><span class="name">detX</span> : <span class="type">int</span></p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>This property holds the sscan record detector number of X dimension</p>
|
|
</div></div><!-- @@@detX -->
|
|
<br/>
|
|
<!-- $$$posX -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="posX-prop">
|
|
<td class="tblQmlPropNode"><p>
|
|
<a name="posX-prop"></a><span class="name">posX</span> : <span class="type">int</span></p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>This property holds the sscan record positioner number of X dimension</p>
|
|
</div></div><!-- @@@posX -->
|
|
<br/>
|
|
<!-- $$$posY -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="posY-prop">
|
|
<td class="tblQmlPropNode"><p>
|
|
<a name="posY-prop"></a><span class="name">posY</span> : <span class="type">int</span></p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>This property holds the sscan record positioner number of Y dimension</p>
|
|
</div></div><!-- @@@posY -->
|
|
<br/>
|
|
<!-- $$$scanX -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="scanX-prop">
|
|
<td class="tblQmlPropNode"><p>
|
|
<a name="scanX-prop"></a><span class="name">scanX</span> : <span class="type">string</span></p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>This property holds the sscan record prefix of X dimension</p>
|
|
</div></div><!-- @@@scanX -->
|
|
<br/>
|
|
<!-- $$$scanY -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="scanY-prop">
|
|
<td class="tblQmlPropNode"><p>
|
|
<a name="scanY-prop"></a><span class="name">scanY</span> : <span class="type">string</span></p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>This property holds the sscan record prefix of X dimension</p>
|
|
</div></div><!-- @@@scanY -->
|
|
<br/>
|
|
<!-- $$$title -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="title-prop">
|
|
<td class="tblQmlPropNode"><p>
|
|
<a name="title-prop"></a><span class="name">title</span> : <span class="type">string</span></p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>This property holds the graph title</p>
|
|
</div></div><!-- @@@title -->
|
|
<br/>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer">Copyright (C) 2012-2021 Xiaoqiang Wang, Paul Scherrer Institute.</div>
|
|
</body>
|
|
</html>
|