NAME

USAGE

DESCRIPTION

'sxspixgti' creates GTI for each SXS pixel. The tool also creates a file necessary to run the tool 'ahexpmap'.

There are two input files, with a minimum of one required: an MKF and/or a GTI lost file.

If the MKF file is set to NONE, the GTI lost file must be input and vice-versa. Both can simultaneously be input.

The outfile is created using the input MKF and/or GTI lost file and an optional GTI file (see gtifile, typically the MXS GTI).

If gtilost is input, the GTILOST (DETNAM=PIXEL) extension is extracted per pixel and inverted using gtiinvert is used for GTI creation.

The mkffile, gtilost and gtifile are used as input into 'ahgtigen' and is run once per SXS pixel (36 times). The label parameter is used in 'ahgtigen' with the CALDB selectfile to calculate GTI from the mkffile. By default label is set to PIXELEXP##, where ## is replaced with a pixel number, e.g. PIXELEXP00, PIXELEXP01, etc. The final outfile has 36 GTI extensions, one for each SXS pixel. The extensions for each pixel are named GTIPIXnn, e.g. GTIPIX00, GTIPIX01, etc.

The outpixfile has two GTI extensions: GTIPIXEL and GTIPIXELOFF. The GTIPIXEL extension contains the 'good' GTI calculated from 'ahgtigen' with all 36 extensions merged into a single extension and an additional PIXEL column. If no gtilost file is input, then the output GTI contains lost events and the output column names are GTIPIXLnn, GTIPIXELL and GTIPIXELLOFF.

The GTIPIXELOFF extension in outpixfile is the 'bad' GTI used in the 'ahexpmap' tool. This is calculated using 'gtiinvert' on the individual pixel GTIs from 'ahgtigen' and merged into a single extension with a PIXEL column added.

Both GTIPIXEL and GTIPIXELOFF are sorted by START then STOP then PIXEL and finally 'coordevt' is run to calculate coordinates up to FOC.

Additional parameters for ahgtigen are adjustable.

PARAMETERS

mkffile [filename]

Input MKF file

outfile [filename]

Output 36-ext GTI file

outpixfile [filename]

Output merged pixel GTI file

selectfile [string]

Input expression file

(gtilost = NONE) [filename]

Input GTI lost file (or NONE)

(label = PIXELEXP##) [string]

Screening expression label in labelfile (## replaced with pixel number)

(gtiexpr = NONE) [string]

Additional GTI expression (or NONE)

(gtifile = NONE) [filename]

Input GTI file (or NONE)

(mergegti = AND) [string]

Merge mode (OR, [AND])

(upkeyword = yes) [boolean]

Update timing keywords ([yes],no)

(leapsecfile = REFDATA) [string]

Input leap second file (or CALDB, [REFDATA])

(instarts = START) [string]

Input column with GTI start times

(instops = STOP) [string]

Input column with GTI stop times

(time = TIME) [string]

Input column with HK parameter times

(outstart = START) [string]

Output column with GTI start times

(outstop = STOP) [string]

Output column with GTI stop times

(prefr = 0.) [real]

Pre-time interval factor [0,1]

(postfr = 1.) [real]

Post-time interval factor [0,1]

(teldeffile = CALDB)[string]

Name of the Telescope Definition (TelDef), specifying the coordinate systems and transformation properties. If the parameter is set to CALDB, the default, a TelDef file for the telescope and SXS is read from the calibration database.

(cleanup = yes) [boolean]

Delete temporary files ([yes]/no)

(clobber = no) [boolean]

Overwrites the existing output file if set to yes (yes/[no]).

(chatter = 1) [integer]

Chatter level for output. Set to 0 to suppress output, or to 1, 2, or 3 for increasing the chatter of the output.

(logfile = !DEFAULT) [string]

Log filename. If set to DEFAULT uses the name of the task and, if preceded by '!', overwrite the file if it exists. If set to NONE no log file is created.

(debug = no) [boolean]

Diagnostic output is printed out on the screen if set to yes (yes/[no]).

(history = yes) [boolean]

Records tool parameters in HISTORY ([yes]/no).

(mode = ql) [string ql|hl|q]

Mode to query the parameter file. Acceptable values include: 'ql' (query and learn/remember), 'hl' (hidden and learn/remember), 'q' (query but don't remember)\ , 'h' (hidden).

EXAMPLES

1. The following command will calculate GTI for SXS pixels using the selection file in CALDB and the default label of PIXELEXP##:

   sxspixgti mkffile=in.mkf outfile=sxs_pixels.gti outpixfile=sxs_pxexpo.gti selectfile=CALDB

NOTES

None, but see help for individual parameters above.

SEE ALSO

ahgtigen mxsgti

LAST MODIFIED

March 2016