NAME

teleing - the TELEmetry INGestor program for the SAX/LECS

SYNOPSIS

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

DESCRIPTION

teleing converts LECS Direct Mode (DM) and Response Bus (RB) HK packet files into FITS event list and FITS HK files respectively. More specifically, the program accepts input files which conform to either of the following formats:
1. Unprocessed real-time telemetry DM LECS files as they are archived at the SAX SDC.
2. DM and Response Bus HK files generated by the LECS's EGSE

DM input files need to have the extension .drt while RB HK file names have to end in .hkt. For each DM file specified on the command line teleing will create a corresponding event list FITS files conforming to the structure and formats specified in [1]. In addition, the program will attempt to open a packet HK file corresponding to the DM input file and generate a FITS HK file. If the sought packet HK file does not exist, a dummy FITS HK with the same time coverage as the event list file will be created. Dummy in this context means that all HK parameter values in the FITS file will be set to INDEF and the attitude and ephemeris extension will be empty.

Please note: teleing is not meant to be used to process FOTs but rather the real-time LECS files, before they have been reformatted by the FOT production software. Since these files are only available to the LECS hardware group and SDC personnel, teleing should merely be of relevance for this group of expert users.

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.



egsemode = no [boolean: yes|no]

A mode switch specifying which kind of the two above described DM input files is shall be processed. egsemode=yes signifies that the input file(s) stem(s) from the instrument's EGSE. Default is no, i.e., real-time telemetry files are to be decoded.



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".



enghk = no [boolean: yes|no]

If this boolean parameter is set to "yes" teleing will for each specified input DM file also search for a corresponding engineering HK file, scan through it, and display all time stamps in the secondary headers. This can be used to detect erroneous time stamps in secondary headers of RB HK files (see Sect. 10.3.8.2 in [2] for more information about this problem).



survey = no [boolean: yes|no]

This boolean switch determines whether the program shall stop after the input file has been inspected for the total accumulation time and possible data integrity errors (see parameter errorcheck 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". The error and warning messages that might result from a run with error checking enabled should be self-explanatory, they require a solid understanding of the structure of LEGSPC Direct Mode and HK files, though. For details on this please refer to [2].



origin = "-" [string]

Value of FITS header keyword ORIGIN. "-" means to use an installation dependant default value - teleing help=yes shows this default value.



obs_mode = "CALIBRATION" [string]

Value of FITS header keyword OBS_MODE.



observer = "-" [string]

Value of FITS header keyword OBSERVER. "-" means to use an installation dependant default value - teleing help=yes shows this default value.



obs_id = "-" [string]

Value of FITS header keyword OBS_ID. "-" means to use an installation dependant default value - teleing help=yes shows this default value.



tape_id = "-" [string representing an integer >=1 or "-"]

Value of FITS header keyword TAPE_ID. "-" means to use an installation dependant default value - teleing help=yes shows this default value.



obs_no = 1 [integer]

Value of FITS header keyword OBS_NO. Default is 1.



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 with default values and the current program version number.

EXAMPLES

1. Convert the real-time Direct Mode files 2a2_q_10.drt and 2a2_q_11.drt and the corresponding HK file 2a2_q_10.hkt and 2a2_q_11.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:

       teleing "2a2_q_10.drt 2a2_q_11.drt" yrev+ errorcheck+
               indirpath=/sax/data/eqm2:/sax/data/fs:/sax/data/pfm
   

FURTHER DOCUMENTATION

1. The SAX LECS Data Analysis System - Software User Manual,
   U. Lammers, Doc. SAX/LEDA/0010
2. SAX LEGSPC User Manual, Arvind Parmar,Doc. SX-UM-ES-001

BUGS

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

SEE ALSO

foting