NAME

mxpsfcorr

USAGE

mxpsfcorr psfevtfile regfile outfile minchan maxchan

DESCRIPTION

Read a simulated point spread function (PSF) event file and generate a (temporary) version of the same filtered by the region file. Record the number of events found in each interval as defined by the GTI extension of the input PSF file, and compute the ratio of these, writing the results to a FITS file. Only include events which fall inside the specified minimum and maximum PI channels.

PARAMETERS

psfevtfile [filename]
The input PSF event file.

regfile [filename]
A standard ds9-compatible region file.

outfile [filename]
The output FITS file.

minchan [integer]
The lowest PI channel number to include in the PSF calculations.

maxchan [integer]
The highest PI channel number to include in the PSF calculations.

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

(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 point spread correction factor file from a input simulated PSF event file and region file for data between PI channels 40 and 400. Record limited terminal output to a log file 'mxpsfcorr.log'. 

mxpsfcorr crab_g8_psf.evt crab_src.reg crab_g8_src_psf.fits minchan=40 maxchan=400 chatter=1 logfile="\!DEFAULT"

The output will be a FITS file named "crab_g8_src_psf.fits" with a single binary table with five columns:

  1. START
  2. STOP
  3. EVT
  4. EVT_SRC
  5. PSFCORR
in which the column EVT contains the number of events within the time interval defined by START and STOP found in the input file "crab_g8_psf.evt" between PI channels 40 and 400, EVT_SRC is the number of these events within the area defined by the input region file "crab_src.reg", and PSFCORR contains the ratio of EVT_SRC / EVT.

SEE ALSO

mxpipeline, mxsim_psf, mxlcraw

LAST MODIFIED

August 2025 (mxpsfcorr v0.4b)