- Updatex nxscipt documentation

This commit is contained in:
koennecke
2006-08-16 14:13:27 +00:00
parent a5c2da6acf
commit fa58bc5165

View File

@ -104,7 +104,7 @@ the dictionary file:
would denote the normal counting tube at a scanning type of would denote the normal counting tube at a scanning type of
experiment. experiment.
</dl> </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 <dd>Writes data from the histogram memory hmName to a NeXus file using
the alias hmAlias. Nxscript automatically updates the dim0, dim1, ..., timedim the alias hmAlias. Nxscript automatically updates the dim0, dim1, ..., timedim
dictionary variables. Thus these can be used to define the dimensions in the 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 string belonging to the alias. Nxscript sets a variable timedim in the
dictionary though which contains the length of a time binning if dictionary though which contains the length of a time binning if
appropriate. This is a special feauture for writing extra detectors at 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 <dt>nxscript puttimebinning aliasName hmName
<dd>Writes the time binning at histogram memory hmName to file using <dd>Writes the time binning at histogram memory hmName to file using
the alias aliasName. The length of the time binning data is the alias aliasName. The length of the time binning data is
@ -132,7 +134,12 @@ considered a float array.
<dt>nxsript putglobal attName bla bla bla <dt>nxsript putglobal attName bla bla bla
<dd>This writes an global attribute attName. Everything after attName <dd>This writes an global attribute attName. Everything after attName
is concatenated to a string which then respresents the value of the 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 <dt>nxscript makelink targetAlias victimAlias
<dd>This creates a symbolic link for victimAlias in the group <dd>This creates a symbolic link for victimAlias in the group
designated by targetAlias. designated by targetAlias.