dkist-processing-cryonirsp 1.8.3__tar.gz → 1.10.0__tar.gz

{dkist_processing_cryonirsp-1.8.3 → dkist_processing_cryonirsp-1.10.0}/CHANGELOG.rst

@@ -1,3 +1,27 @@
+v1.10.0 (2025-07-14)
+====================
+
+Features
+--------
+
+- This change pulls the dispersion axis correction out of the Cryonirsp pipeline and uses the generalized solar-wavelength-calibration library. (`#167 <https://bitbucket.org/dkistdc/dkist-processing-cryonirsp/pull-requests/167>`__)
+
+
+v1.9.0 (2025-07-10)
+===================
+
+Bugfixes
+--------
+
+- Update the CRYO-NIRSP workflows such that the `SubmitDatasetMetadata` task is now dependent on the `AssembleCryonirspMovie` task. This ensures that the metadata is submitted only after the movie has been assembled and that it is counted in downstream checks. (`#210 <https://bitbucket.org/dkistdc/dkist-processing-cryonirsp/pull-requests/210>`__)
+
+
+Misc
+----
+
+- Update dkist-processing-common to handle non-finite values in quality wavecal metrics. (`#210 <https://bitbucket.org/dkistdc/dkist-processing-cryonirsp/pull-requests/210>`__)
+
+
 v1.8.3 (2025-07-08)
 ===================
 

{dkist_processing_cryonirsp-1.8.3 → dkist_processing_cryonirsp-1.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dkist-processing-cryonirsp
-Version: 1.8.3
+Version: 1.10.0
 Summary: Science processing code for the Cryo-NIRSP instrument on DKIST
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause
@@ -17,7 +17,7 @@ Requires-Dist: Pillow==10.4.0
 Requires-Dist: astropy==7.0.2
 Requires-Dist: dkist-fits-specifications==4.17.0
 Requires-Dist: dkist-header-validator==5.2.1
-Requires-Dist: dkist-processing-common==11.0.0
+Requires-Dist: dkist-processing-common==11.0.1
 Requires-Dist: dkist-processing-math==2.2.0
 Requires-Dist: dkist-processing-pac==3.1.1
 Requires-Dist: dkist-spectral-lines==3.0.0
@@ -30,6 +30,7 @@ Requires-Dist: peakutils==1.3.5
 Requires-Dist: scikit-image==0.25.2
 Requires-Dist: scipy==1.15.3
 Requires-Dist: sunpy==6.1.1
+Requires-Dist: solar-wavelength-calibration==1.0
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
@@ -88,9 +89,9 @@ Requires-Dist: WTForms==3.2.1; extra == "frozen"
 Requires-Dist: Werkzeug==2.2.3; extra == "frozen"
 Requires-Dist: aioftp==0.26.2; extra == "frozen"
 Requires-Dist: aiohappyeyeballs==2.6.1; extra == "frozen"
-Requires-Dist: aiohttp==3.12.13; extra == "frozen"
+Requires-Dist: aiohttp==3.12.14; extra == "frozen"
 Requires-Dist: aiosignal==1.4.0; extra == "frozen"
-Requires-Dist: alembic==1.16.3; extra == "frozen"
+Requires-Dist: alembic==1.16.4; extra == "frozen"
 Requires-Dist: amqp==5.3.1; extra == "frozen"
 Requires-Dist: annotated-types==0.7.0; extra == "frozen"
 Requires-Dist: anyio==4.9.0; extra == "frozen"
@@ -114,17 +115,17 @@ Requires-Dist: asdf_transform_schemas==0.6.0; extra == "frozen"
 Requires-Dist: asgiref==3.9.1; extra == "frozen"
 Requires-Dist: asteval==1.0.6; extra == "frozen"
 Requires-Dist: astropy==7.0.2; extra == "frozen"
-Requires-Dist: astropy-iers-data==0.2025.7.7.0.39.39; extra == "frozen"
+Requires-Dist: astropy-iers-data==0.2025.7.14.0.40.29; extra == "frozen"
 Requires-Dist: asyncpg==0.30.0; extra == "frozen"
 Requires-Dist: attrs==25.3.0; extra == "frozen"
 Requires-Dist: babel==2.17.0; extra == "frozen"
 Requires-Dist: billiard==4.2.1; extra == "frozen"
 Requires-Dist: blinker==1.9.0; extra == "frozen"
-Requires-Dist: boto3==1.39.3; extra == "frozen"
-Requires-Dist: botocore==1.39.3; extra == "frozen"
+Requires-Dist: boto3==1.39.4; extra == "frozen"
+Requires-Dist: botocore==1.39.4; extra == "frozen"
 Requires-Dist: cachelib==0.13.0; extra == "frozen"
 Requires-Dist: celery==5.5.3; extra == "frozen"
-Requires-Dist: certifi==2025.6.15; extra == "frozen"
+Requires-Dist: certifi==2025.7.14; extra == "frozen"
 Requires-Dist: cffi==1.17.1; extra == "frozen"
 Requires-Dist: charset-normalizer==3.4.2; extra == "frozen"
 Requires-Dist: click==8.2.1; extra == "frozen"
@@ -144,9 +145,9 @@ Requires-Dist: dacite==1.9.2; extra == "frozen"
 Requires-Dist: decorator==5.2.1; extra == "frozen"
 Requires-Dist: dill==0.4.0; extra == "frozen"
 Requires-Dist: dkist-header-validator==5.2.1; extra == "frozen"
-Requires-Dist: dkist-processing-common==11.0.0; extra == "frozen"
+Requires-Dist: dkist-processing-common==11.0.1; extra == "frozen"
 Requires-Dist: dkist-processing-core==5.1.1; extra == "frozen"
-Requires-Dist: dkist-processing-cryonirsp==1.8.3; extra == "frozen"
+Requires-Dist: dkist-processing-cryonirsp==1.10.0; extra == "frozen"
 Requires-Dist: dkist-processing-math==2.2.0; extra == "frozen"
 Requires-Dist: dkist-processing-pac==3.1.1; extra == "frozen"
 Requires-Dist: dkist-service-configuration==2.2; extra == "frozen"
@@ -161,7 +162,7 @@ Requires-Dist: flower==2.0.1; extra == "frozen"
 Requires-Dist: fonttools==4.58.5; extra == "frozen"
 Requires-Dist: frozenlist==1.7.0; extra == "frozen"
 Requires-Dist: fsspec==2025.5.1; extra == "frozen"
-Requires-Dist: globus-sdk==3.59.0; extra == "frozen"
+Requires-Dist: globus-sdk==3.60.0; extra == "frozen"
 Requires-Dist: google-re2==1.1.20240702; extra == "frozen"
 Requires-Dist: googleapis-common-protos==1.70.0; extra == "frozen"
 Requires-Dist: gqlclient==1.2.3; extra == "frozen"
@@ -208,14 +209,14 @@ Requires-Dist: networkx==3.5; extra == "frozen"
 Requires-Dist: numba==0.61.2; extra == "frozen"
 Requires-Dist: numpy==2.2.5; extra == "frozen"
 Requires-Dist: object-clerk==0.1.2; extra == "frozen"
-Requires-Dist: opentelemetry-api==1.34.1; extra == "frozen"
-Requires-Dist: opentelemetry-exporter-otlp==1.34.1; extra == "frozen"
-Requires-Dist: opentelemetry-exporter-otlp-proto-common==1.34.1; extra == "frozen"
-Requires-Dist: opentelemetry-exporter-otlp-proto-grpc==1.34.1; extra == "frozen"
-Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.34.1; extra == "frozen"
-Requires-Dist: opentelemetry-proto==1.34.1; extra == "frozen"
-Requires-Dist: opentelemetry-sdk==1.34.1; extra == "frozen"
-Requires-Dist: opentelemetry-semantic-conventions==0.55b1; extra == "frozen"
+Requires-Dist: opentelemetry-api==1.35.0; extra == "frozen"
+Requires-Dist: opentelemetry-exporter-otlp==1.35.0; extra == "frozen"
+Requires-Dist: opentelemetry-exporter-otlp-proto-common==1.35.0; extra == "frozen"
+Requires-Dist: opentelemetry-exporter-otlp-proto-grpc==1.35.0; extra == "frozen"
+Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.35.0; extra == "frozen"
+Requires-Dist: opentelemetry-proto==1.35.0; extra == "frozen"
+Requires-Dist: opentelemetry-sdk==1.35.0; extra == "frozen"
+Requires-Dist: opentelemetry-semantic-conventions==0.56b0; extra == "frozen"
 Requires-Dist: ordered-set==4.1.0; extra == "frozen"
 Requires-Dist: packaging==25.0; extra == "frozen"
 Requires-Dist: pandas==2.3.1; extra == "frozen"
@@ -233,7 +234,7 @@ Requires-Dist: proglog==0.1.12; extra == "frozen"
 Requires-Dist: prometheus_client==0.22.1; extra == "frozen"
 Requires-Dist: prompt_toolkit==3.0.51; extra == "frozen"
 Requires-Dist: propcache==0.3.2; extra == "frozen"
-Requires-Dist: protobuf==5.29.5; extra == "frozen"
+Requires-Dist: protobuf==6.31.1; extra == "frozen"
 Requires-Dist: psutil==7.0.0; extra == "frozen"
 Requires-Dist: psycopg2-binary==2.9.10; extra == "frozen"
 Requires-Dist: py==1.11.0; extra == "frozen"
@@ -263,7 +264,7 @@ Requires-Dist: scikit-image==0.25.2; extra == "frozen"
 Requires-Dist: scipy==1.15.3; extra == "frozen"
 Requires-Dist: semantic-version==2.10.0; extra == "frozen"
 Requires-Dist: setproctitle==1.3.6; extra == "frozen"
-Requires-Dist: setuptools==75.6.0; extra == "frozen"
+Requires-Dist: setuptools==65.5.0; extra == "frozen"
 Requires-Dist: six==1.17.0; extra == "frozen"
 Requires-Dist: sniffio==1.3.1; extra == "frozen"
 Requires-Dist: solar-wavelength-calibration==1.0; extra == "frozen"

{dkist_processing_cryonirsp-1.8.3 → dkist_processing_cryonirsp-1.10.0}/dkist_processing_cryonirsp/config.py

@@ -1,11 +1,14 @@
 """Configuration for the dkist-processing-cryonirsp package and the logging thereof."""
 from dkist_processing_common.config import DKISTProcessingCommonConfiguration
+from pydantic import Field
 
 
 class DKISTProcessingCryoNIRSPConfigurations(DKISTProcessingCommonConfiguration):
     """Configurations custom to the dkist-processing-cryonirsp package."""
 
-    pass  # nothing custom yet
+    fts_atlas_data_dir: str | None = Field(
+        default=None, description="Common cached directory for a downloaded FTS Atlas."
+    )
 
 
 dkist_processing_cryonirsp_configurations = DKISTProcessingCryoNIRSPConfigurations()

{dkist_processing_cryonirsp-1.8.3 → dkist_processing_cryonirsp-1.10.0}/dkist_processing_cryonirsp/models/constants.py

@@ -2,6 +2,7 @@
 from enum import Enum
 from enum import unique
 
+import astropy.units as u
 from dkist_processing_common.models.constants import BudName
 from dkist_processing_common.models.constants import ConstantsBase
 
@@ -54,6 +55,8 @@ class CryonirspBudName(Enum):
     gain_frame_type_list = "GAIN_FRAME_TYPE_LIST"
     lamp_gain_frame_type_list = "LAMP_GAIN_FRAME_TYPE_LIST"
     solar_gain_frame_type_list = "SOLAR_GAIN_FRAME_TYPE_LIST"
+    center_wavelength = "CENTER_WAVELENGTH"
+    slit_width = "SLIT_WIDTH"
 
 
 class CryonirspConstants(ConstantsBase):
@@ -112,10 +115,20 @@ class CryonirspConstants(ConstantsBase):
         """Grating littrow angle (deg)."""
         return self._db_dict[CryonirspBudName.grating_littrow_angle_deg.value]
 
+    @property
+    def center_wavelength(self) -> float:
+        """Center wavelength of the selected filter (nm)."""
+        return self._db_dict[CryonirspBudName.center_wavelength.value]
+
+    @property
+    def slit_width(self) -> float:
+        """Physical width of the selected slit (um)."""
+        return self._db_dict[CryonirspBudName.slit_width.value]
+
     @property
     def grating_constant(self) -> float:
         """Grating constant."""
-        return self._db_dict[CryonirspBudName.grating_constant.value]
+        return self._db_dict[CryonirspBudName.grating_constant.value] / u.mm
 
     @property
     def camera_readout_mode(self) -> str:

{dkist_processing_cryonirsp-1.8.3 → dkist_processing_cryonirsp-1.10.0}/dkist_processing_cryonirsp/models/parameters.py

@@ -7,6 +7,7 @@ import numpy as np
 from dkist_processing_common.models.parameters import ParameterArmIdMixin
 from dkist_processing_common.models.parameters import ParameterBase
 from dkist_processing_common.models.parameters import ParameterWavelengthMixin
+from solar_wavelength_calibration import DownloadConfig
 
 from dkist_processing_cryonirsp.models.exposure_conditions import AllowableOpticalDensityFilterNames
 
@@ -267,24 +268,15 @@ class CryonirspParameters(ParameterBase, ParameterWavelengthMixin, ParameterArmI
         """Return the CryoNIRSP pixel pitch."""
         return self._find_most_recent_past_value("cryonirsp_pixel_pitch_micron") * u.micron
 
-    @cached_property
-    def solar_atlas(self) -> np.ndarray:
-        """Solar reference atlas.
-
-        Contains two arrays:
-        - wavelength in nanometers
-        - transmission at given wavelength
-        """
-        param_obj = self._find_most_recent_past_value("cryonirsp_solar_atlas")
-        return self._load_param_value_from_numpy_save(param_obj=param_obj)
+    @property
+    def wavecal_atlas_download_config(self) -> DownloadConfig:
+        """Define the `~solar_wavelength_calibration.DownloadConfig` used to grab the Solar atlas used for wavelength calibration."""
+        config_dict = self._find_most_recent_past_value("cryonirsp_wavecal_atlas_download_config")
+        return DownloadConfig.model_validate(config_dict)
 
     @cached_property
-    def telluric_atlas(self) -> np.ndarray:
-        """Telluric reference atlas.
-
-        Contains two arrays:
-        - wavelength in nanometers
-        - transmission at given wavelength
-        """
-        param_obj = self._find_most_recent_past_value("cryonirsp_telluric_atlas")
-        return self._load_param_value_from_numpy_save(param_obj=param_obj)
+    def wavecal_fraction_of_unweighted_edge_pixels(self) -> int:
+        """Return the fraction of edge pixels to weight to zero during the wavelength calibration."""
+        return self._find_most_recent_past_value(
+            "cryonirsp_wavecal_fraction_of_unweighted_edge_pixels"
+        )

{dkist_processing_cryonirsp-1.8.3 → dkist_processing_cryonirsp-1.10.0}/dkist_processing_cryonirsp/parsers/cryonirsp_l0_fits_access.py

@@ -97,8 +97,7 @@ class CryonirspL0FitsAccess(L0FitsAccess):
         )
         self.grating_position_deg: float = self.header["CNGRTPOS"]
         self.grating_littrow_angle_deg: float = self.header["CNGRTLAT"]
-        # grating_constant is in the L0 header in (mm)^(-1) when needed in (m)^(-1) hence multiply by 1000.
-        self.grating_constant: float = self.header["CNGRTCON"] * 1000
+        self.grating_constant: float = self.header["CNGRTCON"]
         self.obs_ip_start_time = self.header["DKIST011"]
         # The ExposureConditions are a combination of the exposure time and the OD filter name:
         self.exposure_conditions = ExposureConditions(
@@ -106,6 +105,8 @@ class CryonirspL0FitsAccess(L0FitsAccess):
             self.header["CNFILTNP"].upper(),
         )
         self.solar_gain_ip_start_time = self.header["DATE-OBS"]
+        self.center_wavelength = self.header["CNCENWAV"]
+        self.slit_width = self.header["CNSLITW"]
 
     @property
     def cn1_scan_step(self):

{dkist_processing_cryonirsp-1.8.3 → dkist_processing_cryonirsp-1.10.0}/dkist_processing_cryonirsp/tasks/__init__.py

@@ -11,8 +11,8 @@ from dkist_processing_cryonirsp.tasks.make_movie_frames import *
 from dkist_processing_cryonirsp.tasks.parse import *
 from dkist_processing_cryonirsp.tasks.quality_metrics import *
 from dkist_processing_cryonirsp.tasks.sp_beam_boundaries import *
-from dkist_processing_cryonirsp.tasks.sp_dispersion_axis_correction import *
 from dkist_processing_cryonirsp.tasks.sp_geometric import *
 from dkist_processing_cryonirsp.tasks.sp_science import *
 from dkist_processing_cryonirsp.tasks.sp_solar_gain import *
+from dkist_processing_cryonirsp.tasks.sp_wavelength_calibration import *
 from dkist_processing_cryonirsp.tasks.write_l1 import *

{dkist_processing_cryonirsp-1.8.3 → dkist_processing_cryonirsp-1.10.0}/dkist_processing_cryonirsp/tasks/parse.py

@@ -247,21 +247,21 @@ class ParseL0CryonirspSPLinearizedData(ParseL0CryonirspLinearizedData):
             TaskNearFloatBud(
                 constant_name=CryonirspBudName.grating_position_deg.value,
                 metadata_key="grating_position_deg",
-                ip_task_types=TaskName.solar_gain.value,
+                ip_task_types=[TaskName.observe.value, TaskName.solar_gain.value],
                 task_type_parsing_function=parse_header_ip_task_with_gains,
                 tolerance=0.01,
             ),
             TaskNearFloatBud(
                 constant_name=CryonirspBudName.grating_littrow_angle_deg.value,
                 metadata_key="grating_littrow_angle_deg",
-                ip_task_types=TaskName.solar_gain.value,
+                ip_task_types=[TaskName.observe.value, TaskName.solar_gain.value],
                 task_type_parsing_function=parse_header_ip_task_with_gains,
                 tolerance=0.01,
             ),
             TaskUniqueBud(
                 constant_name=CryonirspBudName.grating_constant.value,
                 metadata_key="grating_constant",
-                ip_task_types=TaskName.solar_gain.value,
+                ip_task_types=[TaskName.observe.value, TaskName.solar_gain.value],
                 task_type_parsing_function=parse_header_ip_task_with_gains,
             ),
             TaskUniqueBud(
@@ -276,6 +276,18 @@ class ParseL0CryonirspSPLinearizedData(ParseL0CryonirspLinearizedData):
                 ip_task_types=TaskName.solar_gain.value,
                 task_type_parsing_function=parse_header_ip_task_with_gains,
             ),
+            TaskUniqueBud(
+                constant_name=CryonirspBudName.center_wavelength.value,
+                metadata_key="center_wavelength",
+                ip_task_types=[TaskName.observe.value, TaskName.solar_gain.value],
+                task_type_parsing_function=parse_header_ip_task_with_gains,
+            ),
+            TaskUniqueBud(
+                constant_name=CryonirspBudName.slit_width.value,
+                metadata_key="slit_width",
+                ip_task_types=[TaskName.observe.value, TaskName.solar_gain.value],
+                task_type_parsing_function=parse_header_ip_task_with_gains,
+            ),
             CheckLampGainFramesPickyBud(),
             CryonirspTaskExposureConditionsBud(
                 stem_name=CryonirspBudName.lamp_gain_exposure_conditions_list.value,

dkist_processing_cryonirsp-1.10.0/dkist_processing_cryonirsp/tasks/sp_wavelength_calibration.py

@@ -0,0 +1,300 @@
+"""Cryo SP wavelength calibration task. See :doc:`this page </wavelength_calibration>` for more information."""
+import math
+
+import astropy.units as u
+import numpy as np
+from astropy.time import Time
+from astropy.wcs import WCS
+from dkist_processing_common.codecs.json import json_encoder
+from dkist_processing_common.models.dkist_location import location_of_dkist
+from dkist_service_configuration.logging import logger
+from solar_wavelength_calibration import Atlas
+from solar_wavelength_calibration import WavelengthCalibrationFitter
+from solar_wavelength_calibration.fitter.parameters import AngleBoundRange
+from solar_wavelength_calibration.fitter.parameters import BoundsModel
+from solar_wavelength_calibration.fitter.parameters import DispersionBoundRange
+from solar_wavelength_calibration.fitter.parameters import LengthBoundRange
+from solar_wavelength_calibration.fitter.parameters import UnitlessBoundRange
+from solar_wavelength_calibration.fitter.parameters import WavelengthCalibrationParameters
+from solar_wavelength_calibration.fitter.wavelength_fitter import calculate_initial_crval_guess
+from solar_wavelength_calibration.fitter.wavelength_fitter import WavelengthParameters
+from sunpy.coordinates import HeliocentricInertial
+
+from dkist_processing_cryonirsp.codecs.fits import cryo_fits_array_decoder
+from dkist_processing_cryonirsp.models.tags import CryonirspTag
+from dkist_processing_cryonirsp.tasks.cryonirsp_base import CryonirspTaskBase
+
+__all__ = ["SPWavelengthCalibration"]
+
+
+class SPWavelengthCalibration(CryonirspTaskBase):
+    """Task class for correcting the dispersion axis wavelength values.
+
+    Parameters
+    ----------
+    recipe_run_id : int
+        id of the recipe run used to identify the workflow run this task is part of
+    workflow_name : str
+        name of the workflow to which this instance of the task belongs
+    workflow_version : str
+        version of the workflow to which this instance of the task belongs
+
+    """
+
+    record_provenance = True
+
+    def run(self) -> None:
+        """
+        Run method for the task.
+
+        - Gather 1D characteristic spectrum. This will be the initial spectrum.
+        - Get a header from a solar gain frame for initial wavelength estimation.
+        - Compute the theoretical dispersion, order, and incident light angle.
+        - Compute the input wavelength vector from the spectrum and header.
+        - Get the Doppler velocity and resolving power.
+        - Define fitting bounds and initialize model parameters.
+        - Set and normalize spectral weights, zeroing edges.
+        - Fit the profile using WavelengthCalibrationFitter.
+        - Write fit results to disk.
+
+        Returns
+        -------
+        None
+        """
+        with self.apm_processing_step("Load input spectrum and wavelength"):
+            logger.info("Loading input spectrum")
+            input_spectrum = next(
+                self.read(
+                    tags=[
+                        CryonirspTag.intermediate_frame(beam=1),
+                        CryonirspTag.task_characteristic_spectra(),
+                    ],
+                    decoder=cryo_fits_array_decoder,
+                )
+            )
+
+            logger.info(
+                "Computing instrument specific dispersion, order, and incident light angle."
+            )
+            (
+                dispersion,
+                order,
+                incident_light_angle,
+            ) = self.get_theoretical_dispersion_order_light_angle()
+
+            logger.info("Computing initial wavelength vector.")
+            input_wavelength_vector = self.compute_input_wavelength_vector(
+                spectrum=input_spectrum,
+                dispersion=dispersion,
+                order=order,
+                incident_light_angle=incident_light_angle,
+            )
+
+        # Get the doppler velocity
+        doppler_velocity = self.get_doppler_velocity()
+        logger.info(f"{doppler_velocity = !s}")
+
+        # Get the resolving power
+        resolving_power = self.get_resolving_power()
+        logger.info(f"{resolving_power = }")
+
+        with self.apm_processing_step("Compute brute-force CRVAL initial guess"):
+            atlas = Atlas(config=self.parameters.wavecal_atlas_download_config)
+            crval = calculate_initial_crval_guess(
+                input_wavelength_vector=input_wavelength_vector,
+                input_spectrum=input_spectrum,
+                atlas=atlas,
+                negative_limit=-2 * u.nm,
+                positive_limit=2 * u.nm,
+                num_steps=550,
+            )
+            logger.info(f"{crval = !s}")
+
+        with self.apm_task_step("Set up wavelength fit"):
+            logger.info("Setting bounds")
+            bounds = BoundsModel(
+                crval=LengthBoundRange(min=crval - (5 * u.nm), max=crval + (5 * u.nm)),
+                dispersion=DispersionBoundRange(
+                    min=dispersion - (0.05 * u.nm / u.pix), max=dispersion + (0.05 * u.nm / u.pix)
+                ),
+                incident_light_angle=AngleBoundRange(
+                    min=incident_light_angle - (180 * u.deg),
+                    max=incident_light_angle + (180 * u.deg),
+                ),
+                resolving_power=UnitlessBoundRange(
+                    min=resolving_power - (resolving_power * 0.1),
+                    max=resolving_power + (resolving_power * 0.1),
+                ),
+                opacity_factor=UnitlessBoundRange(min=0.0, max=10.0),
+                straylight_fraction=UnitlessBoundRange(min=0.0, max=0.4),
+            )
+
+            logger.info("Initializing parameters")
+            input_parameters = WavelengthCalibrationParameters(
+                crval=crval,
+                dispersion=dispersion,
+                incident_light_angle=incident_light_angle,
+                resolving_power=resolving_power,
+                opacity_factor=5.0,
+                straylight_fraction=0.2,
+                grating_constant=self.constants.grating_constant,
+                doppler_velocity=doppler_velocity,
+                order=order,
+                bounds=bounds,
+            )
+
+            # Define spectral weights to apply
+            weights = np.ones_like(input_spectrum)
+            # Set edge weights to zero to mitigate flat field artifacts (inner and outer 10% of array)
+            num_pixels = len(weights)
+            weights[: num_pixels // self.parameters.wavecal_fraction_of_unweighted_edge_pixels] = 0
+            weights[-num_pixels // self.parameters.wavecal_fraction_of_unweighted_edge_pixels :] = 0
+
+            fitter = WavelengthCalibrationFitter(
+                input_parameters=input_parameters,
+                atlas=atlas,
+            )
+
+            logger.info(f"Input parameters: {input_parameters.lmfit_parameters.pretty_repr()}")
+
+        with self.apm_processing_step("Run wavelength solution fit"):
+            fit_result = fitter(
+                input_wavelength_vector=input_wavelength_vector,
+                input_spectrum=input_spectrum,
+                spectral_weights=weights,
+            )
+
+        with self.apm_writing_step("Save wavelength solution and quality metrics"):
+            self.write(
+                data=fit_result.wavelength_parameters.to_header(
+                    axis_num=1, add_alternate_keys=True
+                ),
+                tags=[CryonirspTag.task_spectral_fit(), CryonirspTag.intermediate()],
+                encoder=json_encoder,
+            )
+            self.quality_store_wavecal_results(
+                input_wavelength=input_wavelength_vector,
+                input_spectrum=input_spectrum,
+                fit_result=fit_result,
+                weights=weights,
+            )
+
+    def get_theoretical_dispersion_order_light_angle(self) -> tuple[u.Quantity, int, u.Quantity]:
+        # TODO: Make this docstring correct (we use grating constant, not grating spacing) and show calculation of all values.
+        r"""
+        Compute theoretical dispersion, spectral order, and incident light angle.
+
+        The incident light angle, :math:`\alpha`, is computed as
+
+        .. math::
+            \alpha = \phi + \theta_L
+
+        where :math:`\phi`, the grating position, and :math:`\theta_L`, the Littrow angle, come from L0 headers.
+
+        From the grating equation, the spectral order, :math:`m`, is
+
+        .. math::
+            m = \frac{\sin\alpha + \sin\beta}{\sigma\lambda}
+
+        where :math:`\sigma` is the grating constant (lines per mm), :math:`\beta` is the diffracted light angle,
+        and :math:`\lambda` is the wavelength. The wavelength comes from L0 headers and :math:`\beta = \phi - \theta_L`.
+
+        Finally, the linear dispersion (nm / px) is
+
+        .. math::
+            \frac{d\lambda}{dl} = \frac{\mu \cos\beta}{m \sigma f}
+
+        where :math:`\mu` is the detector pixel pitch and :math:`f` is the camera focal length, both of which come from
+        L0 headers.
+        """
+        wavelength = self.constants.wavelength * u.nanometer
+        grating_position_angle_phi = self.constants.grating_position_deg * u.deg
+        grating_littrow_angle_theta = self.constants.grating_littrow_angle_deg * u.deg
+        incident_light_angle = grating_position_angle_phi + grating_littrow_angle_theta
+        beta = grating_position_angle_phi - grating_littrow_angle_theta
+        order = int(
+            (np.sin(incident_light_angle) + np.sin(beta))
+            / (wavelength * self.constants.grating_constant)
+        )
+        camera_mirror_focal_length = self.parameters.camera_mirror_focal_length_mm
+        pixpitch = self.parameters.pixel_pitch_micron
+        linear_disp = (
+            order * (self.constants.grating_constant / np.cos(beta)) * camera_mirror_focal_length
+        )
+        theoretical_dispersion = (pixpitch / linear_disp).to(u.nanometer) / u.pix
+
+        logger.info(f"{theoretical_dispersion = !s}")
+        logger.info(f"{order = }")
+        logger.info(f"{incident_light_angle = !s}")
+
+        return theoretical_dispersion, order, incident_light_angle
+
+    def compute_input_wavelength_vector(
+        self,
+        *,
+        spectrum: np.ndarray,
+        dispersion: u.Quantity,
+        order: int,
+        incident_light_angle: u.Quantity,
+    ) -> u.Quantity:
+        """Compute the expected wavelength vector based on the header information."""
+        num_wave_pix = spectrum.size
+        wavelength_parameters = WavelengthParameters(
+            crpix=num_wave_pix // 2 + 1,
+            crval=self.constants.wavelength,
+            dispersion=dispersion.to_value(u.nm / u.pix),
+            grating_constant=self.constants.grating_constant.to_value(1 / u.mm),
+            order=order,
+            incident_light_angle=incident_light_angle.to_value(u.deg),
+            cunit="nm",
+        )
+        header = wavelength_parameters.to_header(axis_num=1)
+        wcs = WCS(header)
+        input_wavelength_vector = wcs.spectral.pixel_to_world(np.arange(num_wave_pix)).to(u.nm)
+
+        return input_wavelength_vector
+
+    def get_doppler_velocity(self) -> u.Quantity:
+        """Find the speed at which DKIST is moving relative to the Sun's center.
+
+        Positive values refer to when DKIST is moving away from the sun.
+        """
+        coord = location_of_dkist.get_gcrs(obstime=Time(self.constants.solar_gain_ip_start_time))
+        heliocentric_coord = coord.transform_to(
+            HeliocentricInertial(obstime=Time(self.constants.solar_gain_ip_start_time))
+        )
+        obs_vr_kms = heliocentric_coord.d_distance
+        return obs_vr_kms
+
+    def get_resolving_power(self) -> int:
+        """Find the resolving power for the slit and filter center wavelength used during observation."""
+        # Map of (center wavelength) → (slit width) → resolving power
+        resolving_power_map = {1080.0: {175: 39580, 52: 120671}, 1430.0: {175: 42943, 52: 133762}}
+
+        center_wavelength = self.constants.center_wavelength
+        slit_width = self.constants.slit_width
+
+        # Find the closest matching key within tolerance
+        matched_wavelength = next(
+            (
+                key
+                for key in resolving_power_map
+                if math.isclose(center_wavelength, key, abs_tol=10)
+            ),
+            None,
+        )
+
+        if matched_wavelength is None:
+            raise ValueError(
+                f"{center_wavelength} not a valid filter center wavelength. "
+                f"Should be within 10 nm of one of {', '.join(str(k) for k in resolving_power_map)} nm."
+            )
+
+        slit_dict = resolving_power_map[matched_wavelength]
+        if slit_width not in slit_dict:
+            raise ValueError(
+                f"{slit_width} not a valid slit width. "
+                f"Should be one of {', '.join(str(k) for k in slit_dict)} µm."
+            )
+
+        return slit_dict[slit_width]

{dkist_processing_cryonirsp-1.8.3 → dkist_processing_cryonirsp-1.10.0}/dkist_processing_cryonirsp/tasks/write_l1.py

@@ -11,7 +11,7 @@ from astropy.coordinates.builtin_frames.altaz import AltAz
 from astropy.coordinates.sky_coordinate import SkyCoord
 from astropy.io import fits
 from astropy.time.core import Time
-from dkist_processing_common.codecs.asdf import asdf_decoder
+from dkist_processing_common.codecs.json import json_decoder
 from dkist_processing_common.models.dkist_location import location_of_dkist
 from dkist_processing_common.models.wavelength import WavelengthRange
 from dkist_processing_common.tasks import WriteL1Frame
@@ -1020,24 +1020,14 @@ class SPWriteL1Frame(CryonirspWriteL1Frame):
 
     @cached_property
     def spectral_fit_results(self) -> dict:
-        """Get the spectral fit results."""
-        fit_dict = next(
+        """Get the spectral fit results from disk."""
+        return next(
             self.read(
-                tags=[CryonirspTag.task_spectral_fit(), CryonirspTag.intermediate()],
-                decoder=asdf_decoder,
+                tags=[CryonirspTag.intermediate(), CryonirspTag.task_spectral_fit()],
+                decoder=json_decoder,
             )
         )
-        del fit_dict["asdf_library"]
-        del fit_dict["history"]
-        return fit_dict
 
     def update_spectral_headers(self, header: fits.Header):
         """Update spectral headers after spectral correction."""
-        for key, value in self.spectral_fit_results.items():
-            # update the headers
-            header[key] = value
-
-        header["CTYPE1"] = "AWAV-GRA"
-        header["CUNIT1"] = "nm"
-        header["CTYPE1A"] = "AWAV-GRA"
-        header["CUNIT1A"] = "nm"
+        header.update(self.spectral_fit_results)