WFOTFITS --------
FUNCTION Program to extract and process SAX-WFC FOT data
USAGE wfotfits rootname inpdir outdir [options]
DESCRIPTION
Read FOT data either directly from tape or from DISK files previously copied from tape or retrieved by internet. Read and checks the FOT contents. Extract the relevant data into files structured according the FITS standard. Issue warnings about the instrument status and out-of- limit situations. Print an overview of types and times of extracted data. Swap bytes if the data is written according the VAX byte ordering.
PARAMETERS
rootname [string] The name part that prefixes the part that preceedes the 4-digit number of the FOTfile. It is good practice to choose the FOT-ID and some delimiter (e.g. 123456__)
inpdir [string] The name of the directory where the FOT files are located. In case of reading directly from tape this argument is irrelevant (but must be given).
outdir [string] The name of the directory where the resulting data files will be placed. Note that the name has to end with a '/' in case of a unix host.
(minpacks=9) [integer] Required minimal number of science packets that one observation must contain in order to be precessed
(extname=".fot") [string] The extansion part of the input filenames that come after the 4-digit number of the FOTfile.
(outpref="fop_") [string] The part of the all output files that prefixes the program generated name part which starts with a 4-digit observation number. (Cf document on files ....)
(procsite="S.R.O.N.") [string] The processing site will be put in the Primary Header of all resulting FITS-file under the ORIGIN-keyword
(fotscope"="SAX") [string] The placce or institute wher the data is originated will be put in the Primary Header of all resulting FITS-file under the TELESCOP-keyword (in development scope it will be "SAX-LBT")
(swap=no) [string] Specified whether the data is organized according to VAX definition and bytes of words and double-words must be swapped. This will normally the cxase if FOT's were produced produced by the Science Data Centre.
(blockio=yes) [boolean] Option to write output event data files in fast block transfer mode. This may introduce a non-standerd FITS format that cannot be used across different computer systems.
(pseudout=no) [boolean] Enable extraction of Pseudo Events in normal Mode data and write them into a separate FITS file
(minio=1) [integer] Indicates the units in bytes that are written by direct access data transfer to files. For DEC systems this number must be 4.
(calfile1"="..../wfc1.det") [string] The name of the input FITS file that contains the coefficients to calculate the physical values of temperatures and voltages from digitally coded analog value. For a description of the relevant table in this file, see TBD.
(calfile2="..../wfc2.det") [string] Same as for calfile1, only used for SAX WFC-2
(ephfile="-") [string] Pathname of alternative EPHEMERIS auxiliary file
(attfile="-") [string] Pathname of alternative ATTITUDE auxiliary file
(obtfile="-") [string] Pathname of alternative OBT_UTC auxiliary file
(attfile="-") [string] Pathname of alternative ATTITUDE auxiliary file
(fromtape=no) [boolean] If yes the FOT data is read from a tape device.
(tapename="/dev/rmt/0mn") [string] The tape device name is site dependent.
(verbsty=1) [integer] Verbosity volume. The higher the number the more printing 0: is minimal output volume
(testopt=0) [integer] Possible test options (only for testing purposes) 0: is the normal situation 1: extra Reduction Factor breaks will be forced in Normal mode and High Time Resolution mode.
(procmode=1) [integer] Processing mode 0: Only read files do not produce output files. 1: Output all data files
(namemode=1) [integer] name composition option Different ways of composing filenames are obsolete now but may be needed in future again.
(slewopt=yes) [boolean] If this option slew procesing option If 'no' processing of data during slewing periods will be skipped. (only used for test purposes)
(convopt=no) [boolean] If yes the temperatures and voltages in the housekeeping files will be converted to physical values. (only used for testing purposes)
(title=" ") [string] User caption to be tagged to each output FITS file header
(fileseq="1/ON") [string] This string contains the file selection from FOT and is used for including or excluding FOT files The format is "token,token,..." where a token consists of a filenumber and operator separated by a '/'. The operators are: ON : from specified number all files will be processed OF : from specified number all files will be skipped Y : the specified file will be processed in all cases N : the specified file will be skipped in all cases (only used for test purposes)
(fotrev="F2") [string] Denotes the FOT definition level to be used (F1 is out of date now and only used for processing of old simulated FOTs.
(imageopt=no) [boolean] If 'yes' normal mode event data will be accumulated in detector image file. (only for TEST purposes)
NOTES - The program uses the parameter passing of the FTOOLS convention. - Of all data modes the block sequence is checked. Interuptions of such a sequence is reported in the log. Only of the Normal Mode and the High Time Resolution mode the blocksequences and their times are stored separately in a file
EXAMPLES 1. Process complete FOT from tape
--> wfotfits tape=yes swap=yes outdir=/SAXPOOL/ \ outpref=W123456_ calfile1=/SAX_TOP/CAL/wfc1.det calfile2=/SAX_TOP/CAL/wfc2.det
2. Process FOT from disk only the first 7 files
--> wfotfits inpdir=/SAX_POOL/ rootname=SOTLBT__ fileseq=1/ON,8/OF outdir=/SAXPOOL/ \ outpref=WSOTLBT_ calfile1=/SAX_TOP/CAL/wfc1.det calfile2=/SAX_TOP/CAL/wfc2.det
OPEN ISSUES - Documentation of Calibration File input - description of file formats
REMARKS - All produced filenames follow the followoing convention fffff_ ||||||||||||||||||||| FOTID_0005w2phs0.fits (= example filename)
fffff = Any alpha-numeric string, but normally the 6-digit
FOTnumber of the tape.
assigned sequentially by wfotfits. Will be '0000'
for files pertaining to the general FOT information.
w# = wfc camera id (either w1 or w2)
'__' for general FOT data
@ = observation mode (either s = slew or p = pointing)
No distinction for 'initial' or 'final' slew and not
relevant for generakl FOT data.
zz
= instrument/derived contents (The number digits expresses
the level of processing that has been done on the data)
wfotfits only produces raw data resulting in a 0 number
hs0 = housekeeping science
hi0 = housekeeping instrument
rn0 = rate normal
rh0 = rate high
ba0 = background analysis
dr0 = diagnostic reduced
de0 = diagnostic extended
rp0 = pseudo-events [optional with rate normal]
ib0 = packet block info
ib0 = packet block info
ec0 = experiment configureation info
for general files '
0000__eph0 = ephemeris data
0000__att0 = attitude data
0000__utc0 = OBT to UTC conversion date
0000__obs0 = observation survey file
0000w#hit0 = IT housekeeping data
additional files
rn0_gti = GTIs for valid NM event data
rh0_gti = GTIs for valid HTR event data
KNOWN BUGS None
SEE ALSO whkproc, wmakgti, wmrggti, wgtiflt, watproc, wattana, wshift, wslew, wqplot