NAME

ixpeweights -- Calculate event-by-event weights of IXPE event files

USAGE

ixpeweights infile outfile [parameter = < value >]

DESCRIPTION

'ixpeweights' calculates event-by-event track reconstruction weights of IXPE event files. For each event, the module calculates the 'W_MOM' value defined as follows: 'W_MOM'=(('TRK_M2L'-'TRK_M2T')/('TRK_M2L'+'TRK_M2T'))^(0.75) where 'TRK_M2L' is the track length (longitudinal second moment) and 'TRK_M2T' is the track width (transverse second moment) as calculated by 'ixpeevtrecon'.

The 'W_MOM' value, which measures the ellipticity of the track, can be used for a weighted analysis of the Stokes parameters. The computed values are stored in the 'W_MOM' column of the output file.

For more details on the weighed analysis see Di Marco et al. (2022), AJ, Volume 163, Issue 4.

PARAMETERS

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

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

(logFile=ixpeweights.log) [file name]
Name of the weights calculation 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 'W_MOM' 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'. 

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

BUGS

SEE ALSO

LAST MODIFIED

April 2022