NAME

ixpeadjmod -- Remove spurious modulation of IXPE event files

USAGE

ixpeadjmod infile outfile [parameter = < value >]

DESCRIPTION

'ixpeadjmod' corrects the 'DETQ' and 'DETU' columns for the spurious instrumental signal known as spurious modulation. The algorithm makes use of the spatial and energy correction coefficients stored in the spurious modulation calibration file (input parameter 'spmodfile'). As a first step, for each single event, the module calculates the spurious modulation correction coefficients applying a linear interpolation in energy. These interpolated coefficients are then subracted from the 'DETQ' and 'DETU' values of the input event file. The new values of the Stokes parameters are written in the 'DETQ' and 'DETU' of the output event file. Optionally, by setting the input parameter 'writedetqucols' to 'yes', the original values of the Stokes parameters are written in the 'DETQ_ORIG' and 'DETU_ORIG' columns in the output event file.

For more details on the spurious modulation calibration and correction see Rankin et al. (2022), AJ, Vol. 163, p. 39.

PARAMETERS

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

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

(spmodfile=CALDB) [filename]
Name of the spurious modulation calibration file or NONE. If set to CALDB (default), use the file in the Calibration Database.

(writedetqucols=no) [boolean]
Write original values of 'DETQ' and 'DETU' columns in the output event file (columns 'DETQ_ORIG' and 'DETU_ORIG')

(logFile=ixpeadjmod.log) [file name]
Name of the adjustment modulation 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. Corrects the 'DETQ' and 'DETU' columns for the spurious modulation 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'. 

     > ixpeadjmod infile=ixpe00000000_det1_evt1_v01.fits outfile=ixpe00000000_det1_evt1_v01_out.fits

BUGS

SEE ALSO

LAST MODIFIED

February 2022