Source code for hispecdrp.pipelines.calibration.process_detflats_pipeline

import logging

from hispecdrp import datamodels
from ..calibration_pipeline_base import CalibrationPipeline
from ...primitives import (DQInitPrimitive, CheckSaturationPrimitive, NonlinearCorrectionPrimitive,
                           JumpDetectionPrimitive, FitRampPrimitive, DarkSubtractionPrimitive,
                           BiasSubtractionPrimitive, DetectorFlatCorrectionPrimitive, GainCorrectionPrimitive,
                           MakeGainPrimitive, MakeDetectorFlatPrimitive, RegisterCalibrationPrimitive,
                           CoaddFramesPrimitive)
from typing import Sequence

logger = logging.getLogger(__name__)

__all__ = ['ProcessDetFlatsPipeline']


[docs] class ProcessDetFlatsPipeline(CalibrationPipeline): """ Pipeline to process detector flat frames and create master calibrations for detector gain and detector flat. This pipeline applies the following primitives in order: - :class:`~hispecdrp.primitives.dq_init.dqinit_primitive.DQInitPrimitive` - :class:`~hispecdrp.primitives.saturation.saturation_primitive.CheckSaturationPrimitive` - :class:`~hispecdrp.primitives.bias_subtraction.bias_primitive.BiasSubtractionPrimitive` - :class:`~hispecdrp.primitives.nonlinear_correction.nonlin_primitive.NonlinearCorrectionPrimitive` - :class:`~hispecdrp.primitives.jump_detection.jump_detection_primitive.JumpDetectionPrimitive` - :class:`~hispecdrp.primitives.gain.make_gain_primitive.MakeGainPrimitive` - :class:`~hispecdrp.primitives.register_calibration.register_cal_primitive.RegisterCalibrationPrimitive` - :class:`~hispecdrp.primitives.ramp_fitting.ramp_fit_primitive.FitRampPrimitive` - :class:`~hispecdrp.primitives.dark_subtraction.dark_primitive.DarkSubtractionPrimitive` - :class:`~hispecdrp.primitives.gain.gain_primitive.GainCorrectionPrimitive` - :class:`~hispecdrp.primitives.coadd.coadd_frames_primitive.CoaddFramesPrimitive` - :class:`~hispecdrp.primitives.detector_flat.make_detflat_primitive.MakeDetectorFlatPrimitive` - :class:`~hispecdrp.primitives.register_calibration.register_cal_primitive.RegisterCalibrationPrimitive` - :class:`~hispecdrp.primitives.detector_flat.detflat_primitive.DetectorFlatCorrectionPrimitive` Any primitive can be skipped by setting its ``run`` argument to ``False`` when initializing the pipeline. """ PRIMITIVES = { 'dq_init': DQInitPrimitive, 'saturation_check': CheckSaturationPrimitive, 'bias_sub': BiasSubtractionPrimitive, 'nonlin_corr': NonlinearCorrectionPrimitive, 'jump_detec': JumpDetectionPrimitive, 'make_gain': MakeGainPrimitive, 'register_gain_cal' : RegisterCalibrationPrimitive, 'ramp_fit': FitRampPrimitive, 'dark_sub': DarkSubtractionPrimitive, 'gain_corr': GainCorrectionPrimitive, 'coadd': CoaddFramesPrimitive, 'make_detflat': MakeDetectorFlatPrimitive, 'register_det_flat_cal' : RegisterCalibrationPrimitive, 'detflat_corr': DetectorFlatCorrectionPrimitive, } def _perform(self): # Making sure that the input is a list of models for processing if isinstance(self.dataset, (datamodels.DataModel, str)): _input_list = [self.dataset] if isinstance(self.dataset, Sequence): _input_list = self.dataset # First, loop over all inputs to apply DQ init, saturation check, and bias subtraction results = [] logger.info(f"Looping over a list of {len(_input_list)} inputs to apply dq_init, saturation, bias subtraction, and nonlin_corr.") for k, _input in enumerate(_input_list): logger.info(f"Processing input {k+1}/{len(_input_list)}: {_input}") model_to_process = datamodels.open(_input) _result = self.dq_init.apply(model_to_process) _result = self.saturation_check.apply(_result) _result = self.bias_sub.apply(_result) _result = self.nonlin_corr.apply(_result) _result = self.jump_detec.apply(_result) results.append(_result) # Fit gain using all processed inputs gain_result = self.make_gain.apply(results) # Register the detector gain calibration to the calibration database # self.register_gain_cal.apply(gain_result) logger.info(f"Continue loop over inputs to apply ramp_fit, dark, and det_gain.") for k, _result in enumerate(results): logger.info(f"Processing input {k+1}/{len(results)}: {_result}") _result = self.ramp_fit.apply(_result) _result = self.dark_sub.apply(_result) _result = self.gain_corr.apply(_result) results[k] = _result # Get the flat field using all processed inputs. Coadding first. result = self.coadd.apply(results) coadded_rate = result[0] detflat_result = self.make_detflat.apply(coadded_rate) # Register the detector gain calibration to the calibration database # self.register_det_flat_cal.apply(detflat_result) logger.info(f"Continue loop over inputs to apply flat fielding.") for k, _result in enumerate(results): logger.info(f"Processing input {k+1}/{len(results)}: {_result}") _result = self.detflat_corr.apply(_result) results[k] = _result return dict(output=dict(results=results, gain=gain_result, detflat=detflat_result))