HEADAS help file for mxlcurve

NAME

mxlcurve

USAGE

mxlcurve infile outfile binsize

DESCRIPTION

Read a raw scan data file and create a lightcurve file with multiple extensions for each of (in order):

a lightcurve in each requested energy band with each bin being a single scan;
hardness ratio lightcurve(s) for the above, if there are two or more energy bands;
binned lightcurves in each requested energy band;
hardness ration lightcurve(s) for the binned lightcurve.

Up to three energy bands are supported. Hardness ratios are not computed if there is only one band, a single ratio (hard/soft) for two energy bands, and three ratios (medium/soft, hard/soft, and hard/medium, in respective order) if there are three energy bands.

The lightcurves are given with time units in modified julian date (MJD).

PARAMETERS

infile [filename]: The input raw scan data file.
outfile [filename]: The name of the output FITS file with all lightcurves.
lcbin [real] (days): The size of the bins to use when making binned lightcurve 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. If set to DEFAULT, the output logfile will be named “mxlcurve.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 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 MAXI lightcurve with 1.0 day size bins from the raw scan data file 'crab_gsc_raw.fits'. Use the built-in reference data for setting leap seconds when converting times from mission elapsed time (in the raw scan data file) to MJD.

mxlcurve infile=crab_gsc_raw.lc outfile=crab_gsc_binned.lc lcbin=1.0 leapsecfile=REFDATA

LAST MODIFIED