NAME

ixpeflagbgd -- Flags background events in a Level 1 events file

USAGE

ixpeflagbgd.py infile outfile [use_num_pix] [use_efrac] [use_border_pix] [clobber]

DESCRIPTION

ixpeflagbgd uses three techniques to remove background, as described in A. Di Marco et al., AJ 165, 143 (2023) https://iopscience.iop.org/article/10.3847/1538-3881/acba0f. The three techniques use (a) the number of triggered pixels (NUM_PIX) in an event sub-image as a function of event energy, (b) the fraction of the event energy (EVT_FRA) that is contained in the main pixel cluster as a function of energy, and (c) the number of triggered pixels on the edge of the event sub-image (TRK_BORD). Events are flagged as background by setting the 8th bit (0x0100) of the STATUS2 column value for the given row (event) in the EVENTS HDU of the output event file.

By default, all three techniques are used by running ixpeflagbgd with only the name of the input Level 1 event file name (infile) and the name of the output Level 1 event file with background events flagged (outfile). The user can control the use of the background rejection technique with boolean flags for the NUM_PIX (use_num_pix), the EVT_FRA (use_efrac), and the TRK_BORD (use_border_pix) techniques.

PARAMETERS

infile* (str)
Input Level 1 FITS file.

outfile* (str)
Output Level 1 FITS file with background flagged.

use_num_pix
Use the number of triggered event pixels (NUM_PIX) to reject background? (default: yes)

use_efrac
Use the fraction of event energy in the main cluster (EVT_FRA) to reject background? (default: yes)

use_border_pix
Use the number of triggered border pixels (TRK_BORD) to reject background? (default: yes)

clobber
Overwrite existing output file? (default: no)

EXAMPLES

BUGS

SEE ALSO

LAST MODIFIED

Jul 2024