lecspipe realizes
the four-stage LECS data analysis pipeline as
described in Ref. [1].
It is intended to be used to create final product files from raw (event list)
FITS files in a non-interactive, standardized manner. The entry and exit stage
at which pipeline processing shall start and end respectively can be
determined via command line parameters
(entrystage and
exitstage). Per default, all four stages
are executed. An initial raw event list file must be specified
on invocation of lecspipe. If this file exists and all four pipeline
stages shall be executed the following sequential steps are performed:
The compevfiles task is invoked
with the specified initial file to get a list of files that are
suitable for concatenation.
Unless explicitely suppressed via a boolean command line switch
(concat = "no")
the catobs task in invoked with
the file list obtained in step 1. This will create one raw event file and a
corresponding HK file.
The pipeline stages I - IV are executed.
If pipeline processing is requested not to start with stage I, the initial
event file name is just used to derive a unique name stem. This value
will then be used to create the names of files that have to exist prior
to run a particular pipeline stage. If during execution of any individual
pipeline module a fatal error condition occurs, the pipeline processing
is aborted. Per default all software activities will be logged in a log file,
which can be inspected to control the success of a performed pipeline
processing run.
PARAMETERS
The following command line parameters are recognized by the program:
firstevent = "" [string: name of an existing raw event list
file (wildcards allowed)]
The name of the initial raw event list file with which to start the
pipeline. Actually, the file specified will be passed to the
compevfiles task as value of the
command line parameter
evfilename to get
a list of event list files that are to be concatenated with the
catobs task. firstevent
can be a regular expression (Tcl syntax) which must match the name of
exactly one file in the current working directory. If more than one file
is matched, an error message will be issued and the execution is aborted.
stem = "-" [string]
This string parameter will be passed to the
catobs task as value of the command line
parameter stemoutfile.
It determines the file name stem of the files that will be created by
catobs and will be used for all future references to any files created
in this lecspipe run. The stem of a file name
is defined to be everything before any extension _???.fits, e.g.,
the name stem of kv492_rev.fits is just kv492.
entrystage = 1 [integer: 1-4, must be <=
exitstage]
The entry point at which the non-interactive pipeline processing
shall begin. Prior to actually start the data processing at the requested
point, the existence of all necessary files to run stage entrystage
is checked. If this check proves negative the execution of lecsipe
is aborted. Execution is likewise aborted if the illegal condition
entrystage > exitstage (see below) is met.
exitstage = 4 [integer: 1-4, must be >=
entrystage]
The stage after which the non-interactive pipeline processing shall be
stopped. If exitstage < entrystage execution
is aborted.
log = yes [boolean: yes|no]
If set to yes all screen I/O will be logged to a file. The name
of this log file is controlled via the logfile parameter
(see below).
logfile = "-" [string: a valid file name or "-"]
The name of the logfile if logging is enabled with
log = yes (see above).
logfile must be a valid file name or "-". The latter means
that the logfile will get the name xxx.log where xxx is
the stem of the initial event list file name (see description of the
filenamestem parameter).
If the specified log file cannot be created, an error message will be issued
and lecspipe exits.
concat = "yes" [boolean: yes|no]
This switch determines whether or not concatenation of compatible event
list files is carried out as the first step of the pipeline processing. In the
latter case the initial event list file lecspipe was started with
is used as the primary file to be processed.
proddir = "." [string: name of directory]
This must be the name of a directory in which the final product files,
i.e., the output files from stage IV, are to be stored. If the specified
directory does not exist, the program attempts to create it. The default
behavior is to create all product files in the current working directory.
indir = "." [string: name of existing directory]
The name of an already existing directory in which the input files
for stage I shall be sought. Default is the current working directory
delete = yes [boolean: yes|no]
If this is set to "yes" all intermediate files will be automatically
deleted after they are no longer needed.
slewobs = no [boolean: yes|no]
This parameter will be passed to the
compevfiles task which
will be run, in case concat is set to "yes",
at the very beginning of stage-I processing. It determines whether
slew observations shall be taken into account.
dostdplots = no [boolean: yes|no]
This boolean switch allows to control the creation of a set of standard
plots in the form of PostScript files at the end of stage I. Those files
will be stored in a directory stageI relative to the current
working directory. Default is to produce no plots at the end of stage I.
plotlevel = 1 [integer: 0-3]
An integer parameter determining which kind of plots are to be
created at the end of stage I. The assignment plotlevel = 0
is equivalent to dostdplots = "no".
ASCII2PS = "a2ps" [boolean: yes|no]
This is the external command used by lecspipe to convert
ASCII files to PostScript.
dostageIII = yes [boolean: yes|no]
This boolean switch determines whether stage III processing shall
be performed or not.
printout = yes [boolean: yes|no]
At the end of stage I a set of standard plots and images will be created
in the form of Postscript files. This switch specifies whether or not these
files shall be automatically send to a Postscript printer. The way this
is done has actually to be specified via the command line parameter
psprintcmd (see below).
psprintcmd = "lp %s" [string: command to print PS file]
This specifies a command on UNIX shell-level to print PostScript files.
The special token "%s" serves as a substitute for the name of the file
to be printed (up to three occurences of "%s" are recognized in
psprintcmd).
baryconv = yes [boolean: yes|no]
A boolean switch determining whether the baryconv task will be executed at the end of the pipeline
stage III.
losteventlimit = 0 [integer: 0-9999]
An integer specifying the maximum value of EVENT_LOST_RATEMETER which will acceptable,
when filtering on housekeeping data is applied. By default NO data will be accepted when
the EVENT_LOST_RATEMETER value is non-zero.
help = no [boolean: yes|no]
A boolean flag which, when set to yes triggers that the program
prints out a brief on-screen description of all available command line
parameters together with the current program version number and exits
successfully.
EXAMPLES
Run the whole LECS data analysis pipeline starting with the event list
file kv492_rev.fits and log all screen I/O in a file
figaro.log. baryconv shall not be run after stage III: