- made fixes to hkl
- Introduced a help system - introduced a module for handling automatic updates of files during long measurements - Added a circular buffer and handling facilities to varlog - Upgraded documentation SKIPPED: psi/faverage.h psi/nxamor.tex psi/pimotor.h psi/pimotor.tex
This commit is contained in:
@ -36,7 +36,19 @@ system for instance file names are case sensitive and that had to be
|
||||
preserved. Commands defined in the scripting language are lower case by
|
||||
convention.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Most SICS objects also hold the parameters required for their proper
|
||||
operation. The general syntax for handling such parameters is:
|
||||
<pre>
|
||||
objectname parametername
|
||||
</pre>
|
||||
prints the current value of the parameter
|
||||
</p>
|
||||
<pre>
|
||||
objectname parametername newvalue
|
||||
</pre>
|
||||
sets the parameter value to newvalue if you are properly authorized.
|
||||
</p>
|
||||
<h3>Authorisation</h3>
|
||||
<p>
|
||||
A client server system is potentially open to unauthorised hackers
|
||||
|
@ -21,9 +21,6 @@ manually from the command line through the following commands:
|
||||
is minutes.
|
||||
<DT>storefocus intervall newval
|
||||
<DD>Sets the update intervall to newval minutes.
|
||||
<DT>killfile
|
||||
<DD>This command will overwrite the last data file written and thus
|
||||
effectively erase it. Therefore this command requires manager privilege.
|
||||
</DL>
|
||||
FOCUS has three detector banks which may not all be active at all
|
||||
times. Thus a way is needed to tell SICS about the configuration of
|
||||
|
@ -75,15 +75,10 @@ for its number type.
|
||||
</UL>
|
||||
<DT> Rank
|
||||
<DD> Rank defines the number of histograms in memory.
|
||||
<DT> Length
|
||||
<DD> gives the length of an individual histogram.
|
||||
<DT> BinWidth
|
||||
<DD> determines the size of a single bin in histogram memory in bytes.
|
||||
<DT>dim0, dim1, dim2, ... dimn
|
||||
<DD>define the logical dimensions of the histogram. Must be set if the
|
||||
the sum command (see below) is to be used. This is a clutch necessary to
|
||||
cope with the different notions of dimensions in the SINQ histogram memory
|
||||
and physics.
|
||||
<DD>define the logical dimensions of the histogram.
|
||||
</DL>
|
||||
</p>
|
||||
<p>
|
||||
@ -126,6 +121,8 @@ will be generated starting from start with a stepwidth of step (example: HM genb
|
||||
configured with this command. The time bin iNum is set to the value value.
|
||||
<DT>HM clearbin
|
||||
<DD>Deletes the currently active time binning information.
|
||||
<dt>HM notimebin
|
||||
<dd>returns the number of currently configured timebins.
|
||||
</DL>
|
||||
</p>
|
||||
|
||||
@ -150,6 +147,10 @@ transfer the configuration from the host computer to the actual HM.
|
||||
<DD> starts counting using the currently active values for CountMode and
|
||||
preset. This command does not block, i.e. in order to inhibit further
|
||||
commands from the console, you have to give Success afterwards.
|
||||
<DT>HM countblock
|
||||
<DD> starts counting using the currently active values for CountMode and
|
||||
preset. This command does block, i.e. you can give new commands only when
|
||||
the counting operation finishes.
|
||||
<DT>HM initval <i>val</i>
|
||||
<DD> initialises the whole histogram memory to the value val. Ususally 0 in
|
||||
order to clear the HM.
|
||||
@ -164,3 +165,5 @@ allow to retrieve a subset of a histogram between iStart and iEnd.
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
|
@ -53,6 +53,17 @@ Optionally a psi value and a hamilton position can be specified.
|
||||
the motors to drive to that position. This command will wait for the
|
||||
diffractometer to arrive at the setting angles requested.
|
||||
Optionally a psi value and a hamilton position can be specified.
|
||||
<dt>hkl hm
|
||||
<dd>Retrieves the value of the histogram memory flag.
|
||||
<dt>hkl hm val
|
||||
<dd>Sets the histogram memory flag to val. This is a special for
|
||||
TRICS. TRICS has three detectors at 0, 45, 90 degree offset to two
|
||||
theta. If this flag is greater 0, hkl checks if the reflection to be
|
||||
calculated is on any of the three detectors and calculates two theta
|
||||
accordingly.
|
||||
<dt>hkl fromangles two-theta om chi phi
|
||||
<dd>Calculates hkl from the angles given on the command line using the
|
||||
current UB matrix and wavelength.
|
||||
</DL>
|
||||
</p>
|
||||
|
||||
|
@ -3,10 +3,14 @@
|
||||
<TITLE>Hklscan</TITLE>
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<H1>Hklscan</H1>
|
||||
<H1>Hklscan and Hklscan2d</H1>
|
||||
<P>
|
||||
Hklscan is a command which allows to scan in reciprocal space expressed as
|
||||
Miller indizes on a four circle diffractometer. Prerequisite for this is
|
||||
Miller indizes on a four circle diffractometer. Hklscan operates with
|
||||
a single detector. Hklscan2d does the same as hklscan but for the
|
||||
position sensitive detectors, saving data into NeXus files. Hklscan
|
||||
and Hklscan2d share the same syntax.
|
||||
Prerequisite for this is
|
||||
the existence of a scan object and the hkl-object for doing crystallographic
|
||||
calculations. Make sure the properties of the hkl object (UB, wavelength, NB)
|
||||
have some reasonable relation to reality, otherwise the diffractometer may
|
||||
@ -25,10 +29,15 @@ Hklscan is a command which allows to scan in reciprocal space expressed as
|
||||
<dd>executes the HKL scan. NP is the number of points to do, mode is the
|
||||
counting mode and can be either timer or monitor and preset is the preset
|
||||
value for the counter at each step.
|
||||
<dt>hklscan2d sim NP mode preset
|
||||
<dd>This command only for hklscan2d. It tries to calculate all points
|
||||
in the hkl scan and complains if it cannot reached or stays
|
||||
silent. Use this to test if your hklscan2d can be performed.
|
||||
</dl>
|
||||
Data is written automatically into a slightly modified TOPSI data format
|
||||
file. The status display with topsistatus or scanstatus might be slightly
|
||||
erratic as it uses two theta as x-axis.
|
||||
file for hklscan. The status display with topsistatus or scanstatus
|
||||
might be slightly erratic as it uses two theta as x-axis. Hklscan2d
|
||||
writes data into NeXus files.
|
||||
</P>
|
||||
</BODY>
|
||||
</HTML>
|
||||
|
59
doc/user/lowmax.htm
Normal file
59
doc/user/lowmax.htm
Normal file
@ -0,0 +1,59 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>The Local Maximum Search Module</TITLE>
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<h1>The Local Maximum Search Module</h1>
|
||||
<p>
|
||||
This module allows to search for local maxima in two-dimensional
|
||||
datasets stored within a SICS histogram memory. All commands
|
||||
act upon the current content of the histogram memory. The following
|
||||
commands are understood:
|
||||
<dl>
|
||||
<dt>lowmax stat hm
|
||||
<dd>calculates the average and the maximum count in the frame
|
||||
currently held in histogram memory hm.
|
||||
<dt>lowmax search hm
|
||||
<dd>searches the frame held in histogram memory hm for local
|
||||
maxima. Local maxima are returned as sets of three numbers which are
|
||||
the x and y coordinates and the intensity. Each set of numbers is
|
||||
separated from the next one by the @ symbol.
|
||||
<dt>lowmax cog hm x y
|
||||
<dd>calculates the center ogf gravity for the pixel at coordinates x
|
||||
and y in histogram memory hm. Four numbers are returned: the new x and
|
||||
y coordinates, the intensity of the peak and the number of points
|
||||
contributing to the peak.
|
||||
<dt>lowmax steepness val
|
||||
<dd>accesses the steepness parameter for the peak search. With a
|
||||
parameter val sets a new value, without print the current value.
|
||||
<dt>lowmax window val
|
||||
<dd>accesses the window parameter for the peak search. With a
|
||||
parameter val sets a new value, without print the current value.
|
||||
<dt>lowmax threshold val
|
||||
<dd>accesses the thresholds parameter for the peak search. With a
|
||||
parameter val sets a new value, without print the current value.
|
||||
<dt>lowmax cogwindow val
|
||||
<dd>accesses the cogwindow parameter for the peak search. With a
|
||||
parameter val sets a new value, without print the current value.
|
||||
<dt>lowmax cogcontour val
|
||||
<dd>accesses the cogcontour parameter for the peak search. With a
|
||||
parameter val sets a new value, without print the current value.
|
||||
</dl>
|
||||
The local maximum search can be tuned through the parameters: The
|
||||
window parameter sets the size of the quadratic area for which a
|
||||
candidate pixel must be the local maximum. Threshold sets a minimum
|
||||
count rate for a local maximum. Steepness sets a minimum difference to
|
||||
the borders of the window used for the local maximum search which must
|
||||
be fulfilled.
|
||||
</p>
|
||||
<p>
|
||||
The center of gravity calculation can be tuned mainly through the
|
||||
cogcontour parameter which determines at which percentage of the
|
||||
maximum value of the peak the center of gravity calculation
|
||||
stops. Cogwindow is the size of the area in which a center of gravity
|
||||
is calculated. Can be set rather generously.
|
||||
</p>
|
||||
</BODY>
|
||||
</HTML>
|
||||
|
||||
|
@ -7,14 +7,25 @@
|
||||
<p>
|
||||
SICS has a built in macro facility. This macro facility is aimed at instrument managers and users alike. Instrument managers may provide customised measurement procedures in this language, users may write batch files in this language. The macro language is John Ousterhout's Tool Command Language (TCL). Tcl has control constructs, variables of its own, loop constructs, associative arrays and procedures. Tcl is well documented by several books and online tutorials, therefore no details on Tcl will be given here. All SICS commands are available in the macro language. Some potentially harmful Tcl commands have been deleted from the standard Tcl interpreter. These are: exec, source, puts, vwait, exit,gets and socket. A macro or batch file can be executed with the command:</p>
|
||||
<p>
|
||||
<b> fileeval <i>name</i> </b> tries to open the file name and executes the script in this file. </p>
|
||||
<b> fileeval <i>name</i> </b> tries to open the file name and
|
||||
executes the script in this file.
|
||||
</p>
|
||||
<p>
|
||||
<b>batchrun <i>name</i></b> prepends to name a directory name
|
||||
configured in the variable batchroot and then executes that
|
||||
batchfile. The usage scenerio is that you have a directory where you
|
||||
keep batch files. Then the variable batcroot is set to contain the path
|
||||
to that directory. Batchrun then allows to start scripts in that
|
||||
directory without specifying the full path.
|
||||
Then there are some special commands which can be used within macro-sripts:
|
||||
<p>
|
||||
<b> ClientPut sometext1 ... </b> writes everything after ClientPut to
|
||||
the client which started the script. This is needed as SICS supresses
|
||||
the output from intermediate commands in scripts. Except error
|
||||
messages and warnings. With clientput this scheme can be circumvented
|
||||
and data be printed from within scripts.</p>
|
||||
<b> ClientPut sometext1 ... </b>Usally SICS suppresses any messages
|
||||
from SICS during the processing of batch files. This is in order not
|
||||
to confuse users with the output of intermediate results during
|
||||
the processing of batch files. Error messages and warnings, however,
|
||||
come through always. Clientput now allows to send messages to the
|
||||
user on purpose from within scripts.
|
||||
</p>
|
||||
<p>
|
||||
<b> SICSType object </b> allows to query the type of the object specified by object. Possible return values are<ul>
|
||||
<li> <b> DRIV </b> if the object is a SICS drivable object such as a motor
|
||||
|
@ -47,8 +47,83 @@ or equal to zero for the motor being movable.
|
||||
<li> <b> Precision </b> denotes the precision to expect from the motor in positioning. Can usually only be set by managers.
|
||||
<li> <b> AccessCode </b> specifies the level of user privilege necessary to operate the motor. Some motors are for adjustment only and can be harmful to move once the adjustment has been done. Others must be moved for the experiment. Values are 0 - 3 for internal, manager, user and spy. This parameter can only be changed by managers.
|
||||
<li> <b> Sign </b> reverses the operating sense of the motor.
|
||||
For cases where electricians and not physicists have defined the operating sense of the motor. Usually a parameter not to be changed by ordinary users.
|
||||
For cases where electricians and not physicists have defined the
|
||||
operating sense of the motor. Usually a parameter not to be changed
|
||||
by ordinary users.
|
||||
<li><b> failafter </b>This is the number of consecutive failures of
|
||||
positioning operations this motor allows before it thinks that
|
||||
something is really broken and aborts the experiment.
|
||||
<li><b> maxretry </b>When a motor finishes driving, SICS checks if the
|
||||
desired position was reached. If the position read back from the motor
|
||||
is not within precision to the desired value, the motor is
|
||||
restarted. This is done at max maxretry times. After maxretry retries,
|
||||
the motor throws an error.
|
||||
<li></b> ignorefault </b>If this is bigger then 0, positioning faults
|
||||
from the motor will be ignored.
|
||||
</ul>
|
||||
<p>
|
||||
<h2>Motor Error Handling Concepts</h2>
|
||||
<p>
|
||||
As mechanical components motors are prone to errors. SICS knows about
|
||||
two different classes of motor errors:
|
||||
<dl>
|
||||
<dt>HWFault
|
||||
<dd>This is when there is a problem communicating with the motor, a
|
||||
limit is violated etc. SICS assumes that such errors are so grave that
|
||||
no fix is possible. If such a HWFault is detected a configurable
|
||||
interrupt (see parameter InterruptMode) is set which can be used by
|
||||
upper level code to act upon the problem.
|
||||
<dt>HWPosFault
|
||||
<dd>This is a positioning failure, i.e. The motor did not reach the
|
||||
desired position. Such a positioning problem can come from two
|
||||
sources:
|
||||
<ul>
|
||||
<li>The positioning problem is reported by the motor driver. SICS then
|
||||
assumes that the driver has done something to solve the problem and
|
||||
promotes this problem to a HWFault.
|
||||
<li>The motor driver reported no error and SICS figures out by itself,
|
||||
that the desired position has not been reached. SICS thinks that this
|
||||
is the case if the difference between the desired position and the
|
||||
position read from the motor controller is greater then the parameter
|
||||
precision. If SICS detects such a problem it tries to reposition the
|
||||
motor. This is done for the number of times specified through the
|
||||
parameter maxretries. If the position has not been reached after
|
||||
maxretries repositionings, a HWFault is assumed.
|
||||
</ul>
|
||||
</dl>
|
||||
In any case lots of warnings and infos are printed.
|
||||
</p>
|
||||
<p>
|
||||
If SICS tries to drive an axis which is for some reason broken to
|
||||
often hardware damage may occur (and HAS occurred!). Now, SICS has no
|
||||
means to detect if the mispositioning of a motor is due to a concrete
|
||||
block in the path of the instrument or any other reason. What SICS can
|
||||
do though is to count how often a motor mispositions in
|
||||
sequence. This means SICS counts mispositionings if it cannot drive a
|
||||
motor, if the motor is driven succesfully, the count is cleared. If
|
||||
the count of mispositionings becomes higher then the parameter
|
||||
failafter, SICS thinks that there is something really, really wrong
|
||||
and aborts the measurement and prints an error message containing the
|
||||
string: MOTOR ALARM.
|
||||
</p>
|
||||
<p>
|
||||
There are some common pitfalls with this scheme:
|
||||
<dl>
|
||||
<dt>You want upper level code to be signalled when your critical motor
|
||||
fails.
|
||||
<dd>Solution: set the parameter interruptmode to something useful and
|
||||
check for the interrupt in upper level code.
|
||||
<dt>SICS falsly reports mispositionings.
|
||||
<dd>Solution: increase the precision parameter.
|
||||
<dt>You know that a motor is broken, you cannot fix it, but you want
|
||||
to measure anyway.
|
||||
<dd>Solution: increase the precision parameter, if SICS finds the
|
||||
positioning problem, increase maxretries, increase the failafter
|
||||
parameter. In the worst case set the ignorefault parameter to greater
|
||||
0, this will prevent all motor alarms.
|
||||
</dl>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
|
@ -21,9 +21,6 @@ manually from the command line through the following commands:
|
||||
is minutes. Default is 20 minutes.
|
||||
<DT>storedata intervall <i>newval</i>
|
||||
<DD>Sets the update intervall to newval minutes.
|
||||
<DT>killfile
|
||||
<DD>This command will overwrite the last data file written and thus
|
||||
effectively erase it. Therefore this command requires manager privilege.
|
||||
</DL>
|
||||
</P>
|
||||
</BODY>
|
||||
|
@ -225,15 +225,17 @@ can be achieved by using the drive command.
|
||||
and <b>log frequency</b> (both below)
|
||||
</DL>
|
||||
<h3>Logging </h3>
|
||||
The values of any sample environement device can be logged. There are two
|
||||
The values of any sample environement device can be logged. There are three
|
||||
features:
|
||||
<ul>
|
||||
<li>Logging to a file wih a configurable time intervall between log
|
||||
file entries.
|
||||
<li>Sums are kept internally which allow the calculation of the mean
|
||||
value and the standard deviation at all times.
|
||||
<li>A circular buffer holding 1000 timestamps plus values is
|
||||
automatically updated.
|
||||
</ul>
|
||||
The last system is automatically switched on after the first drive or
|
||||
The last two systems are automatically switched on after the first drive or
|
||||
run command on the environment device completed.
|
||||
This system is run through the following commands.
|
||||
<DL>
|
||||
@ -245,7 +247,7 @@ standard deviation.
|
||||
values and prints them.
|
||||
<DT>name log frequency val
|
||||
<DD> With a parameter sets, without a parameter requests the logging intervall
|
||||
for the log file.
|
||||
for the log file and the circular buffer.
|
||||
This parameter specifies the time intervall in seconds
|
||||
between log records. The default is 300 seconds.
|
||||
<DT>name log file filename
|
||||
@ -255,12 +257,22 @@ Logging will happen any 5 minutes initially. The logging frequency
|
||||
of the form date time value. The name of the file must be specified relative
|
||||
to the SICS server.
|
||||
<DT>name log flush
|
||||
<DD>DigitalUnix buffers output heavily. With this command an update of
|
||||
<DD>Unix buffers output heavily. With this command an update of
|
||||
the file can be enforced.
|
||||
<DT>name log status
|
||||
<DD>Queries if logging to file is currently happening or not.
|
||||
<DT>name log close
|
||||
<DD> Stops logging data to the file.
|
||||
<dt>name log tosicsdata dataname
|
||||
<dd>copies the content of the circular buffer to a sicsdata
|
||||
buffer. This is used by graphical clients to display the content of
|
||||
the circular buffer.
|
||||
<dt>name log dump
|
||||
<dd>Prints the content of the circular log buffer to screen.
|
||||
<dt>name log dumptofile filename
|
||||
<dd>Prints the content of the circular log buffer into the file
|
||||
specified as filename. Note, this file is on the computer where the
|
||||
SICS server resides.
|
||||
</DL>
|
||||
</P>
|
||||
|
||||
@ -509,7 +521,7 @@ At SANS there is a Eurotherm temperature controller for the sample heater.
|
||||
with the following command. The eurotherm needs to be connected with a
|
||||
nullmodem adapter.
|
||||
<BLOCKQUOTE>
|
||||
evfactory new name euro Mac-PC Mac-port Mac-channel
|
||||
evfactory new name euro computer port channel
|
||||
</BLOCKQUOTE>
|
||||
</p>
|
||||
<p>
|
||||
@ -663,19 +675,19 @@ device. The LTC-11 behaves like a normal SICS environment control device
|
||||
plus a few additional commands. An LTC-11 can be configured into SICS with
|
||||
the following command:
|
||||
<BLOCKQUOTE>
|
||||
evfactory new name ltc11 Mac-PC Mac-port Mac-channel
|
||||
evfactory new name ltc11 computer port channel
|
||||
</BLOCKQUOTE>
|
||||
</p>
|
||||
<p>
|
||||
name is a placeholder for the name of the device within SICS. A good
|
||||
suggestion is temperature.
|
||||
ltc11 is the keyword for selecting the LTC-11 driver. Mac-PC is the name of
|
||||
the Macintosh PC to which the controller has been connected, Mac-Port is the
|
||||
port number at which the Macintosh-PC's serial port server listens.
|
||||
Mac-channel is the RS-232 channel to which the controller has been
|
||||
ltc11 is the keyword for selecting the LTC-11 driver. Computer is the name of
|
||||
the computer running David Maden's SerPortServer program, port is the
|
||||
port number at which the SerPortServer program listens.
|
||||
Channel is the RS-232 channel to which the controller has been
|
||||
connected. For example (at DMC):
|
||||
<pre>
|
||||
evfactory new temperature ltc11 lnsp18.psi.ch 4000 6
|
||||
evfactory new temperature ltc11 localhost 4000 6
|
||||
</pre>
|
||||
</p>
|
||||
<p>
|
||||
|
@ -24,19 +24,20 @@ these SICS client programs. SICS Clients and the SICServer communicate
|
||||
with each other through the TCP/IP network.
|
||||
</p>
|
||||
<p>
|
||||
Currently these SICS clients are available:
|
||||
Currently the following SICS clients are available:
|
||||
<uL>
|
||||
<li> A command line control client for sending commands to the SICS
|
||||
server and displaying its repsonses.
|
||||
<li> A status display for the powder diffractometers DMC and HRPT.
|
||||
<li> A status display for TOPSI.
|
||||
<li> A status display for SANS.
|
||||
<li> A status display for SANS and SANS2.
|
||||
<li> A status display for FOCUS.
|
||||
<li> A AMOR control and status program.
|
||||
<li> A triple axis control and status program.
|
||||
<li> A SICS variable watcher. This application graphically logs the
|
||||
change of a SICS variable over time. Useful for monitoring for
|
||||
instance temperature controllers.
|
||||
<li>A graphical client for TRICS.
|
||||
</ul>
|
||||
</p>
|
||||
<p>
|
||||
@ -71,12 +72,26 @@ following commands at the command prompt:
|
||||
<DD> for the triple axis status display and control application.
|
||||
<DT>varwatch &
|
||||
<DD> for the variable watcher.
|
||||
<dt>trics-&
|
||||
<dd>for the starting the TRICS graphical client.
|
||||
</dl>
|
||||
On a PC you may find icons for starting the different programs on the
|
||||
desktop.
|
||||
Each of these clients has usage instructions online which can be displayed
|
||||
through the help/about menu entry.
|
||||
</p>
|
||||
<p>
|
||||
Another option to start SICS clients is the Java Webstart mechanism
|
||||
which is available for most platforms. Java webstart requires both
|
||||
Java and Java webstart to be installed on the computer running the
|
||||
client. Then clients can be started directly from a WWW-page. The
|
||||
advantage is that clients are automatically updated in this system as
|
||||
soon as new version have been copied to the WWW-site. Installation
|
||||
instructions for Java webstart and links to start all SICS clients
|
||||
though this mechanism can be found at:
|
||||
<a href="http://lns00.psi.ch/sics/wstart"> the SICS webstart</a>
|
||||
page. This service is only accessible within the PSI network.
|
||||
</p>
|
||||
<h2>Connecting</h2>
|
||||
<p>
|
||||
After startup any SICS client is not connected to a SICS server and thus not
|
||||
@ -101,11 +116,11 @@ the SICS server log in as the instrument user at the instrument computer and
|
||||
invoke the appropriate command to start the server. These are:
|
||||
<dl>
|
||||
<DT>DMC
|
||||
<DD>Computer = lnsa05,User = DMC
|
||||
<DD>Computer = lnsa05, User = DMC
|
||||
<DT>TOPSI
|
||||
<DD>Computer = lnsa07,User = TOPSI
|
||||
<DD>Computer = topsi, User = TOPSI
|
||||
<DT>SANS
|
||||
<DD>Computer = lnsa10,User = SANS
|
||||
<DD>Computer = sans, User = SANS
|
||||
<DT>TRICS
|
||||
<DD>Computer = lnsa18, User = TRICS
|
||||
<DT>HRPT
|
||||
@ -115,7 +130,7 @@ invoke the appropriate command to start the server. These are:
|
||||
<DT>AMOR
|
||||
<DD>Computer = lnsa14, User = AMOR
|
||||
<DT>TASP
|
||||
<DD>Computer = lnsa12, User = TASP
|
||||
<DD>Computer = tasp, User = TASP
|
||||
<DT>POLDI
|
||||
<DD>Computer = poldi, User = POLDI
|
||||
</dl>
|
||||
|
@ -11,7 +11,27 @@
|
||||
<p>
|
||||
<b> resetserver </b> resets the server after an interrupt.</p>
|
||||
<p>
|
||||
<b> dir </b> a single word command which lists all objects available in the SICS system in its current configuration.</p>
|
||||
<b> dir </b> a command which lists objects available in the SICS
|
||||
system. Dir without any options prints a list of all objects. The
|
||||
list can be restricted with:
|
||||
<dl>
|
||||
<dt>dir var
|
||||
<dd>prints all SICS primitive variables
|
||||
<dt>dir mot
|
||||
<dd>prints a list of all motors
|
||||
<dt>dir inter driv
|
||||
<dd> prints a list of all drivable objects. This is more then motors
|
||||
and includes virtual motors such as environment devices and wavelength
|
||||
as well.
|
||||
<dt>dir inter count
|
||||
<dd>Shows everything which can be counted upon.
|
||||
<dt>dir inter env
|
||||
<dd>Shows all currently configured environment devices.
|
||||
<dt>dir match wildcard
|
||||
<dd>lists all objects which match the wildcard string given in
|
||||
wildcard.
|
||||
</dl>
|
||||
</p>
|
||||
<p>
|
||||
<b> status </b> A single word command which makes SICS print its current
|
||||
status. Possible return values can be:
|
||||
@ -45,5 +65,12 @@ above and restores SICS to the state it was in when the status was saved with
|
||||
backup. If no file argument is given the system default file gets
|
||||
read.
|
||||
</p>
|
||||
<p>
|
||||
<b>killfile</b> decrements the data number used for SICS file writing
|
||||
and thus consequently overwrites the last datafile. This is useful
|
||||
when useless data files have been created during tests. As this is
|
||||
critical command in normal user operations, this command requires
|
||||
managers privilege.
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
|
@ -72,9 +72,9 @@
|
||||
e.g. ALF1-ALF4 (carry out command given on variables between ALF1 and
|
||||
ALF4 in storage order; see section V)
|
||||
e.g. DM,ALF1-ALF4,SS,DA (a combination of the above) Variables separated
|
||||
by commas need not be typed in their order of storage in THE Program.
|
||||
by commas need not be typed in their order of storage in the program.
|
||||
|
||||
Note : that for this type of syntax (type a) the only acceptable
|
||||
Note : that for this type of syntax (type A) the only acceptable
|
||||
variable separators are ' ' (i.e. a space), ',' and '-' (' ' and ','
|
||||
are equivalent).
|
||||
|
||||
@ -87,9 +87,9 @@
|
||||
variables in storage [QK, QL] take the values 0 and 2 )
|
||||
e.g. QH=1,0,2.0,AS=3.24,CC=90 (a combination of the above)
|
||||
|
||||
In commands involving this construction type (B) THE Program echoes
|
||||
the variable names and values it has understood.
|
||||
Possible separators are ',' and ' ' ('space')
|
||||
In commands involving this construction type (B) the program echoes
|
||||
the variable names and values it has understood.
|
||||
Possible separators are ',' and ' ' ('space')
|
||||
|
||||
There is a third type of commands which requires no parameters. These
|
||||
commands are:-
|
||||
@ -159,7 +159,7 @@
|
||||
<pre>
|
||||
|
||||
CO(UNT) : Counts for a given preset TIme or MoNitor.
|
||||
This is a command of type b syntax. If the command is issued alone,
|
||||
This is a command of type B syntax. If the command is issued alone,
|
||||
the preset used will be that most recently set. However, the preset
|
||||
may also be specified on the same line as the COUNT command.
|
||||
(For use of COnt in a P.A. file, see SCan and PA).
|
||||
@ -223,11 +223,11 @@
|
||||
new position and the appropriate variable is altered in the memory.
|
||||
|
||||
A DRIVE command will fail (non destructively) if:
|
||||
l a motor or power supply is protected or fixed
|
||||
l a software or hard limit is exceeded; the soft limits may be changed
|
||||
- a motor or power supply is protected or fixed
|
||||
- a software or hard limit is exceeded; the soft limits may be changed
|
||||
if necessary using the SET command provided the value desired is
|
||||
within the allowed range.
|
||||
l there is ambiguity among the driven variables.
|
||||
- there is ambiguity among the driven variables.
|
||||
e.g. DR KI=2.662,A2=40<CR>
|
||||
sets two different targets for A2 and fails.
|
||||
|
||||
@ -332,7 +332,7 @@
|
||||
(within a certain tolerance) to the positions.
|
||||
Clear exceptions are for a power supply which has
|
||||
been turned disabled, the abort of a DRive via
|
||||
^C^C and, for instance, the incident wavevector
|
||||
Interrupt and, for instance, the incident wavevector
|
||||
after a drive of A1 or A2.
|
||||
</pre>
|
||||
<h3><a name="LOG">LOG</a></h3>
|
||||
@ -379,7 +379,7 @@
|
||||
non-zero.(This is because it no longer behaves as a flipper.)
|
||||
|
||||
Note that the ON and OFF commands are the only ones which can be used
|
||||
to change F1 and F2. Both ON and OFF are of type Asyntax.
|
||||
to change F1 and F2. Both ON and OFF are of type A syntax.
|
||||
|
||||
|
||||
</pre>
|
||||
@ -398,8 +398,9 @@
|
||||
be printed for every point in every scan until disabled.
|
||||
Typing OU with NO following variables will stop the output of ALL
|
||||
variables apart from scanned ones.
|
||||
Type A syntax. A variable that has to be output because it is scanned a
|
||||
nd has also been selected with the OUT command will only be output once.
|
||||
Type A syntax. A variable that has to be output because it is scanned
|
||||
and has also been selected with the OUT command will only be output
|
||||
once.
|
||||
|
||||
e.g. OU A3,A4<CR>
|
||||
A3 & A4 will be printed in addition to the scan variables.
|
||||
@ -546,23 +547,9 @@
|
||||
|
||||
2) data files :
|
||||
|
||||
All of this data is also output to a disk file. This file is called
|
||||
either TEMP##.SCN or SV####.SCN where # represents a digit between 0
|
||||
and 9. Both types of data files are used sequentially and thus
|
||||
periodically overwritten but obviously the TEMP##.SCN files disappear
|
||||
sooner.
|
||||
|
||||
A scan initiated from the terminal will be stored in a TEMP file
|
||||
(unless the appropriate SWITCH is on ) while scans input from .JOB files
|
||||
are always saved permanently. The TEMP files are lost ( but see SAVE).
|
||||
For more details on data files see section VI below.
|
||||
|
||||
All SV####.SCN files are copied to the mainframe computer automatically
|
||||
and transfered to the SPECTRA database for Backup and archiving. They
|
||||
can be accessed by the SPECTRA program or by the 3-axis programs (PKFIT
|
||||
or FILING).
|
||||
Programs for manipulating data files are described in another manual
|
||||
(PKFIT, FILING, LOOK, LIST, LHEAD etc.)
|
||||
All tas####.dat files are copied to the mainframe computer
|
||||
automatically.
|
||||
|
||||
3) Scan output :
|
||||
|
||||
@ -602,7 +589,7 @@
|
||||
|
||||
As with the DRIVE command, scans in Q-E space are carried out at fixed
|
||||
KI (FX=1) or fixed KF (FX=2). During a scan with Kf fixed (i.e.FX=2)
|
||||
THE Program will automatically check and adjust A5 and A6; for Ki
|
||||
the program will automatically check and adjust A5 and A6; for Ki
|
||||
fixed (FX=1) however, MAD Program will not adjust at check and adjust
|
||||
at every point A1 and A2 because these variables are not likely to
|
||||
move in a Ki-fix scan.
|
||||
@ -680,9 +667,9 @@
|
||||
described below. In response to the command <em>SW</em>, MAD
|
||||
generates output of the following form:
|
||||
|
||||
1 Powder Mode OFF
|
||||
2 Polarization mode OFF
|
||||
Give Switch Number to change or RETURN to finish >
|
||||
1 Powder Mode OFF
|
||||
2 Polarization mode OFF
|
||||
Give Switch Number to change or RETURN to finish >
|
||||
|
||||
To change a value of one switch, enter the appropriate number
|
||||
(from 1 to 2) and hit <Return>. To make no change, type
|
||||
@ -847,7 +834,7 @@ however, corresponds to a transmission minimum for Ki neutrons.
|
||||
by SET.
|
||||
|
||||
The following list gives the variable identifiers and definitions,
|
||||
where the order is as the variables are stored in THE Program.
|
||||
where the order is as the variables are stored in the program.
|
||||
|
||||
|
||||
P.A Variables : Variables marked with an asterisk are not recognized
|
||||
|
@ -345,6 +345,7 @@ H H L
|
||||
%html histogram.htm 2
|
||||
%html nextrics.htm 2
|
||||
%html peaksearch.htm 2
|
||||
%html lowmax.htm 2
|
||||
%html trscan.htm 2
|
||||
|
||||
%html psddata.htm 1
|
||||
|
@ -11,6 +11,7 @@ TRICS with a PSD requires the following special features.
|
||||
histogram memory</a>.
|
||||
<li><a href="nextrics.htm">NeXus</a> data handling for TRICS.
|
||||
<li>A <a href="peaksearch.htm">peak search</a> command.
|
||||
<li>A <a href="lowmax.htm">local maximum search</a> command.
|
||||
<li>A TRICS specific <a href="trscan.htm">count and scan</a> command.
|
||||
</ul>
|
||||
</p>
|
||||
|
@ -41,7 +41,11 @@ This means the log file has been started at August, 8, 2001 at 00:01:01.
|
||||
There is a new log file daily. Load appropriate files into the editor and
|
||||
look what really happened.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Another good ideas is to use the unix command grep on assorted log
|
||||
files. A grep for the strings ERROR or WARNING will more ofteh then
|
||||
not give an indication for the nature of the problem.
|
||||
</p>
|
||||
<p>
|
||||
The log files show you all commands given and all the responses of the system.
|
||||
Additionally there are hourly time stamps in the file which allow to narrow
|
||||
@ -63,12 +67,8 @@ The log files show you all commands given and all the responses of the system.
|
||||
<dt>EL737__BAD_BSY
|
||||
<dd>A counting operation was aborted while the beam was off. Unfortunately,
|
||||
the counter box does not respond to commands in this state and ignores the
|
||||
stop command sent to it during the abort operation. This can be resolved by
|
||||
the command:
|
||||
<pre>
|
||||
counter stop
|
||||
</pre>
|
||||
when the beam is on again.
|
||||
stop command sent to it during the abort operation. This can be
|
||||
safely ignored, SICS fixes this condition.
|
||||
</dl>
|
||||
</p>
|
||||
<h2>Starting SICS</h2>
|
||||
|
104
doc/user/userrefman
Normal file
104
doc/user/userrefman
Normal file
@ -0,0 +1,104 @@
|
||||
\documentclass[12pt,a4paper]{report}
|
||||
%%\usepackage[dvips]{graphics}
|
||||
%%\usepackage{epsf}
|
||||
\setlength{\textheight}{24cm}
|
||||
\setlength{\textwidth}{16cm}
|
||||
\setlength{\headheight}{0cm}
|
||||
\setlength{\headsep}{0cm}
|
||||
\setlength{\topmargin}{0cm}
|
||||
\setlength{\oddsidemargin}{0cm}
|
||||
\setlength{\evensidemargin}{0cm}
|
||||
\setlength{\hoffset}{0cm}
|
||||
\setlength{\marginparwidth}{0cm}
|
||||
|
||||
\begin{document}
|
||||
%html -d hr " "
|
||||
%html -s report
|
||||
\begin{center}
|
||||
\begin{huge}
|
||||
SICS Master User Manual\\
|
||||
\end{huge}
|
||||
\today\\
|
||||
Dr. Mark K\"onnecke \\
|
||||
Labor f\"ur Neutronenstreuung\\
|
||||
Paul Scherrer Institut\\
|
||||
CH--5232 Villigen--PSI\\
|
||||
Switzerland\\
|
||||
\end{center}
|
||||
\clearpage
|
||||
\clearpage
|
||||
\tableofcontents
|
||||
\clearpage
|
||||
|
||||
\chapter{Introduction}
|
||||
This is the master user manual for SICS. It gives an overview over all
|
||||
command implemented, independent of a specific instrument. This is to
|
||||
be used as the source for more instrument specific user manuals and
|
||||
gives an overview of the commands available within SICS. Please note,
|
||||
that many instruments have special commands realized as scripts in the
|
||||
SICS built in scripting language. Only the most common of such
|
||||
commands are listed here.
|
||||
|
||||
\chapter{System Commands and Concepts}
|
||||
%html sicsinvoc.htm 2
|
||||
%html basic.htm 2
|
||||
%html logging.htm 2
|
||||
%html logbook.htm 3
|
||||
%html commandlog.htm 3
|
||||
%html batch.htm 2
|
||||
%html macro.htm 3
|
||||
%html buffer.htm 3
|
||||
%html token.htm 2
|
||||
%html system.htm 2
|
||||
%html config.htm 2
|
||||
%html madsim.htm 2
|
||||
%html trouble.htm 2
|
||||
|
||||
|
||||
\chapter{Hardware Related Commands}
|
||||
%html drive.htm 1
|
||||
%html motor.htm 2
|
||||
%html chopper.htm 2
|
||||
%html counter.htm 2
|
||||
%html count.htm 2
|
||||
%html histogram.htm 2
|
||||
%html samenv.htm 2
|
||||
%html ctrl.htm 2
|
||||
%html velocity.htm 2
|
||||
%html velolambda.htm 2
|
||||
|
||||
\chapter{Common User Commands}
|
||||
%html topscan.htm 2
|
||||
%html hkl.htm 2
|
||||
%html optimise.htm 2
|
||||
%html xytable.htm 2
|
||||
%html lowmax.htm 2
|
||||
|
||||
\chapter{PSI Specific Commands}
|
||||
\section{Commands specific to the TOF--diffractometer FOCUS}
|
||||
%html focussps.htm 3
|
||||
%html fowrite.htm 3
|
||||
|
||||
\section{Reflectometer AMOR specific Commands}
|
||||
%html amor2t.htm 3
|
||||
%html amorstore.htm 3
|
||||
%html amortof.htm 3
|
||||
|
||||
\section{TRICS Specific Commands}
|
||||
%html hklscan.htm 3
|
||||
%html trscan.htm 3
|
||||
%html mesure.htm 3
|
||||
%html nextrics.htm 3
|
||||
%html peaksearch.htm 3
|
||||
|
||||
\section{Fourier Diffractometer POLDI Specific Commands}
|
||||
%html poldiscan.htm 2
|
||||
%html poldiwrite.htm 3
|
||||
|
||||
\section{Triple Axis Spectrometer Specific Commands}
|
||||
%html tasmad.html 3
|
||||
%html tasvariables.html 3
|
||||
%html tascommands.html 3
|
||||
|
||||
|
||||
\end{document}
|
Reference in New Issue
Block a user