dkist-processing-cryonirsp 1.4.3__tar.gz → 1.4.4__tar.gz

{dkist_processing_cryonirsp-1.4.3 → dkist_processing_cryonirsp-1.4.4}/CHANGELOG.rst

@@ -1,3 +1,12 @@
+v1.4.4 (2024-11-21)
+===================
+
+Misc
+----
+
+- This change adds a new pickybud to make sure that the dataset contains both lamp gain frames and solar gain frames (we need both for calibration). If we don't have both types of frames, the pipeline will fail fast. (`#159 <https://bitbucket.org/dkistdc/dkist-processing-cryonirsp/pull-requests/159>`__)
+
+
 v1.4.3 (2024-11-21)
 ===================
 

{dkist_processing_cryonirsp-1.4.3 → dkist_processing_cryonirsp-1.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dkist-processing-cryonirsp
-Version: 1.4.3
+Version: 1.4.4
 Summary: Science processing code for the Cryo-NIRSP instrument on DKIST
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause

{dkist_processing_cryonirsp-1.4.3 → dkist_processing_cryonirsp-1.4.4}/dkist_processing_cryonirsp/models/constants.py

@@ -46,6 +46,7 @@ class CryonirspBudName(Enum):
     roi_1_size_y = "ROI_1_SIZE_Y"
     optical_density_filter_picky_bud = "OPTICAL_DENSITY_FILTER_PICKY_BUD"
     solar_gain_ip_start_time = "SOLAR_GAIN_IP_START_TIME"
+    gain_frame_type_list = "GAIN_FRAME_TYPE_LIST"
 
 
 class CryonirspConstants(ConstantsBase):
@@ -124,6 +125,11 @@ class CryonirspConstants(ConstantsBase):
         """Construct a sorted tuple of all the dateobs for this dataset."""
         return self._db_dict[CryonirspBudName.time_obs_list.value]
 
+    @property
+    def gain_frame_type_list(self) -> list[str]:
+        """Construct a list of all the types of gain frames for this dataset."""
+        return self._db_dict[CryonirspBudName.gain_frame_type_list.value]
+
     @property
     def exposure_conditions_list(self) -> [ExposureConditions]:
         """Construct a list of ExposureConditions tuples for the dataset."""

dkist_processing_cryonirsp-1.4.4/dkist_processing_cryonirsp/parsers/check_for_gains.py

@@ -0,0 +1,58 @@
+"""Pickybud to check for lamp gain and solar gain frames."""
+from typing import Hashable
+from typing import Type
+
+from dkist_processing_common.models.flower_pot import SpilledDirt
+from dkist_processing_common.models.flower_pot import Stem
+from dkist_processing_common.models.flower_pot import Thorn
+from dkist_processing_common.models.task_name import TaskName
+from dkist_processing_common.parsers.task import parse_header_ip_task_with_gains
+
+from dkist_processing_cryonirsp.models.constants import CryonirspBudName
+from dkist_processing_cryonirsp.parsers.cryonirsp_l0_fits_access import CryonirspL0FitsAccess
+
+
+class CheckGainFramesPickyBud(Stem):
+    """Pickybud to check for lamp gain and solar gain frames."""
+
+    def __init__(self):
+        super().__init__(stem_name=CryonirspBudName.gain_frame_type_list.value)
+
+    def setter(self, fits_obj: CryonirspL0FitsAccess) -> Type[SpilledDirt] | str:
+        """
+        Set the calibration frame type for this fits object.
+
+        Parameters
+        ----------
+        fits_obj
+            The input fits object
+        Returns
+        -------
+        The calibration frame object associated with this fits object
+        """
+        task = parse_header_ip_task_with_gains(fits_obj).casefold()
+
+        if task in [TaskName.lamp_gain.value.casefold(), TaskName.solar_gain.value.casefold()]:
+            return task
+        return SpilledDirt
+
+    def getter(self, key: Hashable) -> Thorn:
+        """
+        Check that lamp and solar gain frames exist. If they do, return a Thorn.
+
+        Parameters
+        ----------
+        key
+            The input key
+
+        Returns
+        -------
+        Thorn
+        """
+        gain_task_types = list(self.key_to_petal_dict.values())
+
+        if TaskName.lamp_gain.value.casefold() not in gain_task_types:
+            raise ValueError("Lamp gain frames not found.")
+        if TaskName.solar_gain.value.casefold() not in gain_task_types:
+            raise ValueError("Solar gain frames not found.")
+        return Thorn

{dkist_processing_cryonirsp-1.4.3 → dkist_processing_cryonirsp-1.4.4}/dkist_processing_cryonirsp/tasks/parse.py

@@ -25,6 +25,7 @@ from dkist_processing_cryonirsp.models.constants import CryonirspBudName
 from dkist_processing_cryonirsp.models.parameters import CryonirspParsingParameters
 from dkist_processing_cryonirsp.models.tags import CryonirspStemName
 from dkist_processing_cryonirsp.models.tags import CryonirspTag
+from dkist_processing_cryonirsp.parsers.check_for_gains import CheckGainFramesPickyBud
 from dkist_processing_cryonirsp.parsers.cryonirsp_l0_fits_access import CryonirspL0FitsAccess
 from dkist_processing_cryonirsp.parsers.cryonirsp_l0_fits_access import CryonirspRampFitsAccess
 from dkist_processing_cryonirsp.parsers.exposure_conditions import (
@@ -179,6 +180,7 @@ class ParseL0CryonirspLinearizedData(ParseDataBase, InputDatasetMixin):
             NumberOfScanStepsBud(),
             NumberOfMeasurementsBud(),
             CryonirspSolarGainStartTimeBud(),
+            CheckGainFramesPickyBud(),
             NumCSStepBud(self.parameters.max_cs_step_time_sec),
             CryonirspTaskExposureConditionsBud(
                 stem_name=CryonirspBudName.dark_frame_exposure_conditions_list.value,

{dkist_processing_cryonirsp-1.4.3 → dkist_processing_cryonirsp-1.4.4}/dkist_processing_cryonirsp/tests/conftest.py

@@ -72,7 +72,7 @@ def generate_214_l1_fits_frame(
 ) -> fits.HDUList:
     """Convert S122 header into 214 L1 only.
 
-    This does NOT include populating all L1 headers, just removing 214 L0 only headers
+    This does NOT include populating all L1 headers, just removing 214 L0 only headers.
 
     NOTE: The stuff you care about will be in hdulist[1]
     """

{dkist_processing_cryonirsp-1.4.3 → dkist_processing_cryonirsp-1.4.4}/dkist_processing_cryonirsp/tests/test_parse.py

@@ -1437,3 +1437,61 @@ def test_polarimetric_checking_unique_bud(dummy_fits_obj):
     Bud.update("key1", nonpol_obs_frame2)
     Bud.update("key2", pol_frame2)
     assert Bud.getter("key1") == "Bad"
+
+
+@pytest.mark.parametrize("arm_id", ["CI", "SP"])
+def test_missing_solar_gain_frames(parse_linearized_task, arm_id):
+    """
+    Given: A dataset missing solar gain frames
+    When: Parsing
+    Then: The 'CheckGainFramesPickyBud' raises an error
+    """
+    task = parse_linearized_task
+
+    lin_tag = [CryonirspTag.linearized()]
+    gain_exposure_condition = ExposureConditions(
+        10.0, AllowableOpticalDensityFilterNames.OPEN.value
+    )
+    dark_exp_condition = ExposureConditions(10.0, AllowableOpticalDensityFilterNames.OPEN.value)
+
+    # Needed so the dark picky bud is happy
+    write_dark_frames_to_task(task, exposure_condition=dark_exp_condition, tags=lin_tag)
+
+    write_lamp_gain_frames_to_task(
+        task,
+        tags=lin_tag,
+        exposure_condition=gain_exposure_condition,
+        num_modstates=1,
+    )
+
+    with pytest.raises(ValueError, match="Solar gain frames not found."):
+        task()
+
+
+@pytest.mark.parametrize("arm_id", ["CI", "SP"])
+def test_missing_lamp_gain_frames(parse_linearized_task, arm_id):
+    """
+    Given: A dataset missing lamp gain frames
+    When: Parsing
+    Then: The 'CheckGainFramesPickyBud' raises an error
+    """
+    task = parse_linearized_task
+
+    lin_tag = [CryonirspTag.linearized()]
+    gain_exposure_condition = ExposureConditions(
+        10.0, AllowableOpticalDensityFilterNames.OPEN.value
+    )
+    dark_exp_condition = ExposureConditions(10.0, AllowableOpticalDensityFilterNames.OPEN.value)
+
+    # Needed so the dark picky bud is happy
+    write_dark_frames_to_task(task, exposure_condition=dark_exp_condition, tags=lin_tag)
+
+    write_solar_gain_frames_to_task(
+        task,
+        tags=lin_tag,
+        exposure_condition=gain_exposure_condition,
+        num_modstates=1,
+    )
+
+    with pytest.raises(ValueError, match="Lamp gain frames not found."):
+        task()

{dkist_processing_cryonirsp-1.4.3 → dkist_processing_cryonirsp-1.4.4}/dkist_processing_cryonirsp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dkist-processing-cryonirsp
-Version: 1.4.3
+Version: 1.4.4
 Summary: Science processing code for the Cryo-NIRSP instrument on DKIST
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause

{dkist_processing_cryonirsp-1.4.3 → dkist_processing_cryonirsp-1.4.4}/dkist_processing_cryonirsp.egg-info/SOURCES.txt

@@ -24,6 +24,7 @@ dkist_processing_cryonirsp/models/parameters.py
 dkist_processing_cryonirsp/models/tags.py
 dkist_processing_cryonirsp/models/task_name.py
 dkist_processing_cryonirsp/parsers/__init__.py
+dkist_processing_cryonirsp/parsers/check_for_gains.py
 dkist_processing_cryonirsp/parsers/cryonirsp_l0_fits_access.py
 dkist_processing_cryonirsp/parsers/cryonirsp_l1_fits_access.py
 dkist_processing_cryonirsp/parsers/exposure_conditions.py