NAME

ixpegaincorrpkmap -- Calculate PI column values of IXPE event files

USAGE

ixpegaincorrpkmap infile outfile pkgainfile [parameter = < value >]

DESCRIPTION

'ixpegaincorrpkmap' calculates the Pulse Invariant (PI) values of IXPE event files. For each event the PI values are calculated applying the gain correction coefficients stored in the peak gain map calibration files (input parameter 'pkgainfile'). The PI calculation also takes into account the high voltage correction using information read from the input parameter 'hvgainfile'. The computed values are stored in the 'PI' column of the output file.

PARAMETERS

infile [file name]
Name of the input FITS Event File.

outfile [file name]
Name of the output FITS Event File.

(dvgemcaldb=no) [boolean]
Use VGEM value from CALDB hvgainfile? (yes/no).

pkgainfile [filename]
Name of the input peak gain map calibration file.

(hvgainfile=CALDB) [filename]
Name of the input high voltage calibration file. If set to CALDB (default), use the file in the Calibration Database.

(logFile=ixpegaincorrpkmap.log) [file name]
Name of Temperature Gain Correction log file.

(logTermLvl=1) [integer]
Log Terminal level (0=dbg, 1=info, 2=wrn, 3=error, 4=critical).

(logFileLvl=1) [integer]
Log File level (0=dbg, 1=info, 2=wrn, 3=error, 4=critical).

(clobber=no) [boolean]
If set to yes, overwrite the output file.

EXAMPLES

  1. Calculate the PI values for the input event file 'ixpe00000000_det1_evt1_v01.fits'. The results are written in the output event file 'ixpe00000000_det1_evt1_v01_out.fits'. 

     > ixpegaincorrpkmap infile=ixpe00000000_det1_evt1_v01.fits outfile=ixpe00000000_det1_evt1_v01_out.fits
   pkgainfile=ixpe00000000_det1_pkgainmap.fits

BUGS

SEE ALSO

LAST MODIFIED

May 2022