Analysis_Control Commands Reference

The following commands are supported in ANALYSIS_CONTROL, Click on any command for additional information.

Begin Analysis, Begin Processing Events with current Configuration.
Call, Manually Call a Module Entrypoint.
Calibrate, Begin Processing Events for Calibration.
Clear specified statistics
Continue Analysis with current configuration.
Comment, Display Comment Text
Delete Data Banks from /BCS/ or A_C Information.
Exit from Program
Filter, Specify whether a Filter is active.
Histogram, Control Histogram manipulations.
Help, Displays general Help Information.
Input, Specify the Source of the Input Data.
Output, Specify the Destination of Output Data.
Quit, Same as EXIT.
Set Analysis Parameters.
Show Status of Analysis.
Spawn a DCL or SHELL Command.
Stop Processing (returns to this Menu).
Talk_to, Modify Module Parameters etc. via TALK_TO Entrypoint.
Tape, Perform Manipulations to Tape Drives.
Use_modules, Define Modules to be Run in Analysis Path.

Begin Analysis

Action: Begin processing events.

The command causes the program to begin reading events using the currently active input module. If input is coming from the standard READ_FILE module, this means that the currently defined input file will be opened and read. If no qualifiers have been been specified and the SET RUN command has not been issued, all events on the file will be processed.

Qualifiers:

/CLEAR or /[NO]CLEAR

Using the NOCLEAR qualifier will instruct A_C to call begin run entry points for all enabled modules only once in the very beginning of the JOB. This is intended for people who want to keep statistics over many runs/files.

Note that /CLEAR is the default so the /NOCLEAR option must be used every time a BEGIN or CONTINUE command is entered even within the same JOB.

/NEVENT = Integer

Number of events to be processed ( Default: All events) The correct syntax for the command is:

BEGIN_ANALYSIS/NEVENT=<number of events>

/GOOD_EVENTS = Integer

This qualifier is meant to be used in conjunction with event filters. It allows the user to specify that events should be processed until the given number have successfully passed all active filters. If no filters are active, this command is identical to the /NEVENT qualifier. The correct syntax for the command is:

BEGIN_ANALYSIS/GOOD_EVENTS=<number of events>

/FIRST_EVENT = Integer

This qualifier allows the user to specify the event number of the first event to be processed. Analysis_control will pass this event and all subsequent events on the file to the analysis modules. The correct syntax of the command is:

BEGIN_ANALYSIS/FIRST_EVENT=<event number>

/SKIP_EVENT = Integer

This qualifier allows the user to specify that a number of event records be skipped before any events are analyzed. The correct syntax of the command is:

BEGIN_ANALYSIS/SKIP_EVENTS=<number of events to skip>

/REPORT_EVENTS = Integer

If this qualifier is used a report is issued every n events. The report is a message about the current run and event number being analyzed and optionally (if /PROCESSED is also specified) the number of events processed thus far.

/PROCESSED

See /REPORT_EVENTS.

/RUN_REPORT

If this qualifier is used a report is issued whenever a new run number is about to be processed. The report is a message about the current run and event number being analyzed and optionally (if /PROCESSED is also specified) the number of events processed thus far.

Call

Action: Allows the user to call the begin run, end run or Talk_to entrypoint for a specified module. The syntax of the command is:

CALL <Module Name> <Entry_point>

The command RUN is an alias for CALL.

Calibrate

Action: This command replaces the BEGIN and CONTINUE commands for calibration users. It tells the program to begin processing events. The syntax of the command is:

CALIBRATE[/qualifiers] <Range of run numbers>

where the range of runs tells which calibration runs should be analyzed. This range can either be entered as a single number or as two numbers separated by a colon. For example,

CALIBRATE 10

would process only run number 10 and

CALIBRATE 1:10

would process all runs from 1 to 10.

Note: all qualifiers must be attached to the CALIBRATE verb. I.e.,the expression CALIBRATE 1:10/nev=2 is NOT legal!

Qualifiers:

/NEVENT = Integer: Number of events to be processed. Default: All events
/TMP or /[NO]TMP: Specifies whether temporary calibration database files should be written at the end of data processing (in the modules' end run entrypoints)
/CHECKREF or /[NO]CHECKREF: Specifies whether the calibration task should check a reference calibration file and create a bad channel for those channels that have changed relative to the reference Default: CHECKREF
/VIEW or /[NO]VIEW: Specifies whether the results of the calibration should be "viewed" (i.e. that results should be printed to or plotted on the terminal). Default: NOVIEW
/BANKLIST: Specify a list of which input banks should be analyzed. The four character bank names should be concatenated without spaces. Default: Analyze default required banklist specified in the module's declaration routine. /CLEAR or /[NO]CLEAR Specifies whether histograms should be cleared before the specified range of runs is analyzed Default: Clear all histograms

Clear

Action: Clear given counter or timer. The correct syntax for the command is:

CLEAR <item to be cleared>

It is possible to clear the following:

TIMING: Clears the CPU timing statistics
MODULE_COUNTER: Clears module counter statistics
FILTER_STATS: Clears filter statistics

Continue Analysis

Action: This command is only meaningful when the user has partially processed an input file (for example, the user had specified BEGIN/NEVENT=5 on a file with more than 5 events). CONTINUE_ANALYSIS will continue processing events in the file starting with the next event. If no file is open, it will signal an error.

Qualifiers:

/CLEAR or /[NO]CLEAR

Note: that /CLEAR is the default so the /NOCLEAR option must be used every time a BEGIN or CONTINUE command is entered even within the same JOB.

/NEVENT = Integer

Number of events to be processed ( Default: All events) The correct syntax for the command is:

CONTINUE_ANALYSIS/NEVENT=<number of events>

/GOOD_EVENTS = Integer

CONTINUE_ANALYSIS/GOOD_EVENTS=<number of events>

/FIRST_EVENT = Integer

CONTINUE_ANALYSIS/FIRST_EVENT=<event number>

/SKIP_EVENT = Integer

This qualifier allows the user to specify that a number of event records be skipped before any events are analyzed. The correct syntax of the command is:

CONTINUE_ANALYSIS/SKIP_EVENTS=<number of events to skip>

/REPORT_EVENTS = Integer

/PROCESSED

See /REPORT_EVENTS.

Comment

Action: Displays the specified text string on the current text output device. The syntax of the command is:

COMMENT "Comment Text"

Where the comment text should be enclosed in quotes.

Delete

Action: Deletes the appropriate data banks from /BCS/ or the specified ANALYSIS_CONTROL control information. The syntax of the command is:

DELETE <Item>

Where the possible items to be deleted are:

RUN_LIST: List of runs to be analyzed
EVENT_LIST: List of events to be analyzed
NOTHING: Return to menu without deleting anything

Exit

Action: Exit from the program

/DISABLE: This Qualifier disables the EXIT Command until a subsequent EXIT/ENABLE Command is received. It is designed to prevent inadvertent exiting from a program in interactive mode.
/ENABLE: This Qualifier re-enables the EXIT Command following a prior EXIT/DISABLE Command. A subsequent EXIT Command will be valid and cause the Program to exit.

Filter

Action: Allows the user to specify whether a given filter is active. The correct syntax for this command is:

FILTER[/Qualifiers] <Module name> <Action>

where action is either ON or OFF. The command ON tells ANALYSIS_CONTROL to terminate analysis for a given event after the specified filter module has been run IF the module has set the global accept flag to false. If the module has set this flag to true, then analysis of that event will continue. If the ON command is given, AND a VETO decision has been specified with a previous FILTER/SPECIFY command, Analysis_Control will terminate event processing after the given module unless that module has set the global accept flag to .FALSE.. Note: Analysis_control will signal an error if the specified module is not present in the currently defined or specified path. Also if the path is later redefined with a USE command the previous filter commands for that path are ignored.

Qualifiers:

/PATH = Integer

This qualifier allows the user to specify that the filter be activated in a path other than the default path 1. For example, the command

FILTER/PATH=2 FRED ON

tells Analysis_Control to stop the path 2 analysis unless the filter FRED says this is a "good" event.

/PARAMETER_SET

This qualifier allows the user to activate filters using alternate parameter sets. For example, the command

FILTER FRED/PARAMETER_SET=2 ON

will stop the event analysis after the module FRED is run with parameter set 2 unless this module says the event is "good." Note: Analysis_control will signal an error if the specified module/parameter set combination is not a member of the current path.

/SPECIFY

This qualifier is used to modify what type of filter the specified filter is. The qualifier can be placed after the verb FILTER, or after the module name. A filter may either be a select or veto type filter. If it is a select filter an event will pass if the global accept flag is .TRUE.. If it is a veto filter an event will pass if the global accept bit is .FALSE.. If this qualifier is used, a parameter (ON or OFF) cannot be used. In this case the third parameter on the command line should be either VETO or SELECT. Thus the syntax used with this qualifier is:

FILTER/SPECIFY FRED VETO    -or-

FILTER/SPECIFY FRED SELECT

Default: By default a given filter is assumed to be a select filter.

/STATISTICS or /[NO]STATISTICS

This qualifier allows the user to enable or disable the tallying of events statistics for the specified filter module. The qualifier can be placed after the verb FILTER, or after the module name. Default: By default statistics tallying is enabled.

Histogram

Action: Control Histogram manipulations The correct syntax for this command is:

: HISTOGRAM[/Qualifier] <Action>[/Qualifier]

where the possible actions are:

CLOSE: Close the current histogram file
DELETE: Delete the currently booked histograms
DIRECTORY: Give a directory of the booked histograms
FETCH: Retrieve/Restore YHIST folder and volume*
OFF: Deactivate (don't delete) booked histograms
ON: Make directories and book histograms
OPEN_PARAMETERS: Setup and open HBOOK4 file
PRINT: Print histograms currently in memory
READ: Retrieve histograms from disk file
STORE: Output YHIST volume with all histograms*
WRITE: Write histograms to disk file
ZERO: Zero the contents of the histograms

* Not implemented for HBOOK4

For HBOOK4 users that wish to limit the number of entries that go into any one file the following sequence of commands is recommended:

ANA>> HISTOGRAM OPEN/FILE=file1.hbook    ! open file one
ANA>> HISTOGRAM ON                       ! make directories & book histograms
ANA>> BEGIN/N=100                        ! fill 100 events worth
ANA>> HISTOGRAM WRITE                    ! write memory to file
ANA>> HISTOGRAM CLOSE                    ! close file1
ANA>> HISTOGRAM DELETE                   ! delete histograms in memory
ANA>> HISTOGRAM OPEN/FILE=file2.hbook    ! open file two
ANA>> HISTOGRAM ON                       ! make directories & book histograms
ANA>> CONTINUE/N=100                     ! fill 100 events worth
ANA>> HISTOGRAM WRITE                    ! write memory to file
ANA>> HISTOGRAM CLOSE                    ! close file2
ANA>> HISTOGRAM DELETE                   ! delete histograms in memory 
...

Qualifiers:

/MODULE = <Module Name>

When this qualifier is used, the action specified only effects the histograms for the specified module. Default: If the qualifier is not used, the command acts on the histograms for all linked modules. This qualifier must be placed on the verb. For example:

HISTOGRAM/MODULE=<Module Name> ON

/CREATE_CHAPTER = <ON/OFF>

This qualifier controls the assignment of histograms within a module to a YHIST chapter, whose number is the module number, and whose name is the module name. Within that chapter, histograms are assigned to a page with the same number as the module and chapter; the page, how- ever, is not named.

This feature allows the association of histograms and modules to be maintained in written volumes, utilizing the YHIST directory (n-ary tree) structure. Default: If the qualifier is not specified as ON, no assignment of histograms to chapters is performed.

Histogram Delete

Deletes all or some of the currently booked histograms for the specified module(s) in memory. If you have already written the contents of memory to a file with a HISTOGRAM WRITE command then this command will not delete that data. Note also that you will not be able to rebook with a HISTOGRAM ON command until all id's for a module are deleted. This is because they are booked on a module by module basis. The syntax for the command is:

HISTOGRAM[/MODULE=<Module Name>] DELETE[/ID=<hbook ID range>] -
                                       [/MODULE=<Module Name>]

The ID qualifier can take either a single ID integer parameter or a range specified with low_number:hi_number or (low_number,hi_number). If an ID qualifier is not used all histograms for the particular module will be deleted. If a module qualifier is not used the command will delete all histograms for all modules.

Histogram Directory

Display a list of all currently booked histograms for the specified module(s). The syntax for the command is:

HISTOGRAM[/MODULE=<Module Name>] DIRECTORY[/MEMORY] -
                                          [/Stream=<stream id>][/MODULE=<Module Name>]

Histogram Fetch

Displays available folders and volumes in current YHIST directory file, prompting for folder, then volume to be used. The specified volume is then placed in the histogram array, overwriting existing contents. Note: this is the complement of the STORE command.

Histogram Off

This command sets a flag indicating that the specified modules' histograms should be deactivated. The syntax for the command is:

HISTOGRAM[/MODULE=<Module Name>] OFF

Histogram On

This command is used to book histograms or to reactive histograms that have been deactivated using the HISTOGRAM OFF command. Also if all of the histograms for a module have been deleted then this command can be used to rebook them. The syntax for the command is:

HISTOGRAM[/MODULE=<Module Name>] ON[/STREAM=<stream #>]

Histogram Open

This command is used to setup and open HBOOK4 files. The syntax for the command is:

HISTOGRAM OPEN_PARAMETERS[/STREAM=<stream #>]
                         [/READ_ONLY][/UPDATE]
                         [/TOP_DIRECTORY=<name>]
                         [/FILE_NAME=<file_name>]
                         [/MAX_NREC=<max#>]
                         [/RECLENGTH=<reclen>]

If no stream is specified stream one is opened. If READ_ONLY is specified the file will be opened for read access. If UPDATE is specified the file will be opened in update mode. If both READ_ONLY and UPDATE are specified the last one on the command line will be used. If neither is specified a new file will be created (Caution on a UNIX machine if the file already exists it must be opened in either READ_ONLY or UPDATE mode). If a TOP_DIRECTORY is not specified the value defaults to 'ACHBK4'. If a FILE_NAME is not specified the value defaults to 'AC_HBK4.DAT'. If MAX_NREC is specified it will be used instead of the default value of 4000. If RECLENGTH is specified (in longwords) it will be used instead of the default value of 1024 longwords.

Note: in order to allow user modules access to this information (needed for calls to HBOOKN for example) a routine called ANGTH4 has been written to retrieve this information. The calling sequence is:

STATUS = ANGTH4(STREAM,TOPDIR,FILNAM,OPNOPT)

Where STREAM is the stream id for which the information should be returned. TOPDIR is the Top directory string, FILNAM is the Filename string and OPNOPT is a character*2 variable indicating the open option as described as CHOPT in the documentation for HROPEN.

Histogram Read

This command can be used to read a file of histograms from disk. It is supported in the HBOOK versions of the package, YHIST users should use FETCH. The syntax of the command is:

HISTOGRAM READ[/ID=<hbook ID range>] -
              [/OFFET=<offset#>][/CYCLE=<cycle#>] -
              /MODULE=<Module Name> <Filename>

The module must be specified so that A_C knows where in memory to read the files into and which directory it should read from. OFFSET and CYCLE have their usual HBOOK4 meanings see the documentation on HRIN. The ID qualifier can take either a single ID integer parameter or a range specified with low_number:hi_number or (low_number,hi_number). If an ID qualifier is not used all histograms from the selected file directory will be read into the corresponding memory directory.

Histogram Print

This command can be used to display a line printer output of histograms, or an ntuple summary. The syntax of the command is:

HISTOGRAM PRINT[/ID=<hbook ID range>][/MODULE=<Module Name>]

The ID qualifier can take either a single ID integer parameter or a range specified with low_number:hi_number or (low_number,hi_number). If an ID qualifier is not used all histograms for the particular module will be printed. If a module qualifier is not used the command will print all histograms for all modules.

Histogram Store

Stores all histograms on as a YHIST volume. Presently, the /MODULE command is not supported for the STORE option. Required Parameters:

: Volume: YHIST volume that is to be written
: Folder: YHIST folder the histograms should belong to

Users should see CDF-181 for an explanation of volumes and folders.

Histogram Write

This command can be used to write a file of histograms to disk. It is supported in both the HBOOK and YHIST versions of the package. The syntax of the command for non-HBOOK4 users is:

HISTOGRAM WRITE <Filename>

Note: The YHIST version of this command ignores the Volume and folder organisational structure. The syntax of the command for HBOOK4 users is:

HISTOGRAM WRITE[/ID=<hbook ID range>][/STREAM=<stream #>]
               [/MODULE=<Module Name>]

This command will write out the requested ID's or the ID's belonging to the requested module to the specified stream. If no stream is specified they will be written to stream one. The ID qualifier can take either a single ID integer parameter or a range specified with low_number:hi_number or (low_number,hi_number). If a module qualifier is not used the command will write all histograms for all modules.

Histogram Zero

Zero the contents all histograms for the specified module(s). The syntax for the command is:

HISTOGRAM/MODULE=<Module Name> ZERO[/ID=<hbook ID range>] -
                                   [/MODULE=<Module Name>]

The ID qualifier can take either a single ID integer parameter or a range specified with low_number:hi_number or (low_number,hi_number). If an ID qualifier is not used all histograms for the particular module will be cleared. If a module qualifier is not used the command will clear all histograms for all modules.

Help

Help on any ANALYSIS_CONTROL command may be obtained online at the ANA>> prompt. The syntax of the command is:

HELP <Command>

In addition, help for individual analysis modules can be obtained by typing:

HELP/MODULE <Module name>

Input

Action: Change the source or characteristics of input data The correct syntax for the command is:

INPUT <item to be modified>

It is possible to modify the following:

MODULE: The input module being used to fill the data buffer
YBOS_MODE: Specify YBOS input mode
FILE: For the standard input module, the file from which events are being read
NODE: Specify the DECnet node from which to get data. This command is only available if the input module works from a DECnet link e.g., NETWORK_READ.
DROP: Specify a list of banks to be dropped from the primary YBOS array after the event is read in.
RENAME: Specify a list of banks from the primary YBOS array that should be renamed after the event is read in.
COPY: Specify a list of banks from the primary YBOS array that should be copied after the event is read in.
OVERWRITE$: Direct A_C to overwrite with a $ bank on the input file, a $ bank with the same name and number as a $ bank in the current YBOS array.
SELECT: Sets up filter based input selection requirements.
RESET: Resets the above 4 commands back to their defaults.

Input Module

Specifies the input module to be used to fill the data buffer. For example,

INPUT MODULE READ_FILE

tells the program that events should be gotten using the standard input module READ_FILE. Note: A list of currently linked input modules can be gotten using the SHOW INPUT command.

Input Ybos_Mode

This command allows the user to specify what YBOS input mode should be used. Input mode must be selected before the input file is opened, therefor it must be specified before the INPUT FILE command. The syntax of the command is:

INPUT YBOS_MODE FAST -or-

INPUT YBOS_MODE NORMAL

Normal is the default. If fast mode is specified Analysis_Control will use the optimized version of the YBOS input routines. The optimized version will typically result in a 30% reduction in processing time. These routines can not however be used for network file access; for this application NORMAL ybos mode should be used.

Note: The SHOW INPUT command has been modified to show the input mode selected.

Input File

Specify the input file to be read (This command is only used when input comes from the READ_FILE input module.) For example,

INPUT FILE[/Qualifiers] MYFILE.DAT

tells the program to take input from the file MYFILE.DAT. This command may also be used to set up a queue of input files to be used in the order they are typed in.

INPUT FILE[/Qualifiers] "<file1>, <file2>, <file3>..."

This command is only available if the input module works from a file, e.g., READ_FILE. These files will be processed as if they had been concatenated together.

Wildcards may be used in specifying input files for either the queue or a single file specification. A "*" or a "%" can be used anywhere where it is also valid in DCL, including tape drives. So if you don't know the names of files on a certain tape you can specify the file using:

INPUT FILE DRIVEn:*

and A_C will sequentially use all files on the tape. On UNIX there is one caution: if you specify a wildcarded file name while the tape is physically positioned in the middle of the tape it will NOT be rewound to pick up any files fitting the wildcard in the beginning of the tape.

UNIX uses ANSI standard labeled tapes. Therefor there is a maximum of 17 characters allowed for tape file names on UNIX. The VAX uses an extension to the standard so that there is no limit on the length of the tape file name. Another UNIX restriction is that UNIX file names including explicit path names MUST be in lower case. If you have a file named in upper or mixed case UIPACK will not recognise it, so you must rename it.

/ADD

If your list of input files is longer than 511 characters UIPACK will not let you specify them all in one command. This qualifier is therefor used to extend an aready existing list of input files. For example the commands:

INPUT FILE "<file1>, <file2>, <file3>"

INPUT FILE/ADD "<file4>, <file5>, <file6>"

means files 1 through 6 will be processed. If the /ADD qualifier had not been used on the second line only files 4 through 6 would be processed.

/FATMEN

This qualifier must be used if the file specified is a FATMEN catalogue entry. At the time the command is issued A_C will contact the catalogue/staging system so that the file will exist on disk after the command is complete.

/ALL

This qualifier is used in conjuction with wildcards on UNIX systems. It instructs A_C to consider files that begin with "." when looking for wildcard matches. If the /ALL qualifier is not specified the "." files are ingored (in analogy to the ls command).

Input Drop

Action: Specifies bank or list of banks to be dropped from the primary YBOS array before any event analysis is performed. The syntax of the command is:

INPUT DROP XXXX

where XXXX is either a single bankname or a concatenated list of banknames. A second call to the INPUT DROP command will extend the banklist without deleting the current list of banks to be dropped. These banks can be explicitly dropped using the command

INPUT/CANCEL DROP

A list of the banks to be dropped is shown as part of the output of the SHOW INPUT command.

Input Rename

Action: Specifies that a bank in the primary YBOS array should be renamed before any event analysis is performed. The syntax of the command is:

INPUT RENAME XXXX YYYY

where XXXX is the name of the bank on the input file and YYYY is the the bankname after renaming. A second call to the INPUT RENAME command will extend the banklist without deleting the current list of banks to be renamed. These banks can be explicitly dropped using the command

INPUT/CANCEL RENAME

A list of the banks to be renamed is shown as part of the output of the SHOW INPUT command.

Input Copy

Action: Specifies that a bank in the primary YBOS array should be copied before any event analysis is performed. The syntax of the command is:

INPUT COPY XXXX YYYY

where XXXX is the name of the bank on the input file and YYYY is the the bankname it is copied to. A second call to the INPUT COPY command will extend the banklist without deleting the current list of banks to be copied. These banks can be explicitly dropped using the command

INPUT/CANCEL COPY

A list of the banks to be copied is shown as part of the output of the SHOW INPUT command.

Input Overwrite$

Changes the default $bank handling. If this command is used $banks from the input file will overwrite $bank in the current YBOS array if both have the same name and number.

Input Select

This command is used to allow the user to specify what events will be passed to processing after being read in. This feature is intended to facilitate secondary analysis when the primary analysis was done using filters. The syntax of the command is:

INPUT SELECT[/Qualifiers] EVENTS[/Qualifiers]/FILTER=-
      (<filter_name>[/Qualifiers],<filter_name2>...)

Note that the FILTER qualifier is a required qualifier for setting up this feature. If this feature is used the SHOW INPUT command will give a description of all defined requirements along with a report of how many events have been read in verse how many events have been passed to processing. Input selection is determined by taking the logical OR of the currently defined requirements. A requirement is a set of filters and their descriptions which are logically ANDed together to make up the requirement decision. A decision about an individual filter is made by comparing the specified filter and its associated description to the corresponding filter information in the appropriate TAGB bank in each event. (If an A_C filter was used in creating the input file A_C will have made a TAGB bank for it.) Most filters are simple; a name and parameter set number completely specifies them (ie. the author of the filter has used ANPTRG). Others, most notably TRGSEL, require a TAGB mask to be specified (ie. the author of the filter has used ANCRTA).

Care must be taken in specifying the filter names and parameter sets since there is no way for A_C to check that the name you typed in was a valid filter used in making the input file. This means that the person using this feature must know how the input file was produced. One way is to know the standard production filter names and parameter sets, another is to dump the TAGB banks from an event on the file since the names and parameter sets are invariant within a file (the parameter set number is the first integer after the filter name). Once input filtering has been enabled by specifying one or more requirements the presence of a nonexistent filter will cause that requirement to fail for every event. If this is the only requirement specified, none of the input file events will be processed.

Below is an example of some input select commands and what the show display for it looks like:

ANA>> INPUT SELECT EVENTS/FILTER=(GWC_FILT,-
                                  TOP_EXPRESS,-
                                  CALORIMETRY)

ANA>> INPUT SELECT/ADD EVENTS/FILTER=-
                       (METFLT/PARAMETER_SET=4)

ANA>> INPUT SELECT/REQUIREMENT=2 EVENTS/FILTER=(ZENFLT,-
      TRGSEL/PARAMETER_SET=3/BITS="6 95 107:109 118:132")

ANA>> INPUT SELECT/REQUIREMENT=4 EVENTS/FILTER=(HATFLT)

ANA>> SHOW INPUT

Possible Input Modules are:

      Module Name:      Description:
      READ_FILE         Read events from a tape or disk file

Currently Active Input Module is: READ_FILE

List of files queued for input are:

 ==>  1. CE1954.ZEN00

Current input file is CE1954.ZEN00

Input is being filtered by:

      Requirement  1
               GWC_FILT Parameter Set:  1
         .AND. TOP_EXPRESS Parameter Set:  1
         .AND. CALORIMETRY Parameter Set:  1
         .AND. METFLT Parameter Set:  4
      Requirement  2
               ZENFLT Parameter Set:  1
         .AND. TRGSEL Parameter Set:  3
         with a Non-exclusive check of the following mask:
         WORD NUMBER     MASK (HEX)      MASK (DECIMAL)
             1                40                  64
             2                 0                   0
             3          80000000         -2147483648
             4          FFC03800            -4179968
             5                1F                  31
      Requirement  4
               HATFLT Parameter Set:  1

Out of     0 events read in     0 have satisfied the logical .OR. of
the above Input Requirements.

Note that the decimal mask is easier to check against ACDUMP output whereas the hex mask makes it easier to check set bits. Legal qualifiers for this command are:

/FILTER=([/Qualifiers],[/Qualifiers],...)

Defines the filter names and associated descriptions that make up the current requirement. For simple requirements all that is needed is a filter name and parameter set (if not equal to one). Otherwise one or more of the following optional qualifiers must be used:

: /BITS="n1 n2 n3:n4 n5 ..." will set up a mask to be compared to the mask in the TAGB bank. Note that n3:n4 specifies an inclusive range of bits to be checked. If this qualifier is not used then only the global accept bit is checked.
: /EXCLUSIVE specifies that an exclusive check for the mask set up by the BITS qualifier should be made, i.e. all bits specified must also be set in the events appropriate TAGB mask. The default is a non-exclusive check which means that if any of the bits specified are set in the events appropriate TAGB mask the filter will pass.

The FILTER qualifier must be the last qualifier used on the EVENT verb.

/ADD

Allows the current specification to be added onto the requirement defined in the previous INPUT SELECT EVENT command. This is useful when the desired requirement specification is so long that it won't fit into the allowed UIPACK command line length (which is 512 characters). This qualifier may be attached to either the SELECT or EVENT verb.

/REQUIREMENT=

Allows the current specification to be assigned to the given requirement number. If this qualifier is not used the current specification will be assigned a number one greater than the largest assigned so far. If the given requirement number has already been used the current specification will be added onto the already existing one. This qualifier may be attached to either the SELECT or EVENT verb.

Input Reset

These commands are the compliments of the SELECT commands and they allow Analysis_Control to be reset to its default setup. These defaults are recovered using the command

INPUT RESET <Option>

where the available options are:

DROP

Instructs A_C to not remove any banks from the input events.

RENAME

Instructs A_C to not rename any banks in the input events.

OVERWRITE$

Sets A_C back to its default where $banks in the current YBOS array do not get overwritten by the corresponding $banks on the input file.

EVENTS

Drops or resets one or more input requirements. The syntax is:

INPUT RESET[/Qualifier] EVENTS[/Qualifier]

The only valid qualifier is /REQUIREMENT=<Requirement_number>. This qualifier may be attached to either the RESET or EVENT verb. If no qualifier is used all requirements are dropped.

Output

Action: Control whether data is output and where that output goes The correct syntax is:

OUTPUT[/Qualifier] <Action>

where the possible actions are:

CLOSE: Close the current output file
OFF: Turn event output off
ON: Turn event output on
FILE_NAME: Specify output filename
FORMAT: Specify output format
MODULE: Specify active output module
YBOS_MODE: Specify YBOS output mode
SELECT: Specify events/banks to output
RESET: Return to defaults
MV_AT_CLOSE: Specify how to rename a file

Qualifiers:

/STREAM=<n>: Specifies that the following output command is for stream n. The program allows multiple output streams to be opened simultaneously. These streams are identified by number (1 through n). If output is enabled, and a stream is not specified the command refers to Stream=1 by default.

Output Close

This command closes the current output file. It will also turn output off, so if more events are processed and you wish to output them you must issue another OUTPUT FILE or OUTPUT ON command. If OUTPUT ON is used this file will have the same name as the previous file on the VAX however on UNIX since there are no file version numbers A_C will change the name to CDFOUT.

Output Off

The command disables the outputting of events for the specified stream. It does not close the output file.

Output On

Enables the outputting of events. Unless the command OUTPUT FILE has been given, the default file specification used for the output is:

For output stream 1, the default file is CDFOUT
For output stream n (n > 1), the default file is CDOUn, where n is written with format I 2.2

Output File_Name

Specifies the filename for output. For example, the command:

OUTPUT FILE DATA_OUT.YBS

would cause the data for the default output stream (#1) to be written to the file DATA_OUT.YBS Remember that on UNIX systems you must use quotes to preserve case, which is true of both input and output file names. This command also turns the specified output stream ON.

Automatic_File_Generation

Normally the Output File should be specified directly using the normal File syntax. However, it is possible to specify a file where several fields may exist within the filename. ANALYSIS_CONTROL will automatically replace these Template Fields by their actual values when the File is opened. Examples of these Template Fields are <RUN_NUMBER>, which will be replaced by the actual Run Number, <DEVICE>, which will be replaced by a real Device etc. This is usefull when the output stream needs to be split into different files either based on a size limit or an input_EOF. Syntax:

Many of the qualifiers for the OUTPUT FILE command are used to specify field values. For example the following commands will setup automatic file generation:

OUTPUT FILE/Template=RAW_Data

OUTPUT FILE/Device=Data_Disk/Directory=Online_Data

and sets up a filename of the form:

<Device><Directory>R<Run_Number><Sequence>.RAW

which gets translated to:

DATA_DISK:[ONLINE_DATA]R12345AA.RAW

Valid template names are:

 Raw_Data, Unix_Raw, Unix_Clg, Unix_Exp, SCC1_Dat, SCC2_Dat
 SCC3_Dat, SCC_Cons, Stream2,  KLum_Dat, LLum_Dat, MLum_Dat
 NLum_Dat, DST,      One_pass, STK_splt, Concat1B, Copy

Most are used in the CDF online system however the last 5 are offline templates. The following details some of the still usefull ones:

STK_splt: STK_splt will split up the output stream into files sizes that are appropriate for the STK silo. You need to specify /type and optionally /Device and /Directory (if they are not specified the default directory is used).
Copy: Copy will cause events from a given input file to go to a corresponding output file modulo any user filters. It requires the /type to be specified and optionally /Device and /Directory. It is usefull if you have wildcarded the input file. In this case it does what you would expect from a "OUT FILE *" command.
Concat1B: Concat1B supports the 1B concatination scheme which means that it uses the input file name and if the "OUTPUT MV_AT_CLOSE/concat1b" command is used the sequence field of the last input file used. For example if the files A56789AA.QJTB_5F, A56789AB.QJTB_5F, and A56789AC.QJTB_5F had enough data in them to satify the user specified /Max_Size then the final output file name would be A56789AAAC.? where ? is filled in but the user specified /type qualifier. /Device and /Directory are optional for this template, if they are not specified the default directory is used.

Qualifiers:

The following Qualifiers may be attached to either the FILE_NAME Command or to the file name itself.

/CAPACITY=<MBytes>: Specifies a maximum file size for the File. By default the file capacity is set to 0 (zero), corresponding to an unlimited size, but this may be overridden by this Qualifier. The size should be specified in MBytes.
/DEVICE=<device>: Specifies a setting for the <DEVICE> Field of a Automatically Generated Filename. Note that the may either be a physical device or a Logical Name. If the specified field does not terminate in a ":", then it will be inserted automatically.
/DIRECTORY=<directory>: Specifies a setting for the <DIRECTORY> Field of a Automatically Generated Filename. Note that the should normally be enclosed in "[...]" but that these will be inserted automatically if necessary.
/EVENT_LIMIT=<n>: Specifies an event limit for the File. The File will be declared to be full when this limit is exceeded and will be closed automatically. /RECORD_LIMIT is a synonym for /EVENT_LIMIT. If both an event limit and a maximum capacity have been specified (i.e. both /EVENT_LIMIT and /CAPACITY have been specified), the file will be declared to be full as soon as one of these limits has been reached. The default Event Limit is 0 (zero), which corresponds to no limit.
/FULL_ACTION=<action>: Specifies an action to be taken when a File is declared to be full.
/MAX_SIZE=<MBytes>: This is a synonym for /CAPACITY and can be used to limit the size of the Output File to the specified no. of MBytes. A Size of 0 (zero) is the default and corresponds to an unlimited size.
/NAME=<name>: Specifies a setting for the Field of a Automatically Generated Filename.
/INPUT_FILE: Specifies that the input file name should be used for the Field of a Automatically Generated Filename.
/INPUT_TYPE: Specifies that the input file type should be used for the Field of a Automatically Generated Filename.
/INPUT_EOF: Specifies that the input file should be comletely read before the out file is closed.
/RADIX_RUN=<radix>: Specifies what radix (decimal, hexadecimal etc.) the Field of an Automatically Generated Filename should be in. Allowed radices are DECIMAL (the default), HEXADECIMAL, OCTAL and RAD36. RAD36 uses the characters 0..9, A..Z to encode the Run Number in Base-36.
/RECORD_LIMIT=<n>: This is synonym for /EVENT_LIMIT and can be used to limit the size of the Output File to the specified no. of Logical Records. The default Record Limit is 0 (zero), which corresponds to no limit.
/REPORT_FREQ=<n>: Specifies a frequency for reporting. This frequency should be given in Integer and determines how frequently ANALYSIS_CONTROL will report that another Logical Record (or event) has been written to the Output File. The default is 0 (zero) and corresponds to no reporting.
/SEQUENCE=<seq>: Specifies an initial Sequence ID for the <SEQUENCE> Field of an Automatically Generated Filename. Sequences normally run through "","A", "B"..."Z","AA"..."AZ", etc., commencing with null, but this Qualifier may be used to explicitly specify the initial sequence ID.
/STANDARD=<template>: Specifies a standard automatically generated Filename. Valid Standard Templates are RAW_DATA. If you use this Qualifier, you should not also specify a Filename.
/TEMPLATE=<template>: This is a synonym for /STANDARD.
/TYPE=<type>: Specifies a setting for the <TYPE> Field of a Automatically Generated Filename. If the specified field does not begin with a ".", then it will be inserted automatically.
/WARNING=<warn>: Specifies when a File Full Warning Message should be reported. The Warning Threshold should be given in % (percent) in the range 0-100%. The default is for a Warning Threshold of 0, corresponding to no warning message being reported. This Qualifier is ignored if the Output File is unlimited in size.
/WIDTH_RUN=<n>: Specifies how many characters wide the <RUN_NUMBER> Field of an Automatically Generated Filename should be. This width should be specified in the range 0 to 10, 0 corresponding to the normal default.
/RECLENGTH=<n>: Specifies that the file should be open with reclength of n in longwords.
/RETRY=<n>: Specifies that in case of failure the output file open should be retried n times.

Output Format

Specifies the format for output. Valid formats are VAX or UNIX. The UNIX format forces A_C to write out a file in HP-UX format (big-endian byte order and IEEE REAL*4 representation), while the VAX format forces A_C to use the VAX format with little-endian byte order and VAX-F REAL*4 representation. For example, the commands:

OUTPUT FILE DATA_OUT.YBS

OUTPUT FORMAT UNIX

would cause the data for the default output stream (#1) to be written to the file DATA_OUT.YBS in HP-UX format. The default format is VAX. In input A_C recognizes the format in which a file was written, so that the user does not need to specify the format to be used.

Output Module

This command allows the user to specify what output module should be used. The syntax of the command is:

OUTPUT MODULE <Module Name>

If no output module is specified, but output is turned ON, the default output module is WRITE_FILE

Output Mv_at_Close

This command allows the user to rename a file when it is closed by A_C. One syntax of the command is:

OUTPUT MV_AT_CLOSE "xyz" "abc"

If the output file was opened with the name xyzDAT.ybs it will be renamed to abcDAT.ybs after it is closed, so you can replace all or part of the file name with another name. This version is useful if you have some daemon process collecting file and you don't want it to touch the ones that are actively being processed. Another command syntax is:

OUTPUT MV_AT_CLOSE/Concat1B

This command should be used in conjuction with Concat1b template. See "OUTPUT FILE Automatic_File_Generation"

Output Ybos_Mode

This VMS ONLY command allows the user to specify what YBOS output mode should be used. Output mode must be selected before the output file is opened, therefor it must be specified before the OUTPUT FILE command. The syntax of the command is:

OUTPUT YBOS_MODE FAST  -or-

OUTPUT YBOS_MODE NORMAL

Normal is the default. If fast mode is specified Analysis_Control will use the optimized version of the YBOS output routines. The optimized version will typically result in a 30% reduction in processing time. These routines can not however be used for network file access; for this application NORMAL ybos mode should be used.

Note: The SHOW OUTPUT command has been modified to show the output mode selected for each output stream.

Output Select

This command is used to allow the user to specify what events or banks are to be written to the output stream. By default, Analysis_Control will create an output file that contains all events that have been analysed. All banks on the input file will be output, along with any banks created in the analysis job that have been added to the "A" bankset using the YBOS command BLIST. These defaults can be modified using the command

OUTPUT SELECT <option>

where the available options are:

EVENTS; Specify that only selected events be output
KEPT_BANKS; Add banks to the output stream
DROPPED_BANKS; Remove banks from the output stream
A_BANKSET; Override whether banks in the A set are output
INPUT_BANKSET; Override whether banks on input file are output
REC_DROP; Specify that selected record types be dropped
REC_KEPT; Specify that selected record types be kept

Output Select Events

This command must be used with one of its valid qualifiers

/FILTER=<Filter name>

The command:

OUTPUT SELECT EVENTS/FILTER=<Filter name>

allows the user to indicate that events should be written to the output file only if the specified filter was satisfied. It is possible to request events be selected on the basis of non-default parameter sets by adding the qualifier /PARAMETER_SET=n or /PARAMETER_SET=<Parameter set name> after the /FILTER=<name> qualifier. For example, the command

OUTPUT/STREAM=2 SELECT EVENTS/FILTER=ELECTRON/PAR=TIGHT_CUTS

tells analysis control that only events that have passed the ELECTRON filter with the TIGHT_CUTS parameter set should be written to output stream 2. Multiple filters may also be specified:

OUTPUT/STREAM=<n> SELECT EVENTS/FILTER=(-
   <modname1>/PARameter_set=<parset>,-
   <modname2>/PARameter_set=<parset>,-
   <modname3>/PARameter_set=<parset>...)

Entering the above will filter stream <n> using the logical AND of the filter decisions from the specified modules.

/PATH=<pathid>

OUTPUT/STREAM=<n> SELECT EVENTS/PATH=(1,2,3...)

Entering the above will direct the successful output of the specified paths to stream <n>. For paths containing filters, the path is considered successful if it has reached the end at the time of output, otherwise the path is always successful. Note that when more than one path is specified the logical OR of all specified path decisions is used.

/OLDPATH=<pathid>

If a PTHB bank exists for <pathid> on input from a previous analysis then it can be used to direct events to a particular output stream with the following command:

OUTPUT/STREAM=<n> SELECT EVENTS/OLDPATH=(1,2...)

For paths containing filters, the path is considered successful if it has reached the end at the time of output, otherwise the path is always successful. Note that when more than one old path is specified the logical OR of all specified path decisions is used.

See "SET PTHB" for more information on the PTHB bank and how to generate it.

Output Select Kept_Banks

This command allows the user to specify a list of banks to be added to the output stream. The syntax of this command is:

OUTPUT SELECT KEPT_BANKS=<bank_names>

where <bank_names> is a concatenated list of 4 letter bank names with no spaces or commas between the names. Note: The list of banknames can be continued over several lines using the UIPACK continuation symbol "-". For example, the command:

OUTPUT SELECT KEPT_BANKS -
CEME-
CHAE-
WHAE

tells Analysis_Control to include the three banks CEME, CHAE and WHAE in the list to be written to the output file. Also "*" can be used as a wildcard so that

OUTPUT SELECT KEPT_BANKS ***D

will keep all D banks and

OUTPUT SELECT KEPT_BANKS ****

will keep all banks.

Output Select Dropped_Banks

This command allows the user to specify a list of banks to be removed from the output stream. The syntax of this command is:

OUTPUT SELECT DROPPED_BANKS=<bank_names>

where <bank_names> is a concatenated list of 4 letter bank names with no spaces of commas between the names. Note: The list of bank names can be continued over several lines using the UIPACK continuation symbol "-". For example, the command:

OUTPUT SELECT DROPPED_BANKS -
CEME-
CHAE-
WHAE

tells Analysis_Control to exclude the three banks CEME, CHAE and WHAE from the list of banks to be written out. Also "*" can be used as a wildcard so that

OUTPUT SELECT DROPPED_BANKS ***D

will drop all D banks.

Note: The user is not permitted to remove the LRID and EVCL banks from the output stream. Requests to drop these banks will be ignored.

Output Select A_Bankset

This command can be used to override the list of banks specified for output within the analysis code. The command:

OUTPUT SELECT A_BANKSET OFF

tells Analysis_Control NOT to output banks in the A bankset. The command:

OUTPUT SELECT A_BANKSET ON

specifies that the banks should be output. By default, all banks in the A bankset are output.

Output Select Input_Bankset

By default all banks on the input file will be written to the output. The user can override this default using the command:

OUTPUT SELECT INPUT_BANKSET OFF

and can restore the default using the command

OUTPUT SELECT INPUT_BANKSET ON

Output Select Rec_Drop

The command:

OUTPUT/STREAM=<n> SELECT REC_DROP

will invoke a toggle menu containing a list of record types that may be dropped on output stream <n>. After entering OK the selected entries will be dropped.

Output Select Rec_Kept

The command:

OUTPUT/STREAM=<n> SELECT REC_KEPT

will invoke a toggle menu containing a list of record types to be kept on output stream <n>. After entering OK all records will be dropped except the specified entries.

Output Reset

These commands are the compliments of the SELECT commands and they allow Analysis_Control to be reset to its default setup. These defaults are recovered using the command:

OUTPUT RESET <Option>

where the available options are:

EVENTS; Reset A_C so that no filtering will be done
KEPT_BANKS; Reset A_C so that only input and"A" set banks will be output.
DROPPED_BANKS; Reset A_C so that no banks are dropped.
A_BANKSET; Reset A_C outputting of the "A" banks.
INPUT_BANKSET; Reset A_C outputting of the input banks.
REC_DROP; Reset A_C so that no records are dropped.
REC_KEPT; Reset A_C so that no records are dropped.

The following are examples of the Output Reset command:

OUTPUT/STREAM=<n> RESET EVENTS/FILTER

OUTPUT/STREAM=<n> RESET EVENTS/PATH

OUTPUT/STREAM=<n> RESET A_BANKSET (ON or OFF)

OUTPUT/STREAM=<n> RESET INPUT_BANKSET (ON or OFF)

OUTPUT/STREAM=<n> RESET REC_DROP

Quit

Action: Quit and Exit are equivalent.

Set

Action: Set analysis parameters. The syntax of the command is:

SET <analysis parameter>[/Qualifier]

where the analysis parameters that can be set are:

DEBUG_LEVEL: Set module debug level
MODE: Set various A_C modes of operation
LOGICAL: Define a logical or env.
PRINT_LEVEL: Set module print level
PROMPT: Subsitute ANA>> for given string
RUN_LIST: Specifies a range of runs to be analyzed
[NO]VERIFY: Set/Unset UIPACK echoing
REPORT: Specify the event reporting frequency
DELAY: Specify idle time between events
TAGC_UPDATING: Turn ON or OFF TAGC bank updating
TPID_UPDATING: Turn ON or OFF TPID bank updating
PTHB_UPDATING: Turn ON or OFF PTHBbank updating
TIME_OUT: Specify a maximum event processing time
ONEOF_ENDRUN: Enable end of run entries for input EOFs

Set Debug_Level

Action: Sets a flag that tells the individual module(s) whether they should generate debug information. What debug information (if any) is produced for a given debug level is dependent upon the module. The syntax for this command is:

SET DEBUG_LEVEL/MODULE=<Module name> <Debug level>

where the debug level must be an integer between 0 and 3. If the optional qualifier /MODULE is absent, the command acts upon all modules.

Set Logical

Action: Allows Logical Names (VAX/VMS) or Enviromental Variables (UNIX) to be defined from within the current Program. The syntax is:-

SET LOGICAL <logical_name> <value>

Set Mode

Action: Allows the user to specify various modes of operation,where the available options are:

ASYNCHRONOUS; Turn on/off synchronous command processing
PROCESSING; Turn on processing mode
VALIDATION; Turn on some form of ybos validation
PROMPTED; Use UIPACK prompted mode
SCROLL; Use UIPACK scrool mode
VIEWPORT; Use UIPACK viewport mode

Set Mode Asynchronous

Action: Specifies whether the program is in synchronous or asynchronous mode. The syntax of the command is:

SET MODE [A]SYNCHRONOUS

In asynchronous mode, event processing (that is started using the BEGIN, CONTINUE or CALIBRATE commands) will be aborted whenever a command (plus carriage return) is typed on the terminal. The event that is in the event buffer when the command is typed will be completely processed before the program returns to the user.

In synchronous mode, all commands typed at the terminal will be stored until event processing is completed.

Set Mode Processing

Action: Specifies whether the program is in processing mode or not. Processing mode is designed to insure that the job will return to processing events after accepting user input. It is meant for interactive use when the program is in asynchronous mode. It is activated using the command:

SET MODE PROCESSING

Once this command has been issued, the program will continue to process events until an end-of-file is issued, or until the user types a command followed by a carriage return. If a command is typed, it will be carried out and event processing will then begin again. To exit from processing mode, the user must type

STOP

Set Mode Validation

Action: Specifies whether the Primary YBOS Array is automatically validated (by a call to BVALID) prior to every YBOS operation or not. Validation is quite time-consuming and is meant to be used as a debugging aid. Validation is turned on by the Command:-

SET MODE VALIDATION[/Qualifier]

and off by the Command:-

SET MODE NOVALIDATION

Validation is initially disabled. The following is a list of valid qualifiers:

/ABORT: Any YBOS function call will fail if named bank validation finds an error. This is the default if no qualifier is specified.
/CONTINUE: YBOS function calls will continue (and possibly be successful) even if named bank validation finds an error.

Set Mode Prompted

The SET MODE PROMPTED command supresses the output of UIPACK scrolling menus.

Set Mode Scroll

The SET MODE SCROLL re-enables scrolling menus if the user code provides them.

Set Mode Viewport

Enables Uipack viewport menus.

Set Print_Level

Action: Sets a flag that tells the individual module(s) whether they should generate printout. What printout is produced for a given print level is dependent upon the module. The syntax for this command is:

SET PRINT_LEVEL/MODULE=<Module name> <Print level>

where the print level must be an integer between 0 and 3. If the optional qualifier /MODULE is absent, the command acts upon all modules.

Set Prompt

Action: Changes the Analysis_Control prompt from ANA>> to the specified character string.

Set Verify

The command SET VERIFY causes all UIPACK commands files to be echoed at the terminal. The command SET NOVERIFY turns such echoing off.

Set Run_List

Specifies a range of runs to be analyzed or not analyzed. Note it can NOT do both at the same time so you must use all positive numbers or all negative numbers. For example:

SET RUN_LIST = 10

SET RUN_LIST = -10

The first tells the program to analyze only run 10, the second tells it to analyze all runs except run 10. Similarly,

SET RUN_LIST = (10:20,30:35)

will analyze all runs from 10 to 20 and from 30 to 35, and

SET RUN_LIST = (-10:-20)

will analyze all runs except runs in the 10 to 20 range. Note: When listing multiple runs, the list must be included in parentheses, and if the lower bound is negative the upper must be as well. If this command is never executed, all runs will be analyzed.

WARNING: Run_lists are not automatically deleted once a set of events have been processed. If you wish to analyze another file that contains different runs, or if you wish to reanalyze the same file but specify a different set of required runs, you must execute a DELETE RUN_LIST command.

Qualifiers:

/EVENT_LIST

This qualifier allows you to specify a list of events to be analyzed or not analyzed for the given run-list. Note it can NOT do both at the same time so you must use all positive numbers or all negative numbers. For example, the commands:

SET RUN=1/EVENT=1:100

SET RUN=2/EVENT=(100,105,110:120)

tell the program that whenever events are processed, only the first 100 events of run 1, and events 100, 105 and 110 through 120 of run 2 should be analyzed. Similary,

SET RUN=2/EVENT=(-100,-105,-110:-120)

tells the program to analyze all events in run 2 except 100, 105 and 110 through 120. Note indeterminate results occur if positive and negative numbers are used together.

Set Report

Specify the Analysis_Control reporting frequency. The report is a message about the current run and event number being analyzed and optionally the number of events processed thus far.

Qualifiers:

/CPU_TIME: Sorry NOT implememted.
/ELAPSED_TIME: Specify the number of elapsed seconds between event reports.
/EVENTS: Specify the number of events between event reports.
/PROCESSED: Turn on the part of the report indicating the number of events processed thus far.

Set Delay

Specify the amount of time to wait between processing events. This is used in Online applications.

Set Tagc_Updating

Turn ON or OFF TAGC bank updating. OFF is the default. The Syntax is:

SET TAGC_UPDATING ON/OFF

The TAGC bank contains the pass/fail status and the bit definition of all triggers. It is needed by TRVIEW (and ACDUMP if you request TAGC dumped). For a full bank discription see C$INC:DSTAGC.CIN.

Set Tpid_Updating

Turn ON or OFF TPID bank updating. OFF is the default. The Syntax is:

SET TPID_UPDATING ON/OFF

This bank keeps a history for each event of the input files used to created the data set. It will at least contain the raw data information as well as the name of the DST file it came from. All other steps in the processing chain many or may not be there depending on how the piece of the chain used this command. For a full bank discription see C$INC:DSTPID.CIN

Set Pthb_Updating

Turn ON or OFF PTHB bank updating. OFF is the default. The Syntax is

SET PTHB_UPDATING ON/OFF

This bank keeps a history for each event of all of the path definitions in the current job and their pass/fail status for each event. If updating is enabled any PTHB bank on the input file will be dropped and remade with information from the current job if it is dissabled then this bank may pass through untouched if it exists on the input file. This bank in an internal A_C bank and is used by the

OUTPUT SELECT EVENTS/OLDPATH

command. If you intend to use this command in a subsequent analysis you MUST turn Pthb_Updating ON, however if not then it is better to leave it off since it takes time to update. Note that 1B production uses this mechanism to pass the results from the event node processes to the output node processes, so the PTHB banks from production will be on the data if no subsequent process used this command.

Set Time_Out

Specify the maximum number of seconds A_C will spend on one event. At the moment if the event times out A_C will crash the program. If a time out is not specified it will be infinite, i.e. there will be no time out.

Set OnEOF_Endrun

If this option is set then A_C will call the user defined end run entry points for all active modules, when an input file EOF is encountered.

Show

Action: Show the status of analysis job. The correct syntax for the command is:

: SHOW <parameter>

where the possible parameters that can be displayed are:

ALL: Show all information about the job
DELAY: Shows the amount of artificial delay between events.
FILTERS: Shows the status of the available filter modules.
INPUT: Shows what input sources are available or queued and which one is currently active
MODES: Shows the current settings of many SET MODE commands
MODULES: Shows what non-I/O modules are available
PATHS: Shows the definition of all currently defined paths.
OUTPUT: Lists currently active output streams and their statistics
REPORT: Shows Processing Reporting Settings.
SPACE: Shows statistics on all primary and secondary ybos arrays
SYMBOLS: Lists currently defined UIPACK symbols
TIMING: Displays the results of timing and execution accumulations.
LOGICAL: Translates the given logical or environmental variable.
VERSION: Lists what versions of the major utilities are linked.
RUN_LIST: Show the current Run Number List
EVENT_LIST: Show the current Event Number List
TIME_OUT: Show the number of second before an event will time out.

Show Filters

Gives a list of the filter modules linked in the current job, and a summary of the number of events tested and passed for each parameter set.

Show Input

Show a list of all input modules that have been linked and specifies which one is currently active. It also displays the queue of input files as typed in on the command line with an arrow indicating the current input file. The translated name of the current input file is also displayed. This may be different from the name typed in if a logical or wildcard was used. If different than their defaults, other input characteristics may be displayed, such as drop banklists or input event selection.

Show Modes

Shows whether asynchronous input is enabled, whether Analysis_control is in "processing mode", whether or not TAGC, TPID, or PTHB updating is enabled, and whether or not EOF end run calls are enabled. See the entries for SET and SET MODE for an explanation of these modes.

Show Paths

Give a list of what analysis modules are active for each path that is currently defined. It specifies what filters are active, what type of decision will be made and whether any non-default parameter sets have been enabled. Paths are defined with the USE command.

Show Output

Gives a list of available output modules, and then shows a list of currently active output streams, along with some output statistics for each. It also gives the current setup of various output options i.e. filtering, bank selection, and whether or not history files have been enabled.

Show Space

Show space statistics for the primary YBOS array, the ANALYSIS_CONTROL array, the UIPACK array and the YHIST array (if YHIST is in use). The statistics show the total amount of space, the current amount of free space and the minimum amount of free space for the job, in units of INTEGER words.

Show Symbols

Show the currently defined UIPACK symbols. The qualifier /CLASS can be used to show only those symbols beginning with a certain string. E.g.:

: SHOW SYMBOLS/CLASS=abc

will list all symbols starting with the string abc.

Show Run_List

Show the current Run/Event Number List. This is in two sections; the Run List giving the set of runs for which all Events will be analysed (unless the Run also has an enumerated Event List) and Event List giving the the set of Events that will be analysed for each Run individually. Either or both of these sections may be present, depending on previous SET RUN_LIST and DELETE RUN_LIST Commands.

Show Event List

Shows the Event List for a specified Run Number. You will be prompted to supply a Run Number. Note that Run Number 0 corresponds to the Global Event List which will be applied to all Runs.

Spawn

Action: This command allows the user to execute a spawn a DCL or shell command. The syntax of the command is:

: SPAWN[/Qualifier] <Command Text>
or: SPAWN DCL (for VMS) SHELL (for UNIX)
or: SPAWN <Module Name> (VMS only)

Qualifiers:

/COMMAND

On VMS if the user wishes to spawn a DCL command file (i.e. if he want to send the command @) he can do so by typing

: SPAWN/COMMAND <Command Filename>

Analysis_control will then place the @ sign in front of the command file name and perform the Spawn. For example, typing

: SPAWN/COMMAND Usr$Root1:[User]Command

will cause the command

: @Usr$Root:[User]Command

to be spawned.

On UNIX the @ is not needed so the string is executed as is. The user is then returned to the ANA prompt after it is completed. Also note that since UNIX commands are case sensitive the user MUST inclose the command text in double quotes. SPAWN/COMMAND "ls" will work, however SPAWN/COMMAND ls, will not.

/SYMBOL

If the user wishes to spawn a command line without having an @ sign placed at the start of the line, he should use the /SYMBOL qualifier. For example, typing

: SPAWN/SYMBOL BUILD

will cause Analysis_control to spawn a subprocess that executes the command BUILD. If the Build_Job logicals have been defined, this will cause the Build_Job program to begin execution.

Note on UNIX this is equivalent to SPAWN/COMMAND.

DCL: The SPAWN DCL command creates creates a DCL subprocess. When the user gets the $ prompt, he can execute any DCL commands. Typing the command LOGOUT will return the user to the ANA>> prompt.
SHELL: The SPAWN SHELL command creates a shell child process. The shell that is selected is the users login shell specified in the password file, also the users .cshrc gets executed, so if you define your aliases there (as you should) they should be available to you. Standard output and error are redirected to standard output. When the user gets a prompt, he can execute any shell commands. Typing the command "exit" will return the user to the ANA>> prompt.
Module_Name: The command SPAWN <Module namegt; allows the user to spawn a subprocess that executes a module specific command. A list of modules with spawn commands can be gotten by typing ? after giving the SPAWN command in ANA>>. The user can then exit from the SPAWN command without executing a spawn by answering NONE, or (VMS only) by typing Control-z.

Stop

The command STOP is used to return to the ANA>> prompt from processing mode. See SET MODE PROCESSING for details.

Talk_to

Action: Modify module status or parameters for a given module by calling the appropriate TALK_TO subroutine for that module. The correct syntax is:

TALK_TO[/Qualifier] <Module Name>[/Qualifier]

Qualifiers:

/PARAMETER_SET

This qualifier can be applied either to the TALK_TO command or to the module name. It specifies (for modules that can be run with more than one parameter set) what parameter set should be used for the module's Talk_to entry point. The default parameter set is number 1. If the user types:

TALK_TO/PARAMETER_SET=<n> ALL

then the parameter set for all modules (that can be run with multiple parameter sets) is set to n, and the talk_to entrypoint for every module is called in the default sequence.

TALK_TO <Module>/PARAMETER_SET=<n>

Invokes the talk to with parameter set n and is usefull for defining new parameter sets for a module or redefining and old one. Note that by convention you should not modify the default parameter set wich is 1.

/NAME=<New_Name>

This parameter is used to name the parameter set that is being generated with the talk_to command. The syntax is:

TALK_TO/NAME=<New_Name>/PARAMETER_SET=<Parset #> <Module>

If the name is specified it will be associated with that parameter set number so that either may be specified for future A_C commands (eg. USE and FILTER).

Tape

Simple tape requests can be handled within Analysis_control. The following commands are supported:

ALLOCATE: Allocate specified tape drive
DEALLOCATE: Deallocate specified tape drive
DIRECTORY: Display a directory of files
DISMOUNT: Dismount tape
MOUNT: Mount labeled tape
SETUP: Setup a new Drive or Modify existing Drive
STATUS: Show Status of Tape Drives

Tape Allocate

The syntax of this command is:

TAPE ALLOCATE[/Qualif.] <Tape Drive> [<Logical Name>]

Where the Logical Name is optional and will only be created if it is present on the Command Line. The Tape Drive name must correspond to one as shown via a TAPE STATUS Command, except that "*" will act as a Wildcard and attempt to allocate a presently unallocated drive.

Allocate Qualifiers:

/STREAM=<stream>

This Qualifier allows the Tape Drive to be allocated to a specified Output Stream. This could be used to allow, for instance, two Drives to be allocated for Stream 1 and another two for Stream 2. Tape Drive cycling (See the TAPE SETUP/FULL_ACTION qualifier) will then cycle independently over the two sets of Drives rather than treating all four as a cycle set. If this Qualifier is omitted the Tape Drive is not allocated to a specific Output Stream, but just to this Job.

/Class=<Device Class>

This is a UNIX only qualifier that is used together with a wildcard drive specification in order to determine which type of drive you are requesting. Possible device classes and corresponding default density are:

"exabyte_8200": allocate only an exabyte 8200 device; default density is 8200
"exabyte_8500": allocate only an exabyte 8500 device; default density is 8500
"exabyte_8505": allocate only an exabyte 8505 device; default density is 8500
"exabyte_850x": allocate either an exabyte 8500 or 8505 device; default density is 8500
"exabyte": allocate either an exabyte 8200, 8500 or 8505 device; default density is 8200

If /CLASS is not specifed, the default Device Class is "exabyte_850x".

/GROUP=<Device Group Name>

This is a UNIX only qualifier specifies from which OCS Device Group name to allocate a tape drive. The default is "any".

/QUEUE or /[No]Queue

This UNIX only qualifier specifies whether or not to queue (wait) for an available tape drive if none are currently available. The default, if neither QUEUE nor NOQUEUE is present, is to queue if drives are unavailable.

/TIMEOUT=<seconds>

If the QUEUE qualifier is present, then this UNIX only qualifier specifies how long to wait for a drive to become available. The default is 7200 seconds (i.e. 2 hours).

Tape Deallocate

The syntax of this command is:

TAPE DEALLOCATE <Tape Drive>

where <Tape Drive> may either be a physical Tape Drive or a Logical Name that translates to a valid Drive. If a Tape is mounted on the drive you will be prompted whether you want to continue and dismount the tape or abort the request.

Tape Directory

The syntax of this command is:

TAPE DIRECTORY <Tape Drive>

where <Tape Drive> may either be a physical Tape Drive or a Logical Name that translates to a valid Drive. A list of files on the tape will be displayed. If you are doing a directory of an 8mm tape this command may take a LONG time depending on the number of files on the tape.

NOTE: On UNIX, the drive must first be allocated but can not yet be mounted by RBIO. Therefore you first allocate the drive and either:

stick the tape in it and then issue the DIR command. You can then mount the tape after the ANA>> prompt returns.
Issue the mount command with the NOWAIT qualifier. After the operator has mounted the tape, but before you complete the mount (e.g. issue a subsequent mount with a WAIT qualifier or open a file), issue the DIR command. You can then complete the mount or open a file after the ANA>> prompt returns.

Also note that UNIX uses ANSI standard labeled tapes. The VAX uses an extension to the standard. There is a maximum of 17 characters allowed for tape file names opened on UNIX, however RBIO has now been fixed (as of v6_2) so that it will read VAX labeled tapes even if the file names are longer than 17 characters.

Tape Dismount

The syntax of this command is:

TAPE DISMOUNT[/Qualifier] <Tape Drive>

where <Tape Drive> may either be a physical Tape Drive, a Logical Name that translates to a valid Drive or "*". If "*" is used all currently mounted tape drives will be dismounted. You will be prompted to verify that the dismount should proceed.

Dismount Qualifiers:

/CONFIRM or /[No]CONFIRM

This Qualifier determines whether the user is prompted to confirm that a tape should be dismounted. The default is /NOCONFIRM.

/UNLOAD or /[No]UNLOAD

This Qualifier may be used to determine whether the Tape that is presently mounted is unloaded (vacuum off) or not. The default is to unload the Tape, but this may be overridden by the following syntax:-

TAPE DISMOUNT/NOUNLOAD <Tape Drive>

Tape Mount

The syntax of this command is:

TAPE MOUNT[/Qualifier] <Tape Drive> <Tape Label>

where the Tape drive may be identified either by its physical device name (e.g. $1$MUA0:) or by a logical name that translates to the physical device name, or by the "user name" as specified in a previous TAPE SETUP Command. On VMS the Tape label may be wildcarded either explicitly, by specifying it as "*", or by using the /OVERRIDE Qualifier. On UNIX the Tape label must be specified and if it is in lower case (or mixed case)it must be "quoted". For both VMS and UNIX new files will be written at the end of the data already on the tape, however on UNIX this default may be changed so that the old files will be overwritten by using the /OVERWRITE qualifier.

Mount Qualifiers:

/ASSISTANCE=<Destination>

The Qualifier may be used to determine where any Assistance messages for the Mount command are displayed. Valid destinations are OPERATOR, which is the default for Batch Jobs, TERMINAL, which is the default for interactive jobs and NONE. These defaults may be overridden either by this Qualifier or by a prior TAPE SETUP/ASSISTANCE=... request. On UNIX systems, both TERMINAL and OPERATOR will issue an OCS mount request, but if ASSISTANCE=NONE, then the tape is presumed to be in the tape drive and no mount request will be issued.

/BLOCKSIZE=<size>

This Qualifier may be used to override the default Blocksize for the device as specified by a previous TAPE SETUP command. The default is 16384. This is used in conjunction with the density, tape length and safety factor to calculate an effective capacity for the drive. If the /CAPACITY or /MAX_SIZE Qualifier were also used in the TAPE SETUP Command, the smaller of the two capacities will be used.

/COMMENT=<text>

This Qualifier may be used to specify a text string which will be displayed, together with a mount assistance message, to the current assistance destination (see the /ASSISTANCE Qualifier). The comment text should be enclosed in quotes if it contains embedded spaces or commas.

/DENSITY=<density>

This Qualifier may be used to setup a default Density for 9-track or exabyte 8mm tapes. It is ignored for other tape devices. For 9-track tapes the default is 6250. For exabyte 8mm tapes the density may be:

8200: for reading/writing in 8200 mode on either an exabyte 8200, 8500 or 8505 tape device
8500: for reading/writing in 8500 mode on either an exabyte 8500 or 8505 tape device
8200c: for reading/witing in 8200 compressed mode on an exabyte 8505 device
8500c: for reading/witing in 8500 compressed mode on an exabyte 8505 device The default density for 8mm tapes depends on the class of tape device allocated. (see ALLOCATE/CLASS).

The density is also used in conjunction with the blocksize, tape length and safety factor to calculate an effective capacity for the drive. If the /CAPACITY or /MAX_SIZE Qualifier is also present, the smaller of the two capacities will be used.

/EMPTY_CHECK=<action>

This Qualifier may be used to determine what action should be taken if a non-empty tape is mounted on this drive. Valid actions are NONE, corresponding to no check being made; ABORT, which dismounts the tape, signals an error and ignores the request; and RETRY, which dismounts the tape and requests the mount of another tape (using assistance as specified by the /ASSISTANCE qualifier). The default is NONE unless overridden by a previous TAPE SETUP/EMPTY_CHECK request. This Qualifier currently has no effect on UNIX systems.

/INPUT

This Qualifier may be used on UNIX systems to indicate that the tape is going to have an input file on it. If neither the INPUT qualified nor the OUTPUT qualifer is specifed, the default is to mount the tape for input. If both are specifed, the tape will be mounted for input.

/OUTPUT

This Qualifier is needed on UNIX systems to indicate that the tape is going to have an output file on it. You cannot use a tape for output on UNIX systems if you do not use this qualifier. If neither the INPUT qualified nor the OUTPUT qualifer is specifed, the default is to mount the tape for input. If both are specifed, the tape will be mounted for input.

/OVERRIDE or /[No]Override

On VAX systems, this Qualifier causes the tape label not to be prompted for. It may be used as an alternative to:

TAPE MOUNT DRIVE0 *

where the "*" acts as a tape label wildcard.

On UNIX systems, this Qualifier causes a tape label mismatch to be ignored. If the tape is opened for OUTPUT, the tape label specified by the user will be used to overwrite the existing tape label and subsequent files will be written at the beginning of the tape. If the tape is opened for INPUT, the label found on the tape will be subsequently used instead of the one specified on the mount command.

/OVERWRITE

This Qualifier causes any new files to be written at the beginning of the tape even if there is data already on the tape. The default is to append new file at the end of the data already on the tape. On UNIX, the /OUTPUT qualifier must also be present with this qualifier.

/RETRY=<attempts>

On VAX systems, this qualifier specifies how many time to retry mounting a tape. On UNIX, this qualifier specifies how many times to retry the YBOS portion of the mount; the other (physical) portion of the mount is automatically retried if the label or read/write protection is incorrect and never retried on errors such as a damaged tape. On both VAX and UNIX systems, the default for this qualifier is 0.

/STREAM=<stream>

This Qualifier allows the Tape Drive to be mounted for a specified Output Stream. This could be used to allow, for instance, two Drives to be allocated and mounted for Stream 1 and another two for Stream 2. Tape Drive cycling will then cycle independently over the two sets of Drives rather than treating all four as a cycle set. If this Qualifier is omitted the Tape Drive is not mounted to a specific Output Stream, but just to this Job, the connection to an output stream being made dynamically when a file is opened.

/TIMEOUT=<seconds>

This UNIX only qualifier is specifies how long to wait for an operator to respond to the mount request. The default is 7200 seconds (i.e. 2 hours).

/UNLOAD or /[No]UNLOAD

This Qualifier may be used to change the unload action following a TAPE DISMOUNT request. /UNLOAD will cause a dismount request to rewind and unload the tape, whereas /NOUNLOAD will just cause the tape to be rewound.

/WAIT or /[No]WAIT

This UNIX only qualifier specifies whether or not to wait for an operator to respond to the mount request before proceeding. If NOWAIT is specified, other Analysis Control commands can be entered before the file on tape is actually opened. This reduces the overhead of waiting to an operator to respond to multiple mount request. The default, if neither WAIT nor NOWAIT is present, is to wait for the operator response.

/WRITE_CHECK=<action>

This Qualifier may be used to specify a default action to be taken if a write-protected tape is mounted. Possible actions are NONE, which performs no checking; ABORT, which dismounts the tape, signals an error and aborts the request; and RETRY, which dismounts the tape and attempts to mount another tape (using assistance as specified by the /ASSISTANCE qualifier). The default action is NONE, unless overridden by a previous TAPE SETUP/WRITE_CHECK request. This Qualifier currently has no effect on UNIX systems.

Tape Setup

The syntax of this command is:

TAPE SETUP[/Qualifiers] <Tape Drive>

where the Tape drive may be identified either by its physical device name (e.g. $1$MUA0:) or by a logical name.

Setup Qualifiers:

/ASSISTANCE=<destination>

The Qualifier may be used to determine where any Assistance messages for the Mount command are displayed. Valid destinations are OPERATOR, which is the default for Batch Jobs, TERMINAL, which is the default for interactive jobs and NONE. On UNIX systems, both TERMINAL and OPERATOR will issue an OCS mount request, but if ASSISTANCE=NONE, then the tape is presumed to be in the tape drive and no mount request will be issued.

/BLOCKSIZE=<size>

This Qualifier may be used to setup a default Blocksize for the device. The default is 16384 on VAX systems and 49152 on UNIX systems. This is used in conjunction with the density, tape length and safety factor to calculate an effective capacity for the drive. If the /CAPACITY or /MAX_SIZE Qualifier is also present, the smaller of the two capacities will be used.

/CAPACITY=<kbytes>

This Qualifier may be used to specify a capacity (in kbytes) for the current device. If this is different from that calculated from the density, blocksize and length, the smaller value is used. The default is to take the value calculated by the default density etc. The capacity should be specified in kbytes, e.g.

TAPE SETUP/CAPACITY=150000.0

CAPACITY is a synonym for MAX_SIZE.

/CONDITIONAL or /[No]CONDITIONAL

This Qualifier determines whether an error is reported if a TAPE SETUP operation is attempted on a non-existent hardware device. The main purpose is to allow for a single setup file to be used in a VAX Cluster environment where some of the drives are cluster-wide and others are node-specific.

/DENSITY=<density>

8200: for reading/writing in 8200 mode on either an exabyte 8200, 8500 or 8505 tape device
8500: for reading/writing in 8500 mode on either an exabyte 8500 or 8505 tape device
8200c: for reading/witing in 8200 compressed mode on an exabyte 8505 device
8500c: for reading/witing in 8500 compressed mode on an exabyte 8505 device

The default density for 8mm tapes depends on the class of tape device allocated (see ALLOCATE/CLASS). The density is also used in conjunction with the blocksize, tape length and safety factor to calculate an effective capacity for the drive. If the /CAPACITY or /MAX_SIZE Qualifier is also present, the smaller of the two capacities will be used.

/EMPTY_CHECK=<action>

This Qualifier may be used to determine what action should be taken if a non-empty tape is mounted on this drive. Valid actions are NONE, corresponding to no check being made; ABORT, which dismounts the tape, signals an error and ignores the request; and RETRY, which dismounts the tape and requests the mount of another tape (using assistance as specified by the /ASSISTANCE qualifier). The default is NONE. This Qualifier currently has no effect on UNIX systems.

/FREQUENCY=<percent>

This Qualifier may be used to specify how frequently warning messages will be reported when a tape is becoming full and the Warning Threshold (see the /WARN_THRESHOLD qualifier) has been exceeded. The default is 0.0, corresponding to no warnings and the warning interval should be specified in percent, e.g.

TAPE SETUP/FREQUENCY=10.0

FREQUENCY is a synonym for WARN_FREQ.

/FULL_ACTION=<action>

This Qualifier may be used to determine what action should be taken when a tape becomes full. Possible actions are CLOSE, which just closes the current output file and continues processing; PROMPT, which closes the output file and returns to the ANA>> prompt; ALL_CLOSE, which closes all currently open output files; CYCLE which rewinds and dismounts the tape, attempts to find another allocated and mounted tape and carries on; and ALL_CYCLE which forces all currently mounted tapes to rewind and dismount and attempt to cycle. The default is PROMPT.

/LENGTH=<length>

This Qualifier may be used to specify a tape length in meters for an exabyte 8mm tape drive or in feet for any other type of tape drive. This is used in conjunction with the blocksize and density to calculate the effective capacity of the device. If the /CAPACITY or /MAX_SIZE qualifier has also been specified, the smaller of the two calculations is used to determine the effective capacity. The default length is 112 meters for an exabyte 8mm tape drive and 2400 feet for other tape drives. For example to change the tape length to 108 meters for an exabyte 8mm tape drive, the syntax would be:

TAPE SETUP/LENGTH=108

/LOGICAL_NAME=<name>

This Qualifier may be used to specify a user or logical name by which the physical device may be referenced as an alternative to the physical device name. LOGICAL_NAME is a synonym for USER_NAME.

/MAX_SIZE=<kbytes>

TAPE SETUP/MAX_SIZE=150000.0

MAX_SIZE is a synonym for CAPACITY.

/NODE_NAME=<node>

This Qualifier may be used on VAX systems to specify a specific DECnet Node name for a particular device. The TAPE SETUP Command will be ignored if the current DECnet node does not correspond to that specified. This, together with the /CONDITIONAL Qualifier may be used to create universal tape configuration files for VAX clusters where some devices are cluster-wide and others are node-specific. The nodename defaults to none and may be specified either with or without the trailing "::".

TAPE SETUP/NODE_NAME=B0SCCF::

/REPORT_FREQ=<percent>

This Qualifier may be used to report the percentage occupancy of the tape at regular intervals. The default is 0.0, corresponding to no reporting and the frequency should be specified in percent, e.g.

TAPE SETUP/REPORT_FREQ=10.0

/SAFETY_FACTOR=<percent>

This Qualifier may be used to specify a safety factor in calculating the effective capacity of the device from the tape length, density and blocksize. The default is 10.0 and the safety factor should be specified in percent, e.g.

TAPE SETUP/SAFETY_FACTOR=10.0

/THRESHOLD=<percent>

This Qualifier may be used to specify a threshold above which warning will be reported at the appropriate frequency as a tape becomes full. The frequency is determined by a /FREQUENCY or /WARN_FREQ Qualifier. The default threshold is 0.0, corresponding to no threshold and the warning threshold should be specified in percent, e.g.

TAPE SETUP/THRESHOLD=80.0

THRESHOLD is a synonym for WARN_THRESHOLD.

/UNLOAD or /[No]UNLOAD

This Qualifier may be used to specify a default unload action following a TAPE DISMOUNT request. The default is /UNLOAD which will cause a dismount request to rewind and unload the tape, whereas /NOUNLOAD will just cause the tape to be rewound.

/USER_NAME=<name>

This Qualifier may be used to specify a user or logical name by which the physical device may be referenced as an alternative to the physical device name. USER_NAME is a synonym for LOGICAL_NAME

/WARN_FREQ=<percent>

TAPE SETUP/WARN_FREQ=10.0

WARN_FREQ is a synonym for FREQUENCY.

/WARN_THRESHOLD=<percent>

TAPE SETUP/WARN_THRESHOLD=80.0

WARN_THRESHOLD is a synonym for THRESHOLD.

/WRITE_CHECK=<action>

This Qualifier may be used to specify a default action to be taken if a write-protected tape is mounted. Possible actions are NONE, which performs no checking; ABORT, which dismounts the tape, signals an error and aborts the request; and RETRY, which dismounts the tape and attempts to mount another tape (using assistance as specified by the /ASSISTANCE qualifier). The default action is NONE. This Qualifier currently has no effect on UNIX systems.

Tape Status

This Command displays the Status of the Tape Drives, whether they are Allocated, mounted etc. On UNIX, if no Qualifiers are present, then the status of the tape drives in the OCS database is also reported. The syntax is:

TAPE STATUS[/Qualifiers]

Status Qualifiers:

/BRIEF: This Qualifier causes a brief status summary to be reported, with no expanded information for drives with tape mounted or with files opened.
/MOUNTED: This Qualifier causes the status summary to be reported only for drives having tapes mounted on them.
/DRIVE=<drive>: This Qualifier causes the status summary to be reported only for the specified tape drive.
/OCS or /[No]OCS: This Qualifier applies only to systems running UNIX. If the OCS Qualifier is present, then the OCS tape drive status is reported even when the BRIEF, MOUNTED or DRIVE qualifiers are present. The NOOCS Qualifier will cause the OCS tape drive status to be suppressed even when no other Qualifier is present.

Use_modules

Action: Define modules to be run and order in which to run them. If USE_MODULES is not invoked, the default is to run all modules in the standard default order which is the order they were specified in the BUILD_JOB link command. The correct syntax is:

USE_MODULES[/Qualifier] <Module 1> <Module 2>

Instead of specifying a list of modules, the user can type ALL (to indicate that all modules should be run in the default order) or NONE (to indicate that no modules should be called).

Note: This command assumes that you are redefining a path (even if path = 1) so any previous FILTER commands for the new path will be ignored.

Qualifiers:

/PATH = Integer

The program allows the user to set up multiple analysis paths. Each of these paths will be run for each event, but any modules common to two paths will be run only once. For example, the commands:

USE/PATH=1 MYANA1 MYANA2

USE/PATH=2 MYANA3 MYANA2

will cause two analysis paths to be set up. The first path causes the modules MYANA1 and MYANA2 to be executed. The second path causes MYANA3 to be executed. The module MYANA2 will not be called a second time.

Note: If a filtering routine had caused the analysis for path 1 to stop before MYANA2 has been called, or if the user had specified that MYANA2 should be run with a different parameter set in the second path, then MYANA2 would be called in path 2.

/PARAMETER_SET = Integer

This qualifier can be applied either to the USE command or to the module name. It specifies (for modules that can be run with more than one parameter set) what parameter set should be used for data analysis. The default parameter set is number 1.

If the user types:

USE_MODULES/PARAMETER_SET=<n> <Module 1> <Module 2>

then the parameter set for all modules (that can be run with multiple parameter sets) is set to n. If instead, the user types:

USE_MODULES <Module 1>/PARAMETER_SET=<n> <Module 2>

only the parameter set for Module 1 is set to n. All other modules are run with parameter set 1.

Analysis_Control Commands Reference

Qualifiers:

Qualifiers:

Qualifiers:

Qualifiers:

Qualifiers:

Qualifiers:

Qualifiers:

Qualifiers:

Qualifiers:

Qualifiers:

DCL

SHELL

Module_Name

Qualifiers:

Allocate Qualifiers:

Dismount Qualifiers:

Mount Qualifiers:

Setup Qualifiers:

Status Qualifiers:

Qualifiers: