dkist-processing-cryonirsp 1.4.2__py3-none-any.whl → 1.4.4__py3-none-any.whl

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/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/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/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/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.2.dist-info → dkist_processing_cryonirsp-1.4.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dkist-processing-cryonirsp
-Version: 1.4.2
+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
@@ -17,7 +17,7 @@ Requires-Dist: Pillow==10.3.0
 Requires-Dist: astropy==6.1.0
 Requires-Dist: dkist-fits-specifications==4.7.0
 Requires-Dist: dkist-header-validator==5.1.1
-Requires-Dist: dkist-processing-common==10.5.1
+Requires-Dist: dkist-processing-common==10.5.2
 Requires-Dist: dkist-processing-math==2.1.1
 Requires-Dist: dkist-processing-pac==3.1.0
 Requires-Dist: dkist-spectral-lines==3.0.0
@@ -43,16 +43,16 @@ Requires-Dist: dkist-processing-cryonirsp[asdf]; extra == "test"
 Requires-Dist: dkist-processing-cryonirsp[quality]; extra == "test"
 Provides-Extra: inventory
 Requires-Dist: dkist-processing-common[inventory]; extra == "inventory"
-Requires-Dist: dkist-inventory==1.4.2; extra == "inventory"
+Requires-Dist: dkist-inventory==1.4.3; extra == "inventory"
 Provides-Extra: asdf
 Requires-Dist: dkist-processing-common[asdf]; extra == "asdf"
-Requires-Dist: dkist-inventory[asdf]==1.4.2; extra == "asdf"
+Requires-Dist: dkist-inventory[asdf]==1.4.3; extra == "asdf"
 Provides-Extra: quality
 Requires-Dist: dkist-quality==1.1.1; extra == "quality"
 Provides-Extra: grogu
 Requires-Dist: dkist; extra == "grogu"
 Requires-Dist: pyparsing; extra == "grogu"
-Requires-Dist: dkist-inventory>=1.4.2; extra == "grogu"
+Requires-Dist: dkist-inventory>=1.4.3; extra == "grogu"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx-astropy; extra == "docs"

{dkist_processing_cryonirsp-1.4.2.dist-info → dkist_processing_cryonirsp-1.4.4.dist-info}/RECORD

@@ -2,12 +2,13 @@ changelog/.gitempty,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dkist_processing_cryonirsp/__init__.py,sha256=Z6-kB7fXXUI-F7Vz1HnEaja2h8qgH9IZExRl1lUxvZg,350
 dkist_processing_cryonirsp/config.py,sha256=xNkUNJ1BeBxJX881mTCIEbirZlD5_5txpV1QqkbfRM0,507
 dkist_processing_cryonirsp/models/__init__.py,sha256=m6UekKftTahNJ3W5K3mZSz4Y4ZZpHRxF_ZAxuaKYL7o,12
-dkist_processing_cryonirsp/models/constants.py,sha256=1R3rWj__ay6lHZJpXBaSdfSozmi7K6ceU2U9PkdIJwc,9360
+dkist_processing_cryonirsp/models/constants.py,sha256=qjXu7iaA-8cw5wZF-EaudWrDb8WDt3ALmRkX0lzBm7g,9629
 dkist_processing_cryonirsp/models/exposure_conditions.py,sha256=slFq5-Qz4fRpJKDBabbm4evPWLQVYmT-Uf9rk7nI734,813
 dkist_processing_cryonirsp/models/parameters.py,sha256=oAB_68AY2HdxK8IkvzisPKDI-c2agZeKiE5VIkHkkRI,13422
 dkist_processing_cryonirsp/models/tags.py,sha256=1Q2ag0ud9gx3su-XUqa--gwSnf5di7CGnlkyiEFreRs,4388
 dkist_processing_cryonirsp/models/task_name.py,sha256=xK4AKwgOx2uANbjhr0Q5Q3R9iPxLfkVKxWYY8wWjKhE,439
 dkist_processing_cryonirsp/parsers/__init__.py,sha256=m6UekKftTahNJ3W5K3mZSz4Y4ZZpHRxF_ZAxuaKYL7o,12
+dkist_processing_cryonirsp/parsers/check_for_gains.py,sha256=z5DZ4b4gQILb2mv1SowVulpiVGBZPYZNFsM6i6PjM24,2021
 dkist_processing_cryonirsp/parsers/cryonirsp_l0_fits_access.py,sha256=e4vDjsG5ye6N8cSg6WCJDHmlGAgM_2w1DRpp_KSddJw,4453
 dkist_processing_cryonirsp/parsers/cryonirsp_l1_fits_access.py,sha256=sc8MzxYMc8E1eFrL5KguAGHViCMJhaDfiBtZPml4ELg,886
 dkist_processing_cryonirsp/parsers/exposure_conditions.py,sha256=Xj466IJyaMXUCudrdTOUFmjsOr_CYENI7BegwwmEjoA,6098
@@ -32,7 +33,7 @@ dkist_processing_cryonirsp/tasks/instrument_polarization.py,sha256=uaQWIcQkw61az
 dkist_processing_cryonirsp/tasks/l1_output_data.py,sha256=FdL_Dv-YTLgT-xH_uOOUjk4GUYMjbaSDPIg1rIQu_iY,1621
 dkist_processing_cryonirsp/tasks/linearity_correction.py,sha256=-R0iBJDNF9o57GUd5C8YlOL6wyVUzKf5rSDFgu0kpgA,24310
 dkist_processing_cryonirsp/tasks/make_movie_frames.py,sha256=Ql_bg1r1W1m-tTOParAdkllFJEJFdNoE16GgHyhDgdw,13900
-dkist_processing_cryonirsp/tasks/parse.py,sha256=4qHU_Zy0gfoRBDY94jZhkRqKXwz-QPM42eUY9Db7e5Y,12326
+dkist_processing_cryonirsp/tasks/parse.py,sha256=MeqdHk1pb5dBlYQBlJrH3qXm9vzJ7d6nV-eh2cMDJqs,12452
 dkist_processing_cryonirsp/tasks/quality_metrics.py,sha256=r4mS1Qp88tHlbNKsqed-MOsFT_6Zbhr5H8-4hrx9OGw,11424
 dkist_processing_cryonirsp/tasks/science_base.py,sha256=-BjPNPI5jjiBR7K8p_9fa4vYCEUEdOFx7c2AC5EmFoE,17619
 dkist_processing_cryonirsp/tasks/sp_beam_boundaries.py,sha256=3bdj6W2H_UiOhmj2xHvADwOzojteLsTL9RkTwvzB6_M,10300
@@ -48,7 +49,7 @@ dkist_processing_cryonirsp/tasks/mixin/intermediate_frame.py,sha256=fFeIvuA4AtkQ
 dkist_processing_cryonirsp/tasks/mixin/linearized_frame.py,sha256=oyiMA_rzBUYtlmh1ilfE5DkuIe4FFiyptaYjcU8-joA,10176
 dkist_processing_cryonirsp/tasks/mixin/shift_measurements.py,sha256=7ToSy9uOJ_JrFfd-X225wqW_laq4xoRJkBiAPanfb_g,11225
 dkist_processing_cryonirsp/tests/__init__.py,sha256=m6UekKftTahNJ3W5K3mZSz4Y4ZZpHRxF_ZAxuaKYL7o,12
-dkist_processing_cryonirsp/tests/conftest.py,sha256=SiE_QHRy5IQ5SNOjBYdm9OhZBFqCB7Lx_FrTELqYS4M,17103
+dkist_processing_cryonirsp/tests/conftest.py,sha256=QZSEWZvgmWsqv2310AInV4m6NqweNJYJt-HNWgec-B4,17104
 dkist_processing_cryonirsp/tests/header_models.py,sha256=Ny4h5lS54bGRPDo4nOzvJgNWMzFY9DDs1IQorr_r3s8,20591
 dkist_processing_cryonirsp/tests/test_assemble_movie.py,sha256=YNZINIFXR9kZBlE1AIvjlVmwwhZJeVYOOPk7Q8IVkcI,6222
 dkist_processing_cryonirsp/tests/test_assemble_qualilty.py,sha256=upk-oUqVBHGK3F0eemshLpAPrnfh9mbeuZXow4E1Rmc,16859
@@ -64,7 +65,7 @@ dkist_processing_cryonirsp/tests/test_instrument_polarization.py,sha256=GgZmPJVt
 dkist_processing_cryonirsp/tests/test_linearity_correction.py,sha256=y9gDWlHsOaTMP7K5-lIIVmboa6nd0ozaqEtl6Fvt5T0,9406
 dkist_processing_cryonirsp/tests/test_make_movie_frames.py,sha256=WznHp9dV2-jbJYzRniCAIbSHCGNc0SpSzyVDSrZkYd4,4904
 dkist_processing_cryonirsp/tests/test_parameters.py,sha256=CbaEnxx3HGZmqZJbNzQ2IJpIg6AKlK26BT3TXUMGYAE,11438
-dkist_processing_cryonirsp/tests/test_parse.py,sha256=8SN3Dw3OE50nORZelRM7epznz6CGiNL0cPkziM4kVto,51693
+dkist_processing_cryonirsp/tests/test_parse.py,sha256=PsTco2G1_APKEPeSpqpYfsIkNXSM_GtY_jbgkNtj8r8,53539
 dkist_processing_cryonirsp/tests/test_quality.py,sha256=DWuL7q8x2RtPz3LN9-KEw541sv6Law9WyVQKaamkOmE,8169
 dkist_processing_cryonirsp/tests/test_sp_beam_boundaries.py,sha256=4hONuVLQAqkQjNtpNzvmqEWLg3LI1XJLWaekkeS3SJo,4815
 dkist_processing_cryonirsp/tests/test_sp_dispersion_axis_correction.py,sha256=lhwT_I0HQuH66I0TRvARfuNnWWjxeAvQ4fEEVmbhp_E,6098
@@ -103,7 +104,7 @@ docs/requirements_table.rst,sha256=FaqSag9kPi77gWPhzeo_tFEhRFjb3qUuNqqQe1K76NM,2
 docs/scientific_changelog.rst,sha256=01AWBSHg8zElnodCgAq-hMxhk9CkX5rtEENx4iz0sjI,300
 docs/sp_science_calibration.rst,sha256=fHBOZ2cqySxLjNi737KfynlmHZy9W4EwvuzxnyjDNvk,2597
 licenses/LICENSE.rst,sha256=piZaQplkzOMmH1NXg6QIdo9wwo9pPCoHkvm2-DmH76E,1462
-dkist_processing_cryonirsp-1.4.2.dist-info/METADATA,sha256=c1g9CAb5IDd2DsJKECGamb2hUtWT5OnI7ouoVbHaw6I,8403
-dkist_processing_cryonirsp-1.4.2.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-dkist_processing_cryonirsp-1.4.2.dist-info/top_level.txt,sha256=Sm9b1ddKnsF9Bh3mqDOct1Sm7k8I9aN7vGHgpmu-MlQ,51
-dkist_processing_cryonirsp-1.4.2.dist-info/RECORD,,
+dkist_processing_cryonirsp-1.4.4.dist-info/METADATA,sha256=p-j8AOqWDkXAdSPh4DWTIZD3--gI_heSvs6fgJetv8I,8403
+dkist_processing_cryonirsp-1.4.4.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+dkist_processing_cryonirsp-1.4.4.dist-info/top_level.txt,sha256=Sm9b1ddKnsF9Bh3mqDOct1Sm7k8I9aN7vGHgpmu-MlQ,51
+dkist_processing_cryonirsp-1.4.4.dist-info/RECORD,,