NAME

mxtilelist

USAGE

mxtilelist datapath detector ra dec radius mjdstart mjdstop

DESCRIPTION

Generates an ASCII list of all MAXI raw data tile files within a date range and radius from a sky location for a given MAXI instrument. Assumes 'datapath' is the top level directory under which all the files are stored in the standard MAXI structure of subdirectories.

PARAMETERS

datapath [string]
Path to the raw tile data.

detector [string]
The name of the MAXI detector. Should be one of "gsc_low", "gsc_med", or "ssc" ("ssc_med" is also accepted and is equivalent to "ssc").

ra [real] (J2000; degrees)
Right ascension of the sky search location.

dec [real] (J2000; degrees)
Declination of the sky search location.

radius [real] (degrees)
Search radius around the sky location.

mjdstart [integer]
Modified Julian Date for start of data search. The earliest possible date for MAXI is 55046 (2009-08-03). If dates are requested that are not found in the local datapath, they will not be included.

mjdstop [integer]
Modified Julian Date to end data search. Data on this day is included if found in datapath.

(outfile = "evt_tile.list") [filename]
Output file list name. Default is set to "evt_tile.list".

(cleanup = no) [boolean]
Determines whether to delete temporary files. When set to no (default), intermediate files will be retained. NOTE: this features is not implimented in this tool.

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

(logfile = "NONE") [string]
Record output from running this tool in a logfile. If set to DEFAULT, the output logfile will be named "mxtilelist.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. No log file made if set to NONE (default).

(history = no) [boolean]
Records tool parameters in HISTORY keywords if set to yes. NOTE: this feature not implimented in this tool.

(debug = no) [boolean]
If set to yes, the code will provide detailed logging of variables and settings. This can be useful when debugging features in the code or deciphering unexpected error conditions. Default is no.

(mode=ql) [string ql|hl|q]
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 a list of MAXI event tiles saved in the directory ./obs (structured in the standard fashion for MAXI archives) for GSC_LOW between MJD 55200 and 55204 (start of 2010-01-04 - end of 2010-01-07) in an 8 degree search radius around the Crab, (at RA 83.6287 Dec 22.0147 (degrees; J2000) and write this list to the file 'crab_tilelist.txt'.

  mxtilelist ./obs gsc_low 83.6287 22.0147 8.0 55200 55204 crab_tilelist.txt 

SEE ALSO

mxpipeline, mxauxlist

LAST MODIFIED

July 2025 (mxtilelist v0.2a)