Updated user documentation. MK

This commit is contained in:
cvs
2000-02-11 15:21:07 +00:00
parent b98f7db7f6
commit af97d16309
26 changed files with 1506 additions and 394 deletions

View File

@ -7,6 +7,12 @@
<h1>The Scan Command </h1>
<hr size=4 width="66%">
<p>
An important concept in neutron scattering instrument control is a
"scan". For a simple scan a range of instrument positions is divided
into equidistant steps. The instrument then proceeds to drive to each
of these points and collects data at each of them.
</p>
<p>
The general idea of the scan object for TOPSI is, that you configure the
scan by typing commands at the command line. Once, the configuration is
finished the requested scan is started. A data file will be written
@ -59,7 +65,7 @@ cscan var center delta np preset
</BLOCKQUOTE>
All parameters must be specified. The parameters and their meanings:
<UL>
<LI><b>var</b> is the varibale which is to be center scanned.
<LI><b>var</b> is the variable which is to be center scanned.
Only one can be specified.
<LI><b>center</b> is the value to use as center of the scan.
<LI><b>delta</b> is the step width to use for the scan.
@ -79,10 +85,11 @@ sscan var1 start end var2 start end ... np preset
All parameters must be specified. The parameters and their meanings:
<UL>
<LI><b>var1 start end</b> This is how the variables to scan are specified. For
each variable scanned a triplet must be given which consists of the name of the
variable, the start value and the end value of the scan. More then one triplet
each variable scanned the name of the
variable, the start value and the end value of the scan must be
given. More then one triplet
can be given in order to allow for several scan variables.
<LI><b>np</b> is the number of points to scan in each direction.
<LI><b>np</b> is the number of points to scan.
<LI><b>preset</b> is the preset to use for the counter. As the counter mode,
the mode currently configured active in the scan object is used.
</UL>
@ -94,7 +101,8 @@ the results of the last scan still in memory. The command <b>peak</b> prints
the position, FWHM and maximum value of the peak in the last scan. The
command <b>center</b> drives the first scan variable to the peak center of the
last scan. Both peak and center use a rather simple but effective method for
locating peaks. The prerequisite is that the peak is about gauss shaped. The
locating peaks. The prerequisite is that the peak is approximatly
gaussian shaped. The
algorithm first locates the peak maximum. Then it goes to the left and
right of the maximum and tries to find the points of half maximum peak height.
The two points are interpolated from the data and the peak position