PSI update

r1464 | ffr | 2007-02-12 12:20:21 +1100 (Mon, 12 Feb 2007) | 2 lines
This commit is contained in:
Ferdi Franceschini
2007-02-12 12:20:21 +11:00
committed by Douglas Clowes
parent 634f2023b1
commit 3168325921
157 changed files with 29053 additions and 910 deletions

View File

@ -104,7 +104,7 @@ the dictionary file:
would denote the normal counting tube at a scanning type of
experiment.
</dl>
<dt>nxscript puthm hmAlias hmName ?start? ?length?
<dt>nxscript puthm hmAlias hmName ?start? ?length? ?bank?
<dd>Writes data from the histogram memory hmName to a NeXus file using
the alias hmAlias. Nxscript automatically updates the dim0, dim1, ..., timedim
dictionary variables. Thus these can be used to define the dimensions in the
@ -116,7 +116,9 @@ subset writing, the dimensions have to be specified in the definition
string belonging to the alias. Nxscript sets a variable timedim in the
dictionary though which contains the length of a time binning if
appropriate. This is a special feauture for writing extra detectors at
SANS and AMOR.
SANS and AMOR. Optionally, together with start and length, a bank number can
be given. This is a feauture to support the rare case of having multiple banks
in one histogram memory. If not give bank defaults to 0.
<dt>nxscript puttimebinning aliasName hmName
<dd>Writes the time binning at histogram memory hmName to file using
the alias aliasName. The length of the time binning data is
@ -125,11 +127,19 @@ automatically appended to the definition string for the alias.
<dd>Writes the Tcl array arrayName to file using the aliasName. The
definiton string belonging to aliasName does not need to contain a
-dim argument as this is set by this routine. The parameter length is
the length of the array. Only rank 1 arrays are supported.
the length of the array. Only rank 1 arrays are supported. The array is
considered a float array.
<dt>nxscript putintarray aliasName arrayName length
<dd>The same as above, but the data is considered integer.
<dt>nxsript putglobal attName bla bla bla
<dd>This writes an global attribute attName. Everything after attName
is concatenated to a string which then respresents the value of the
attribute.
attribute.
<dt>nxscript putsicsdata alias dataname
<dd>Writes the sicsdata array dataname to alias.
<dt>nxscript putattribute alias name value
<dd>Add another text attribute to alias. The name of the attribute is name, the
value value.
<dt>nxscript makelink targetAlias victimAlias
<dd>This creates a symbolic link for victimAlias in the group
designated by targetAlias.

View File

@ -65,6 +65,9 @@ file.
<dt>updateintervall
<dd>The time intervall in seconds between updates. The defualt is
1200, eg. 20 minutes.
<dt>onoff
<dd>can be 1 or 0. Switches automatic updates on or off. It might be usefule for
scans to switch this off.
</dl>
</p>
</BODY>

View File

@ -21,6 +21,37 @@ The TAS requires the following initializations in its instrument file:
<dt>MakeTasUB tasub
<dd>Installs the TAS crystallographic calculation module into SICS. It will
have the name tasub (recommended).
<dt>MakeTasUB tasub a1 a2 mcv mch a3 a4 sgu sgl a5 a6 acv ach
<dd>Installs the TAS crystallographic calculation module into SICS. It will
have the name tasub (recommended). This versions allows to specifiy motor names for functions. If there is no motor for
a function it can be replaced with a placeholder in the parameter list, like dummy. This is only allowed for the
curvature motors. The motor functions:
<dl>
<dt>a1
<dd>monochormator rotation
<dt>a2
<dd>monochromator two theta
<dt>mcv
<dd>monochromator vertical curvature
<dt>mch
<dd>monochromator horizontal curvature
<dt>a3
<dd> sample rotation
<dt>a4
<dd>sample tow theta
<dt>sgu
<dd>sample tilt
<dt>sgl
<dd>second sample tilt
<dt>a5
<dd>analyzer rotation
<dt>a6
<dd>analyzer two theta
<dt>acv
<dd>analyzer vertical curvature
<dt>ach
<dd>analyzer horizontal curvature
</dl>
<dt>MakeTasScan iscan tasub
<dd>Installs the module with the TAS specific scan functions into SICS. The
TAS implements its own data format resembling the ILL TAS data format.

View File

@ -35,6 +35,11 @@ started. In order to make this work a ServerOption with the name logstartfile
must exist in the instrument configuration file. The value of this option
must be the full path name of the file to execute.
</P>
<p>
<b>Note:</b> with the command <it>config listen 1</it> you can have the output
to the command log printed into your client, too. With <it>config listen 0</it> you can switch this off again. This is useful for listening into a running
instrument.
</p>
</BODY>
</HTML>

View File

@ -45,6 +45,13 @@ named buffer within the stack of nested buffers.
<dt>Clears the queue of batch buffers
<dt>exe queue
<dd>Prints the content of the batch buffer queue.
<dt>exe fullpath filename
<dd>Prints the full path name for filename if the file can be located
somewhere in exe paths. Else an error is printed. The purpose is to use
exe file management facilties in scripts.
<dt>exe makepath filename
<dd>Prints the full path name for filename in the first direcory of batch path.
This is a tool to have scripts open files in the proper user directory.
<dt>exe run
<dd>Starts executing the batch buffers in the queue.
<dt>exe print buffername
@ -58,7 +65,12 @@ most useful for SICS clients watching the progress of the experiment.
<dt>exe append some text
<dd> Appends a line with everything after append to the upload buffer
<dt>exe save filename
<dd>saves the recently uploaded buffer under filename on the SICS server.
<dd>saves the recently uploaded buffer under filename on the SICS server. Does not overwrite
existing files.
<dt>exe forcesave filename
<dd>saves the recently uploaded buffer under filename on the SICS server. Overwrites existing file.
<dt>exe clearupload
<dd>clears any pending upload operations.
</dl>
</P>
</BODY>

View File

@ -29,6 +29,18 @@ maximum number of cycles was reached. This routine requires that the
instrument is currently placed somewhere on the peak and not miles away.
</P>
<p>
The peak optimiser supports another optimisation algorithm which is faster but
may not be as accurate. This is hill climbing:
<pre>
while errors gt precision and cycles lt maxcycles
for all variables
find the direction into which the intensity rises
step into this direction until the intensity drops
end for
end while
</pre>
</p>
<p>
The Peak Optimiser is implemented as an object with the name opti. It
understand the following commands:
<DL>
@ -43,7 +55,10 @@ and number of steps parameters should cover the whole peak. However, the
Optimiser will extend the scan is the specified range is not sufficient.
<DT>opti run
<DD>Starts the optimiser. It will then optimise the peak. This may take some
time.
time as it uses a time consuming scan based algorithm.
<DT>opti climb
<DD>Starts the optimiser in hill climbing mode. Hill climbing is faster but may
not be as accurate as a scan based optimization.
</DL>
The behaviour of the optimiser can be configured by modifying some
parameters. The synatx is easy: <b>opti parameter</b> prints the value of the
@ -72,5 +87,12 @@ status of the countmode parameter this is either a preset time or a preset
monitor.
</DL>
</p>
<p>
It is the users reponsability to provide meaningful step widths. Usually this is
dependent on the instrument resolution and thus fairly constant. Also these
optimisation algorithms will fail if the instrument is not positioned at the
flank of a peak. Probaly the best will be to do several cycles of hill
climbing first, followed by one cycle of scan optimisation for extra accuracy.
</p>
</BODY>
</HTML>

5284
doc/user/sansdocbook.xml Normal file

File diff suppressed because it is too large Load Diff

View File

@ -81,6 +81,12 @@ In order to calculate a UB matrix a list of reflections must be maintained. This
<dd>Add a new reflection to the list. Besides the indices all angles are given:
a3, the sample rotation, a4, sample two theta, sgu, upper tilt cradle, sgl, lower tilt
cradle and incoming energey ei and outgoing energy ef.
<dt>tasub addauxref qh qk ql
<dd>Adds an auxiliary reflection with indices qh, qk, ql to the list. A4 is
calculated from cell constants. A3 is either left alone or is calculated to
have the correct angular difference to a previous reflection. This is a help
for setting up the instrument or running powder mode. When a UB has been
generated from auxiliary reflections, a3, sgu and sgl angles will be incorrect.
</dl>
</p>
<h3>Calculations</h3>