dkist-processing-cryonirsp 0.0.58__tar.gz → 0.0.59__tar.gz

{dkist_processing_cryonirsp-0.0.58 → dkist_processing_cryonirsp-0.0.59}/CHANGELOG.rst

@@ -1,3 +1,12 @@
+v0.0.59 (2024-05-06)
+====================
+
+Misc
+----
+
+- Add ability to handle data with zero modulator states corresponding to intensity mode. (`#118 <https://bitbucket.org/dkistdc/dkist-processing-cryonirsp/pull-requests/118>`__)
+
+
 v0.0.58 (2024-05-03)
 ====================
 

{dkist_processing_cryonirsp-0.0.58 → dkist_processing_cryonirsp-0.0.59}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dkist_processing_cryonirsp
-Version: 0.0.58
+Version: 0.0.59
 Summary: Science processing code for the Cryo-NIRSP instrument on DKIST
 Home-page: https://bitbucket.org/dkistdc/dkist_processing_cryonirsp/src/main/
 Author: NSO / AURA

{dkist_processing_cryonirsp-0.0.58 → dkist_processing_cryonirsp-0.0.59}/dkist_processing_cryonirsp/parsers/modstates.py

@@ -29,4 +29,7 @@ class ModstateNumberFlower(SingleValueSingleKeyFlower):
         """
         if fits_obj.ip_task_type != "observe" and fits_obj.ip_task_type != "polcal":
             return SpilledDirt
+        # Some intensity data incorrectly has modulator state = 0
+        if getattr(fits_obj, self.metadata_key) == 0:
+            return 1
         return super().setter(fits_obj)

{dkist_processing_cryonirsp-0.0.58 → dkist_processing_cryonirsp-0.0.59}/dkist_processing_cryonirsp/parsers/polarimetric_check.py

@@ -7,6 +7,7 @@ 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_cryonirsp.models.constants import CryonirspBudName
 from dkist_processing_cryonirsp.parsers.cryonirsp_l0_fits_access import CryonirspL0FitsAccess
 
 
@@ -66,12 +67,21 @@ class PolarimetricCheckingUniqueBud(Stem):
             A single FitsAccess object
         """
         task = fits_obj.ip_task_type.casefold()
+
+        # Some intensity mode data has the number of modulator states set to 0
+        num_modstates = fits_obj.number_of_modulator_states or 1
+
+        if self.metadata_key == "number_of_modulator_states":
+            bud_value = num_modstates
+        else:
+            bud_value = getattr(fits_obj, self.metadata_key)
+
         if task in [self.observe_task_name, self.polcal_task_name]:
             return self.PolarimetricValueData(
                 task=task,
-                num_modstates=fits_obj.number_of_modulator_states,
+                num_modstates=num_modstates,
                 spin_mode=fits_obj.modulator_spin_mode,
-                bud_value=getattr(fits_obj, self.metadata_key),
+                bud_value=bud_value,
             )
         return SpilledDirt
 

{dkist_processing_cryonirsp-0.0.58 → dkist_processing_cryonirsp-0.0.59}/dkist_processing_cryonirsp/tests/test_parse.py

@@ -96,8 +96,10 @@ def write_polcal_frames_to_task(
 ):
     num_frames = 0
 
+    modstates = [0] if num_modstates == 0 else range(1, num_modstates + 1)
+
     for map_scan in range(1, num_map_scans + 1):
-        for mod_state in range(1, num_modstates + 1):
+        for mod_state in modstates:
             frame_generator = ModulatedPolcalHeaders(
                 num_modstates=num_modstates,
                 modstate=mod_state,
@@ -127,12 +129,14 @@ def write_observe_frames_to_task(
 ):
     num_frames = 0
 
+    modstates = [0] if num_modstates == 0 else range(1, num_modstates + 1)
+
     start_time = datetime.now()
     frame_delta_time = timedelta(seconds=10)
     for map_scan in range(1, num_map_scans + 1):
         for scan_step in range(1, num_scan_steps + 1):
             for measurement in range(1, num_measurements + 1):
-                for mod_state in range(1, num_modstates + 1):
+                for mod_state in modstates:
                     for repeat in range(1, num_sub_repeats + 1):
                         frame_generator = ModulatedObserveHeaders(
                             start_date=start_time.isoformat(),
@@ -393,8 +397,9 @@ def test_parse_cryonirsp_non_linearized_data_bad_filter_name(parse_non_linearize
         task()
 
 
+@pytest.mark.parametrize("number_of_modstates", [0, 1, 8])
 @pytest.mark.parametrize("arm_id", ["CI", "SP"])
-def test_parse_cryonirsp_linearized_data(parse_linearized_task, arm_id):
+def test_parse_cryonirsp_linearized_data(parse_linearized_task, arm_id, number_of_modstates):
     """
     Given: A ParseCryonirspInputData task
     When: Calling the task instance
@@ -418,7 +423,7 @@ def test_parse_cryonirsp_linearized_data(parse_linearized_task, arm_id):
         task,
         arm_id,
         dark_exposure_conditions=dark_exp_conditions,
-        num_modstates=8,
+        num_modstates=number_of_modstates,
         num_scan_steps=3,
         num_map_scans=1,
         num_sub_repeats=1,
@@ -478,6 +483,22 @@ def test_parse_cryonirsp_linearized_data(parse_linearized_task, arm_id):
         == num_obs
     )
 
+    if number_of_modstates in [0, 1]:
+        assert (
+            len(
+                list(
+                    parse_linearized_task.read(
+                        tags=[
+                            CryonirspTag.linearized(),
+                            CryonirspTag.task_observe(),
+                            CryonirspTag.modstate(1),
+                        ]
+                    )
+                )
+            )
+            == num_obs
+        )
+
 
 @pytest.mark.parametrize("arm_id", ["CI", "SP"])
 def test_parse_cryonirsp_linearized_data_mismatched_darks(parse_linearized_task, arm_id):
@@ -1094,8 +1115,11 @@ def test_parse_cryonirsp_linearized_polcal_task_types(parse_linearized_task, arm
     )
 
 
+@pytest.mark.parametrize("number_of_modulator_states", [0, 1, 8])
 @pytest.mark.parametrize("arm_id", ["CI", "SP"])
-def test_parse_cryonirsp_linearized_data_constants(parse_linearized_task, arm_id):
+def test_parse_cryonirsp_linearized_data_constants(
+    parse_linearized_task, arm_id, number_of_modulator_states
+):
     """
     Given: A ParseCryonirspInputData task
     When: Calling the task instance
@@ -1115,7 +1139,7 @@ def test_parse_cryonirsp_linearized_data_constants(parse_linearized_task, arm_id
         polcal_exp_cond,
     ]
 
-    num_modstates = 8
+    num_modstates = number_of_modulator_states
     num_scan_steps = 3
     num_map_scans = 2
     num_sub_repeats = 2
@@ -1136,7 +1160,10 @@ def test_parse_cryonirsp_linearized_data_constants(parse_linearized_task, arm_id
 
     task()
 
-    assert task.constants._db_dict[CryonirspBudName.num_modstates.value] == num_modstates
+    if num_modstates == 0:
+        assert task.constants._db_dict[CryonirspBudName.num_modstates.value] == 1
+    else:
+        assert task.constants._db_dict[CryonirspBudName.num_modstates.value] == num_modstates
     assert task.constants._db_dict[CryonirspBudName.num_map_scans.value] == num_map_scans
     assert task.constants._db_dict[CryonirspBudName.num_scan_steps.value] == num_scan_steps
     assert task.constants._db_dict[CryonirspBudName.modulator_spin_mode.value] == "Continuous"

{dkist_processing_cryonirsp-0.0.58 → dkist_processing_cryonirsp-0.0.59}/dkist_processing_cryonirsp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dkist-processing-cryonirsp
-Version: 0.0.58
+Version: 0.0.59
 Summary: Science processing code for the Cryo-NIRSP instrument on DKIST
 Home-page: https://bitbucket.org/dkistdc/dkist_processing_cryonirsp/src/main/
 Author: NSO / AURA