dkist-processing-dlnirsp 0.32.2__py3-none-any.whl → 0.32.4__py3-none-any.whl

dkist_processing_dlnirsp/models/fits_access.py

@@ -0,0 +1,32 @@
+"""DLNIRSP control of FITS key names and values."""
+
+from enum import StrEnum
+
+from dkist_processing_common.models.fits_access import MetadataKey
+
+
+class DlnirspMetadataKey(StrEnum):
+    """Controlled list of names for FITS metadata header keys."""
+
+    crpix_1 = "CRPIX1"
+    crpix_2 = "CRPIX2"
+    modulator_spin_mode = "DLMOD"
+    camera_readout_mode = "DLCAMSMD"
+    num_frames_in_ramp = "DLCAMNS"
+    current_frame_in_ramp = "DLCAMCUR"
+    arm_id = "DLARMID"
+    camera_sample_sequence = "DLCAMSSQ"
+    polarimeter_mode = "DLPOLMD"
+    number_of_modulator_states = "DLNUMST"
+    modulator_state = "DLSTNUM"
+    num_mosaic_repeats = "DLMOSNRP"
+    mosaic_num = "DLCURMOS"
+    num_X_tiles = "DLNSSTPX"
+    X_tile_num = "DLCSTPX"
+    num_Y_tiles = "DLNSSTPY"
+    Y_tile_num = "DLCSTPY"
+    num_dither_steps = "DLDMODE"
+    dither_step = "DLCURSTP"
+    arm_position_mm = "DLARMPS"
+    grating_position_deg = "DLGRTAN"
+    grating_constant_inverse_mm = "DLGRTCN"

dkist_processing_dlnirsp/parsers/dlnirsp_l0_fits_access.py

@@ -3,6 +3,8 @@
 from astropy.io import fits
 from dkist_processing_common.parsers.l0_fits_access import L0FitsAccess
 
+from dkist_processing_dlnirsp.models.fits_access import DlnirspMetadataKey
+
 
 class DlnirspRampFitsAccess(L0FitsAccess):
     """
@@ -30,12 +32,18 @@ class DlnirspRampFitsAccess(L0FitsAccess):
     ):
         super().__init__(hdu=hdu, name=name, auto_squeeze=auto_squeeze)
 
-        self.modulator_spin_mode: str = self.header["DLMOD"]
-        self.camera_readout_mode: str = self.header.get("DLCAMSMD", "DEFAULT_VISIBLE_CAMERA")
-        self.num_frames_in_ramp: int = self.header.get("DLCAMNS", -99)
-        self.current_frame_in_ramp: int = self.header.get("DLCAMCUR", -88)
-        self.arm_id: str = self.header["DLARMID"]
-        self.camera_sample_sequence: str = self.header.get("DLCAMSSQ", "VISIBLE_CAMERA_SEQUENCE")
+        self.modulator_spin_mode: str = self.header[DlnirspMetadataKey.modulator_spin_mode]
+        self.camera_readout_mode: str = self.header.get(
+            DlnirspMetadataKey.camera_readout_mode, "DEFAULT_VISIBLE_CAMERA"
+        )
+        self.num_frames_in_ramp: int = self.header.get(DlnirspMetadataKey.num_frames_in_ramp, -99)
+        self.current_frame_in_ramp: int = self.header.get(
+            DlnirspMetadataKey.current_frame_in_ramp, -88
+        )
+        self.arm_id: str = self.header[DlnirspMetadataKey.arm_id]
+        self.camera_sample_sequence: str = self.header.get(
+            DlnirspMetadataKey.camera_sample_sequence, "VISIBLE_CAMERA_SEQUENCE"
+        )
 
 
 class DlnirspL0FitsAccess(L0FitsAccess):
@@ -64,24 +72,28 @@ class DlnirspL0FitsAccess(L0FitsAccess):
     ):
         super().__init__(hdu=hdu, name=name, auto_squeeze=auto_squeeze)
 
-        self.crpix_1: float = self.header["CRPIX1"]
-        self.crpix_2: float = self.header["CRPIX2"]
-        self.arm_id: str = self.header["DLARMID"]
-        self.polarimeter_mode: str = self.header["DLPOLMD"]
-        self.number_of_modulator_states: int = self.header["DLNUMST"]
-        self.modulator_state: int = self.header["DLSTNUM"]
-        self.num_mosaic_repeats: int = self.header["DLMOSNRP"]
-        self.mosaic_num: int = self.header["DLCURMOS"]
-        self.num_X_tiles: int = self.header["DLNSSTPX"]
-        self.X_tile_num: int = self.header["DLCSTPX"]
-        self.num_Y_tiles: int = self.header["DLNSSTPY"]
-        self.Y_tile_num: int = self.header["DLCSTPY"]
+        self.crpix_1: float = self.header[DlnirspMetadataKey.crpix_1]
+        self.crpix_2: float = self.header[DlnirspMetadataKey.crpix_2]
+        self.arm_id: str = self.header[DlnirspMetadataKey.arm_id]
+        self.polarimeter_mode: str = self.header[DlnirspMetadataKey.polarimeter_mode]
+        self.number_of_modulator_states: int = self.header[
+            DlnirspMetadataKey.number_of_modulator_states
+        ]
+        self.modulator_state: int = self.header[DlnirspMetadataKey.modulator_state]
+        self.num_mosaic_repeats: int = self.header[DlnirspMetadataKey.num_mosaic_repeats]
+        self.mosaic_num: int = self.header[DlnirspMetadataKey.mosaic_num]
+        self.num_X_tiles: int = self.header[DlnirspMetadataKey.num_X_tiles]
+        self.X_tile_num: int = self.header[DlnirspMetadataKey.X_tile_num]
+        self.num_Y_tiles: int = self.header[DlnirspMetadataKey.num_Y_tiles]
+        self.Y_tile_num: int = self.header[DlnirspMetadataKey.Y_tile_num]
         # DLDMODE is a bool in the header; the number of dither steps is either 1 or 2, corresponding to dither
         # mode being True or False, respectively
-        self.num_dither_steps: int = int(self.header["DLDMODE"]) + 1
+        self.num_dither_steps: int = int(self.header[DlnirspMetadataKey.num_dither_steps]) + 1
         # Same with DLCURSTP. We'll index the dither loop at 0 so `False` is the first step and `True` is the second
         # Use `get` because this key only exists if DLDMODE is `True`
-        self.dither_step: int = int(self.header.get("DLCURSTP", False))
-        self.arm_position_mm: float = self.header["DLARMPS"]
-        self.grating_position_deg: float = self.header["DLGRTAN"]
-        self.grating_constant_inverse_mm: float = self.header["DLGRTCN"]
+        self.dither_step: int = int(self.header.get(DlnirspMetadataKey.dither_step, False))
+        self.arm_position_mm: float = self.header[DlnirspMetadataKey.arm_position_mm]
+        self.grating_position_deg: float = self.header[DlnirspMetadataKey.grating_position_deg]
+        self.grating_constant_inverse_mm: float = self.header[
+            DlnirspMetadataKey.grating_constant_inverse_mm
+        ]

dkist_processing_dlnirsp/parsers/task.py

@@ -1,15 +1,11 @@
 """Custom parsers to identify task sub-groupings not captured by a single header key."""
 
-from typing import Callable
-
-from dkist_processing_common.models.flower_pot import SpilledDirt
+from dkist_processing_common.models.fits_access import MetadataKey
 from dkist_processing_common.models.tags import StemName
 from dkist_processing_common.models.task_name import TaskName
-from dkist_processing_common.parsers.near_bud import NearFloatBud
 from dkist_processing_common.parsers.single_value_single_key_flower import (
     SingleValueSingleKeyFlower,
 )
-from dkist_processing_common.parsers.unique_bud import UniqueBud
 
 from dkist_processing_dlnirsp.parsers.dlnirsp_l0_fits_access import DlnirspL0FitsAccess
 
@@ -41,7 +37,7 @@ class DlnirspTaskTypeFlower(SingleValueSingleKeyFlower):
     """Flower to find the DLNIRSP task type."""
 
     def __init__(self):
-        super().__init__(tag_stem_name=StemName.task.value, metadata_key="ip_task_type")
+        super().__init__(tag_stem_name=StemName.task.value, metadata_key=MetadataKey.ip_task_type)
 
     def setter(self, fits_obj: DlnirspL0FitsAccess):
         """

dkist_processing_dlnirsp/parsers/time.py

@@ -2,6 +2,7 @@
 
 from typing import Hashable
 
+from dkist_processing_common.models.fits_access import MetadataKey
 from dkist_processing_common.models.flower_pot import Stem
 from dkist_processing_common.models.task_name import TaskName
 from dkist_processing_common.parsers.unique_bud import TaskUniqueBud
@@ -17,7 +18,7 @@ class DLnirspSolarGainIpStartTimeBud(TaskUniqueBud):
     def __init__(self):
         super().__init__(
             constant_name=DlnirspBudName.solar_gain_ip_start_time.value,
-            metadata_key="ip_start_time",
+            metadata_key=MetadataKey.ip_start_time,
             ip_task_types=TaskName.solar_gain.value,
             task_type_parsing_function=parse_header_ip_task,
         )

dkist_processing_dlnirsp/parsers/wavelength.py

@@ -1,5 +1,6 @@
 """Bud to get the wavelength."""
 
+from dkist_processing_common.models.fits_access import MetadataKey
 from dkist_processing_common.models.flower_pot import SpilledDirt
 from dkist_processing_common.parsers.unique_bud import UniqueBud
 
@@ -11,7 +12,10 @@ class ObserveWavelengthBud(UniqueBud):
     """Bud to find the wavelength."""
 
     def __init__(self):
-        super().__init__(constant_name=DlnirspBudName.wavelength.value, metadata_key="wavelength")
+        super().__init__(
+            constant_name=DlnirspBudName.wavelength.value,
+            metadata_key=MetadataKey.wavelength,
+        )
 
     def setter(self, fits_obj: DlnirspL0FitsAccess):
         """

dkist_processing_dlnirsp/tasks/linearity_correction.py

@@ -28,14 +28,32 @@ class LinearityCorrection(DlnirspTaskBase):
 
     record_provenance = True
 
-    camera_sequence_regex: re.Pattern = re.compile(r"(\d*)line,(\d*)read")
+    valid_camera_sequence_regex: re.Pattern = re.compile(
+        r"^(\d*subframe)?(?(1)|(?:\d*line,\d*read,?)+)(?:,\d*line)?$"
+    )
     """
-    regex pattern used to parse line-read-line values for a single coadd.
+    regex pattern that defines all valid camera-sample sequences.
+
+    It must start with either "Xline,Yread", which can repeat any number of times, or "Xsubframe" which must be by itself.
+    Either of these sequences may be padded with ",Zline" reset frames.
+    """
+
+    uptheramp_coadd_regex: re.Pattern = re.compile(r"(\d*)line,(\d*)read")
+    """
+    regex pattern used to parse line-read-line values for a single UpTheRamp coadd.
 
     This is where we decide that camera sequences are one or more coadd sequences, where each coadd sequence is
     "Xline,Yread". The total sequence may be padded with ",Zline" reset frames, which are not captured by this regex.
     """
 
+    subframe_sequence_regex: re.Pattern = re.compile(r"(\d*)subframe")
+    """
+    regex pattern used to parse coadds in SubFrame mode
+
+    Simply looks for "Xsubframe" and captures the "X". The sequence may be padded with ",Zline" reset frames, which are
+    not captured by this regex.
+    """
+
     def run(self):
         """
         Linearize IR camera frames or tag VIS camera frames as LINEARIZED.
@@ -110,17 +128,16 @@ class LinearityCorrection(DlnirspTaskBase):
         )
         num_coadds = len(coadd_sequence_nums_list)
 
-        line_read_line_indices = coadd_sequence_nums_list[0]
-        num_bias, num_read = line_read_line_indices[:2]
-
-        ndr_per_coadd = num_bias + num_read
-
         # In `is_ramp_valid` we already confirmed that all NDRs have the same values and that they are one of the
         # expected values
         camera_readout_mode = ramp_obj_list[0].camera_readout_mode
         modulator_spin_mode = ramp_obj_list[0].modulator_spin_mode
         match camera_readout_mode:
             case "UpTheRamp":
+                line_read_line_indices = coadd_sequence_nums_list[0]
+                num_bias, num_read = line_read_line_indices[:2]
+                ndr_per_coadd = num_bias + num_read
+
                 match modulator_spin_mode:
                     case "Continuous":
                         linearization_func = partial(
@@ -136,6 +153,11 @@ class LinearityCorrection(DlnirspTaskBase):
                         )
 
             case "SubFrame":
+                # `self.valid_camera_sequence_regex`, along with `parse_camera_sample_sequence`, provides assurance that
+                # by the time we get here these assumptions are valid
+                num_bias = 0
+                num_read = 1
+                ndr_per_coadd = 1
                 linearization_func = self.linearize_subframe_coadd
 
         coadd_stack = np.zeros((num_coadds, *ramp_obj_list[0].data.shape))
@@ -291,16 +313,25 @@ class LinearityCorrection(DlnirspTaskBase):
         "3line,45read,3line,45read,2line"
             `[[3, 45], [3, 45]]`
 
+        "4subframe,89line"
+            `[[1], [1], [1], [1]]`
+
         Returns
         -------
-        A list of lists. Top-level list contains an item for each coadd. These items are themselves lists of
-        length 2. The numbers in these inner lists correspond to the number of bias and read frames in that coadd,
-        respectively.
+        A list of lists. Top-level list contains an item for each coadd. In UpTheRamp mode these items are themselves
+        lists of length 2. The numbers in these inner lists correspond to the number of bias and read frames in that coadd,
+        respectively. In SubFrame mode the inner lists will always be length 1 and should be equal to `[1]`.
         """
-        coadd_matches = self.camera_sequence_regex.findall(camera_sample_sequence)
-        coadd_sequence_numbers = [
-            [int(num) for num in coadd_match] for coadd_match in coadd_matches
-        ]
+        if "subframe" in camera_sample_sequence:
+            coadd_matches = self.subframe_sequence_regex.findall(camera_sample_sequence)
+            # `is_ramp_valid` ensures we only have a single match here
+            num_coadd = int(coadd_matches[0])
+            coadd_sequence_numbers = [[1]] * num_coadd
+        else:
+            coadd_matches = self.uptheramp_coadd_regex.findall(camera_sample_sequence)
+            coadd_sequence_numbers = [
+                [int(num) for num in coadd_match] for coadd_match in coadd_matches
+            ]
 
         return coadd_sequence_numbers
 
@@ -310,15 +341,15 @@ class LinearityCorrection(DlnirspTaskBase):
 
         Current validity checks are:
 
-          1. All frames in the ramp have the same value for NUM_FRAMES_IN_RAMP
-          2. All frames in the ramp have the same value for CAMERA_READOUT_MODE
-          3. All frames in the ramp have the same value for MODULATOR_SPIN_MODE
-          4. The CAMERA_READOUT and MODULATOR_SPIN modes have expected values
-          5. The value of NUM_FRAMES_IN_RAMP equals the length of actual frames found
-          6. All frames in the ramp have the same value for CAMERA_SAMPLE_SEQUENCE
-          7. The camera sample sequence has the expected form ('(,?\d*line,\d*read)*(,\d*line)?')
-          8. All coadds in the ramp have the same camera sample sequence
-          9. The ramp length is equal to the expected length from the camera sample sequence
+        #. All frames in the ramp have the same value for NUM_FRAMES_IN_RAMP
+        #. All frames in the ramp have the same value for CAMERA_READOUT_MODE
+        #. All frames in the ramp have the same value for MODULATOR_SPIN_MODE
+        #. The CAMERA_READOUT and MODULATOR_SPIN modes have expected values
+        #. The value of NUM_FRAMES_IN_RAMP equals the length of actual frames found
+        #. All frames in the ramp have the same value for CAMERA_SAMPLE_SEQUENCE
+        #. The camera sample sequence has the expected form (`valid_camera_sequence_regex`)
+        #. All coadds in the ramp have the same camera sample sequence
+        #. The ramp length is equal to the expected length from the camera sample sequence
 
         If a ramp is not valid then the reason is logged and `False` is returned.
         """
@@ -382,7 +413,7 @@ class LinearityCorrection(DlnirspTaskBase):
             return False
 
         camera_sample_sequence = camera_sample_sequence_set.pop()
-        if re.search(r"\d*line,\d*line", camera_sample_sequence):
+        if not self.valid_camera_sequence_regex.search(camera_sample_sequence):
             logger.info(
                 f"Malformed camera sample sequence: '{camera_sample_sequence}'. "
                 f"{common_status_str}"

dkist_processing_dlnirsp/tasks/parse.py

@@ -2,6 +2,7 @@
 
 from typing import TypeVar
 
+from dkist_processing_common.models.fits_access import MetadataKey
 from dkist_processing_common.models.flower_pot import Stem
 from dkist_processing_common.models.task_name import TaskName
 from dkist_processing_common.parsers.cs_step import CSStepFlower
@@ -22,6 +23,7 @@ from dkist_processing_common.tasks import default_constant_bud_factory
 from dkist_processing_common.tasks import default_tag_flower_factory
 
 from dkist_processing_dlnirsp.models.constants import DlnirspBudName
+from dkist_processing_dlnirsp.models.fits_access import DlnirspMetadataKey
 from dkist_processing_dlnirsp.models.parameters import DlnirspParsingParameters
 from dkist_processing_dlnirsp.models.tags import DlnirspStemName
 from dkist_processing_dlnirsp.models.tags import DlnirspTag
@@ -72,7 +74,9 @@ class ParseL0DlnirspRampData(ParseDataBase):
             # Time Obs is the unique identifier for each ramp in the data set
             DlnirspTimeObsBud(),
             # This is used to determine whether we need to do any linearity correction at all.
-            UniqueBud(constant_name=DlnirspBudName.arm_id.value, metadata_key="arm_id"),
+            UniqueBud(
+                constant_name=DlnirspBudName.arm_id.value, metadata_key=DlnirspMetadataKey.arm_id
+            ),
         ]
 
     @property
@@ -81,12 +85,12 @@ class ParseL0DlnirspRampData(ParseDataBase):
         return [
             SingleValueSingleKeyFlower(
                 tag_stem_name=DlnirspStemName.current_frame_in_ramp.value,
-                metadata_key="current_frame_in_ramp",
+                metadata_key=DlnirspMetadataKey.current_frame_in_ramp,
             ),
             # time_obs is a unique identifier for all raw frames in a single ramp
             SingleValueSingleKeyFlower(
                 tag_stem_name=DlnirspStemName.time_obs.value,
-                metadata_key="time_obs",
+                metadata_key=MetadataKey.time_obs,
             ),
         ]
 
@@ -144,12 +148,13 @@ class ParseL0DlnirspLinearizedData(ParseDataBase):
             DLnirspSolarGainIpStartTimeBud(),
             NumCSStepBud(max_cs_step_time_sec=self.parameters.max_cs_step_time_sec),
             UniqueBud(
-                constant_name=DlnirspBudName.polarimeter_mode.value, metadata_key="polarimeter_mode"
+                constant_name=DlnirspBudName.polarimeter_mode.value,
+                metadata_key=DlnirspMetadataKey.polarimeter_mode,
             ),
             RetarderNameBud(),
             UniqueBud(
                 constant_name=DlnirspBudName.num_modstates.value,
-                metadata_key="number_of_modulator_states",
+                metadata_key=DlnirspMetadataKey.number_of_modulator_states,
             ),
             NumMosaicRepeatsBud(
                 crpix_correction_method=self.parameters.wcs_crpix_correction_method,
@@ -189,20 +194,20 @@ class ParseL0DlnirspLinearizedData(ParseDataBase):
             ),
             TaskNearFloatBud(
                 constant_name=DlnirspBudName.arm_position_mm.value,
-                metadata_key="arm_position_mm",
+                metadata_key=DlnirspMetadataKey.arm_position_mm,
                 ip_task_types=[TaskName.solar_gain.value, TaskName.observe.value],
                 tolerance=0.01,
                 task_type_parsing_function=parse_header_ip_task,
             ),
             TaskUniqueBud(
                 constant_name=DlnirspBudName.grating_constant_inverse_mm.value,
-                metadata_key="grating_constant_inverse_mm",
+                metadata_key=DlnirspMetadataKey.grating_constant_inverse_mm,
                 ip_task_types=[TaskName.solar_gain.value, TaskName.observe.value],
                 task_type_parsing_function=parse_header_ip_task,
             ),
             TaskNearFloatBud(
                 constant_name=DlnirspBudName.grating_position_deg.value,
-                metadata_key="grating_position_deg",
+                metadata_key=DlnirspMetadataKey.grating_position_deg,
                 ip_task_types=[TaskName.solar_gain.value, TaskName.observe.value],
                 tolerance=0.01,
                 task_type_parsing_function=parse_header_ip_task,
@@ -216,14 +221,17 @@ class ParseL0DlnirspLinearizedData(ParseDataBase):
             DlnirspTaskTypeFlower(),
             PolcalTaskFlower(),
             SingleValueSingleKeyFlower(
-                tag_stem_name=DlnirspStemName.arm_id.value, metadata_key="arm_id"
+                tag_stem_name=DlnirspStemName.arm_id.value,
+                metadata_key=DlnirspMetadataKey.arm_id,
             ),
             ExposureTimeFlower(),
             SingleValueSingleKeyFlower(
-                tag_stem_name=DlnirspStemName.modstate.value, metadata_key="modulator_state"
+                tag_stem_name=DlnirspStemName.modstate.value,
+                metadata_key=DlnirspMetadataKey.modulator_state,
             ),
             SingleValueSingleKeyFlower(
-                tag_stem_name=DlnirspStemName.mosaic_num.value, metadata_key="mosaic_num"
+                tag_stem_name=DlnirspStemName.mosaic_num.value,
+                metadata_key=DlnirspMetadataKey.mosaic_num,
             ),
             MosaicStepXFlower(
                 crpix_correction_method=self.parameters.wcs_crpix_correction_method,
@@ -234,7 +242,8 @@ class ParseL0DlnirspLinearizedData(ParseDataBase):
                 bin_crpix_to_multiple_of=self.parameters.parse_bin_crpix_to_multiple_of,
             ),
             SingleValueSingleKeyFlower(
-                tag_stem_name=DlnirspStemName.dither_step.value, metadata_key="dither_step"
+                tag_stem_name=DlnirspStemName.dither_step.value,
+                metadata_key=DlnirspMetadataKey.dither_step,
             ),
             CSStepFlower(max_cs_step_time_sec=self.parameters.max_cs_step_time_sec),
         ]

dkist_processing_dlnirsp/tasks/science.py

@@ -18,6 +18,7 @@ from dkist_processing_common.codecs.fits import fits_access_decoder
 from dkist_processing_common.codecs.fits import fits_array_decoder
 from dkist_processing_common.codecs.fits import fits_array_encoder
 from dkist_processing_common.codecs.fits import fits_hdulist_encoder
+from dkist_processing_common.models.fits_access import MetadataKey
 from dkist_processing_common.models.tags import EXP_TIME_ROUND_DIGITS
 from dkist_processing_common.models.task_name import TaskName
 from dkist_processing_common.tasks.mixin.quality import QualityMixin
@@ -29,6 +30,7 @@ from dkist_processing_pac.optics.telescope import Telescope
 from dkist_service_configuration.logging import logger
 from scipy.spatial import Delaunay
 
+from dkist_processing_dlnirsp.models.fits_access import DlnirspMetadataKey
 from dkist_processing_dlnirsp.models.tags import DlnirspTag
 from dkist_processing_dlnirsp.parsers.dlnirsp_l0_fits_access import DlnirspL0FitsAccess
 from dkist_processing_dlnirsp.parsers.wcs_corrections import correct_crpix_values
@@ -738,7 +740,7 @@ class ScienceCalibration(
         date_end = (Time(sorted_obj_list[-1].time_obs) + exp_time).isot
 
         header = sorted_obj_list[0].header
-        header["DATE-BEG"] = date_beg
+        header[MetadataKey.time_obs] = date_beg
         header["DATE-END"] = date_end
 
         return header
@@ -773,13 +775,13 @@ class ScienceCalibration(
 
         crpix_correction_method = self.parameters.wcs_crpix_correction_method
         cached_info_logger(f"Applying CRPIX correction method '{crpix_correction_method}'")
-        OG_crpix1 = header["CRPIX1"]
-        OG_crpix2 = header["CRPIX2"]
+        OG_crpix1 = header[DlnirspMetadataKey.crpix_1]
+        OG_crpix2 = header[DlnirspMetadataKey.crpix_2]
 
         new_crpix1, new_crpix2 = correct_crpix_values(OG_crpix1, OG_crpix2, crpix_correction_method)
 
-        header["CRPIX1"] = new_crpix1
-        header["CRPIX2"] = new_crpix2
+        header[DlnirspMetadataKey.crpix_1] = new_crpix1
+        header[DlnirspMetadataKey.crpix_2] = new_crpix2
 
         return header
 

dkist_processing_dlnirsp/tasks/write_l1.py

@@ -12,6 +12,7 @@ from dkist_processing_common.tasks import WriteL1Frame
 from dkist_service_configuration.logging import logger
 
 from dkist_processing_dlnirsp.models.constants import DlnirspConstants
+from dkist_processing_dlnirsp.models.fits_access import DlnirspMetadataKey
 from dkist_processing_dlnirsp.models.tags import DlnirspTag
 
 cached_info_logger = cache(logger.info)
@@ -83,7 +84,7 @@ class DlnirspWriteL1Frame(WriteL1Frame):
             header[f"DPNAME{axis_index}"] = "dither step"
             header[f"DWNAME{axis_index}"] = "time"
             header[f"DUNIT{axis_index}"] = "s"
-            header[f"DINDEX{axis_index}"] = int(header["DLCURSTP"]) + 1
+            header[f"DINDEX{axis_index}"] = int(header[DlnirspMetadataKey.dither_step]) + 1
 
         if self.constants.correct_for_polarization:
             cached_info_logger("Polarimetric data detected")
@@ -211,7 +212,7 @@ class DlnirspWriteL1Frame(WriteL1Frame):
             tile_as_temporal_axis = False
             temporal_axis_size = num_mosaic_repeats
             pname = "mosaic repeat number"
-            dindex = header["DLCURMOS"]
+            dindex = header[DlnirspMetadataKey.mosaic_num]
 
         elif num_mosaic_repeats == 1 and (
             (num_X_tiles == 1 and num_Y_tiles == 1) or (num_X_tiles > 1 and num_Y_tiles > 1)
@@ -224,14 +225,14 @@ class DlnirspWriteL1Frame(WriteL1Frame):
             tile_as_temporal_axis = True
             temporal_axis_size = num_X_tiles
             pname = "repeat number"
-            dindex = header["DLCSTPX"]
+            dindex = header[DlnirspMetadataKey.X_tile_num]
 
         elif num_mosaic_repeats == 1 and num_X_tiles == 1 and num_Y_tiles > 1:
             has_temporal_axis = True
             tile_as_temporal_axis = True
             temporal_axis_size = num_Y_tiles
             pname = "repeat number"
-            dindex = header["DLCSTPY"]
+            dindex = header[DlnirspMetadataKey.Y_tile_num]
 
         else:
             raise ValueError(

dkist_processing_dlnirsp/tests/conftest.py

@@ -436,7 +436,19 @@ class RawRampHeaders(DlnirspHeaders):
                 raise ValueError(f"{array_shape = } is weird")
             array_shape = array_shape[1:]
 
-        self.num_frames_per_coadd = num_line + num_read
+        match camera_readout_mode:
+            case "UpTheRamp":
+                self.num_frames_per_coadd = num_line + num_read
+                coadd_read_sequence = f"{num_line}line,{num_read}read"
+                cam_read_sequence = ",".join([coadd_read_sequence] * num_coadd)
+            case "SubFrame":
+                self.num_frames_per_coadd = 1
+                cam_read_sequence = f"{num_coadd}subframe"
+                num_line = 0
+                num_read = 1
+            case _:
+                raise ValueError(f"Don't know how to make data for {camera_readout_mode = }")
+
         num_NDR_per_ramp = self.num_frames_per_coadd * num_coadd + num_reset
         num_frames = num_ramps * num_NDR_per_ramp
         dataset_shape = (num_frames, *array_shape)
@@ -446,12 +458,8 @@ class RawRampHeaders(DlnirspHeaders):
         self.ramp_length_sec = TimeDelta(ramp_length_sec, format="sec")
         self.num_coadd = num_coadd
         self.num_line = num_line
-        self.num_read = num_read
         self.num_reset = num_reset
 
-        coadd_read_sequence = f"{num_line}line,{num_read}read"
-        cam_read_sequence = ",".join([coadd_read_sequence] * num_coadd)
-
         if num_reset > 0:
             cam_read_sequence += f",{num_reset}line"
 

dkist_processing_dlnirsp/tests/local_trial_workflows/local_trial_dev_mockers.py

@@ -9,6 +9,7 @@ from dkist_processing_common.codecs.fits import fits_array_decoder
 from dkist_processing_common.codecs.fits import fits_array_encoder
 from dkist_processing_common.codecs.fits import fits_hdulist_encoder
 from dkist_processing_common.models.constants import BudName
+from dkist_processing_common.models.fits_access import MetadataKey
 from dkist_processing_common.models.task_name import TaskName
 from dkist_processing_common.tasks import TransferTrialData
 from dkist_processing_common.tasks import WorkflowTaskBase
@@ -17,6 +18,7 @@ from dkist_processing_math.statistics import average_numpy_arrays
 from dkist_service_configuration.logging import logger
 
 from dkist_processing_dlnirsp.models.constants import DlnirspBudName
+from dkist_processing_dlnirsp.models.fits_access import DlnirspMetadataKey
 from dkist_processing_dlnirsp.models.tags import DlnirspTag
 from dkist_processing_dlnirsp.tasks import DlnirspWriteL1Frame
 from dkist_processing_dlnirsp.tasks.dlnirsp_base import DlnirspTaskBase
@@ -87,7 +89,7 @@ def permissive_write_l1_task(force_intensity_only: bool):
             self, header: fits.Header, stokes: Literal["I", "Q", "U", "V"]
         ) -> fits.Header:
             if force_intensity_only:
-                header["DLPOLMD"] = "Stokes I"
+                header[MetadataKey.polarimeter_mode] = "Stokes I"
 
             return super().add_dataset_headers(header=header, stokes=stokes)
 
@@ -138,11 +140,11 @@ class TagPolcasAsScience(DlnirspTaskBase):
                 avg_array = average_numpy_arrays(arrays=arrays)
 
                 hdul = fits.HDUList([fits.PrimaryHDU(data=avg_array, header=first_header)])
-                hdul[0].header["DLCSTPX"] = 1
-                hdul[0].header["DLCSTPY"] = 1
-                hdul[0].header["DLMOSNRP"] = self.constants.num_cs_steps
-                hdul[0].header["DLCURMOS"] = cs_step
-                hdul[0].header["XPOSURE"] = obs_exp_time
+                hdul[0].header[DlnirspMetadataKey.X_tile_num] = 1
+                hdul[0].header[DlnirspMetadataKey.Y_tile_num] = 1
+                hdul[0].header[DlnirspMetadataKey.num_mosaic_repeats] = self.constants.num_cs_steps
+                hdul[0].header[DlnirspMetadataKey.mosaic_num] = cs_step
+                hdul[0].header[MetadataKey.fpa_exposure_time_ms] = obs_exp_time
 
                 new_tags = [
                     DlnirspTag.task_observe(),
@@ -186,11 +188,11 @@ class TagSingleSolarGainAsScience(DlnirspTaskBase):
         avg_array = average_numpy_arrays(arrays=arrays)
 
         hdul = fits.HDUList([fits.PrimaryHDU(data=avg_array, header=first_header)])
-        hdul[0].header["DLCSTPX"] = 1
-        hdul[0].header["DLCSTPY"] = 1
-        hdul[0].header["DLMOSNRP"] = 1
-        hdul[0].header["DLCURMOS"] = 0
-        hdul[0].header["DLDMODE"] = False
+        hdul[0].header[DlnirspMetadataKey.X_tile_num] = 1
+        hdul[0].header[DlnirspMetadataKey.Y_tile_num] = 1
+        hdul[0].header[DlnirspMetadataKey.num_mosaic_repeats] = 1
+        hdul[0].header[DlnirspMetadataKey.mosaic_num] = 0
+        hdul[0].header[DlnirspMetadataKey.num_dither_steps] = False
 
         new_tags = [
             DlnirspTag.task_observe(),
@@ -237,11 +239,11 @@ class TagModulatedSolarGainsAsScience(DlnirspTaskBase):
             avg_array = average_numpy_arrays(arrays=arrays)
 
             hdul = fits.HDUList([fits.PrimaryHDU(data=avg_array, header=first_header)])
-            hdul[0].header["DLCSTPX"] = 1
-            hdul[0].header["DLCSTPY"] = 1
-            hdul[0].header["DLMOSNRP"] = 1
-            hdul[0].header["DLCURMOS"] = 0
-            hdul[0].header["DLDMODE"] = False
+            hdul[0].header[DlnirspMetadataKey.X_tile_num] = 1
+            hdul[0].header[DlnirspMetadataKey.Y_tile_num] = 1
+            hdul[0].header[DlnirspMetadataKey.num_mosaic_repeats] = 1
+            hdul[0].header[DlnirspMetadataKey.mosaic_num] = 0
+            hdul[0].header[DlnirspMetadataKey.num_dither_steps] = False
 
             new_tags = [
                 DlnirspTag.task_observe(),

dkist_processing_dlnirsp/tests/local_trial_workflows/local_trial_helpers.py

@@ -20,6 +20,7 @@ from loguru import logger
 
 from dkist_processing_dlnirsp.models.constants import DlnirspBudName
 from dkist_processing_dlnirsp.models.constants import DlnirspConstants
+from dkist_processing_dlnirsp.models.fits_access import DlnirspMetadataKey
 from dkist_processing_dlnirsp.models.tags import DlnirspTag
 from dkist_processing_dlnirsp.models.task_name import DlnirspTaskName
 from dkist_processing_dlnirsp.tasks.dlnirsp_base import DlnirspTaskBase
@@ -38,7 +39,7 @@ def get_camera_number(scratch_dir: Path, suffix: str = "FITS", data_ext: int = 1
     header_list = [fits.getheader(f, ext=data_ext) for f in file_list]
     table = Table(header_list)
 
-    camera_IDs = np.unique(table["DLARMID"])
+    camera_IDs = np.unique(table[DlnirspMetadataKey.arm_id])
     if camera_IDs.size > 1:
         raise ValueError(f"Found more than one arm in scratch dir. Found {camera_IDs}")