HEADAS help file for mxevtgti

NAME

mxevtgti

USAGE

mxevtgti filelist rootname detector threshold gap

DESCRIPTION

Generate GTI by scanning input MAXI event files and looking for long gaps between events.

PARAMETERS

filelist [string]: A list of event files. This may be a comma-delimited list, or the name of a text file containing a list of files, one per line, preceded by an '@' character.
rootname [string]: The file name prefix for all output files.
detector [string]: The name of the MAXI detector. Should be one of 'gsc_low', 'gsc_med', or 'ssc' ('ssc_med' is equivalent to 'ssc').
(binwidth = 1) [real] (s): The size of time bins to use in making the field-of-view GTI files. The default setting is 1 second.
threshold [real] (count/s): The minimum threshold event rate. Events found at greater than this rate are included.
gap [real] (s): The minimum interval of time between adjacent events to be considered part of the same scan, in seconds.
(usergti = "NONE") [filename]: Only use events within intervals defined by this file. If set to "NONE" (default), no user GTI file will be used.
(leapsecfile = "REFDATA") [string]: If set to "REFDATA" (default), use the built-in reference file for defining leap seconds. If set to "CALDB", use the reference file in the MAXI calibration database. Otherwise, use the specified file name.
(cleanup = no) [boolean]: Delete temporary files when finished with analysis. When set to no (default), intermediate files will be retained. Default is no.
(clobber = no) [boolean]: Overwrites the existing output file if set to yes. Default is no.
(chatter = 1) [integer]: Sets the amount of output from the code. Values range from 0 (little to no output) to 3 (verbose). Default value of 1 provides basic details as code runs.
(logfile = "!DEFAULT") [string]: Record output from running this tool in a logfile. If set to "DEFAULT", the output logfile will be named 'mxevtgti.log'. If preceded by the "!", any existing file with the same name will be overwritten; otherwise this output will be appended to any existing file.
(history = yes) [boolean]: Records tool parameters in HISTORY keywords if set to yes (default).
(debug = no) [boolean]: If set to yes, the code will provide detailed logging of variables and settings as the code runs. This can be useful when debugging features or deciphering unexpected error conditions. Default is no.
(mode = ql) [string ql|hl|q|h]: Mode to query the parameter file. Acceptable values include: "ql" (query and learn/remember)(default), "hl" (hidden and learn/remember), "q" (query but don't remember), "h" (hidden).

EXAMPLES

Generate MAXI GTI from a list of GSC event files. Look for gaps of at least 10 seconds with bin sizes of 1.0 second with a minimum included rate of >0.99 count/s. Do not keep temporary files, only the final GTIs. Record a log file called "mxevtgti.log", clobbering any existing log file with this name (the default setting for logging)

  mxevtgti filelist=@crab_gsc_files.txt rootname=crab detector=gsc threshold=0.99 gap=10.0 cleanup=yes

where the file 'crab_gsc_files.txt' is a list of event files, one for each GSC camera:

crab_g1.evt
crab_g2.evt
crab_g7.evt
crab_g8.evt

This creates files 'crab_g1_fov.gti', 'crab_g2_fov.gti', 'crab_g7_fov.gti', and 'crab_g8_fov.gti'.

LAST MODIFIED