3.1.1. addDQ

Add a DQ extension to the input AstroData objects.

The value of a pixel in the DQ extension will be the sum of the following: (0=good, 1=bad pixel (found in bad pixel mask), 2=pixel is in the non-linear regime, 4=pixel is saturated). This primitive will trim the BPM to match the input AstroData object(s).

3.1.1.1. Parameters

adinputslist of AstroData

Input AstroData objects with no DQ extension.

suffix: str

suffix to be added to output files

static_bpm: str

Name of bad pixel mask (“default” -> use default from look-up table) If set to None, no static_bpm will be added.

user_bpm: str

Name of the bad pixel mask created by the user from flats and darks. It is an optional BPM that can be added to the static one.

illum_mask: bool

add illumination mask?

3.1.1.2. Returns

adinputs : list of AstroData objects with a DQ extension added to them

3.1.1.3. Parameter defaults and options

suffix               '_dqAdded'           Filename suffix
illum_mask           None                 Name of illumination mask
static_bpm           'default'            Static bad pixel mask
user_bpm             None                 User bad pixel mask
add_illum_mask       False                Apply illumination mask?

3.1.1.4. Algorithm

Todo

add description

3.1.1.5. Issues and Limitations

Todo

add description