dkist-processing-common 11.7.1rc1__py3-none-any.whl → 11.8.0rc1__py3-none-any.whl

changelog/245.feature.1.rst

@@ -0,0 +1 @@
+Add parameters and their associated values relevant to a particular processing pipeline run to the metadata ASDF file generated in trial workflows.

dkist_processing_common/models/constants.py

@@ -6,6 +6,7 @@ accessing the database (tab completion, etc.)
 """
 
 from enum import StrEnum
+from enum import unique
 from string import ascii_uppercase
 
 from sqids import Sqids
@@ -13,6 +14,7 @@ from sqids import Sqids
 from dkist_processing_common._util.constants import ConstantsDb
 
 
+@unique
 class BudName(StrEnum):
     """Controlled list of names for constant stems (buds)."""
 
@@ -33,6 +35,58 @@ class BudName(StrEnum):
     dark_exposure_times = "DARK_EXPOSURE_TIMES"
     dark_readout_exp_times = "DARK_READOUT_EXP_TIMES"
     wavelength = "WAVELENGTH"
+    camera_id = "CAMERA_ID"
+    camera_name = "CAMERA_NAME"
+    camera_bit_depth = "CAMERA_BIT_DEPTH"
+    hardware_binning_x = "HARDWARE_BINNING_X"
+    hardware_binning_y = "HARDWARE_BINNING_Y"
+    software_binning_x = "SOFTWARE_BINNING_X"
+    software_binning_y = "SOFTWARE_BINNING_Y"
+    hls_version = "HLS_VERSION"
+    # Multi-task buds start here:
+    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"
+    dark_date_end = "DARK_DATE_END"
+    solar_gain_date_end = "SOLAR_GAIN_DATE_END"
+    polcal_date_end = "POLCAL_DATE_END"
+    solar_gain_num_raw_frames_per_fpa = "SOLAR_GAIN_NUM_RAW_FRAMES_PER_FPA"
+    polcal_num_raw_frames_per_fpa = "POLCAL_NUM_RAW_FRAMES_PER_FPA"
+    solar_gain_telescope_tracking_mode = "SOLAR_GAIN_TELESCOPE_TRACKING_MODE"
+    polcal_telescope_tracking_mode = "POLCAL_TELESCOPE_TRACKING_MODE"
+    solar_gain_coude_table_tracking_mode = "SOLAR_GAIN_COUDE_TABLE_TRACKING_MODE"
+    polcal_coude_table_tracking_mode = "POLCAL_COUDE_TABLE_TRACKING_MODE"
+    solar_gain_telescope_scanning_mode = "SOLAR_GAIN_TELESCOPE_SCANNING_MODE"
+    polcal_telescope_scanning_mode = "POLCAL_TELESCOPE_SCANNING_MODE"
+    dark_average_light_level = "DARK_AVERAGE_LIGHT_LEVEL"
+    solar_gain_average_light_level = "SOLAR_GAIN_AVERAGE_LIGHT_LEVEL"
+    polcal_average_light_level = "POLCAL_AVERAGE_LIGHT_LEVEL"
+    dark_average_telescope_elevation = "DARK_AVERAGE_TELESCOPE_ELEVATION"
+    solar_gain_average_telescope_elevation = "SOLAR_GAIN_AVERAGE_TELESCOPE_ELEVATION"
+    polcal_average_telescope_elevation = "POLCAL_AVERAGE_TELESCOPE_ELEVATION"
+    dark_average_coude_table_angle = "DARK_AVERAGE_COUDE_TABLE_ANGLE"
+    solar_gain_average_coude_table_angle = "SOLAR_GAIN_AVERAGE_COUDE_TABLE_ANGLE"
+    polcal_average_coude_table_angle = "POLCAL_AVERAGE_COUDE_TABLE_ANGLE"
+    dark_average_telescope_azimuth = "DARK_AVERAGE_TELESCOPE_AZIMUTH"
+    solar_gain_average_telescope_azimuth = "SOLAR_GAIN_AVERAGE_TELESCOPE_AZIMUTH"
+    polcal_average_telescope_azimuth = "POLCAL_AVERAGE_TELESCOPE_AZIMUTH"
+    dark_gos_level3_status = "DARK_GOS_LEVEL3_STATUS"
+    solar_gain_gos_level3_status = "SOLAR_GAIN_GOS_LEVEL3_STATUS"
+    dark_gos_level3_lamp_status = "DARK_GOS_LEVEL3_LAMP_STATUS"
+    solar_gain_gos_level3_lamp_status = "SOLAR_GAIN_GOS_LEVEL3_LAMP_STATUS"
+    dark_gos_polarizer_status = "DARK_GOS_POLARIZER_STATUS"
+    solar_gain_gos_polarizer_status = "SOLAR_GAIN_GOS_POLARIZER_STATUS"
+    dark_gos_polarizer_angle = "DARK_GOS_POLARIZER_ANGLE"
+    solar_gain_gos_polarizer_angle = "SOLAR_GAIN_GOS_POLARIZER_ANGLE"
+    dark_gos_retarder_status = "DARK_GOS_RETARDER_STATUS"
+    solar_gain_gos_retarder_status = "SOLAR_GAIN_GOS_RETARDER_STATUS"
+    dark_gos_retarder_angle = "DARK_GOS_RETARDER_ANGLE"
+    solar_gain_gos_retarder_angle = "SOLAR_GAIN_GOS_RETARDER_ANGLE"
+    dark_gos_level0_status = "DARK_GOS_LEVEL0_STATUS"
+    solar_gain_gos_level0_status = "SOLAR_GAIN_GOS_LEVEL0_STATUS"
 
 
 class ConstantsBase:
@@ -87,11 +141,11 @@ class ConstantsBase:
 
     @property
     def dataset_id(self) -> str:
-        """Define the dataset_id constant."""
+        """Define the dataset id constant."""
         return Sqids(min_length=6, alphabet=ascii_uppercase).encode([self._recipe_run_id])
 
     @property
-    def stokes_params(self) -> [str]:
+    def stokes_params(self) -> list[str]:
         """Return the list of stokes parameter names."""
         return ["I", "Q", "U", "V"]
 
@@ -101,45 +155,41 @@ class ConstantsBase:
         return self._db_dict[BudName.instrument]
 
     @property
-    def num_cs_steps(self):
+    def num_cs_steps(self) -> int:
         """Get the number of calibration sequence steps."""
         return self._db_dict[BudName.num_cs_steps]
 
     @property
-    def num_modstates(self):
+    def num_modstates(self) -> int:
         """Get the number of modulation states."""
         return self._db_dict[BudName.num_modstates]
 
     @property
-    def retarder_name(self):
+    def retarder_name(self) -> str:
         """Get the retarder name."""
         return self._db_dict[BudName.retarder_name]
 
     @property
     def proposal_id(self) -> str:
-        """Get the proposal_id constant."""
+        """Get the proposal ID constant."""
         return self._db_dict[BudName.proposal_id]
 
     @property
-    def contributing_proposal_ids(self) -> [str]:
+    def contributing_proposal_ids(self) -> list[str]:
         """Return the list of contributing proposal IDs."""
         proposal_ids = self._db_dict[BudName.contributing_proposal_ids]
-        if isinstance(proposal_ids, str):
-            return [proposal_ids]
-        return proposal_ids
+        return list(proposal_ids)
 
     @property
     def experiment_id(self) -> str:
-        """Get the experiment_id constant."""
+        """Get the experiment ID constant."""
         return self._db_dict[BudName.experiment_id]
 
     @property
-    def contributing_experiment_ids(self) -> [str]:
+    def contributing_experiment_ids(self) -> list[str]:
         """Return the list of contributing experiment IDs."""
         experiment_ids = self._db_dict[BudName.contributing_experiment_ids]
-        if isinstance(experiment_ids, str):
-            return [experiment_ids]
-        return experiment_ids
+        return list(experiment_ids)
 
     @property
     def obs_ip_start_time(self) -> str:
@@ -148,7 +198,7 @@ class ConstantsBase:
 
     @property
     def average_cadence(self) -> float:
-        """Get the average_cadence constant."""
+        """Get the average cadence constant."""
         return self._db_dict[BudName.average_cadence]
 
     @property
@@ -172,16 +222,278 @@ class ConstantsBase:
         return self._db_dict[BudName.num_dsps_repeats]
 
     @property
-    def dark_exposure_times(self) -> [float]:
+    def dark_exposure_times(self) -> list[float]:
         """Get a list of exposure times used in the dark calibration."""
-        return self._db_dict[BudName.dark_exposure_times]
+        exposure_times = self._db_dict[BudName.dark_exposure_times]
+        return list(exposure_times)
 
     @property
-    def dark_readout_exp_times(self) -> [float]:
-        """Get a list of readout exp times for all DARK frames."""
-        return self._db_dict[BudName.dark_readout_exp_times]
+    def dark_readout_exp_times(self) -> list[float]:
+        """Get a list of readout exp times for all dark frames."""
+        readout_times = self._db_dict[BudName.dark_readout_exp_times]
+        return list(readout_times)
 
     @property
     def wavelength(self) -> float:
         """Wavelength."""
         return self._db_dict[BudName.wavelength]
+
+    @property
+    def camera_id(self) -> str:
+        """Return the camera ID constant."""
+        return self._db_dict[BudName.camera_id]
+
+    @property
+    def camera_name(self) -> str:
+        """Return the camera name for humans constant."""
+        return self._db_dict[BudName.camera_name]
+
+    @property
+    def camera_bit_depth(self) -> int:
+        """Return the camera bit depth constant."""
+        return self._db_dict[BudName.camera_bit_depth]
+
+    @property
+    def hardware_binning_x(self) -> int:
+        """Return the x-direction hardware binning constant."""
+        return self._db_dict[BudName.hardware_binning_x]
+
+    @property
+    def hardware_binning_y(self) -> int:
+        """Return the y-direction hardware binning constant."""
+        return self._db_dict[BudName.hardware_binning_y]
+
+    @property
+    def software_binning_x(self) -> int:
+        """Return the x-direction software binning constant."""
+        return self._db_dict[BudName.software_binning_x]
+
+    @property
+    def software_binning_y(self) -> int:
+        """Return the y-direction software binning constant."""
+        return self._db_dict[BudName.software_binning_y]
+
+    @property
+    def hls_version(self) -> str:
+        """Return the High-Level Software version."""
+        return self._db_dict[BudName.hls_version]
+
+    # Multi-task constants start here:
+
+    @property
+    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_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_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
+    def dark_date_begin(self) -> str:
+        """Return the date begin header constant for the dark task."""
+        return self._db_dict[BudName.dark_date_begin]
+
+    @property
+    def solar_gain_date_begin(self) -> str:
+        """Return the date begin header constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_date_begin]
+
+    @property
+    def polcal_date_begin(self) -> str:
+        """Return the time obs header constant for the polcal task."""
+        return self._db_dict[BudName.polcal_date_begin]
+
+    @property
+    def dark_date_end(self) -> str:
+        """Return the date end constant for the dark task."""
+        return self._db_dict[BudName.dark_date_end]
+
+    @property
+    def solar_gain_date_end(self) -> str:
+        """Return the date end constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_date_end]
+
+    @property
+    def polcal_date_end(self) -> str:
+        """Return the date end constant for the polcal task."""
+        return self._db_dict[BudName.polcal_date_end]
+
+    @property
+    def solar_gain_num_raw_frames_per_fpa(self) -> int:
+        """Return the number of raw frames per fpa constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_num_raw_frames_per_fpa]
+
+    @property
+    def polcal_num_raw_frames_per_fpa(self) -> int:
+        """Return the num raw frames per fpa constant for the polcal task."""
+        return self._db_dict[BudName.polcal_num_raw_frames_per_fpa]
+
+    @property
+    def solar_gain_telescope_tracking_mode(self) -> str:
+        """Return the telescope tracking mode constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_telescope_tracking_mode]
+
+    @property
+    def polcal_telescope_tracking_mode(self) -> str:
+        """Return the telescope tracking mode constant for the polcal task."""
+        return self._db_dict[BudName.polcal_telescope_tracking_mode]
+
+    @property
+    def solar_gain_coude_table_tracking_mode(self) -> str:
+        """Return the coude table tracking mode constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_coude_table_tracking_mode]
+
+    @property
+    def polcal_coude_table_tracking_mode(self) -> str:
+        """Return the coude table tracking mode constant for the polcal task."""
+        return self._db_dict[BudName.polcal_coude_table_tracking_mode]
+
+    @property
+    def solar_gain_telescope_scanning_mode(self) -> str:
+        """Return the telescope scanning mode constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_telescope_scanning_mode]
+
+    @property
+    def polcal_telescope_scanning_mode(self) -> str:
+        """Return the telescope scanning mode constant for the polcal task."""
+        return self._db_dict[BudName.polcal_telescope_scanning_mode]
+
+    @property
+    def dark_average_light_level(self) -> float:
+        """Return the average light level constant for the dark task."""
+        return self._db_dict[BudName.dark_average_light_level]
+
+    @property
+    def solar_gain_average_light_level(self) -> float:
+        """Return the average light level constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_average_light_level]
+
+    @property
+    def polcal_average_light_level(self) -> float:
+        """Return the average light level constant for the polcal task."""
+        return self._db_dict[BudName.polcal_average_light_level]
+
+    @property
+    def dark_average_telescope_elevation(self) -> float:
+        """Return the average telescope elevation constant for the dark task."""
+        return self._db_dict[BudName.dark_average_telescope_elevation]
+
+    @property
+    def solar_gain_average_telescope_elevation(self) -> float:
+        """Return the average telescope elevation constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_average_telescope_elevation]
+
+    @property
+    def polcal_average_telescope_elevation(self) -> float:
+        """Return the average telescope elevation constant for the polcal task."""
+        return self._db_dict[BudName.polcal_average_telescope_elevation]
+
+    @property
+    def dark_average_coude_table_angle(self) -> float:
+        """Return the average coude table angle constant for the dark task."""
+        return self._db_dict[BudName.dark_average_coude_table_angle]
+
+    @property
+    def solar_gain_average_coude_table_angle(self) -> float:
+        """Return the average coude table angle constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_average_coude_table_angle]
+
+    @property
+    def polcal_average_coude_table_angle(self) -> float:
+        """Return the average coude table angle constant for the polcal task."""
+        return self._db_dict[BudName.polcal_average_coude_table_angle]
+
+    @property
+    def dark_average_telescope_azimuth(self) -> float:
+        """Return the average telescope azimuth constant for the dark task."""
+        return self._db_dict[BudName.dark_average_telescope_azimuth]
+
+    @property
+    def solar_gain_average_telescope_azimuth(self) -> float:
+        """Return the average telescope azimuth constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_average_telescope_azimuth]
+
+    @property
+    def polcal_average_telescope_azimuth(self) -> float:
+        """Return the average telescope azimuth constant for the polcal task."""
+        return self._db_dict[BudName.polcal_average_telescope_azimuth]
+
+    @property
+    def dark_gos_level3_status(self) -> str:
+        """Return the gos level3 status constant for the dark task."""
+        return self._db_dict[BudName.dark_gos_level3_status]
+
+    @property
+    def solar_gain_gos_level3_status(self) -> str:
+        """Return the gos level3 status constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_gos_level3_status]
+
+    @property
+    def dark_gos_level3_lamp_status(self) -> str:
+        """Return the gos level3 lamp status constant for the dark task."""
+        return self._db_dict[BudName.dark_gos_level3_lamp_status]
+
+    @property
+    def solar_gain_gos_level3_lamp_status(self) -> str:
+        """Return the gos level3 lamp status constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_gos_level3_lamp_status]
+
+    @property
+    def dark_gos_polarizer_status(self) -> str:
+        """Return the gos polarizer status constant for the dark task."""
+        return self._db_dict[BudName.dark_gos_polarizer_status]
+
+    @property
+    def solar_gain_gos_polarizer_status(self) -> str:
+        """Return the gos polarizer status constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_gos_polarizer_status]
+
+    @property
+    def dark_gos_polarizer_angle(self) -> float:
+        """Return the gos polarizer angle constant for the dark task."""
+        return self._db_dict[BudName.dark_gos_polarizer_angle]
+
+    @property
+    def solar_gain_gos_polarizer_angle(self) -> float:
+        """Return the gos polarizer angle constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_gos_polarizer_angle]
+
+    @property
+    def dark_gos_retarder_status(self) -> str:
+        """Return the gos retarder status constant for the dark task."""
+        return self._db_dict[BudName.dark_gos_retarder_status]
+
+    @property
+    def solar_gain_gos_retarder_status(self) -> str:
+        """Return the gos retarder status constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_gos_retarder_status]
+
+    @property
+    def dark_gos_retarder_angle(self) -> float:
+        """Return the gos retarder angle constant for the dark task."""
+        return self._db_dict[BudName.dark_gos_retarder_angle]
+
+    @property
+    def solar_gain_gos_retarder_angle(self) -> float:
+        """Return the gos retarder angle constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_gos_retarder_angle]
+
+    @property
+    def dark_gos_level0_status(self) -> str:
+        """Return the gos level0 status constant for the dark task."""
+        return self._db_dict[BudName.dark_gos_level0_status]
+
+    @property
+    def solar_gain_gos_level0_status(self) -> str:
+        """Return the gos level0 status constant for the solar gain task."""
+        return self._db_dict[BudName.solar_gain_gos_level0_status]

dkist_processing_common/models/fits_access.py

@@ -3,15 +3,16 @@
 from __future__ import annotations
 
 from enum import StrEnum
+from enum import unique
 from pathlib import Path
-from typing import Any
 
 import numpy as np
 from astropy.io import fits
 
-NOT_FOUND_MESSAGE = "_HEADER_KEYWORD_NOT_FOUND"
+HEADER_KEY_NOT_FOUND = "HEADER_KEY_NOT_FOUND"
 
 
+@unique
 class MetadataKey(StrEnum):
     """Controlled list of names for FITS metadata header keys."""
 
@@ -39,6 +40,19 @@ class MetadataKey(StrEnum):
     fpa_exposure_time_ms = "XPOSURE"
     sensor_readout_exposure_time_ms = "TEXPOSUR"
     num_raw_frames_per_fpa = "NSUMEXP"
+    camera_id = "CAM_ID"
+    camera_name = "CAMERA"
+    camera_bit_depth = "BITDEPTH"
+    hardware_binning_x = "HWBIN1"
+    hardware_binning_y = "HWBIN2"
+    software_binning_x = "SWBIN1"
+    software_binning_y = "SWBIN2"
+    observing_program_execution_id = "OBSPR_ID"
+    telescope_tracking_mode = "TELTRACK"
+    coude_table_tracking_mode = "TTBLTRCK"
+    telescope_scanning_mode = "TELSCAN"
+    light_level = "LIGHTLVL"
+    hls_version = "HLSVERS"
 
 
 class FitsAccessBase:
@@ -68,29 +82,6 @@ class FitsAccessBase:
     def __repr__(self):
         return f"{self.__class__.__name__}(hdu={self._hdu!r}, name={self.name!r}, auto_squeeze={self.auto_squeeze})"
 
-    def _set_metadata_key_value(
-        self, key: StrEnum, optional: bool = False, default: Any = NOT_FOUND_MESSAGE
-    ) -> None:
-        """
-        Get the header value and assign it as a metadata key name attribute.
-
-        Parameters
-        ----------
-        key
-            The StrEnum member in attribute_name = fits_keyword structure
-        optional
-            If the keyword is optional
-        default
-            Value for the attribute if the key is not found
-        """
-        if optional:
-            if default != NOT_FOUND_MESSAGE:
-                setattr(self, key.name, self.header.get(key, default))
-            else:
-                setattr(self, key.name, self.header.get(key, key + NOT_FOUND_MESSAGE))
-        else:
-            setattr(self, key.name, self.header[key])
-
     @property
     def data(self) -> np.ndarray:
         """

dkist_processing_common/parsers/average_bud.py

@@ -0,0 +1,48 @@
+"""Pre-made flower that reads a single header key from all files with specific task types and returns the average."""
+
+from enum import StrEnum
+from statistics import mean
+from typing import Callable
+from typing import Hashable
+
+import numpy as np
+
+from dkist_processing_common.parsers.near_bud import TaskNearFloatBud
+from dkist_processing_common.parsers.task import passthrough_header_ip_task
+
+
+class TaskAverageBud(TaskNearFloatBud):
+    """
+    Pre-made bud that returns the average of a single header key from all files with specific task types.
+
+    Parameters
+    ----------
+    constant_name
+        The name for the constant to be defined
+
+    metadata_key
+        The metadata key associated with the constant
+
+    ip_task_types
+        Only consider objects whose parsed header IP task type matches a string in this list
+
+    task_type_parsing_function
+        The function used to convert a header into an IP task type
+    """
+
+    key_to_petal_dict: dict[str, float]
+
+    def __init__(
+        self,
+        constant_name: str,
+        metadata_key: str | StrEnum,
+        ip_task_types: str | list[str],
+        task_type_parsing_function: Callable = passthrough_header_ip_task,
+    ):
+        super().__init__(
+            constant_name=constant_name,
+            metadata_key=metadata_key,
+            ip_task_types=ip_task_types,
+            tolerance=np.inf,
+            task_type_parsing_function=task_type_parsing_function,
+        )

dkist_processing_common/parsers/experiment_id_bud.py

@@ -2,16 +2,19 @@
 
 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.parsers.id_bud import ContributingIdsBud
-from dkist_processing_common.parsers.id_bud import IdBud
+from dkist_processing_common.parsers.unique_bud import TaskUniqueBud
 
 
-class ExperimentIdBud(IdBud):
+class ExperimentIdBud(TaskUniqueBud):
     """Class to create a Bud for the experiment_id."""
 
     def __init__(self):
         super().__init__(
-            constant_name=BudName.experiment_id, metadata_key=MetadataKey.experiment_id
+            constant_name=BudName.experiment_id,
+            metadata_key=MetadataKey.experiment_id,
+            ip_task_types=TaskName.observe,
         )
 
 
@@ -20,5 +23,6 @@ class ContributingExperimentIdsBud(ContributingIdsBud):
 
     def __init__(self):
         super().__init__(
-            stem_name=BudName.contributing_experiment_ids, metadata_key=MetadataKey.experiment_id
+            constant_name=BudName.contributing_experiment_ids,
+            metadata_key=MetadataKey.experiment_id,
         )

dkist_processing_common/parsers/id_bud.py

@@ -1,36 +1,25 @@
 """Base classes for ID bud parsing."""
 
 from enum import StrEnum
+from typing import Callable
 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.task_name import TaskName
 from dkist_processing_common.parsers.l0_fits_access import L0FitsAccess
-from dkist_processing_common.parsers.unique_bud import TaskUniqueBud
-
-
-class IdBud(TaskUniqueBud):
-    """Base class for ID buds."""
-
-    def __init__(self, constant_name: str, metadata_key: str | StrEnum):
-        super().__init__(
-            constant_name=constant_name,
-            metadata_key=metadata_key,
-            ip_task_types=TaskName.observe,
-        )
+from dkist_processing_common.parsers.task import passthrough_header_ip_task
 
 
 class ContributingIdsBud(Stem):
     """Base class for contributing ID buds."""
 
-    def __init__(self, stem_name: str, metadata_key: str | StrEnum):
-        super().__init__(stem_name=stem_name)
+    def __init__(self, constant_name: str, metadata_key: str | StrEnum):
+        super().__init__(stem_name=constant_name)
         if isinstance(metadata_key, StrEnum):
             metadata_key = metadata_key.name
         self.metadata_key = metadata_key
 
-    def setter(self, fits_obj: L0FitsAccess) -> str | Type[SpilledDirt]:
+    def setter(self, fits_obj: L0FitsAccess) -> str:
         """
         Set the id for any type of frame.
 
@@ -44,9 +33,9 @@ class ContributingIdsBud(Stem):
         """
         return getattr(fits_obj, self.metadata_key)
 
-    def getter(self, key) -> tuple:
+    def getter(self, key) -> tuple[str, ...]:
         """
-        Get all ids seen in non observe frames.
+        Get all ids seen for any type of frame.
 
         Parameters
         ----------
@@ -55,6 +44,33 @@ class ContributingIdsBud(Stem):
 
         Returns
         -------
-        IDs from non observe frames
+        IDs from all types of frames
         """
         return tuple(set(self.key_to_petal_dict.values()))
+
+
+class TaskContributingIdsBud(ContributingIdsBud):
+    """Base class for contributing ID buds for a particular task type."""
+
+    def __init__(
+        self,
+        constant_name: str,
+        metadata_key: str | StrEnum,
+        ip_task_types: str | list[str],
+        task_type_parsing_function: Callable = passthrough_header_ip_task,
+    ):
+        super().__init__(constant_name=constant_name, metadata_key=metadata_key)
+
+        if isinstance(ip_task_types, str):
+            ip_task_types = [ip_task_types]
+        self.ip_task_types = [task.casefold() for task in ip_task_types]
+        self.parsing_function = task_type_parsing_function
+
+    def setter(self, fits_obj: L0FitsAccess) -> str | Type[SpilledDirt]:
+        """Ingest an object only if its parsed IP task type matches what's desired."""
+        task = self.parsing_function(fits_obj)
+
+        if task.casefold() in self.ip_task_types:
+            return super().setter(fits_obj)
+
+        return SpilledDirt