Next: Some Advanced Features
Up: A Beginner's Guide to
Previous: Linking ANALYSIS CONTROL
ANALYSIS_CONTROL allows the user many options from within his
executable image. The package is controlled using the UIPACK
command line interpreter and therefore works equally well in interactive
mode (taking its commands from the terminal or from a command
file) and in batch. Some noteworthy features of this interface are:
- Commands may be truncated as long as they remain unambiguous
- Commands may be continued across several lines by typing
a minus sign ("-") as the last character in the line
- A response of the form:-
?
will provide the user with a list of all valid responses and a
response of the form:-
?<command>
will provide the user with help text for that command.
- A response of the form:-
@Filename
will cause further responses to be read from the file "Filename"
(with default file extension .UIC). Once the commands in this file have
been exhasted, further response is taken from the default input
(the terminal for interactive mode, the Batch command file in Batch).
- A response of the form:-
{Filename
will cause all further responses to be stored in a file
"Filename" (with default file type .UIC). These commands will also be
executed. The file can be closed by typing the response:-
}
Another feature of the driver is it's command line processing when the users
program is envoked. If the first argument is an existing file, it will be
executed as a .UIC file as if it had been entered at the ANA>> prompt.
For more general command line processing any module can call ANGARG (see
Appendix B), which will retrieve the string that the program was invoked with.
It is then up to the users code to parse this string, and interpret it.
A complete list of the commands available at run time is given
in Appendix A.
Among the most important commands are:
- HELP - This command allows the user to get further information
about analysis_control or about the linked modules.
- BEGIN - This command tells the program to start processing events. If
input is coming from a file, the command causes the file to be opened.
An optional qualifier /NEVENT=n can be used to specify how many events
should be processed.
Note: For online calibration users, the command BEGIN is replaced by the
command CALIBRATE. The difference between these commands is described in
Appendix A.
- CONTINUE - This command causes the program to continue processing events
in an already opened file. If no file is currently open, an error condition
is reported. The /NEVENT=n qualifier can be used here as well.
Note: This command is not accessible to online calibration users (see Appendix
A for details.)
- USE_MODULES - This command can be used to specify that only a subset of
the linked analysis modules should be run. (The default mode is to run
all modules.) In addition, the command allows the user to change the
order in which the modules are executed.
- INPUT - The user can use this command to change between available
input modules (e.g., Reading from a file and reading from the online
event buffer). It is also used to specify the input filename (the
default name is CDFINP).
- OUTPUT - The command controls whether event output to disk or tape
is enabled. (The default is output disabled.) The OUTPUT command
can also be used to change the output destination (the default
destination is CDFOUT)
- SET - This command is used to set a number of driver parameters.
For example, the user can specify a list of runs to be analysed
and (optionally) a list of events to be analysed for these runs.
He also can use the SET command to enable asynchronous input.
- SHOW - The command is used the give status information. It can be used
to give a list of modules, information about input and output, and
information about what modules are active.
- TALK_TO - The command is used to access the Talk_to entrypoint
for the specified module.
- HISTOGRAM - This command is used to book, delete, and clear the
histograms associated with a specified module or module(s). The
driver does not by default book histograms. Users wishing histograms
enabled must do so using the HISTOGRAM ON command. (Note: this is not
true of calibration users. See section 5.6 for details, also HBOOK users
must first use the HISTOGRAM OPEN command.) More
information on histograms is available in section 5.1.
- TAPE - (Vax and UNIX Only) Allows the user to mount and dismount tapes
from within the Analysis Job.
- EXIT - This command causes the program to terminate. (In batch mode,
the program will automatically terminate when the list of commands
to be executed has been exhausted.)
In ANALYSIS_CONTROL, reasonable default options have been set, so that a
user performing a simple task does not need to specify much.
For example, if a user enters his program and types the following:
BEGIN
EXIT
His job will run all linked modules in the default order. Input
will come from the first input module he has specified in
BUILD_JOB. If he has not specified an input module, the default
will be to read all of the events in the file with logical name CDFINP.
If, however, the user wants to run only the module MYANL and
wants to analyze only the first ten events in the file MYFILE.YBS,
he must type:
USE MYANL
INPUT FILE MYFILE.YBS
BEGIN/NEVENT=10
At this point, the user could EXIT the program. Instead, he can
continue reading the same file (with the eleventh event)
by typing CONTINUE.
Alternately, before doing any more event processing,
the user can change the default conditions. For example, he
could demand that the events be
written to an output file (using the
OUTPUT command), or specify that he
wishes to begin reading the same file again (using
the BEGIN command), or respecify which analysis modules he wants run
(using the USE_MODULE command).
Next: Some Advanced Features
Up: A Beginner's Guide to
Previous: Linking ANALYSIS CONTROL
sexton@fnal.gov