Syntax

[ Home ] [ Up ] [ General ] [ Short ] [ Syntax ] [ Postscript ] [ Hints ] [ Cursor ] [ DSN ] [ Arithmetik ] [ Line Modes ] [ Colours ] [ Polar ] [ 2Dim ] [ 3Dim ] [ Analyzers ] [ Library ] [ Types ] [ Text ] [ Graphic ] [ Inbed ] [ Fit ] [ Presentation ] [ Extend ] [ Concepts ] [ Dynamic ] [ Listmode ] [ Macros ] [ Goosydata ] [ Online ] [ Commands (List) ] [ Commands (Details) ] [ Install ] [ MSWindows ] [ Problems ]

SATAN Help

The object of most commands is defined by the first letter(s), the operation by the rest of the command word:
A        handling of analyzers,
C        command handling,
F        fit package,
E        handling of list-mode event parameters,
G        graphics,
I        interactive parameters,
L        input and output of list-mode data,
O        handling of protocol output,
P        display points,
S        handling of SCOM lists,
W1    analyzer windows (1-dim.),
W2    analyzer windows (2-dim.),
?        desc calculator.

Example: The command GWRITE adds a text to a graphic output (screen or plotter).

The following example demonstrates the syntax of the parameters:

==> GWRITE BLABLA / X(20) Y(30)

The first word GWRITE is the command.

BLABLA is a positional parameter. It is identified by its position as first parameter behind the command word. Additional positional parameters may be defined as second, third, ... parameter behind the command word. Some positional parameters may be required, others are optional.

X(20) and Y(30) are keyword parameters. There sequence is free. All keyword parameters are optional.

Positional parameters and keyword parameters are devided by a slash. The slash may also be repeated inside the list of keyword parameters:

==> GWRITE BLABLA / X(20) / Y(30)

This version corresponds very much to the VAX DCL conventions with the additional rule that THE POSITIONAL PARAMETERS MUST APPEAR FIRST, THE KEYWORD PARAMETERS LAST.

Most numbers appearing in the parameters of the commands may be entered as complex arithmetic expressions including parentheses and dynamic parameters. Dynamic parameters must appear as "&name.".

HISTORY

A history of previously entered commands is provided in the DOS window by WINDOWS/NT. Define the properties of the SATAN DOS window accordingly.
As an alternative for the use in WINDOWS95 and WINDOWS98, a history of the 100 previously entered commands or promptings is available by entering "<" or ">" signs in the command line and pressing the "ENTER" key. Larger steps (e.g. "<<<") are supported.

CASE-SENSITIVE INPUT, BLANKS AND BRACKETS

All input to the command decoder is translated into capital letters. This translation is suppressed for a text which is enclosed in special parentheses: {}.
==> GWRITE {Blabla}
==> AMOD XS / CYAXIS({si^ / mb})

The command decoder counts words by the appearance of blanks. A character string which contains blanks is recognized as one string, if it is included in quotes (==> 'This text'). Quotes are also useful to pass brackets through the command decoder.

AUTOMATIC TREATMENT OF FILES (on Windows)

WINDOWS allows to pull datasets from the WINDOWS explorer into the SATAN command window. SATAN creates the command and performs the appropriate action just by pressing the ENTER key, without entering a command.
The supported file qualifiers and the appropriate actions are

"... .GRF"		GREAD / DSN(...)  &  GDISP
"... .DMP"		AFETCH * / DSN(...)
"... .LMD"		LINPUT / DSN(...)
"... .SCOM"		EXEC ...

Optional parameters are added to the command:

"... .DMP / FILL"		AFETCH * / DSN(...) / FILL

SELECTING OPTIONS FROM THE SATAN INTERFACE WINDOW (on WINDOWS)

Several options of SATAN can be selected by the mouse. For this purpose, several buttons are offered in the interface window. The buttons in the left column correspond to the default options which are active when SATAN is started. The SATAN command which is equivalent to a specific option is displayed when the button is selected.

Detailed list:
"zone off"      deactivate the ZONE option of the GSET command.
"break"         interrupt SATAN commands (e.g. LINPUT, EXEC ...).
"release"       release the "fix limits" option.
"fix limits"    fix the limits of the preceding figure for the 
                 following GDISP, GOVER or GPLOT commands.
"output long"   long output in the command window.
"output short"  limits the output in the command window to the
                 absolutely necessary amount.
"page mode"     stop output in the command window after 25 lines.
"continuous"    continuous output in the command window.
"EPScopy off"   deactivate EPS softcopy for GDISP and GOVER.
"EPScopy on"    activate EPS softcopy for GDISP and GOVER.
"PS->file"      orientation of EPS file from GCOPY is normal.
"PS->printer"   orientation of EPS file from GCOPY is optimised
                 for printer.
"fit to data"   the SATAN fit package uses the data from the
                 input dataset or from the analyzer.
"fit to pres."  for logarithmic x or y axis, the logarithm
                 of the input data is taken for the fit.
"fit nonzeroes" the SATAN fit package disregards zeroes.
"fit zeroes"    the SATAN fit package consideres zeroes.
"bins"          For histograms only: The height of the
                 histogram corresponds to "counts per bin".
                 With this option the statistical uncertainty 
                 is the square-root of the height.   
"channels"      For histograms only: The height of the
                 histogram corresponds to "counts per x unit".
                 With this option the integral of the histogram
                 is equal to the number of counts in the spectrum.
"standard"      The standard cursor is used in the graphic window.
"full cursor"   A full-cross cursor is used in the graphic window.
"SCOM continue" SCOM lists are not interrupted when errors occur.
"SCOM stop"     SCOM lists stop if an error occurs. This option
                 is recommended for debugging SCOM command lists.

ANALYZER INPUT FROM SATAN INTERFACE WINDOW (on WINDOWS)

Analyzers can be selected from the interface window for display:
Usage: 1. Click on the name of the desired analyzer in the
SATAN INTERFACE window,
2. Click on the DOS SATAN window,
3. Press ENTER key

Analyzer name is added to command input string:
Usage: 1. Click on the name of the desired analyzer in the
SATAN INTERFACE window,
2. Click on the DOS SATAN window,
3. Enter first part of command input string (e.g. ALIST),
4. Press ENTER key

The special character "#" acts as a placeholder in the command line to
be replaced by a character string from the SATAN INTERFACE window
Usage: 1. Click on the name of the desired analyzer in the
SATAN INTERFACE window,
2. Click on the DOS SATAN window,
3. Enter the command (e.g. GDISP # / YLOG)
4. Press ENTER key