irs2_flag_saturation
- jwst.saturation.saturation.irs2_flag_saturation(output_model, ref_model, n_pix_grow_sat, use_readpatt, bias_model=None)[source]
Apply saturation flagging for NIRSpec IRS2 mode data.
For NIRSPEC IRS2 mode only, apply flagging for saturation based on threshold values stored in the saturation reference file and A/D floor based on testing for 0 DN values. For A/D floor flagged groups, the DO_NOT_USE flag is also set.
- Parameters:
- output_model
RampModel The input science data to be corrected
- ref_model
SaturationModel Saturation reference file data model
- n_pix_grow_satint
Number of layers of pixels adjacent to a saturated pixel to also flag as saturated (i.e., ‘1’ will flag the surrounding 8 pixels) to account for charge spilling.
- use_readpattbool
Use grouped read pattern information to assist with flagging
- bias_model
SuperBiasModelor None, optional Superbias reference file data model.
- output_model
- Returns:
- output_model
RampModel Data model with saturation, A/D floor, and do not use flags set in the GROUPDQ array
- output_model