dkist-processing-visp 5.0.0__tar.gz → 5.0.0rc2__tar.gz

{dkist_processing_visp-5.0.0 → dkist_processing_visp-5.0.0rc2}/CHANGELOG.rst

@@ -1,36 +1,3 @@
-v5.0.0 (2025-12-02)
-===================
-
-Features
---------
-
-- Only compute a single lamp gain for each beam. In the past a single map gain was also computed for each modulation state. (`#246 <https://bitbucket.org/dkistdc/dkist-processing-visp/pull-requests/246>`__)
-- Add quality report metrics that show the quality of the vignette estimation in the Solar Gain tasks. (`#246 <https://bitbucket.org/dkistdc/dkist-processing-visp/pull-requests/246>`__)
-- Update the Solar Gain task to measure vignetting signal, compute a single gain for each beam (as opposed to for each beam and modulator state),
-  and stop applying residual spectral shifts to the characteristic spectra before removing from the input gain array.
-  See the `Science Changelog <https://docs.dkist.nso.edu/projects/visp/en/stable/scientific_changelog.html>`_ and
-  `gain algorithm docs <https://docs.dkist.nso.edu/projects/visp/en/stable/gain_correction.html>`_ for more information. (`#246 <https://bitbucket.org/dkistdc/dkist-processing-visp/pull-requests/246>`__)
-- Add Buds to parse the spectrograph setup into pipeline constants to be used when fitting a solar atlas. (`#246 <https://bitbucket.org/dkistdc/dkist-processing-visp/pull-requests/246>`__)
-
-
-Misc
-----
-
-- Remove the `LineZonesMixin` and move its methods directly to the Geometric calibration task, which is now the only task that uses them. (`#246 <https://bitbucket.org/dkistdc/dkist-processing-visp/pull-requests/246>`__)
-- Rename the ``solar_spectral_avg_window`` to ``solar_spatial_median_filter_width_px`` to more accurately capture what it does. (`#246 <https://bitbucket.org/dkistdc/dkist-processing-visp/pull-requests/246>`__)
-- Rename all line-zone parameters to be "geo*" parameters instead of "solar*" parameters. These parameters are now only used in the
-  Geometric calibration task. (`#246 <https://bitbucket.org/dkistdc/dkist-processing-visp/pull-requests/246>`__)
-
-
-Documentation
--------------
-
-- Update the online doc page for `gain calibration <https://docs.dkist.nso.edu/projects/visp/en/stable/gain_correction.html>`_
-  to reflect the updates to the Solar Gain task. (`#246 <https://bitbucket.org/dkistdc/dkist-processing-visp/pull-requests/246>`__)
-- Add intersphinx mappings for `lmfit <https://lmfit.github.io/lmfit-py/>`_ and `scikit-learn <https://scikit-learn.org/stable/>`_
-  for linking bliss. (`#246 <https://bitbucket.org/dkistdc/dkist-processing-visp/pull-requests/246>`__)
-
-
 v4.0.0 (2025-11-12)
 ===================
 

{dkist_processing_visp-5.0.0 → dkist_processing_visp-5.0.0rc2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dkist-processing-visp
-Version: 5.0.0
+Version: 5.0.0rc2
 Summary: Science processing code for the ViSP instrument on DKIST
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause
@@ -13,14 +13,14 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.12
 Description-Content-Type: text/x-rst
-Requires-Dist: dkist-processing-common==11.8.1
+Requires-Dist: dkist-processing-common==11.8.1rc2
 Requires-Dist: dkist-processing-math==2.2.1
 Requires-Dist: dkist-processing-pac==3.1.1
 Requires-Dist: dkist-header-validator==5.2.1
 Requires-Dist: dkist-fits-specifications==4.17.0
 Requires-Dist: dkist-service-configuration==4.1.7
 Requires-Dist: dkist-spectral-lines==3.0.0
-Requires-Dist: solar-wavelength-calibration==2.0.0
+Requires-Dist: solar-wavelength-calibration==2.0.0rc3
 Requires-Dist: astropy==7.0.2
 Requires-Dist: numpy==2.2.5
 Requires-Dist: sunpy==6.1.1
@@ -95,44 +95,44 @@ Requires-Dist: aiohappyeyeballs==2.6.1; extra == "frozen"
 Requires-Dist: aiohttp==3.13.2; extra == "frozen"
 Requires-Dist: aiosignal==1.4.0; extra == "frozen"
 Requires-Dist: aiosmtplib==5.0.0; extra == "frozen"
-Requires-Dist: alembic==1.17.2; extra == "frozen"
+Requires-Dist: alembic==1.17.1; extra == "frozen"
 Requires-Dist: amqp==5.3.1; extra == "frozen"
 Requires-Dist: annotated-types==0.7.0; extra == "frozen"
-Requires-Dist: anyio==4.12.0; extra == "frozen"
+Requires-Dist: anyio==4.11.0; extra == "frozen"
 Requires-Dist: apache-airflow==2.11.0; extra == "frozen"
-Requires-Dist: apache-airflow-providers-celery==3.13.1; extra == "frozen"
-Requires-Dist: apache-airflow-providers-common-compat==1.10.0; extra == "frozen"
-Requires-Dist: apache-airflow-providers-common-io==1.7.0; extra == "frozen"
-Requires-Dist: apache-airflow-providers-common-sql==1.29.0; extra == "frozen"
+Requires-Dist: apache-airflow-providers-celery==3.10.0; extra == "frozen"
+Requires-Dist: apache-airflow-providers-common-compat==1.8.0; extra == "frozen"
+Requires-Dist: apache-airflow-providers-common-io==1.6.4; extra == "frozen"
+Requires-Dist: apache-airflow-providers-common-sql==1.28.2; extra == "frozen"
 Requires-Dist: apache-airflow-providers-fab==1.5.3; extra == "frozen"
-Requires-Dist: apache-airflow-providers-ftp==3.14.0; extra == "frozen"
-Requires-Dist: apache-airflow-providers-http==5.6.0; extra == "frozen"
-Requires-Dist: apache-airflow-providers-imap==3.10.0; extra == "frozen"
-Requires-Dist: apache-airflow-providers-postgres==6.5.0; extra == "frozen"
-Requires-Dist: apache-airflow-providers-smtp==2.4.0; extra == "frozen"
-Requires-Dist: apache-airflow-providers-sqlite==4.2.0; extra == "frozen"
-Requires-Dist: apispec==6.9.0; extra == "frozen"
+Requires-Dist: apache-airflow-providers-ftp==3.13.2; extra == "frozen"
+Requires-Dist: apache-airflow-providers-http==5.4.0; extra == "frozen"
+Requires-Dist: apache-airflow-providers-imap==3.9.3; extra == "frozen"
+Requires-Dist: apache-airflow-providers-postgres==6.4.0; extra == "frozen"
+Requires-Dist: apache-airflow-providers-smtp==2.3.1; extra == "frozen"
+Requires-Dist: apache-airflow-providers-sqlite==4.1.2; extra == "frozen"
+Requires-Dist: apispec==6.8.4; extra == "frozen"
 Requires-Dist: argcomplete==3.6.3; extra == "frozen"
 Requires-Dist: asdf==3.5.0; extra == "frozen"
 Requires-Dist: asdf_standard==1.4.0; extra == "frozen"
 Requires-Dist: asdf_transform_schemas==0.6.0; extra == "frozen"
-Requires-Dist: asgiref==3.11.0; extra == "frozen"
+Requires-Dist: asgiref==3.10.0; extra == "frozen"
 Requires-Dist: asteval==1.0.7; extra == "frozen"
 Requires-Dist: astropy==7.0.2; extra == "frozen"
-Requires-Dist: astropy-iers-data==0.2025.12.1.0.45.12; extra == "frozen"
-Requires-Dist: asyncpg==0.31.0; extra == "frozen"
+Requires-Dist: astropy-iers-data==0.2025.11.10.0.38.31; extra == "frozen"
+Requires-Dist: asyncpg==0.30.0; extra == "frozen"
 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: billiard==4.2.2; extra == "frozen"
 Requires-Dist: blinker==1.9.0; extra == "frozen"
-Requires-Dist: boto3==1.42.1; extra == "frozen"
-Requires-Dist: botocore==1.42.1; extra == "frozen"
+Requires-Dist: boto3==1.40.72; extra == "frozen"
+Requires-Dist: botocore==1.40.72; extra == "frozen"
 Requires-Dist: cachelib==0.13.0; extra == "frozen"
-Requires-Dist: celery==5.6.0; extra == "frozen"
+Requires-Dist: celery==5.3.1; extra == "frozen"
 Requires-Dist: certifi==2025.11.12; extra == "frozen"
 Requires-Dist: cffi==2.0.0; extra == "frozen"
 Requires-Dist: charset-normalizer==3.4.4; extra == "frozen"
-Requires-Dist: click==8.3.1; extra == "frozen"
+Requires-Dist: click==8.3.0; extra == "frozen"
 Requires-Dist: click-didyoumean==0.3.1; extra == "frozen"
 Requires-Dist: click-plugins==1.1.1.2; extra == "frozen"
 Requires-Dist: click-repl==0.3.0; extra == "frozen"
@@ -149,20 +149,19 @@ 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.8.1; extra == "frozen"
+Requires-Dist: dkist-processing-common==11.8.1rc2; extra == "frozen"
 Requires-Dist: dkist-processing-core==6.0.0; 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.0.0; extra == "frozen"
+Requires-Dist: dkist-processing-visp==5.0.0rc2; extra == "frozen"
 Requires-Dist: dkist-service-configuration==4.1.7; extra == "frozen"
 Requires-Dist: dkist-spectral-lines==3.0.0; extra == "frozen"
 Requires-Dist: dkist_fits_specifications==4.17.0; extra == "frozen"
 Requires-Dist: dnspython==2.8.0; extra == "frozen"
 Requires-Dist: email-validator==2.3.0; extra == "frozen"
-Requires-Dist: exceptiongroup==1.3.1; extra == "frozen"
 Requires-Dist: fastjsonschema==2.21.2; extra == "frozen"
 Requires-Dist: flower==2.0.1; extra == "frozen"
-Requires-Dist: fonttools==4.61.0; extra == "frozen"
+Requires-Dist: fonttools==4.60.1; extra == "frozen"
 Requires-Dist: frozenlist==1.8.0; extra == "frozen"
 Requires-Dist: fsspec==2025.10.0; extra == "frozen"
 Requires-Dist: globus-sdk==3.65.0; extra == "frozen"
@@ -187,7 +186,7 @@ Requires-Dist: jsonschema==4.25.1; extra == "frozen"
 Requires-Dist: jsonschema-specifications==2025.9.1; extra == "frozen"
 Requires-Dist: jupyter_core==5.9.1; extra == "frozen"
 Requires-Dist: kiwisolver==1.4.9; extra == "frozen"
-Requires-Dist: kombu==5.6.1; extra == "frozen"
+Requires-Dist: kombu==5.6.0; extra == "frozen"
 Requires-Dist: lazy-object-proxy==1.12.0; extra == "frozen"
 Requires-Dist: lazy_loader==0.4; extra == "frozen"
 Requires-Dist: limits==5.6.0; extra == "frozen"
@@ -207,7 +206,7 @@ Requires-Dist: more-itertools==10.8.0; extra == "frozen"
 Requires-Dist: moviepy==2.1.2; extra == "frozen"
 Requires-Dist: multidict==6.7.0; extra == "frozen"
 Requires-Dist: nbformat==5.10.4; extra == "frozen"
-Requires-Dist: networkx==3.6; extra == "frozen"
+Requires-Dist: networkx==3.5; extra == "frozen"
 Requires-Dist: numpy==2.2.5; extra == "frozen"
 Requires-Dist: object-clerk==1.0.0; extra == "frozen"
 Requires-Dist: opentelemetry-api==1.38.0; extra == "frozen"
@@ -252,11 +251,11 @@ Requires-Dist: proglog==0.1.12; extra == "frozen"
 Requires-Dist: prometheus_client==0.23.1; extra == "frozen"
 Requires-Dist: prompt_toolkit==3.0.52; extra == "frozen"
 Requires-Dist: propcache==0.4.1; extra == "frozen"
-Requires-Dist: protobuf==6.33.1; extra == "frozen"
+Requires-Dist: protobuf==6.33.0; extra == "frozen"
 Requires-Dist: psutil==7.1.3; extra == "frozen"
 Requires-Dist: psycopg2-binary==2.9.11; extra == "frozen"
 Requires-Dist: pycparser==2.23; extra == "frozen"
-Requires-Dist: pydantic==2.12.5; extra == "frozen"
+Requires-Dist: pydantic==2.12.4; extra == "frozen"
 Requires-Dist: pydantic-settings==2.12.0; extra == "frozen"
 Requires-Dist: pydantic_core==2.41.5; extra == "frozen"
 Requires-Dist: pyerfa==2.0.1.5; extra == "frozen"
@@ -274,17 +273,18 @@ Requires-Dist: requests-toolbelt==1.0.0; extra == "frozen"
 Requires-Dist: rfc3339-validator==0.1.4; extra == "frozen"
 Requires-Dist: rich==13.9.4; extra == "frozen"
 Requires-Dist: rich-argparse==1.7.2; extra == "frozen"
-Requires-Dist: rpds-py==0.30.0; extra == "frozen"
-Requires-Dist: s3transfer==0.16.0; extra == "frozen"
+Requires-Dist: rpds-py==0.28.0; extra == "frozen"
+Requires-Dist: s3transfer==0.14.0; extra == "frozen"
 Requires-Dist: scikit-image==0.25.2; extra == "frozen"
 Requires-Dist: scikit-learn==1.6.1; extra == "frozen"
 Requires-Dist: scipy==1.15.3; extra == "frozen"
 Requires-Dist: semantic-version==2.10.0; extra == "frozen"
 Requires-Dist: setproctitle==1.3.7; extra == "frozen"
 Requires-Dist: six==1.17.0; extra == "frozen"
-Requires-Dist: solar-wavelength-calibration==2.0.0; extra == "frozen"
+Requires-Dist: sniffio==1.3.1; extra == "frozen"
+Requires-Dist: solar-wavelength-calibration==2.0.0rc3; extra == "frozen"
 Requires-Dist: sqids==0.5.1; extra == "frozen"
-Requires-Dist: sqlparse==0.5.4; extra == "frozen"
+Requires-Dist: sqlparse==0.5.3; extra == "frozen"
 Requires-Dist: sunpy==6.1.1; extra == "frozen"
 Requires-Dist: tabulate==0.9.0; extra == "frozen"
 Requires-Dist: talus==1.3.4; extra == "frozen"
@@ -299,17 +299,16 @@ Requires-Dist: traitlets==5.14.3; extra == "frozen"
 Requires-Dist: typing-inspection==0.4.2; extra == "frozen"
 Requires-Dist: typing_extensions==4.15.0; extra == "frozen"
 Requires-Dist: tzdata==2025.2; extra == "frozen"
-Requires-Dist: tzlocal==5.3.1; extra == "frozen"
 Requires-Dist: uc-micro-py==1.0.3; extra == "frozen"
 Requires-Dist: uncertainties==3.2.3; extra == "frozen"
-Requires-Dist: universal_pathlib==0.3.6; extra == "frozen"
+Requires-Dist: universal_pathlib==0.3.5; extra == "frozen"
 Requires-Dist: urllib3==2.5.0; extra == "frozen"
 Requires-Dist: vine==5.1.0; extra == "frozen"
 Requires-Dist: voluptuous==0.15.2; extra == "frozen"
 Requires-Dist: wcwidth==0.2.14; extra == "frozen"
 Requires-Dist: wirerope==1.0.0; extra == "frozen"
 Requires-Dist: wrapt==1.17.3; extra == "frozen"
-Requires-Dist: yamale==6.1.0; extra == "frozen"
+Requires-Dist: yamale==6.0.0; extra == "frozen"
 Requires-Dist: yarl==1.22.0; extra == "frozen"
 Requires-Dist: zipp==3.23.0; extra == "frozen"
 

{dkist_processing_visp-5.0.0 → dkist_processing_visp-5.0.0rc2}/SCIENCE_CHANGELOG.rst

@@ -1,22 +1,3 @@
-v5.0.0 (2025-12-02)
-===================
-
-
-
-
-- Major update to the gain algorithm to mitigate polarization artifacts in L1 science frames. This change can be split into
-  three parts. See the `gain correction <https://docs.dkist.nso.edu/projects/visp/en/stable/gain_correction.html>`_ page for more information.
-
-  #. Compute a single gain correction image for each beam. In the past we had computed a separate gain image for each modstate as well, but this was found to couple residual polarization structure into the final science frames.
-
-  #. Stop "refining" (i.e., applying small spectral offsets to) the characteristic solar spectrum on a per-spatial-pixel basis. This was initially done to minimize line residuals in Telluric lines but was found to have a more-negative on polarimetric residuals.
-
-  #. Separate vignetting caused by aperture masks from the solar signal used to remove spectral lines in the final gain image. This is done by fitting a solar atlas and taking the deviation in continuum to be the vignetting signal.
-
-  Computing a single gain per beam will greatly reduce the polarization artifacts in L1 data. Measuring the vignette
-  signal directly will further reduce these artifacts and improve flatness across the array. (`#246 <https://bitbucket.org/dkistdc/dkist-processing-visp/pull-requests/246>`__)
-
-
 v4.0.0 (2025-11-12)
 ===================
 

dkist_processing_visp-5.0.0rc2/changelog/246.doc.2.rst

@@ -0,0 +1,2 @@
+Add intersphinx mappings for `lmfit <https://lmfit.github.io/lmfit-py/>`_ and `scikit-learn <https://scikit-learn.org/stable/>`_
+for linking bliss.

dkist_processing_visp-5.0.0rc2/changelog/246.doc.rst

@@ -0,0 +1,2 @@
+Update the online doc page for `gain calibration <https://docs.dkist.nso.edu/projects/visp/en/stable/gain_correction.html>`_
+to reflect the updates to the Solar Gain task.

dkist_processing_visp-5.0.0rc2/changelog/246.feature.2.rst

@@ -0,0 +1 @@
+Only compute a single lamp gain for each beam. In the past a single map gain was also computed for each modulation state.

dkist_processing_visp-5.0.0rc2/changelog/246.feature.3.rst

@@ -0,0 +1 @@
+Add Buds to parse the spectrograph setup into pipeline constants to be used when fitting a solar atlas.

dkist_processing_visp-5.0.0rc2/changelog/246.feature.4.rst

@@ -0,0 +1 @@
+Add quality report metrics that show the quality of the vignette estimation in the Solar Gain tasks.

dkist_processing_visp-5.0.0rc2/changelog/246.feature.rst

@@ -0,0 +1,4 @@
+Update the Solar Gain task to measure vignetting signal, compute a single gain for each beam (as opposed to for each beam and modulator state),
+and stop applying residual spectral shifts to the characteristic spectra before removing from the input gain array.
+See the `Science Changelog <https://docs.dkist.nso.edu/projects/visp/en/stable/scientific_changelog.html>`_ and
+`gain algorithm docs <https://docs.dkist.nso.edu/projects/visp/en/stable/gain_correction.html>`_ for more information.

dkist_processing_visp-5.0.0rc2/changelog/246.misc.2.rst

@@ -0,0 +1 @@
+Remove the `LineZonesMixin` and move its methods directly to the Geometric calibration task, which is now the only task that uses them.

dkist_processing_visp-5.0.0rc2/changelog/246.misc.3.rst

@@ -0,0 +1 @@
+Rename the ``solar_spectral_avg_window`` to ``solar_spatial_median_filter_width_px`` to more accurately capture what it does.

dkist_processing_visp-5.0.0rc2/changelog/246.misc.rst

@@ -0,0 +1,2 @@
+Rename all line-zone parameters to be "geo_" parameters instead of "solar_" parameters. These parameters are now only used in the
+Geometric calibration task.

dkist_processing_visp-5.0.0rc2/changelog/246.science.rst

@@ -0,0 +1,11 @@
+Major update to the gain algorithm to mitigate polarization artifacts in L1 science frames. This change can be split into
+three parts. See the `gain correction <https://docs.dkist.nso.edu/projects/visp/en/stable/gain_correction.html>`_ page for more information.
+
+#. Compute a single gain correction image for each beam. In the past we had computed a separate gain image for each modstate as well, but this was found to couple residual polarization structure into the final science frames.
+
+#. Stop "refining" (i.e., applying small spectral offsets to) the characteristic solar spectrum on a per-spatial-pixel basis. This was initially done to minimize line residuals in Telluric lines but was found to have a more-negative on polarimetric residuals.
+
+#. Separate vignetting caused by aperture masks from the solar signal used to remove spectral lines in the final gain image. This is done by fitting a solar atlas and taking the deviation in continuum to be the vignetting signal.
+
+Computing a single gain per beam will greatly reduce the polarization artifacts in L1 data. Measuring the vignette
+signal directly will further reduce these artifacts and improve flatness across the array.

{dkist_processing_visp-5.0.0 → dkist_processing_visp-5.0.0rc2}/dkist_processing_visp/models/parameters.py

@@ -1,7 +1,6 @@
 """Visp calibration pipeline parameters."""
 
 from datetime import datetime
-from random import randint
 from typing import Any
 
 import astropy.units as u
@@ -187,38 +186,10 @@ class VispParameters(ParameterBase, ParameterWavelengthMixin, ParameterArmIdMixi
             "visp_solar_vignette_initial_continuum_poly_fit_order"
         )
 
-    @property
-    def solar_vignette_crval_bounds_px(self) -> float:
-        """
-        Define the bounds (in *pixels*) on crval when fitting the initial vignette signal.
-
-        The actual bounds on the value of crval are equal to ± the initial dispersion times this number. Note that the
-        total range searched by the fitting algorithm will be twice this number (in pixels).
-        """
-        return self._find_most_recent_past_value("visp_solar_vignette_crval_bounds_px") * u.pix
-
-    @property
-    def solar_vignette_dispersion_bounds_fraction(self) -> float:
-        """
-        Define the ± fraction away from the initial value for bounds on dispersion when fitting the initial vignette signal.
-
-        This value should be between 0 and 1. For example, the minimum bound is `init_value * (1 - solar_vignette_dispersion_bounds_fraction)`.
-        """
-        return self._find_most_recent_past_value("visp_solar_vignette_dispersion_bounds_fraction")
-
     @property
     def solar_vignette_wavecal_fit_kwargs(self) -> dict[str, Any]:
         """Define extra keyword arguments to pass to the wavelength calibration fitter."""
-        doc_dict = self._find_most_recent_past_value("visp_solar_vignette_wavecal_fit_kwargs")
-        rng_kwarg = dict()
-        fitting_method = doc_dict.get("method", False)
-        if fitting_method in ["basinhopping", "differential_evolution", "dual_annealing"]:
-            rng = randint(1, 1_000_000)
-            rng_kwarg["rng"] = rng
-
-        # The order here allows us to override `rng` in a parameter value
-        fit_kwargs = rng_kwarg | doc_dict
-        return fit_kwargs
+        return self._find_most_recent_past_value("visp_solar_vignette_wavecal_fit_kwargs")
 
     @property
     def solar_vignette_spectral_poly_fit_order(self) -> int:
@@ -257,13 +228,6 @@ class VispParameters(ParameterBase, ParameterWavelengthMixin, ParameterArmIdMixi
         config_dict = self._find_most_recent_past_value("visp_wavecal_atlas_download_config")
         return DownloadConfig.model_validate(config_dict)
 
-    @property
-    def wavecal_init_crval_guess_normalization_percentile(self) -> float | None:
-        """Define the CDF percentage used to normalize the Atlas to the input spectrum level when computing an initial CRVAL guess."""
-        return self._find_most_recent_past_value(
-            "visp_wavecal_init_crval_guess_normalization_percentile"
-        )
-
     @property
     def wavecal_init_resolving_power(self) -> int:
         """Define the initial guess for ViSP resolving power in wavecal fits."""

{dkist_processing_visp-5.0.0 → dkist_processing_visp-5.0.0rc2}/dkist_processing_visp/tasks/solar.py

@@ -70,7 +70,6 @@ class WavelengthCalibrationParametersWithContinuum(WavelengthCalibrationParamete
 
     continuum_poly_fit_order: int
     normalized_abscissa: np.ndarray
-    zeroth_order_continuum_coefficient: float
 
     @property
     def continuum_function(self) -> Callable[[np.ndarray, Parameters], np.ndarray]:
@@ -94,26 +93,16 @@ class WavelengthCalibrationParametersWithContinuum(WavelengthCalibrationParamete
         #       dynamically create the required number of "poly_coeff_{o:02n}" fields. Sorry if this bites you!
         params = super().lmfit_parameters
         for o in range(self.continuum_poly_fit_order + 1):
-            # `np.polyval` uses its input coefficient list "backwards", so `poly_coeff_{self.continuum_poly_fit_order}`
-            # is the 0th order polynomial term.
             params.add(
                 f"poly_coeff_{o:02n}",
                 vary=True,
-                value=(
-                    self.zeroth_order_continuum_coefficient
-                    if o == self.continuum_poly_fit_order
-                    else 0
-                ),
+                value=o // self.continuum_poly_fit_order,
                 min=-1,
                 max=1,
             )
 
-        params[f"poly_coeff_{self.continuum_poly_fit_order:02n}"].min = (
-            self.zeroth_order_continuum_coefficient * 0.5
-        )
-        params[f"poly_coeff_{self.continuum_poly_fit_order:02n}"].max = (
-            self.zeroth_order_continuum_coefficient * 1.5
-        )
+        params[f"poly_coeff_{self.continuum_poly_fit_order:02n}"].min = 0.7
+        params[f"poly_coeff_{self.continuum_poly_fit_order:02n}"].max = 1.3
 
         # Remove the default continuum parameterization
         del params["continuum_level"]
@@ -562,11 +551,9 @@ class SolarCalibration(
 
         fitter = WavelengthCalibrationFitter(input_parameters=init_parameters, atlas=atlas)
         with self.telemetry_span("Fit atlas and continuum"):
-            extra_kwargs = self.parameters.solar_vignette_wavecal_fit_kwargs
-            logger.info(f"Calling fitter with extra kwargs: {extra_kwargs}")
             fit_result = fitter(
                 input_spectrum=representative_spectrum,
-                **extra_kwargs,
+                **self.parameters.solar_vignette_wavecal_fit_kwargs,
             )
 
         return fit_result
@@ -623,7 +610,6 @@ class SolarCalibration(
             negative_limit=-wavelength_range / 2,
             positive_limit=wavelength_range / 2,
             num_steps=500,
-            normalization_percentile=self.parameters.wavecal_init_crval_guess_normalization_percentile,
         )
 
         logger.info(f"{crval_init = !s}")
@@ -641,22 +627,18 @@ 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(
-            crval_init=crval_init,
-            wavelength_range=wavelength_range,
-            atlas=atlas,
-            representative_spectrum=representative_spectrum,
-        )
-        logger.info(f"0th order coefficient initial guess: {relative_atlas_scaling}")
 
-        wavelength_search_width = dispersion * self.parameters.solar_vignette_crval_bounds_px
+        # The first time we have to change these ranges (which may never happen!) we should at least consider making
+        # them parameters.
+        wavelength_search_width = wavelength_range * 0.15
         bounds = BoundsModel(
+            # An alternative for the crval bounds would be `[input_wavelength_vector.min(), input_wavelength_vector.max()]`
             crval=LengthBoundRange(
                 min=crval_init - wavelength_search_width, max=crval_init + wavelength_search_width
             ),
             dispersion=DispersionBoundRange(
-                min=dispersion * (1 - self.parameters.solar_vignette_dispersion_bounds_fraction),
-                max=dispersion * (1 + self.parameters.solar_vignette_dispersion_bounds_fraction),
+                min=dispersion * 0.96,
+                max=dispersion * 1.04,
             ),
             incident_light_angle=AngleBoundRange(
                 min=incident_light_angle - 1 * u.deg, max=incident_light_angle + 1 * u.deg
@@ -664,6 +646,7 @@ class SolarCalibration(
             resolving_power=UnitlessBoundRange(min=1e5, max=5e5),
             opacity_factor=UnitlessBoundRange(min=1.0, max=10),
             straylight_fraction=UnitlessBoundRange(min=0.0, max=0.8),
+            continuum_level=UnitlessBoundRange(min=0.99, max=1.1),
         )
 
         init_params = WavelengthCalibrationParametersWithContinuum(
@@ -673,7 +656,7 @@ class SolarCalibration(
             grating_constant=grating_constant,
             doppler_velocity=doppler_velocity,
             order=spectral_order,
-            continuum_level=1,
+            continuum_level=1.0,
             resolving_power=resolving_power,
             opacity_factor=opacity_factor,
             straylight_fraction=straylight_faction,
@@ -681,44 +664,10 @@ class SolarCalibration(
             bounds=bounds,
             continuum_poly_fit_order=self.parameters.solar_vignette_initial_continuum_poly_fit_order,
             normalized_abscissa=normalized_abscissa,
-            zeroth_order_continuum_coefficient=relative_atlas_scaling,
         )
 
         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.0.0 → dkist_processing_visp-5.0.0rc2}/dkist_processing_visp/tests/conftest.py

@@ -149,8 +149,6 @@ class VispInputDatasetParameterValues:
     )
     visp_solar_characteristic_spatial_normalization_percentile: float = 90.0
     visp_solar_vignette_initial_continuum_poly_fit_order: int = 6
-    visp_solar_vignette_crval_bounds_px: float = 7
-    visp_solar_vignette_dispersion_bounds_fraction: float = 0.02
     visp_solar_vignette_wavecal_fit_kwargs: dict[str, Any] = field(
         default_factory=lambda: {
             "method": "differential_evolution",
@@ -186,7 +184,6 @@ class VispInputDatasetParameterValues:
             "solar_reference_atlas_hash_id": "md5:84ab4c50689ef235fe5ed4f7ee905ca0",
         }
     )
-    visp_wavecal_init_crval_guess_normalization_percentile: float = 95
     visp_wavecal_init_resolving_power: int = 150000
     visp_wavecal_init_straylight_fraction: float = 0.2
     visp_wavecal_init_opacity_factor: float = 5.0

{dkist_processing_visp-5.0.0 → dkist_processing_visp-5.0.0rc2}/dkist_processing_visp/tests/test_parameters.py

@@ -34,7 +34,6 @@ def arm_parameter_names() -> list[str]:
 @pytest.fixture(scope="session")
 def unit_parameter_names_and_units() -> dict[str, u.Unit | list[u.Unit]]:
     return {
-        "solar_vignette_crval_bounds_px": u.pix,
         "wavecal_camera_lens_parameters": [u.m, u.m / u.nm, u.m / u.nm**2],
         "wavecal_pixel_pitch_micron_per_pix": u.um / u.pix,
     }
@@ -103,11 +102,7 @@ def test_non_wave_parameters(
             pn = f"{pn}_{arm_id}"
         pv = expected[pn]
         is_wavelength_param = isinstance(pv, dict) and "wavelength" in pv
-        if (
-            parameter_name not in parse_parameter_names
-            and not is_wavelength_param
-            and parameter_name != "solar_vignette_wavecal_fit_kwargs"
-        ):
+        if parameter_name not in parse_parameter_names and not is_wavelength_param:
             param_obj_value = getattr(task_param_attr, parameter_name)
             if isinstance(pv, tuple):
                 pv = list(pv)
@@ -175,47 +170,3 @@ def test_wave_parameters(
         is_wavelength_param = isinstance(pv, dict) and "wavelength" in pv
         if is_wavelength_param and property_name not in parse_parameter_names + arm_parameter_names:
             assert getattr(task_param_attr, property_name) == pv["values"][idx]
-
-
-class AnyInt:
-    pass
-
-
-@pytest.mark.parametrize("arm_id", [pytest.param("1")])
-@pytest.mark.parametrize(
-    "db_value, expected",
-    [
-        pytest.param({"method": "nelder"}, {"method": "nelder"}, id="non_rng_method"),
-        pytest.param(
-            {"method": "basinhopping"}, {"method": "basinhopping", "rng": AnyInt}, id="random_rng"
-        ),
-        pytest.param(
-            {"method": "differential_evolution", "rng": 6.28},
-            {"method": "differential_evolution", "rng": 6.28},
-            id="override_rng",
-        ),
-        pytest.param(dict(), dict(), id="no_kwargs"),
-    ],
-)
-def test_fit_kwarg_parameters(
-    basic_science_task_with_parameter_mixin,
-    db_value,
-    expected,
-):
-    """
-    Given: A Science task with the parameter mixin
-    When: Accessing properties for parameters that do not depend on wavelength
-    Then: The correct value is returned
-    """
-    task, _ = next(
-        basic_science_task_with_parameter_mixin(
-            VispInputDatasetParameterValues(visp_solar_vignette_wavecal_fit_kwargs=db_value)
-        )
-    )
-    kwarg_dict = task.parameters.solar_vignette_wavecal_fit_kwargs
-    assert kwarg_dict.keys() == expected.keys()
-    for k in expected.keys():
-        if expected[k] is AnyInt:
-            assert type(kwarg_dict[k]) is int
-        else:
-            assert expected[k] == kwarg_dict[k]

{dkist_processing_visp-5.0.0 → dkist_processing_visp-5.0.0rc2}/dkist_processing_visp/tests/test_solar.py

@@ -311,10 +311,7 @@ def solar_gain_task(
 
 @pytest.mark.parametrize(
     "background_on",
-    [
-        pytest.param(True, id="background_on"),
-        pytest.param(False, id="background_off"),
-    ],
+    [pytest.param(True, id="background_on"), pytest.param(False, id="background_off")],
 )
 def test_solar_gain_task(
     solar_gain_task,
@@ -450,10 +447,8 @@ def test_continuum_wavecal_parameters():
     Then: The polynomial coefficients are present
     """
     order = 3
-    zeroth_order = 6.28
     param_object = WavelengthCalibrationParametersWithContinuum(
         continuum_poly_fit_order=order,
-        zeroth_order_continuum_coefficient=zeroth_order,
         crval=400 * u.nm,
         dispersion=3 * u.nm / u.pix,
         incident_light_angle=4 * u.deg,
@@ -461,7 +456,6 @@ def test_continuum_wavecal_parameters():
         doppler_velocity=0 * u.km / u.s,
         order=1,
         normalized_abscissa=np.arange(10),
-        continuum_level=99999.9,
     )
     lmfit_params = param_object.lmfit_parameters
 
@@ -470,13 +464,13 @@ def test_continuum_wavecal_parameters():
     assert "poly_coeff_01" in lmfit_params
     assert "poly_coeff_00" in lmfit_params
 
-    assert lmfit_params["poly_coeff_03"].init_value == zeroth_order
-    assert lmfit_params["poly_coeff_02"].init_value == 0
-    assert lmfit_params["poly_coeff_01"].init_value == 0
-    assert lmfit_params["poly_coeff_00"].init_value == 0
+    assert lmfit_params["poly_coeff_03"].value == 1
+    assert lmfit_params["poly_coeff_02"].value == 0
+    assert lmfit_params["poly_coeff_01"].value == 0
+    assert lmfit_params["poly_coeff_00"].value == 0
 
-    assert lmfit_params["poly_coeff_03"].min == zeroth_order * 0.5
-    assert lmfit_params["poly_coeff_03"].max == zeroth_order * 1.5
+    assert lmfit_params["poly_coeff_03"].min == 0.7
+    assert lmfit_params["poly_coeff_03"].max == 1.3
     assert lmfit_params["poly_coeff_02"].min == -1
     assert lmfit_params["poly_coeff_02"].max == 1
     assert lmfit_params["poly_coeff_01"].min == -1