linse/sics
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial revision

Browse Source
This commit is contained in:
cvs
2000-02-07 10:38:55 +00:00
commit fdc6b051c9
846 changed files with 230218 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
doc/manager/var.htm Normal file
View File

@ -0,0 +1,86 @@
<html>
<head>
<title>SICS Variables</title>
</head>
<body>
<h2>SICS Variables </h2>
<p>
In SICS most parameters necessary for instrument control are kept with the SICS
object implementing the functionality. However, there are some odd bits of
information which need to be known, mostly additional information about and
from the user, which should go into data files. Such information is kept in
SICS variables, created with the command VarMake detailed below.
</p>
<p>
Another usage for variables is to control composite movements of instrument
components. For instance for changing the wavelength it is necessary to
drive at least two motors, Theta and TwoTheta. Such behaviour is implemented
with some SICS special variables. Their creation is described below.
</p>
<p>
Variables are also used in order to control the SINQ automatic file name
creation scheme for data files. At SINQ, data files are put into a special
directory. The actual name consists of a prefix, a sequential number, the
last two digits of the year and an ending. All these components are
controlled by variables.
</p>
<p>
The exact syntax for creating variables lokks like this:
<ul>
<li> <b> VarMake name type access </b> creates a simple variable name. The
variable type can be Text, Int or Float. The access parameter defines who
may may change the variable. Possible values are: Internal, Manager, User
and Spy.
<li> <b> MakeWaveLength nam mono </b> creates a wavelength variable nam.
The monochromator mono is used for adjustment.
<li> <b> MakeEnergy nam mono </b> creates a energy variable nam. The
monochromator mono is used for adjustment.
<li> <b> MakeO2T nam OM 2TM </b> creates an omega 2Theta dummy variable
with name nam for omega 2Theta scans. OM defines an omega motor, 2TM a two
theta motor.
<li><b>MakeDataNumber SicsDataNumber filename</b> This command makes a
variable SicsDataNumber available which holds the current sequential data
file number. filename is the complete path to the file were this data
number is stored. This file should never, ever be edited without good
reason, i.e. resetting the sequential number to 0 at the beginning of a
year.
</ul>
</p>
<p>
There are quite a few SICS variables which have special usages and should be
present. Some of them may need to be set by the user, all of them should be
inspectable by the user. Many of these variables are used when writing
NeXus data files. These special variables are:
<DL>
<DT> sample
<DD> The sample name. To be set by the user.
<DT> title.
<DD> The experiment title.
<DT> User
<DD> The name of the user to be specified in a data file.
<DT> Instrument.
<DD> The name of the instrument.
<DT> SicsDataPath
<DD>The full path name of the instruments data directory. Should have a / at
the end.
<DT> SicsDataPrefix
<DD> The prefix to use for data file names.
<DT> SicsDataPostFix
<DD> The ending to use for the data file name. Including the '.'.
<DT> Adress
<DD> The users adress.
<DT> phone
<DD> The users phone number.
<DT> email
<DD> The users e-mail adress.
<DT> fax
<DD> The users fax number.
</DL>
</p>
<p>
Some of the variables stated above should never be changed by a user. This
can be achieved by the variable lock command described in the user
documentation.
</p>
</body>
</html>