dkist-processing-common 11.7.0rc3__py3-none-any.whl → 11.7.0rc4__py3-none-any.whl

dkist_processing_common/models/constants.py

@@ -44,9 +44,9 @@ class BudName(StrEnum):
     software_binning_y = "SOFTWARE_BINNING_Y"
     hls_version = "HLS_VERSION"
     # Multi-task buds start here:
-    dark_observing_program_execution_id = "DARK_OBSERVING_PROGRAM_EXECUTION_ID"
-    solar_gain_observing_program_execution_id = "SOLAR_GAIN_OBSERVING_PROGRAM_EXECUTION_ID"
-    polcal_observing_program_execution_id = "POLCAL_OBSERVING_PROGRAM_EXECUTION_ID"
+    dark_observing_program_execution_ids = "DARK_OBSERVING_PROGRAM_EXECUTION_IDS"
+    solar_gain_observing_program_execution_ids = "SOLAR_GAIN_OBSERVING_PROGRAM_EXECUTION_IDS"
+    polcal_observing_program_execution_ids = "POLCAL_OBSERVING_PROGRAM_EXECUTION_IDS"
     dark_date_begin = "DARK_DATE_BEGIN"
     solar_gain_date_begin = "SOLAR_GAIN_DATE_BEGIN"
     polcal_date_begin = "POLCAL_DATE_BEGIN"
@@ -285,21 +285,21 @@ class ConstantsBase:
     # Multi-task constants start here:
 
     @property
-    def dark_observing_program_execution_id(self) -> list[str]:
-        """Return the observing program execution id constant for the dark task."""
-        observing_programs = self._db_dict[BudName.dark_observing_program_execution_id]
+    def dark_observing_program_execution_ids(self) -> list[str]:
+        """Return the observing program execution ids constant for the dark task."""
+        observing_programs = self._db_dict[BudName.dark_observing_program_execution_ids]
         return list(observing_programs)
 
     @property
-    def solar_gain_observing_program_execution_id(self) -> list[str]:
-        """Return the observing program execution id constant for the solar_gain task."""
-        observing_programs = self._db_dict[BudName.solar_gain_observing_program_execution_id]
+    def solar_gain_observing_program_execution_ids(self) -> list[str]:
+        """Return the observing program execution ids constant for the solar_gain task."""
+        observing_programs = self._db_dict[BudName.solar_gain_observing_program_execution_ids]
         return list(observing_programs)
 
     @property
-    def polcal_observing_program_execution_id(self) -> list[str]:
-        """Return the observing program execution id constant."""
-        observing_programs = self._db_dict[BudName.polcal_observing_program_execution_id]
+    def polcal_observing_program_execution_ids(self) -> list[str]:
+        """Return the observing program execution ids constant."""
+        observing_programs = self._db_dict[BudName.polcal_observing_program_execution_ids]
         return list(observing_programs)
 
     @property

dkist_processing_common/parsers/observing_program_id_bud.py

@@ -0,0 +1,24 @@
+"""Observing Program Id parser."""
+
+from typing import Callable
+
+from dkist_processing_common.models.fits_access import MetadataKey
+from dkist_processing_common.parsers.id_bud import TaskContributingIdsBud
+from dkist_processing_common.parsers.task import passthrough_header_ip_task
+
+
+class TaskContributingObservingProgramExecutionIdsBud(TaskContributingIdsBud):
+    """Class to create a Bud for the supporting observing_program_ids."""
+
+    def __init__(
+        self,
+        constant_name: str,
+        ip_task_types: str | list[str],
+        task_type_parsing_function: Callable = passthrough_header_ip_task,
+    ):
+        super().__init__(
+            constant_name=constant_name,
+            metadata_key=MetadataKey.observing_program_execution_id,
+            ip_task_types=ip_task_types,
+            task_type_parsing_function=task_type_parsing_function,
+        )

dkist_processing_common/tasks/parse_l0_input_data.py

@@ -37,7 +37,9 @@ from dkist_processing_common.models.task_name import TaskName
 from dkist_processing_common.parsers.average_bud import TaskAverageBud
 from dkist_processing_common.parsers.experiment_id_bud import ContributingExperimentIdsBud
 from dkist_processing_common.parsers.experiment_id_bud import ExperimentIdBud
-from dkist_processing_common.parsers.id_bud import TaskContributingIdsBud
+from dkist_processing_common.parsers.observing_program_id_bud import (
+    TaskContributingObservingProgramExecutionIdsBud,
+)
 from dkist_processing_common.parsers.proposal_id_bud import ContributingProposalIdsBud
 from dkist_processing_common.parsers.proposal_id_bud import ProposalIdBud
 from dkist_processing_common.parsers.task import parse_header_ip_task_with_gains
@@ -88,20 +90,17 @@ def dataset_extra_bud_factory() -> list[S]:
             constant_name=BudName.hls_version,
             metadata_key=MetadataKey.hls_version,
         ),
-        TaskContributingIdsBud(
-            constant_name=BudName.dark_observing_program_execution_id,
-            metadata_key=MetadataKey.observing_program_execution_id,
+        TaskContributingObservingProgramExecutionIdsBud(
+            constant_name=BudName.dark_observing_program_execution_ids,
             ip_task_types=TaskName.dark,
         ),
-        TaskContributingIdsBud(
-            constant_name=BudName.solar_gain_observing_program_execution_id,
-            metadata_key=MetadataKey.observing_program_execution_id,
+        TaskContributingObservingProgramExecutionIdsBud(
+            constant_name=BudName.solar_gain_observing_program_execution_ids,
             ip_task_types=TaskName.solar_gain,
             task_type_parsing_function=parse_header_ip_task_with_gains,
         ),
-        TaskContributingIdsBud(
-            constant_name=BudName.polcal_observing_program_execution_id,
-            metadata_key=MetadataKey.observing_program_execution_id,
+        TaskContributingObservingProgramExecutionIdsBud(
+            constant_name=BudName.polcal_observing_program_execution_ids,
             ip_task_types=TaskName.polcal,
         ),
         TaskUniqueBud(
@@ -120,11 +119,6 @@ def dataset_extra_bud_factory() -> list[S]:
             metadata_key=MetadataKey.num_raw_frames_per_fpa,
             ip_task_types=TaskName.polcal,
         ),
-        TaskUniqueBud(
-            constant_name=BudName.dark_telescope_tracking_mode,
-            metadata_key=MetadataKey.telescope_tracking_mode,
-            ip_task_types=TaskName.dark,
-        ),
         TaskUniqueBud(
             constant_name=BudName.solar_gain_telescope_tracking_mode,
             metadata_key=MetadataKey.telescope_tracking_mode,
@@ -136,11 +130,6 @@ def dataset_extra_bud_factory() -> list[S]:
             metadata_key=MetadataKey.telescope_tracking_mode,
             ip_task_types=TaskName.polcal,
         ),
-        TaskUniqueBud(
-            constant_name=BudName.dark_coude_table_tracking_mode,
-            metadata_key=MetadataKey.coude_table_tracking_mode,
-            ip_task_types=TaskName.dark,
-        ),
         TaskUniqueBud(
             constant_name=BudName.solar_gain_coude_table_tracking_mode,
             metadata_key=MetadataKey.coude_table_tracking_mode,
@@ -152,11 +141,6 @@ def dataset_extra_bud_factory() -> list[S]:
             metadata_key=MetadataKey.coude_table_tracking_mode,
             ip_task_types=TaskName.polcal,
         ),
-        TaskUniqueBud(
-            constant_name=BudName.dark_telescope_scanning_mode,
-            metadata_key=MetadataKey.telescope_scanning_mode,
-            ip_task_types=TaskName.dark,
-        ),
         TaskUniqueBud(
             constant_name=BudName.solar_gain_telescope_scanning_mode,
             metadata_key=MetadataKey.telescope_scanning_mode,

dkist_processing_common/tests/test_parse_l0_input_data.py

@@ -260,7 +260,7 @@ def test_subclass_flowers(visp_parse_inputs_task, max_cs_step_time_sec):
     tag_pot, constant_pot = visp_parse_inputs_task.make_flower_pots()
 
     assert len(tag_pot.stems) == 1
-    assert len(constant_pot.stems) == 64
+    assert len(constant_pot.stems) == 61
     all_flower_names = [StemName.modstate]
     assert sorted([f.stem_name for f in tag_pot.stems]) == sorted(all_flower_names)
     all_bud_names = [b.stem_name for b in default_constant_bud_factory()] + [BudName.num_modstates]
@@ -277,7 +277,7 @@ def test_dataset_extra_bud_factory(visp_parse_inputs_task, max_cs_step_time_sec)
     stem_names = [f.stem_name.value for f in constant_pot.stems]
     bud_name_base = [
         "DATE_BEGIN",
-        "OBSERVING_PROGRAM_EXECUTION_ID",
+        "OBSERVING_PROGRAM_EXECUTION_IDS",
         "NUM_RAW_FRAMES_PER_FPA",
         "TELESCOPE_TRACKING_MODE",
         "COUDE_TABLE_TRACKING_MODE",
@@ -295,8 +295,9 @@ def test_dataset_extra_bud_factory(visp_parse_inputs_task, max_cs_step_time_sec)
         "GOS_LEVEL0_STATUS",
     ]
     for base in bud_name_base:
-        assert "DARK_" + base in stem_names
         assert "SOLAR_GAIN_" + base in stem_names
+        if "MODE" not in base:
+            assert "DARK_" + base in stem_names
         if "GOS" not in base:
             assert "POLCAL_" + base in stem_names
 

dkist_processing_common/tests/test_stems.py

@@ -19,6 +19,9 @@ from dkist_processing_common.parsers.experiment_id_bud import ExperimentIdBud
 from dkist_processing_common.parsers.id_bud import TaskContributingIdsBud
 from dkist_processing_common.parsers.near_bud import NearFloatBud
 from dkist_processing_common.parsers.near_bud import TaskNearFloatBud
+from dkist_processing_common.parsers.observing_program_id_bud import (
+    TaskContributingObservingProgramExecutionIdsBud,
+)
 from dkist_processing_common.parsers.proposal_id_bud import ContributingProposalIdsBud
 from dkist_processing_common.parsers.proposal_id_bud import ProposalIdBud
 from dkist_processing_common.parsers.retarder import RetarderNameBud
@@ -51,6 +54,7 @@ class FitsReaderMetadataKey(StrEnum):
     near_thing = "near"
     proposal_id = "ID___013"
     experiment_id = "ID___012"
+    observing_program_execution_id = "ID___008"
     ip_task_type = "DKIST004"
     ip_start_time = "DKIST011"
     fpa_exposure_time_ms = "XPOSURE"
@@ -77,6 +81,9 @@ class FitsReader(FitsAccessBase):
         self.name = name
         self.proposal_id: str = self.header.get(FitsReaderMetadataKey.proposal_id)
         self.experiment_id: str = self.header.get(FitsReaderMetadataKey.experiment_id)
+        self.observing_program_execution_id: str = self.header.get(
+            FitsReaderMetadataKey.observing_program_execution_id
+        )
         self.ip_task_type: str = self.header.get(FitsReaderMetadataKey.ip_task_type)
         self.ip_start_time: str = self.header.get(FitsReaderMetadataKey.ip_start_time)
         self.fpa_exposure_time_ms: float = self.header.get(
@@ -113,6 +120,7 @@ def basic_header_objs():
                 "DKIST004": "observe",
                 "ID___012": "experiment_id_1",
                 "ID___013": "proposal_id_1",
+                "ID___008": "observing_program_execution_id_1",
                 "XPOSURE": 0.0013000123,
                 "TEXPOSUR": 10.0,
                 "NSUMEXP": 3,
@@ -131,6 +139,7 @@ def basic_header_objs():
                 "DKIST004": "observe",
                 "ID___012": "experiment_id_1",
                 "ID___013": "proposal_id_1",
+                "ID___008": "observing_program_execution_id_2",
                 "XPOSURE": 0.0013000987,
                 "TEXPOSUR": 10.0,
                 "NSUMEXP": 3,
@@ -150,6 +159,7 @@ def basic_header_objs():
                 "DKIST004": "dark",
                 "ID___012": "experiment_id_2",
                 "ID___013": "proposal_id_2",
+                "ID___008": "observing_program_execution_id_2",
                 "XPOSURE": 12.345,
                 "TEXPOSUR": 1.123456789,
                 "NSUMEXP": 1,
@@ -170,6 +180,7 @@ def basic_header_objs():
                 "DKIST004": "observe",
                 "ID___012": "experiment_id_1",
                 "ID___013": "proposal_id_1",
+                "ID___008": "observing_program_execution_id_1",
                 "XPOSURE": 100.0,
                 "TEXPOSUR": 11.0,
                 "NSUMEXP": 4,
@@ -185,6 +196,7 @@ def basic_header_objs():
             {
                 "DKIST004": "gain",
                 "ID___013": "proposal_id_1",
+                "ID___008": "observing_program_execution_id_1",
                 "id_key": 0,
                 "constant": 6.28,
                 "near": 1.23,
@@ -603,6 +615,29 @@ def test_task_contributing_ids_bud(basic_header_objs):
     assert sorted(list(petal[0].value)) == ["experiment_id_2"]
 
 
+def test_task_contributing_observing_program_ids_bud(basic_header_objs):
+    """
+    Given: A set of headers with observing program ID values for different tasks
+    When: Ingesting the headers with a TaskContributingIdsBud for a task type
+    Then: The Bud's petal is just the experiment ID for the that task type
+    """
+    bud = TaskContributingObservingProgramExecutionIdsBud(
+        constant_name="NOT_A_REAL_BUD",
+        ip_task_types=TaskName.observe,
+    )
+    assert bud.stem_name == "NOT_A_REAL_BUD"
+    for fo in basic_header_objs:
+        key = fo.name
+        bud.update(key, fo)
+
+    petal = list(bud.petals)
+    assert len(petal) == 1
+    assert sorted(list(petal[0].value)) == [
+        "observing_program_execution_id_1",
+        "observing_program_execution_id_2",
+    ]
+
+
 def test_exp_time_flower(basic_header_objs):
     """
     Given: A set of filepaths and associated headers with XPOSURE keywords

{dkist_processing_common-11.7.0rc3.dist-info → dkist_processing_common-11.7.0rc4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dkist-processing-common
-Version: 11.7.0rc3
+Version: 11.7.0rc4
 Summary: Common task classes used by the DKIST science data processing pipelines
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause

{dkist_processing_common-11.7.0rc3.dist-info → dkist_processing_common-11.7.0rc4.dist-info}/RECORD

@@ -27,7 +27,7 @@ dkist_processing_common/codecs/str.py,sha256=Xqt5k8IhLc95KiiNiFwB1JWcVVc6T8AfcLr
 dkist_processing_common/fonts/Lato-Regular.ttf,sha256=1jbkaDIx-THtoiLViOlE0IK_0726AvkovuRhwPGFslE,656568
 dkist_processing_common/fonts/__init__.py,sha256=hBvZRtkoGRPlNDWCK-ZePXdSIlThCcjwBDfYaamVgAw,101
 dkist_processing_common/models/__init__.py,sha256=6LMqemdzVZ87fRrpAsbEnTtWZ02_Gu_oajsUlwGRH_Q,74
-dkist_processing_common/models/constants.py,sha256=zwDHNmRUajbTg6-FUYqzbT07kIMipNyLRqKn36Rf_rA,20873
+dkist_processing_common/models/constants.py,sha256=-bJpDnp_CaJ0KgRx4_kcBo2Sy-iC1JWSFwdkzR8Q0lQ,20888
 dkist_processing_common/models/dkist_location.py,sha256=6Nk0wvv4R8ptlrV7BXon7abq4YLvmTdUmPsDN5G8nWc,971
 dkist_processing_common/models/fits_access.py,sha256=imKqL4-_g6gTR-IeIjZ6qkMhQX3JujdrKFrTd9gOXnw,5605
 dkist_processing_common/models/flower_pot.py,sha256=_J7DwHM8u5kQfdPCpk5pUmALtLrM1L_h-x8JW5BSjXA,5129
@@ -52,6 +52,7 @@ dkist_processing_common/parsers/id_bud.py,sha256=dWNr-njRqDzTnXa2WLZQEb48ul7RdeG
 dkist_processing_common/parsers/l0_fits_access.py,sha256=Ol3eo8yyNbGqbN2whhD2jBNoqhOrlwmH8DbMmCLtNk0,1033
 dkist_processing_common/parsers/l1_fits_access.py,sha256=BWojvcFl_RmkrRWHe1WxDCsPeexervlRFPothuXAyoI,4410
 dkist_processing_common/parsers/near_bud.py,sha256=ithuQpnAaK5MDXFhMPNoNIGuF2M94q0n6_qofGl-CdU,4006
+dkist_processing_common/parsers/observing_program_id_bud.py,sha256=dmskHh9cVdSqcRk5Z8rVw9vihGDo_iKugmpjDmzrYWI,874
 dkist_processing_common/parsers/proposal_id_bud.py,sha256=VvVoYM-MUivra2fMZOSAOgGQslLROZxFuwHnuAZyAjc,942
 dkist_processing_common/parsers/quality.py,sha256=hhCT-bHODOYSp9jvgsiWfYcLYtQCSWgfuy0xZnkYXwo,1141
 dkist_processing_common/parsers/retarder.py,sha256=AvDrMLmxuwKOIP3NNm9mtV7dV2kw_aqW92hTLd1UdK0,1507
@@ -65,7 +66,7 @@ dkist_processing_common/tasks/assemble_movie.py,sha256=1ixDG-f4ODt0vywqVccG3aodL
 dkist_processing_common/tasks/base.py,sha256=itAHCvzcodo-q8_AjpWoRaM86BlcjWDpCIiUP7uwmP0,13236
 dkist_processing_common/tasks/l1_output_data.py,sha256=D4S3kH2uRKp1b8_xF2YiWO_mGj19UJS5wKQZ4OdatGs,10568
 dkist_processing_common/tasks/output_data_base.py,sha256=r1Bu3FX5zTVj66GTMWtaV_NdhxjyjSm661Bt2Mxmfi4,3685
-dkist_processing_common/tasks/parse_l0_input_data.py,sha256=Mg3Wk6JApGJX0YbO1kIx3RzlKTt_6nBcbhbwS1B1t6A,19718
+dkist_processing_common/tasks/parse_l0_input_data.py,sha256=R9IDCwuzJ9U5HG0Clm6SAMKKLR9aC9yfxQu62S-z19U,19034
 dkist_processing_common/tasks/quality_metrics.py,sha256=cvGF6tJ8yAvxOvkeG3tWxYwL885BrFW5X3V7_MSzL-A,12481
 dkist_processing_common/tasks/teardown.py,sha256=rwT9lWINVDF11-az_nx-Z5ykMTX_SJCchobpU6sErgk,2360
 dkist_processing_common/tasks/transfer_input_data.py,sha256=DAYfS-B1o-iBT9MXU-TiJG4Hv05Z0c_JzPrnFgvnK9g,5786
@@ -99,12 +100,12 @@ dkist_processing_common/tests/test_interservice_bus_mixin.py,sha256=IptJkW7Qeu2Y
 dkist_processing_common/tests/test_manual_processing.py,sha256=iHF7yQPlar9niYAGXtFv28Gw3Undlds38yMfszk4ccY,1037
 dkist_processing_common/tests/test_output_data_base.py,sha256=D8b1XKvbE3C5cGOiHq58yJ2pzQL3iL0wLZy_AkDdB9Y,3085
 dkist_processing_common/tests/test_parameters.py,sha256=CUEUIGBPMCUXPll0G0UxFDbMXi8lmnjRwXBarGX1PAQ,14033
-dkist_processing_common/tests/test_parse_l0_input_data.py,sha256=I2djQFvFTpI9XaHwig8ig9r3DBCA6mamzscRISavc-k,11691
+dkist_processing_common/tests/test_parse_l0_input_data.py,sha256=OoGqlH_sitvLra7ViydKRdRCr32eJQvCq0hDPdWEvBg,11727
 dkist_processing_common/tests/test_publish_catalog_messages.py,sha256=l6Wga1s2wNBIf4wGZ78ZIO_rtqjdidmtvlN9nMnQUAs,3222
 dkist_processing_common/tests/test_quality.py,sha256=IPz7liXcmoqWIsY78oX07Ui0nWHxoUH2FbKGEmMle7E,10258
 dkist_processing_common/tests/test_quality_mixin.py,sha256=qanm3SXEiLb0OJDawbh8ixVAG9uRglFMzwxTeYxkDsM,55369
 dkist_processing_common/tests/test_scratch.py,sha256=WO8C1VJlkcC5IzST9Hj08CyyrINwYcN8pyteD9x38xs,16482
-dkist_processing_common/tests/test_stems.py,sha256=Q-XrrTrF4joeWLh50vWpt34LrQ3mwLXqLraJszq0WLc,37460
+dkist_processing_common/tests/test_stems.py,sha256=LnGuyh7L1y2Gud6oOaZpIXMQsD4LiKFsRwJ8WPeWe9s,38891
 dkist_processing_common/tests/test_submit_dataset_metadata.py,sha256=LHEyjoIxJHXXssqKkr8Qn1NzzHD1FLJiD3lP8yaLiXU,3764
 dkist_processing_common/tests/test_tags.py,sha256=w5gmVfp3Ck92KNV80lJQRMz0OYgTYzWtwVUFWv1b5i8,5024
 dkist_processing_common/tests/test_task_name.py,sha256=kqFr59XX2K87xzfTlClzDV4-Je1dx72LvdaJ22UE8UU,1233
@@ -124,7 +125,7 @@ docs/landing_page.rst,sha256=aPAuXFhBx73lEZ59B6E6JXxkK0LlxzD0n-HXqHrfumQ,746
 docs/make.bat,sha256=mBAhtURwhQ7yc95pqwJzlhqBSvRknr1aqZ5s8NKvdKs,4513
 docs/requirements.txt,sha256=Kbl_X4c7RQZw035YTeNB63We6I7pvXFU4T0Uflp2yDY,29
 licenses/LICENSE.rst,sha256=piZaQplkzOMmH1NXg6QIdo9wwo9pPCoHkvm2-DmH76E,1462
-dkist_processing_common-11.7.0rc3.dist-info/METADATA,sha256=x7gZ2v1D_PI0eQ_8NPwGptH63QUVYw2dvUdRoGAA8JI,13316
-dkist_processing_common-11.7.0rc3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-dkist_processing_common-11.7.0rc3.dist-info/top_level.txt,sha256=LJhd1W-Vn90K8HnQDIE4r52YDpUjjMWDnllAWHBByW0,48
-dkist_processing_common-11.7.0rc3.dist-info/RECORD,,
+dkist_processing_common-11.7.0rc4.dist-info/METADATA,sha256=pRBfFqyqarQKT1UZ9eiLwrhyfeSA9WXClBoPdFps9nw,13316
+dkist_processing_common-11.7.0rc4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+dkist_processing_common-11.7.0rc4.dist-info/top_level.txt,sha256=LJhd1W-Vn90K8HnQDIE4r52YDpUjjMWDnllAWHBByW0,48
+dkist_processing_common-11.7.0rc4.dist-info/RECORD,,