HEADAS help file for mxlcraw

NAME

mxlcraw

USAGE

mxlcraw outfile srcevt_list bkgevt_list src_regfile bkg_regfile scancond_list psf_list maskfile

DESCRIPTION

Reads a list of source and background event files, region files, matching scan condition files, point spread function corection factor files, image mask, plus ancilliary data from CALDB, reference data, or user inputs. The output is a FITS file with a table in which all the scan condition information has been combined with exposure, flags for low exposure, correction factors, and with source and background raw counts for each scan and camera computed for each requested energy band. Each row in the table represents a single scan for a single camera. This raw data file is used an input for generating lightcurves and spectra.

PARAMETERS

outfile [filename]: The name of the output FITS file to contain the raw scan data.
srcevt_list [string]: A list of source 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.
bkgevt_list [string]: A list of background 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. Set to "NONE" or blank if no background is used.
src_regfile [string]: The name of the source region file.
bkg_regfile [string]: The name of the background region file. Set to "NONE" or blank if there is no background. Ignored for simulated background.
scancond_list [string]: A list of scan condition 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.
psf_list [string]: A list of point-spread function (PSF) correction factor 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. The point spread function correction factor is the fraction defined by the ratio of the total PSF to the PSF within the source region.
(teldef = "CALDB") [file list]: A list of telescope definition (TELDEF) files. This can be "CALDB" (default), a comma-delimited list, or the name of a text file containing a list of files, one per line, preceded by an '@' character. When set to "CALDB", TELDEF files are obtained from the MAXI calibration database.
(colea = "CALDB") [file list]: A list of files containing the collimator effective area (COLEA) maps for each camera. This can be "CALDB" (default), a comma-delimited list, or the name of a text file containing a list of files, one per line, preceded by an '@' character. When set to "CALDB", COLEA information is obtained from the MAXI calibration database.
attlist [filename]: The name of FITS format attitude list file.
(eband_fname = "REFDATA") [filename]: The name of ASCII format file specifying the energy bands for GSC and SSC processing. If set to REFDATA (default), it will use the standard default settings.
maskfile [filename]: The name of the FITS image file containing image projection plane masks for the source and background regions and FITS keywords to define the total number of pixels in each region.
(efffile = "CALDB") [filename]: The name of the FITS file containing efficiency correction factor values for each PI channel and theta angle based on a model spectrum of the Crab. If set to "CALDB" (default), the file is obtained from the MAXI calibration database. Ignored when processing SSC data.
(simback = no) [boolean]: A flag to indicate if background events are simulated ("yes") or observed ("no"; default). Ignored if there is no background.
(simscal = 10) [integer]: The simulation scale factor used when computing events with mxsim_bgd. Ignored when processing SSC data or when simulated background events were not generated.
(angsepar = 0.3) [real; degrees]: If using observed background, the tolerated difference between the center of the source and background regions when determining if they are concentric. Background regions with centers more than this value offset from the source region center are considered non-concentric. Ignored if there is no background or when using simulated background events.
(hvsel = 0) [integer]: Flag setting for indicating which high voltage settings to include in data. Allowed settings are :
0 (include both 1650 V and 1550 V data) (default);
1 (only include 1650 V data);
2 (only include 1550 V data). Ignored when processing SSC data.
(lowexpo_limit = 20.0) [real; cm^2 s]: Threshold value to set a low exposure flag for any individual camera scan. Default value is 20.0 cm^2 s.
(timegap = 50.0) [real; seconds]: Combine treat multiple intervals as part of a single scan if they are separated by less this threshold. Default is 50.0 seconds.
(use_c1c2 = yes) [boolean]: A flag, set to "yes" (default) or "no", to include anodes C1 and C2 in the analysis of GSC data. Ignored when processing SSC data.
(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]: Determines whether to delete temporary files (yes/[no]).
(clobber = no) [boolean]: Overwrites the existing output file if set to yes (yes/[no]).
(chatter = 1) [integer]: Sets the amount of output from the code. Values range from 0 (little to no output) to 3 (verbose: provides considerable output). 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 'mxlcraw.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 ([yes]/no).
(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 deciphering unexpected error conditions, but not appropriate for routine processing. 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 a MAXI raw data file for observations of the Crab with an observed background. Record output from this task with basic details only, saved to a logfile 'mxlcraw.log'.

mxlcraw outfile=crab_gsc_raw.fits srcevt_list=@crab_gsc_srcevt.list bkgevt_list=@crab_gsc_bkgevt.list \
  src_regfile=crab_src.reg bkg_regfile=crab_bkg.reg scancond_list=@crab_gsc_scancond.list \
  psf_list=@crab_psfcorr.list attlistfile="trend/iatlist.fits" \
  maskfile=crab_gsc_mask.img

where the file 'crab_gsc_srcevt.list' contains a list of source event files such as:

crab_g1_src.evt
crab_g2_src.evt
crab_g7_src.evt
crab_g8_src.evt

and similar for the other ASCII list files (in this example, those with the suffix '.list'). The resulting output file, 'crab_gsc_raw.fits', is a scan-by-scan list of raw counts, correction factors, and data condition flags, used as an input to other MAXI tasks.

LAST MODIFIED