NAME

egseing - the EGSE INGestor program for the SAX/LEGSPC

SYNOPSIS

egseing [infiles=] <filelist> [parameter=value ...]

DESCRIPTION

egseing is a conversion program to process packet data files created with the LEGSPC EGSE and convert them into FITS format. In the case of Direct Mode data, two output files are actually generated, viz., a FITS event list and a corresponding HK file, the structure and format of which is identical to those created with the FOT ingestor foting - see the document LEDA0002 for details.
For each EGSE packet file specified on the command line the following steps are performed:
1. Identification of the file type
2. Initial scan of the file
3. ...

PARAMETERS

The following command line parameters are recognized by the program:

infiles = "" [string]

This is a blank or colon separated list of files to convert to FITS format. The name extension of each file is used to derive the type of the file. Valid extensions are: .drt (Direct Mode), .spt (Spectrum Mode), .imt (Image Mode), .hkt (RB HK Data), .ent (Engineering HK Data), and .mmt (Memory Dump Data). For Direct-Mode data, the names of the two FITS output files are derived from the input file name, i.e. the events file will get a suffix _rev.fits (for Raw EVents) whilst the name of the FITS HK file will have a suffix _rhk.fits (for Raw HouseKeeping).



indirpath = "" [string]

A colon separated list of directories to seek for the specified input files. For each file given in infiles this is performed by first attempting to open the file as specified in infiles. If this fails, each directory component in indirpath is inspected for the location of the desired input file.



outdir = "=" [string]

The destination directory for the FITS output files. If "=" is specified for outdir (the default), the output files are written to the directory where the corresponding input file was found.



verbosity = 2 [integer: 0|1|2|3]

Specifies the program verbosity level, i.e. the amount of screen output that will be issued during program execution. Level 0 means "mute", only fatal error messages will be printed. Verbosity level 3 results into detailed diagnostic messages. Default is level 1.



help = no [boolean: yes|no]

Display a brief on-screen description of all available command line parameters together with the current program version number.



selectevents = no [boolean: yes|no]

If set to yes, the program prompts for an event selection time interval. The default is "no" which means that all events contained in the input file will be considered for the output.



caldb = no [boolean: yes|no]

If set to yes, the created FITS files are eligible for inclusion into the SAX/LEGSPC calibration database. In this case, the primary FITS headers of the output files contain the mandatory keywords for FITS calibration files. Default is "no".



nohk = no [boolean: yes|no]

If set to yes, the generation of a HK FITS file is suppressed. Default is "no".



survey = no [boolean: yes|no]

This boolean switch triggers whether the program should stop after the input file has been inspected for the total accumulation time and possible data integrity errors (see below). In this case, no output FITS file will be created. Default is "no".



xreverse/yreverse = no [boolean: yes|no]

Switches to trigger the mirroring of X/Y event detection coordinates. Default is "no".



errorcheck = no [boolean: yes|no]

If set to yes, the program inspects the input packet file for data integrity errors (such as errors in the initial and final time stamps of packet headers or block sequence count errors) and prints a summary of detected problems at the end. Default is "no".



origin = "SSD" [string]

Value of FITS header keyword ORIGIN.



obs_mode = "CALIBRATION" [string]

Value of FITS header keyword OBS_MODE.



observer = "SSD, SAX-TEAM" [string]

Value of FITS header keyword OBSERVER.



obs_id = "00000001" [string]

Value of FITS header keyword OBS_ID.



tape_id = 1 [integer: >=1]

Value of FITS header keyword TAPE_ID.



obs_no = 1 [integer]

Value of FITS header keyword OBS_NO. Default is 1.

EXAMPLES

1. Convert the Direct Mode files sample1.drt and sample2.drt and the corresponding HK file sample1.hkt and sample2.hkt, respectively, into FITS format. The directories /sax/data/eqm2, /sax/data/fs, as well as /sax/data/pfm are considered as possible locations for the input files. The FITS output files shall be written to the directories where the corresponding input files were found. Detector Y coordinates shall be mirrored and the input files shall be inspected for data integrity errors:

       egseing "sample1.drt sample2.drt" yrev+ errorcheck+
               indirpath=/sax/data/eqm2:/sax/data/fs:/sax/data/pfm
   

FURTHER DOCUMENTATION

1. Contents and structures of event and HK files in the SAX/LEGSPC data analysis system,
   U. Lammers and M. Busetta, Doc. SAX/LEDA/0002
2. SAX LEGSPC User Manual, A. Parmar, ESA/SSD, Issue 8.0

BUGS

• The decoding of Spectrum, Image, and Memory Dump data is not supported
• In case of Engineering HK packet files, merley an integrity check of the time stamps in the secondary header is performed.

SEE ALSO

foting