NAME

mxauxlist

USAGE

mxauxlist datapath

DESCRIPTION

Generates lists of files of various MAXI auxiliary data. By default, auxiliary lists are generated for each of ISS attitude (.iat files), GSC housekeeping (_gsc.hk files), and ISS solar panel ancillary joint angles (.isa and .isp files): individual list files may be excluded by setting the relevant input parameter to "NONE".

PARAMETERS

(auxpath=trend) [string]
Destination directory for auxiliary list files. Default is trend. This directory will be created if it does not already exist.

datapath [string]
Path to the MAXI raw event and auxiliary data.

(attlist="NONE") [filename]
MAXI attitude list file, based on values in the .att files. Set to "NONE" if this file is not desired (default).

(iaclist="NONE") [filename]
MAXI attitude list file, based on values in the .iac files. Set to "NONE" if this file is not desired (default).

(iatlist=iatlist.fits) [filename]
MAXI attitude list file, based on values in the .iat files. Set to "NONE" if this file is not desired. Default value is 'iatlist.fits'.

(vclist=vclist.fits) [filename]
GSC housekeeping list file, based on the values in the _gsc.hk auxiliary files. Set to "NONE" if not desired.

(isplist=isplist.fits) [filename]
ISS solar panel angle settings list filename, based on values in the .isp auxiliary files. Set to "NONE" if not desired.

(isalist=isalist.fits) [string]
ISS SARJ (solar ancillary joint angle) file list, based on the values in the .isa auxiliary files. Set to "NONE" if not desired.

(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 any existing output list files if set to yes. Halt if files exist and clobber=no (default).

(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. Note that if the lists are particulary long, this task may take some time: a higher chatter setting may be desirable to track progress.

(logfile="!DEFAULT") [string]
Record output from running this tool in a logfile. If set to DEFAULT, the output logfile will be named 'mxauxlist.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. The default is "!DEFAULT".

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

(debug=no) [boolean]
If set to yes, the code will provide detailed logging of variables and settings as the code runs in considerable detail. 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), "hl" (hidden and learn/remember), "q" (query but don't remember), "h" (hidden).(Optional)

EXAMPLES

Generate the list of auxiliary files found in obs, generating the IAT attitude list (named 'iatlist.fits'), GSC housekeeping ('vclist.fits'), and both sets of solar panel angle files ('isalist.fits' and 'isplist.fits'). Do not generate the IAC and ATT list files. The list files will be written in the directory trend. Halt if any list files are already present (default clobber=no).

  mxtilelist obs attlist=NONE iaclist=NONE

CAVEATS

TIM and CAT file lists are not supported. CAT file lists were deprecated with MAXI raw data processing version 2.7. TIM file lists are not used in any current MAXI processing.

SEE ALSO

mxpipeline, mxtilelist

LAST MODIFIED

July 2025 (mxauxlist v0.211a)