dkist-processing-visp 5.2.1__tar.gz → 5.2.2__tar.gz

{dkist_processing_visp-5.2.1 → dkist_processing_visp-5.2.2}/CHANGELOG.rst

@@ -1,3 +1,27 @@
+v5.2.2 (2025-12-17)
+===================
+
+Bugfixes
+--------
+
+- Normalize atlas and input spectrum when computing an initial CRVAL guess in the `WavelengthCalibration` task. This fixes
+  failing fits caused by very poor initial guesses caused by large continuum offsets. (`#255 <https://bitbucket.org/dkistdc/dkist-processing-visp/pull-requests/255>`__)
+
+
+Misc
+----
+
+- Move the `estimate_relative_continuum_level` method from `SolarCalibration` class to be a module-level function in
+  "wavelength_calibration.py" so it can be used by both the `SolarCalibration` and `WavelengthCalibration` tasks. (`#255 <https://bitbucket.org/dkistdc/dkist-processing-visp/pull-requests/255>`__)
+- Import the `WavelengthCalibration` task into the top-level `tasks` package and use that import path in workflow definitions. (`#255 <https://bitbucket.org/dkistdc/dkist-processing-visp/pull-requests/255>`__)
+
+
+Documentation
+-------------
+
+- Fix issue that prevented module-level functions in the wavelength calibration module from rendering in API docs. (`#255 <https://bitbucket.org/dkistdc/dkist-processing-visp/pull-requests/255>`__)
+
+
 v5.2.1 (2025-12-16)
 ===================
 

{dkist_processing_visp-5.2.1 → dkist_processing_visp-5.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dkist-processing-visp
-Version: 5.2.1
+Version: 5.2.2
 Summary: Science processing code for the ViSP instrument on DKIST
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause
@@ -126,8 +126,8 @@ Requires-Dist: attrs==25.4.0; extra == "frozen"
 Requires-Dist: babel==2.17.0; extra == "frozen"
 Requires-Dist: billiard==4.2.4; extra == "frozen"
 Requires-Dist: blinker==1.9.0; extra == "frozen"
-Requires-Dist: boto3==1.42.10; extra == "frozen"
-Requires-Dist: botocore==1.42.10; extra == "frozen"
+Requires-Dist: boto3==1.42.11; extra == "frozen"
+Requires-Dist: botocore==1.42.11; extra == "frozen"
 Requires-Dist: cachelib==0.13.0; extra == "frozen"
 Requires-Dist: celery==5.6.0; extra == "frozen"
 Requires-Dist: certifi==2025.11.12; extra == "frozen"
@@ -154,7 +154,7 @@ Requires-Dist: dkist-processing-common==11.9.1; extra == "frozen"
 Requires-Dist: dkist-processing-core==6.0.1; extra == "frozen"
 Requires-Dist: dkist-processing-math==2.2.1; extra == "frozen"
 Requires-Dist: dkist-processing-pac==3.1.1; extra == "frozen"
-Requires-Dist: dkist-processing-visp==5.2.1; extra == "frozen"
+Requires-Dist: dkist-processing-visp==5.2.2; extra == "frozen"
 Requires-Dist: dkist-service-configuration==4.1.13; extra == "frozen"
 Requires-Dist: dkist-spectral-lines==3.0.0; extra == "frozen"
 Requires-Dist: dkist_fits_specifications==4.19.0; extra == "frozen"
@@ -170,6 +170,7 @@ Requires-Dist: globus-sdk==4.2.0; extra == "frozen"
 Requires-Dist: google-re2==1.1.20251105; extra == "frozen"
 Requires-Dist: googleapis-common-protos==1.72.0; extra == "frozen"
 Requires-Dist: gqlclient==1.2.3; extra == "frozen"
+Requires-Dist: greenlet==3.3.0; extra == "frozen"
 Requires-Dist: grpcio==1.76.0; extra == "frozen"
 Requires-Dist: gunicorn==23.0.0; extra == "frozen"
 Requires-Dist: h11==0.16.0; extra == "frozen"

{dkist_processing_visp-5.2.1 → dkist_processing_visp-5.2.2}/dkist_processing_visp/tasks/__init__.py

@@ -12,4 +12,5 @@ from dkist_processing_visp.tasks.parse import *
 from dkist_processing_visp.tasks.quality_metrics import *
 from dkist_processing_visp.tasks.science import *
 from dkist_processing_visp.tasks.solar import *
+from dkist_processing_visp.tasks.wavelength_calibration import WavelengthCalibration
 from dkist_processing_visp.tasks.write_l1 import *

{dkist_processing_visp-5.2.1 → dkist_processing_visp-5.2.2}/dkist_processing_visp/tasks/solar.py

@@ -46,6 +46,7 @@ from dkist_processing_visp.tasks.visp_base import VispTaskBase
 from dkist_processing_visp.tasks.wavelength_calibration import compute_initial_dispersion
 from dkist_processing_visp.tasks.wavelength_calibration import compute_input_wavelength_vector
 from dkist_processing_visp.tasks.wavelength_calibration import compute_order
+from dkist_processing_visp.tasks.wavelength_calibration import estimate_relative_continuum_level
 from dkist_processing_visp.tasks.wavelength_calibration import get_doppler_velocity
 
 __all__ = [
@@ -638,11 +639,12 @@ class SolarCalibration(
         resolving_power = self.parameters.wavecal_init_resolving_power
         opacity_factor = self.parameters.wavecal_init_opacity_factor
         straylight_faction = self.parameters.wavecal_init_straylight_fraction
-        relative_atlas_scaling = self.estimate_relative_continuum_level(
+        relative_atlas_scaling = estimate_relative_continuum_level(
             crval_init=crval_init,
             wavelength_range=wavelength_range,
             atlas=atlas,
             representative_spectrum=representative_spectrum,
+            normalization_percentile=self.parameters.wavecal_init_crval_guess_normalization_percentile,
         )
         logger.info(f"0th order coefficient initial guess: {relative_atlas_scaling}")
 
@@ -683,39 +685,6 @@ class SolarCalibration(
 
         return init_params
 
-    def estimate_relative_continuum_level(
-        self,
-        *,
-        crval_init: Quantity,
-        wavelength_range: Quantity,
-        atlas: Atlas,
-        representative_spectrum: np.ndarray,
-    ) -> float:
-        """
-        Estimate the multiplicative scaling between the representative spectrum and atlas solar transmission.
-
-        This scaling is used to set the initial guess of 0th-order polynomial fit coefficient. We estimate the scaling
-        factor by comparing the values of the two spectra at a given percent of the CDF. This percent is taken from
-        the `~dkist_processing_visp.models.parameters.VispParameters.wavecal_init_crval_guess_normalization_percentile`
-        pipeline parameter.
-        """
-        wave_min = crval_init - wavelength_range / 2
-        wave_max = crval_init + wavelength_range / 2
-
-        atlas_idx = np.where(
-            (atlas.solar_atlas_wavelength >= wave_min) & (atlas.solar_atlas_wavelength <= wave_max)
-        )
-        atlas_norm = np.nanpercentile(
-            atlas.solar_atlas_transmission[atlas_idx],
-            self.parameters.wavecal_init_crval_guess_normalization_percentile,
-        )
-        spec_norm = np.nanpercentile(
-            representative_spectrum,
-            self.parameters.wavecal_init_crval_guess_normalization_percentile,
-        )
-
-        return spec_norm / atlas_norm
-
     def compute_final_vignette_estimate(self, init_vignette_correction: np.ndarray) -> np.ndarray:
         """
         Fit the spectral shape of continuum residuals for each spatial pixel.

{dkist_processing_visp-5.2.1 → dkist_processing_visp-5.2.2}/dkist_processing_visp/tasks/wavelength_calibration.py

@@ -26,8 +26,6 @@ from sunpy.coordinates import HeliocentricInertial
 from dkist_processing_visp.models.tags import VispTag
 from dkist_processing_visp.tasks.visp_base import VispTaskBase
 
-__all__ = ["WavelengthCalibration"]
-
 
 class WavelengthCalibration(VispTaskBase, QualityMixin):
     """Task class for correcting the dispersion axis wavelength values.
@@ -125,6 +123,7 @@ class WavelengthCalibration(VispTaskBase, QualityMixin):
                 negative_limit=-wavelength_range / 2,
                 positive_limit=wavelength_range / 2,
                 num_steps=550,
+                normalization_percentile=self.parameters.wavecal_init_crval_guess_normalization_percentile,
             )
             logger.info(f"{crval_initial_guess = !s}")
 
@@ -135,6 +134,15 @@ class WavelengthCalibration(VispTaskBase, QualityMixin):
             resolving_power = self.parameters.wavecal_init_resolving_power
             logger.info(f"{resolving_power = }")
 
+            init_continuum_level = estimate_relative_continuum_level(
+                crval_init=crval_initial_guess,
+                wavelength_range=wavelength_range,
+                atlas=atlas,
+                representative_spectrum=input_spectrum,
+                normalization_percentile=self.parameters.wavecal_init_crval_guess_normalization_percentile,
+            )
+            logger.info(f"{init_continuum_level = !s}")
+
             logger.info("Setting bounds")
             wavelength_search_width = dispersion * self.parameters.wavecal_crval_bounds_px
             bounds = BoundsModel(
@@ -158,7 +166,9 @@ class WavelengthCalibration(VispTaskBase, QualityMixin):
                 ),
                 opacity_factor=UnitlessBoundRange(min=0.0, max=10.0),
                 straylight_fraction=UnitlessBoundRange(min=0.0, max=0.4),
-                continuum_level=UnitlessBoundRange(min=0.5, max=2.0),
+                continuum_level=UnitlessBoundRange(
+                    min=init_continuum_level * 0.7, max=init_continuum_level * 1.3
+                ),
             )
 
             fit_flags = FitFlagsModel(
@@ -180,6 +190,7 @@ class WavelengthCalibration(VispTaskBase, QualityMixin):
                 opacity_factor=self.parameters.wavecal_init_opacity_factor,
                 straylight_fraction=self.parameters.wavecal_init_straylight_fraction,
                 grating_constant=self.constants.grating_constant_inverse_mm,
+                continuum_level=init_continuum_level,
                 doppler_velocity=doppler_velocity,
                 order=order,
                 bounds=bounds,
@@ -428,3 +439,33 @@ def compute_initial_dispersion(
     dispersion = pixel_pitch / linear_dispersion
 
     return dispersion.to(u.nm / u.pix)
+
+
+def estimate_relative_continuum_level(
+    *,
+    crval_init: Quantity,
+    wavelength_range: Quantity,
+    atlas: Atlas,
+    representative_spectrum: np.ndarray,
+    normalization_percentile: float,
+) -> float:
+    """
+    Estimate the multiplicative scaling between the representative spectrum and atlas solar transmission.
+
+    This scaling is used to set the initial guess of 0th-order continuum scaling. We estimate the scaling factor by
+    comparing the values of the two spectra at a given percent of the CDF. This percent is taken from the
+    `~dkist_processing_visp.models.parameters.VispParameters.wavecal_init_crval_guess_normalization_percentile`
+    pipeline parameter.
+    """
+    wave_min = crval_init - wavelength_range / 2
+    wave_max = crval_init + wavelength_range / 2
+
+    atlas_idx = np.where(
+        (atlas.solar_atlas_wavelength >= wave_min) & (atlas.solar_atlas_wavelength <= wave_max)
+    )
+    atlas_norm = np.nanpercentile(
+        atlas.solar_atlas_transmission[atlas_idx], normalization_percentile
+    )
+    spec_norm = np.nanpercentile(representative_spectrum, normalization_percentile)
+
+    return spec_norm / atlas_norm

{dkist_processing_visp-5.2.1 → dkist_processing_visp-5.2.2}/dkist_processing_visp/workflows/l0_processing.py

@@ -22,7 +22,7 @@ from dkist_processing_visp.tasks import VispAssembleQualityData
 from dkist_processing_visp.tasks import VispL0QualityMetrics
 from dkist_processing_visp.tasks import VispL1QualityMetrics
 from dkist_processing_visp.tasks import VispWriteL1Frame
-from dkist_processing_visp.tasks.wavelength_calibration import WavelengthCalibration
+from dkist_processing_visp.tasks import WavelengthCalibration
 
 l0_pipeline = Workflow(
     category="visp",

{dkist_processing_visp-5.2.1 → dkist_processing_visp-5.2.2}/dkist_processing_visp/workflows/trial_workflows.py

@@ -23,7 +23,7 @@ from dkist_processing_visp.tasks import VispAssembleQualityData
 from dkist_processing_visp.tasks import VispL0QualityMetrics
 from dkist_processing_visp.tasks import VispL1QualityMetrics
 from dkist_processing_visp.tasks import VispWriteL1Frame
-from dkist_processing_visp.tasks.wavelength_calibration import WavelengthCalibration
+from dkist_processing_visp.tasks import WavelengthCalibration
 
 full_trial_pipeline = Workflow(
     category="visp",

{dkist_processing_visp-5.2.1 → dkist_processing_visp-5.2.2}/dkist_processing_visp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dkist-processing-visp
-Version: 5.2.1
+Version: 5.2.2
 Summary: Science processing code for the ViSP instrument on DKIST
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause
@@ -126,8 +126,8 @@ Requires-Dist: attrs==25.4.0; extra == "frozen"
 Requires-Dist: babel==2.17.0; extra == "frozen"
 Requires-Dist: billiard==4.2.4; extra == "frozen"
 Requires-Dist: blinker==1.9.0; extra == "frozen"
-Requires-Dist: boto3==1.42.10; extra == "frozen"
-Requires-Dist: botocore==1.42.10; extra == "frozen"
+Requires-Dist: boto3==1.42.11; extra == "frozen"
+Requires-Dist: botocore==1.42.11; extra == "frozen"
 Requires-Dist: cachelib==0.13.0; extra == "frozen"
 Requires-Dist: celery==5.6.0; extra == "frozen"
 Requires-Dist: certifi==2025.11.12; extra == "frozen"
@@ -154,7 +154,7 @@ Requires-Dist: dkist-processing-common==11.9.1; extra == "frozen"
 Requires-Dist: dkist-processing-core==6.0.1; extra == "frozen"
 Requires-Dist: dkist-processing-math==2.2.1; extra == "frozen"
 Requires-Dist: dkist-processing-pac==3.1.1; extra == "frozen"
-Requires-Dist: dkist-processing-visp==5.2.1; extra == "frozen"
+Requires-Dist: dkist-processing-visp==5.2.2; extra == "frozen"
 Requires-Dist: dkist-service-configuration==4.1.13; extra == "frozen"
 Requires-Dist: dkist-spectral-lines==3.0.0; extra == "frozen"
 Requires-Dist: dkist_fits_specifications==4.19.0; extra == "frozen"
@@ -170,6 +170,7 @@ Requires-Dist: globus-sdk==4.2.0; extra == "frozen"
 Requires-Dist: google-re2==1.1.20251105; extra == "frozen"
 Requires-Dist: googleapis-common-protos==1.72.0; extra == "frozen"
 Requires-Dist: gqlclient==1.2.3; extra == "frozen"
+Requires-Dist: greenlet==3.3.0; extra == "frozen"
 Requires-Dist: grpcio==1.76.0; extra == "frozen"
 Requires-Dist: gunicorn==23.0.0; extra == "frozen"
 Requires-Dist: h11==0.16.0; extra == "frozen"

{dkist_processing_visp-5.2.1 → dkist_processing_visp-5.2.2}/dkist_processing_visp.egg-info/requires.txt

@@ -92,8 +92,8 @@ attrs==25.4.0
 babel==2.17.0
 billiard==4.2.4
 blinker==1.9.0
-boto3==1.42.10
-botocore==1.42.10
+boto3==1.42.11
+botocore==1.42.11
 cachelib==0.13.0
 celery==5.6.0
 certifi==2025.11.12
@@ -120,7 +120,7 @@ dkist-processing-common==11.9.1
 dkist-processing-core==6.0.1
 dkist-processing-math==2.2.1
 dkist-processing-pac==3.1.1
-dkist-processing-visp==5.2.1
+dkist-processing-visp==5.2.2
 dkist-service-configuration==4.1.13
 dkist-spectral-lines==3.0.0
 dkist_fits_specifications==4.19.0
@@ -136,6 +136,7 @@ globus-sdk==4.2.0
 google-re2==1.1.20251105
 googleapis-common-protos==1.72.0
 gqlclient==1.2.3
+greenlet==3.3.0
 grpcio==1.76.0
 gunicorn==23.0.0
 h11==0.16.0

{dkist_processing_visp-5.2.1 → dkist_processing_visp-5.2.2}/pyproject.toml

@@ -9,8 +9,8 @@ find = {}
 
 [tool.dkist-dev-tools]
 # Most recently frozen version by dkist-dev-tools
-version = "5.2.1"
-date = 2025-12-16T13:02:14.592784
+version = "5.2.2"
+date = 2025-12-17T09:12:25.459200
 
 [project]
 dynamic = ["version"]
@@ -154,8 +154,8 @@ frozen = [
     "babel == 2.17.0",
     "billiard == 4.2.4",
     "blinker == 1.9.0",
-    "boto3 == 1.42.10",
-    "botocore == 1.42.10",
+    "boto3 == 1.42.11",
+    "botocore == 1.42.11",
     "cachelib == 0.13.0",
     "celery == 5.6.0",
     "certifi == 2025.11.12",
@@ -182,7 +182,7 @@ frozen = [
     "dkist-processing-core == 6.0.1",
     "dkist-processing-math == 2.2.1",
     "dkist-processing-pac == 3.1.1",
-    "dkist-processing-visp == 5.2.1",
+    "dkist-processing-visp == 5.2.2",
     "dkist-service-configuration == 4.1.13",
     "dkist-spectral-lines == 3.0.0",
     "dkist_fits_specifications == 4.19.0",
@@ -198,6 +198,7 @@ frozen = [
     "google-re2 == 1.1.20251105",
     "googleapis-common-protos == 1.72.0",
     "gqlclient == 1.2.3",
+    "greenlet == 3.3.0",
     "grpcio == 1.76.0",
     "gunicorn == 23.0.0",
     "h11 == 0.16.0",