dkist-processing-common 6.0.3__tar.gz → 6.0.4__tar.gz

{dkist-processing-common-6.0.3 → dkist-processing-common-6.0.4}/CHANGELOG.rst

@@ -1,3 +1,12 @@
+v6.0.4 (2024-03-26)
+===================
+
+Bugfixes
+--------
+
+- `FitsAccessBase.from_header` no longer clobbers "NAXISn" (and likely other FITS controlled keys) values from input header. (`#179 <https://bitbucket.org/dkistdc/dkist-processing-common/pull-requests/179>`__)
+
+
 v6.0.3 (2024-03-05)
 ===================
 

{dkist-processing-common-6.0.3 → dkist-processing-common-6.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dkist-processing-common
-Version: 6.0.3
+Version: 6.0.4
 Summary: Common task classes used by the DKIST Science Data Processing pipelines to process DKIST data.
 Home-page: https://bitbucket.org/dkistdc/dkist-processing-common/src/main/
 Author: NSO / AURA

{dkist-processing-common-6.0.3 → dkist-processing-common-6.0.4}/dkist_processing_common/models/fits_access.py

@@ -106,7 +106,11 @@ class FitsAccessBase:
         """
         if isinstance(header, dict):
             header = fits.Header(header)
-        hdu = fits.PrimaryHDU(header=header)
+        hdu = fits.PrimaryHDU()
+
+        # We need to update the header after `PrimaryHDU` instantiation because some of the FITS controlled keys
+        # (e.g., NAXIS, NAXISn) would otherwise be changed by checks that occur during instantiation.
+        hdu.header.update(header)
         return cls(hdu=hdu, name=name)
 
     @classmethod

{dkist-processing-common-6.0.3 → dkist-processing-common-6.0.4}/dkist_processing_common/tests/test_fits_access.py

@@ -125,6 +125,14 @@ def fits_file_path_with_data_in_imagehdu(tmp_path, complete_common_header):
     return file_path
 
 
+class FitsAccessWithNaxisKeys(FitsAccessBase):
+    def __init__(self, hdu, name):
+        super().__init__(hdu, name)
+        self.naxis = self.header["NAXIS"]
+        self.naxis1 = self.header["NAXIS1"]
+        self.naxis2 = self.header["NAXIS2"]
+
+
 def test_from_single_hdu(hdu_with_complete_common_header):
     """
     Given: an HDU with expected, common by-frame keywords
@@ -279,3 +287,27 @@ def test_header_dict(hdu_with_special_keys):
     fits_obj = FitsAccessBase(hdu_with_special_keys)
     assert isinstance(fits_obj.header_dict, dict)
     assert len(fits_obj.header_dict) == len(fits_obj.header)
+
+
+@pytest.mark.parametrize(
+    "header_type",
+    [
+        pytest.param(dict, id="Dict"),
+        pytest.param(fits.header.Header, id="Header"),
+        pytest.param(fits.hdu.compressed.CompImageHeader, id="CompHeader"),
+    ],
+)
+def test_from_header_naxis_preserved(header_type):
+    """
+    Given: A header with NAXIS and NAXISn keys
+    When: Ingesting that header with `FitsAccessBase.from_header`
+    Then: The original NAXIS and NAXISn keys are preserved
+    """
+    raw_header = {"NAXIS": 2, "NAXIS1": 123, "NAXIS2": 456}
+    header = header_type(raw_header)
+
+    fits_obj = FitsAccessWithNaxisKeys.from_header(header)
+
+    assert fits_obj.naxis == 2
+    assert fits_obj.naxis1 == 123
+    assert fits_obj.naxis2 == 456

{dkist-processing-common-6.0.3 → dkist-processing-common-6.0.4}/dkist_processing_common.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dkist-processing-common
-Version: 6.0.3
+Version: 6.0.4
 Summary: Common task classes used by the DKIST Science Data Processing pipelines to process DKIST data.
 Home-page: https://bitbucket.org/dkistdc/dkist-processing-common/src/main/
 Author: NSO / AURA