dkist-processing-common 14.6.0__tar.gz → 14.6.1__tar.gz

{dkist_processing_common-14.6.0 → dkist_processing_common-14.6.1}/CHANGELOG.rst

@@ -1,3 +1,12 @@
+v14.6.1 (2026-10-14)
+====================
+
+Bugfixes
+--------
+
+- Exclude negative light-level readings from the LIGHT_LEVEL quality plot and summary statistics. Omit the metric when only negative readings remain. (`#355 <https://bitbucket.org/dkistdc/dkist-processing-common/pull-requests/355>`__)
+
+
 v14.6.0 (2026-10-08)
 ====================
 

{dkist_processing_common-14.6.0 → dkist_processing_common-14.6.1}/PKG-INFO

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

@@ -620,10 +620,13 @@ class QualityL1Metrics(WorkflowTaskBase, QualityMixin):
         self.write(metric, tags=Tag.quality("GENERIC"), encoder=basemodel_encoder)
 
     def compute_and_write_light_level(self, l1_quality_data: L1QualityData) -> None:
-        """Write LIGHT_LEVEL quality metric."""
-        # don't need to check for None -  l1_quality_data.light_level_values does not allow None
-        datetimes = l1_quality_data.datetimes
-        light_level_values = l1_quality_data.light_level_values
+        """Write LIGHT_LEVEL quality metric using only nonnegative measurements."""
+        datetimes: list[datetime] = []
+        light_level_values: list[float] = []
+        for date, light_level in zip(l1_quality_data.datetimes, l1_quality_data.light_level_values):
+            if light_level >= 0:
+                datetimes.append(date)
+                light_level_values.append(light_level)
 
         # don't write anything if there is no data
         if not light_level_values:
@@ -642,8 +645,10 @@ class QualityL1Metrics(WorkflowTaskBase, QualityMixin):
             series_data=series_data,
         )
 
-        statement = f"Average Light Level for L1 dataset: "
-        f"{round(np.mean(light_level_values), 2)} ± {round(np.std(light_level_values), 2)} adu"
+        statement = (
+            f"Average Light Level for L1 dataset: "
+            f"{round(np.mean(light_level_values), 2)} ± {round(np.std(light_level_values), 2)} adu"
+        )
 
         metric = QualityMetric(
             name="Light Level",

{dkist_processing_common-14.6.0 → dkist_processing_common-14.6.1}/dkist_processing_common/tests/test_quality.py

@@ -1084,7 +1084,7 @@ def test_compute_and_write_light_level(
     all_statements = metric.statement
     assert isinstance(all_statements, list)
     assert len(all_statements) == 1
-    assert all_statements[0].startswith("Average Light Level for L1 dataset")
+    assert all_statements == ["Average Light Level for L1 dataset: 0.45 ± 0.2 adu"]
     assert metric.warnings is None
     # data
     all_plot_data = metric.plot_data
@@ -1112,6 +1112,58 @@ def test_compute_and_write_light_level(
     assert len(time_series.x_values) == 7
 
 
+def test_light_level_excludes_negative_values(
+    quality_l1_task_no_scratch_data: QualityL1Metrics, l1_quality_data: L1QualityData
+):
+    """
+    Given: negative, zero, and positive light levels with distinct timestamps
+    When: the light level quality metric is written
+    Then: only nonnegative readings and their timestamps contribute to the plot and statistics
+    """
+    task = quality_l1_task_no_scratch_data
+    l1_quality_data.light_level_values = (-1.0, 0.0, 2.0, -0.01, 4.0, -2.0, 6.0)
+    original_quality_data = l1_quality_data.model_dump()
+
+    task.compute_and_write_light_level(l1_quality_data)
+
+    metrics = list(
+        task.read(tags=[Tag.quality("GENERIC")], decoder=basemodel_decoder, model=QualityMetric)
+    )
+    assert len(metrics) == 1
+    metric = metrics[0]
+    time_series = metric.plot_data[0].series_data[""]
+    assert time_series.x_values == tuple(l1_quality_data.datetimes[i] for i in (1, 2, 4, 6))
+    assert time_series.y_values == (0.0, 2.0, 4.0, 6.0)
+    assert metric.statement == ["Average Light Level for L1 dataset: 3.0 ± 2.24 adu"]
+    assert l1_quality_data.model_dump() == original_quality_data
+
+
+def test_light_level_all_negative_values(
+    quality_l1_task_with_calibrated_frames: QualityL1Metrics,
+):
+    """
+    Given: calibrated frames whose light levels are all negative
+    When: the L1 quality workflow task runs
+    Then: light level is omitted, other metrics are written, and FITS headers retain their readings
+    """
+    task = quality_l1_task_with_calibrated_frames
+    frame_paths = list(task.read(tags=[Tag.calibrated(), Tag.frame()]))
+    for frame_path in frame_paths:
+        with fits.open(frame_path, mode="update") as hdul:
+            hdul[0].header["LIGHTLVL"] = -1.0
+
+    task()
+
+    metrics = list(
+        task.read(tags=[Tag.quality("GENERIC")], decoder=basemodel_decoder, model=QualityMetric)
+    )
+    assert "LIGHT_LEVEL" not in {metric.metric_code for metric in metrics}
+    assert "HEALTH_STATUS" in {metric.metric_code for metric in metrics}
+    for frame_path in frame_paths:
+        with fits.open(frame_path) as hdul:
+            assert hdul[0].header["LIGHTLVL"] == -1.0
+
+
 def test_no_calibration_frames_no_l1_metrics(quality_l1_task_no_scratch_data: QualityL1Metrics):
     """
     Given: No calibrated frames

{dkist_processing_common-14.6.0 → dkist_processing_common-14.6.1}/dkist_processing_common.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dkist-processing-common
-Version: 14.6.0
+Version: 14.6.1
 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-14.6.1/dkist_processing_common.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "14.6.1",
+  "distance": 0,
+  "node": "g973c26e0f5932cfa29522cda89e3be9cedc1b8d2",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-10-14"
+}

dkist_processing_common-14.6.0/dkist_processing_common.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "14.6.0",
-  "distance": 0,
-  "node": "gfdf3dc49b280fcf0e203ef318adda23c2f29fc85",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-10-08"
-}