hispecdrp.primitives.dark_subtraction.dark_primitive
Functions
|
|
|
Subtract the dark current rate from the input rate. |
Classes
|
Subtract the dark current from the input data. |
- class DarkSubtractionPrimitive(dataset=None, config=None, context=None, log_config=None, parent=None, **kwargs)[source]
Bases:
BasePrimitiveSubtract the dark current from the input data.
This primitive applies the appropriate dark calibration to the input data product. The dark frame is subtracted from the science data, the associated uncertainties are propagated by adding errors in quadrature, and data quality (DQ) flags are combined using a bitwise OR.
- Parameters:
dataset (str or L0Model) – Input file path or data model to process. Currently, 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
'darksub'.max_cores (int, optional) – Maximum number of CPU cores to use for Numba parallel processing. Default is 1.
- Calibrations:
dark (DarkModel) –
selector:
DarkSelector
- Returns:
output – The dark-subtracted data model with updated error and data quality arrays.
- dark_subtraction_rate(input_rate, input_err, input_dq, dark_rate, dark_err, dark_dq, max_cores=1)[source]
Subtract the dark current rate from the input rate. Input and dark rates are DN/s. The error arrays are added in quadrature. The data quality arrays are combined with a bitwise OR. The corrections are done in-place. Dark should be corrected before gain correction.
- Parameters:
input_rate (np.ndarray) – 2D array of rate values (DN/s)
input_err (np.ndarray) – 2D array of error values (DN/s)
input_dq (np.ndarray) – 2D array of data quality flags
dark_rate (np.ndarray) – 2D array of dark rate values (DN/s)
dark_err (np.ndarray) – 2D array of dark error values (DN/s)
dark_dq (np.ndarray) – 2D array of dark data quality flags
max_cores (int) – Maximum number of CPU cores to use for parallel processing.
- Returns:
input_rate (np.ndarray) – Dark-subtracted rate array (modified in place)
input_err (np.ndarray) – Updated error array (modified in place)
input_dq (np.ndarray) – Updated data quality array (modified in place)