hispecdrp.primitives.gain.gain_primitive

Functions

_gain_correction_numba(input_rate, ...)

gain_correction(input_rate, input_err, ...)

Apply detector gain correction to 2D rate image.

Classes

GainCorrectionPrimitive([dataset, config, ...])

Convert rate maps from DN/s to electrons/s using the gain calibration.

class GainCorrectionPrimitive(dataset=None, config=None, context=None, log_config=None, parent=None, **kwargs)[source]

Bases: BasePrimitive

Convert rate maps from DN/s to electrons/s using the gain calibration.

The conversion is performed by multiplying the input data and error arrays by the per-pixel gain values provided in the gain calibration file, which are expressed in units of e-/DN.

Parameters:
  • dataset (str or RampModel) – Input file path or data model to process. This is expected to be a level 0 (rate map) data product.

  • suffix (str or None, optional) – Suffix to append to the output filename. Default is 'gaincorr'.

Calibrations:

gain (GainModel) –

Returns:

output (DataModel) – Data model with values and uncertainties converted to units of electrons.

gain_correction(input_rate, input_err, input_dq, gain, gain_err, gain_dq, max_cores=1)[source]

Apply detector gain correction to 2D rate image.

Parameters:
  • input_rate (np.ndarray) – 2D array of input rates.

  • input_err (np.ndarray) – 2D array of input rate errors.

  • input_dq (np.ndarray) – 2D array of input data quality flags.

  • gain (np.ndarray) – 2D array of gain values.

  • gain_err (np.ndarray) – 2D array of gain errors.

  • gain_dq (np.ndarray) – 2D array of gain data quality flags.

  • max_cores (int, optional) – Maximum number of CPU cores to use for parallel processing. Default is 1.

Returns:
  • input_rate (np.ndarray) – Gain-corrected rate array.

  • input_err (np.ndarray) – Updated rate error array.

  • input_dq (np.ndarray) – Updated data quality flags array.