dkist-processing-common 10.8.1__tar.gz → 10.8.2__tar.gz

{dkist_processing_common-10.8.1 → dkist_processing_common-10.8.2}/CHANGELOG.rst

@@ -1,3 +1,12 @@
+v10.8.2 (2025-05-27)
+====================
+
+Bugfixes
+--------
+
+- Prevent the `WAVEBAND` key from being populated with a spectral line that falls outside the wavelength bounds of the data. (`#251 <https://bitbucket.org/dkistdc/dkist-processing-common/pull-requests/251>`__)
+
+
 v10.8.1 (2025-05-22)
 ====================
 

{dkist_processing_common-10.8.1 → dkist_processing_common-10.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dkist-processing-common
-Version: 10.8.1
+Version: 10.8.2
 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-10.8.1 → dkist_processing_common-10.8.2}/dkist_processing_common/tasks/write_l1.py

@@ -295,10 +295,14 @@ class WriteL1Frame(WorkflowTaskBase, MetadataStoreMixin, ABC):
         header["SOLARRAD"] = self.calculate_solar_angular_radius(obstime=obstime)
         header["SPECSYS"] = "TOPOCENT"  # no wavelength correction made due to doppler velocity
         header["VELOSYS"] = 0.0  # no wavelength correction made due to doppler velocity
-        header["WAVEBAND"] = get_closest_spectral_line(wavelength=header["LINEWAV"] * u.nm).name
         wavelength_range = self.get_wavelength_range(header=header)
         header["WAVEMIN"] = wavelength_range.min.to_value(u.nm)
         header["WAVEMAX"] = wavelength_range.max.to_value(u.nm)
+        waveband: str | None = self.get_waveband(
+            wavelength=header["LINEWAV"] * u.nm, wavelength_range=wavelength_range
+        )
+        if waveband:
+            header["WAVEBAND"] = waveband
         return header
 
     def l1_filename(self, header: fits.Header, stokes: Literal["I", "Q", "U", "V"]):
@@ -515,3 +519,18 @@ class WriteL1Frame(WorkflowTaskBase, MetadataStoreMixin, ABC):
         if header.get("AO_LOCK") is not True:
             header.pop("ATMOS_R0", None)
         return header
+
+    @staticmethod
+    def get_waveband(wavelength: u.Quantity, wavelength_range: WavelengthRange) -> str | None:
+        """
+        Get the spectral line information of the closest spectral line to the wavelength argument.
+
+        If the spectral line rest wavelength in air does not fall in the wavelength range of the data,
+        do not populate the keyword.
+        """
+        print(wavelength_range)
+        closest_line = get_closest_spectral_line(wavelength=wavelength)
+        rest_wavelength = closest_line.rest_wavelength_in_air
+        if rest_wavelength < wavelength_range.min or rest_wavelength > wavelength_range.max:
+            return None
+        return closest_line.name

{dkist_processing_common-10.8.1 → dkist_processing_common-10.8.2}/dkist_processing_common/tests/test_write_l1.py

@@ -101,6 +101,12 @@ class CompleteWriteL1Frame(WriteL1Frame):
         return WavelengthRange(min=1075.0 * u.nm, max=1085.0 * u.nm)
 
 
+class CompleteWriteL1FrameWithEmptyWaveband(CompleteWriteL1Frame):
+    def get_wavelength_range(self, header: fits.Header) -> WavelengthRange:
+        # Return an empty range to test the empty waveband case
+        return WavelengthRange(min=10000.0 * u.nm, max=10050.0 * u.nm)
+
+
 @dataclass
 class FakeConstantDb:
     INSTRUMENT: str = "TEST"
@@ -154,6 +160,44 @@ def write_l1_task(request, recipe_run_id, tmp_path):
         task._purge()
 
 
+@pytest.fixture(
+    scope="function",
+    params=[
+        pytest.param((1, "complete_common_header"), id="Intensity"),
+        pytest.param((4, "complete_polarimetric_header"), id="Polarimetric"),
+    ],
+)
+def write_l1_task_with_empty_waveband(recipe_run_id, tmp_path, request):
+    with CompleteWriteL1FrameWithEmptyWaveband(
+        recipe_run_id=recipe_run_id,
+        workflow_name="workflow_name",
+        workflow_version="workflow_version",
+    ) as task:
+        task.scratch = WorkflowFileSystem(recipe_run_id=recipe_run_id, scratch_base_path=tmp_path)
+        num_of_stokes_params, header_fixture_name = request.param
+        header = request.getfixturevalue(header_fixture_name)
+        stokes_params = ["I", "Q", "U", "V"]
+        used_stokes_params = []
+        hdu = fits.PrimaryHDU(data=np.random.random(size=(1, 128, 128)) * 10, header=header)
+        hdu.header["IPTASK"] = "level0_only key to be removed"
+        hdul = fits.HDUList([hdu])
+        for i in range(num_of_stokes_params):
+            task.write(
+                data=hdul,
+                tags=[
+                    Tag.calibrated(),
+                    Tag.frame(),
+                    Tag.stokes(stokes_params[i]),
+                    Tag.dsps_repeat(i),
+                ],
+                encoder=fits_hdulist_encoder,
+            )
+            used_stokes_params.append(stokes_params[i])
+        task.constants._update(asdict(FakeConstantDb()))
+        yield task, used_stokes_params, header
+        task._purge()
+
+
 @pytest.fixture(
     scope="function",
     params=[
@@ -616,3 +660,67 @@ def test_check_r0_ao_lock(write_l1_task_no_data):
         with pytest.raises(KeyError, match="Keyword 'ATMOS_R0' not found"):
             invalid_r0 = header_after_check["ATMOS_R0"]
         assert header.get("AO_LOCK") != True
+
+
+@pytest.mark.parametrize(
+    "wavelength, wavemin, wavemax, expected",
+    [
+        pytest.param(
+            617,
+            615,
+            619,
+            "Fe I (617.33 nm)",
+            id="line_is_between_wavemin_and_wavemax_and_exists",
+        ),
+        pytest.param(
+            700,
+            698,
+            702,
+            None,
+            id="line_is_between_wavemin_and_wavemax_and_does_not_exist",
+        ),
+        pytest.param(
+            617,
+            698,
+            702,
+            None,
+            id="line_is_not_between_wavemin_and_wavemax_and_exists",
+        ),
+    ],
+)
+def test_get_waveband(write_l1_task, wavelength, wavemin, wavemax, expected):
+    """
+    :Given: an input wavelength contribution
+    :When: determining the waveband
+    :Then: the correct waveband is returned
+    """
+    wavelength_range = WavelengthRange(min=wavemin * u.nm, max=wavemax * u.nm)
+    task, _, _ = write_l1_task
+    waveband = task.get_waveband(wavelength=wavelength * u.nm, wavelength_range=wavelength_range)
+    assert waveband == expected
+
+
+def test_empty_waveband(write_l1_task_with_empty_waveband, mocker):
+    """
+    :Given: a header converted to SPEC 214 L1 and a wavelength range that has no listed spectral lines
+    :When: checking the waveband key
+    :Then: it does not exist
+    """
+    mocker.patch(
+        "dkist_processing_common.tasks.mixin.metadata_store.GraphQLClient", new=FakeGQLClient
+    )
+    mocker.patch(
+        "dkist_processing_common.tasks.write_l1.WriteL1Frame.version_from_module_name",
+        new_callable=Mock,
+        return_value="fake_version_number",
+    )
+
+    task, _, _ = write_l1_task_with_empty_waveband
+    task()
+    files = list(task.read(tags=[Tag.frame(), Tag.output()]))
+    for file in files:
+        header = fits.open(file)[1].header
+        assert header["WAVEMIN"] == 10000
+        assert header["WAVEMAX"] == 10050
+        with pytest.raises(KeyError):
+            header["WAVEBAND"]

{dkist_processing_common-10.8.1 → dkist_processing_common-10.8.2}/dkist_processing_common.egg-info/PKG-INFO

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