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

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

@@ -1,3 +1,36 @@
+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-4.0.0 → dkist_processing_visp-5.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dkist-processing-visp
-Version: 4.0.0
+Version: 5.0.0
 Summary: Science processing code for the ViSP instrument on DKIST
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause
@@ -13,13 +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.0
+Requires-Dist: dkist-processing-common==11.8.1
 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: astropy==7.0.2
 Requires-Dist: numpy==2.2.5
 Requires-Dist: sunpy==6.1.1
@@ -94,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.1; extra == "frozen"
+Requires-Dist: alembic==1.17.2; extra == "frozen"
 Requires-Dist: amqp==5.3.1; extra == "frozen"
 Requires-Dist: annotated-types==0.7.0; extra == "frozen"
-Requires-Dist: anyio==4.11.0; extra == "frozen"
+Requires-Dist: anyio==4.12.0; extra == "frozen"
 Requires-Dist: apache-airflow==2.11.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-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-fab==1.5.3; 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: 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: 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.10.0; extra == "frozen"
+Requires-Dist: asgiref==3.11.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.11.10.0.38.31; extra == "frozen"
-Requires-Dist: asyncpg==0.30.0; 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: attrs==25.4.0; extra == "frozen"
 Requires-Dist: babel==2.17.0; extra == "frozen"
-Requires-Dist: billiard==4.2.2; extra == "frozen"
+Requires-Dist: billiard==4.2.4; extra == "frozen"
 Requires-Dist: blinker==1.9.0; extra == "frozen"
-Requires-Dist: boto3==1.40.71; extra == "frozen"
-Requires-Dist: botocore==1.40.71; extra == "frozen"
+Requires-Dist: boto3==1.42.1; extra == "frozen"
+Requires-Dist: botocore==1.42.1; extra == "frozen"
 Requires-Dist: cachelib==0.13.0; extra == "frozen"
-Requires-Dist: celery==5.3.1; extra == "frozen"
+Requires-Dist: celery==5.6.0; 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.0; extra == "frozen"
+Requires-Dist: click==8.3.1; 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"
@@ -148,25 +149,27 @@ 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.0; extra == "frozen"
+Requires-Dist: dkist-processing-common==11.8.1; 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==4.0.0; extra == "frozen"
+Requires-Dist: dkist-processing-visp==5.0.0; 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.60.1; extra == "frozen"
+Requires-Dist: fonttools==4.61.0; 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"
 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.2.4; 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"
@@ -184,7 +187,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.0; extra == "frozen"
+Requires-Dist: kombu==5.6.1; 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"
@@ -204,7 +207,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.5; extra == "frozen"
+Requires-Dist: networkx==3.6; 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"
@@ -249,11 +252,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.0; extra == "frozen"
+Requires-Dist: protobuf==6.33.1; 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.4; extra == "frozen"
+Requires-Dist: pydantic==2.12.5; 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"
@@ -271,18 +274,17 @@ 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.28.0; extra == "frozen"
-Requires-Dist: s3transfer==0.14.0; extra == "frozen"
+Requires-Dist: rpds-py==0.30.0; extra == "frozen"
+Requires-Dist: s3transfer==0.16.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: sniffio==1.3.1; extra == "frozen"
-Requires-Dist: solar-wavelength-calibration==1.0.1; extra == "frozen"
+Requires-Dist: solar-wavelength-calibration==2.0.0; extra == "frozen"
 Requires-Dist: sqids==0.5.1; extra == "frozen"
-Requires-Dist: sqlparse==0.5.3; extra == "frozen"
+Requires-Dist: sqlparse==0.5.4; 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"
@@ -297,16 +299,17 @@ 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.5; extra == "frozen"
+Requires-Dist: universal_pathlib==0.3.6; 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.0.0; extra == "frozen"
+Requires-Dist: yamale==6.1.0; extra == "frozen"
 Requires-Dist: yarl==1.22.0; extra == "frozen"
 Requires-Dist: zipp==3.23.0; extra == "frozen"
 

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

@@ -1,3 +1,22 @@
+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-4.0.0 → dkist_processing_visp-5.0.0}/dkist_processing_visp/models/constants.py

@@ -2,12 +2,15 @@
 
 from enum import Enum
 
+import astropy.units as u
+from astropy.units import Quantity
 from dkist_processing_common.models.constants import ConstantsBase
 
 
 class VispBudName(Enum):
     """Names to be used in Visp buds."""
 
+    arm_id = "ARM_ID"
     num_raster_steps = "NUM_RASTER_STEPS"
     polarimeter_mode = "POLARIMETER_MODE"
     wavelength = "WAVELENGTH"
@@ -22,6 +25,10 @@ class VispBudName(Enum):
     polcal_readout_exp_times = "POLCAL_READOUT_EXP_TIMES"
     non_dark_task_readout_exp_times = "NON_DARK_TASK_READOUT_EXP_TIMES"
     num_map_scans = "NUM_MAP_SCANS"
+    incident_light_angle_deg = "INCIDENT_LIGHT_ANGLE_DEG"
+    reflected_light_angle_deg = "REFLECTED_LIGHT_ANGLE_DEG"
+    grating_constant_inverse_mm = "GRATING_CONSTANT_INVERSE_MM"
+    solar_gain_ip_start_time = "SOLAR_GAIN_IP_START_TIME"
     axis_1_type = "AXIS_1_TYPE"
     axis_2_type = "AXIS_2_TYPE"
     axis_3_type = "AXIS_3_TYPE"
@@ -31,6 +38,16 @@ class VispBudName(Enum):
 class VispConstants(ConstantsBase):
     """Visp specific constants to add to the common constants."""
 
+    @property
+    def arm_id(self) -> str:
+        """
+        Return the current ViSP arm ID.
+
+        Arm IDs are ints in the headers, but we convert them to str here because that's what downstream machinery expects
+        the type to be.
+        """
+        return str(self._db_dict[VispBudName.arm_id])
+
     @property
     def wavelength(self) -> float:
         """Wavelength."""
@@ -76,17 +93,17 @@ class VispConstants(ConstantsBase):
                 raise ValueError(f"No init set known for {retarder_name = }")
 
     @property
-    def lamp_exposure_times(self) -> [float]:
+    def lamp_exposure_times(self) -> list[float]:
         """Find the lamp exposure time."""
         return self._db_dict[VispBudName.lamp_exposure_times.value]
 
     @property
-    def solar_exposure_times(self) -> [float]:
+    def solar_exposure_times(self) -> list[float]:
         """Find the solar exposure time."""
         return self._db_dict[VispBudName.solar_exposure_times.value]
 
     @property
-    def polcal_exposure_times(self) -> [float]:
+    def polcal_exposure_times(self) -> list[float]:
         """Find the polarization calibration exposure time."""
         if self.correct_for_polarization:
             return self._db_dict[VispBudName.polcal_exposure_times.value]
@@ -94,22 +111,22 @@ class VispConstants(ConstantsBase):
             return []
 
     @property
-    def observe_exposure_times(self) -> [float]:
+    def observe_exposure_times(self) -> list[float]:
         """Find the observation exposure time."""
         return self._db_dict[VispBudName.observe_exposure_times.value]
 
     @property
-    def lamp_readout_exp_times(self) -> [float]:
+    def lamp_readout_exp_times(self) -> list[float]:
         """Find the lamp readout exposure time."""
         return self._db_dict[VispBudName.lamp_readout_exp_times.value]
 
     @property
-    def solar_readout_exp_times(self) -> [float]:
+    def solar_readout_exp_times(self) -> list[float]:
         """Find the solar readout exposure time."""
         return self._db_dict[VispBudName.solar_readout_exp_times.value]
 
     @property
-    def polcal_readout_exp_times(self) -> [float]:
+    def polcal_readout_exp_times(self) -> list[float]:
         """Find the polarization calibration readout exposure time."""
         if self.correct_for_polarization:
             return self._db_dict[VispBudName.polcal_readout_exp_times.value]
@@ -117,7 +134,7 @@ class VispConstants(ConstantsBase):
             return []
 
     @property
-    def non_dark_task_readout_exp_times(self) -> [float]:
+    def non_dark_task_readout_exp_times(self) -> list[float]:
         """
         Find all readout exposure times that *need* to exist in a dark IP.
 
@@ -127,10 +144,34 @@ class VispConstants(ConstantsBase):
         return self._db_dict[VispBudName.non_dark_task_readout_exp_times.value]
 
     @property
-    def observe_readout_exp_times(self) -> [float]:
+    def observe_readout_exp_times(self) -> list[float]:
         """Find the observation readout exposure time."""
         return self._db_dict[VispBudName.observe_readout_exp_times.value]
 
+    @property
+    def incident_light_angle_deg(self) -> Quantity:
+        """Return the spectrograph incident light angle [deg]."""
+        return self._db_dict[VispBudName.incident_light_angle_deg] * u.deg
+
+    @property
+    def reflected_light_angle_deg(self) -> Quantity:
+        """
+        Return the spectrograph reflected light angle [deg].
+
+        This angle is the incident light angle plus the angular position of the ViSP arm.
+        """
+        return self._db_dict[VispBudName.reflected_light_angle_deg] * u.deg
+
+    @property
+    def grating_constant_inverse_mm(self) -> Quantity:
+        """Return the spectrograph grating constant [1/mm]."""
+        return self._db_dict[VispBudName.grating_constant_inverse_mm] / u.mm
+
+    @property
+    def solar_gain_ip_start_time(self) -> str:
+        """Return the start time of the SOLAR GAIN Instrument Program."""
+        return self._db_dict[VispBudName.solar_gain_ip_start_time]
+
     @property
     def axis_1_type(self) -> str:
         """Find the type of the first array axis."""

{dkist_processing_visp-4.0.0 → dkist_processing_visp-5.0.0}/dkist_processing_visp/models/fits_access.py

@@ -6,11 +6,15 @@ from enum import StrEnum
 class VispMetadataKey(StrEnum):
     """Controlled list of names for FITS metadata header keys."""
 
+    arm_id = "VSPARMID"
+    number_of_modulator_states = "VSPNUMST"
     raster_scan_step = "VSPSTP"
     total_raster_steps = "VSPNSTP"
     modulator_state = "VSPSTNUM"
-    number_of_modulator_states = "VSPNUMST"
     polarimeter_mode = "VISP_006"
+    grating_angle_deg = "VSPGRTAN"
+    arm_position_deg = "VSPARMPS"
+    grating_constant_inverse_mm = "VSPGRTCN"
     axis_1_type = "CTYPE1"
     axis_2_type = "CTYPE2"
     axis_3_type = "CTYPE3"

dkist_processing_visp-5.0.0/dkist_processing_visp/models/metric_code.py

@@ -0,0 +1,10 @@
+"""Controlled list of quality metric codes."""
+
+from enum import StrEnum
+
+
+class VispMetricCode(StrEnum):
+    """Controlled list of quality metric codes."""
+
+    solar_first_vignette = "SOLAR_CAL_FIRST_VIGNETTE"
+    solar_final_vignette = "SOLAR_CAL_FINAL_VIGNETTE"

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

@@ -1,9 +1,14 @@
 """Visp calibration pipeline parameters."""
 
 from datetime import datetime
+from random import randint
+from typing import Any
 
+import astropy.units as u
+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
 
 
 class VispParsingParameters(ParameterBase):
@@ -22,7 +27,7 @@ class VispParsingParameters(ParameterBase):
         )
 
 
-class VispParameters(ParameterBase, ParameterWavelengthMixin):
+class VispParameters(ParameterBase, ParameterWavelengthMixin, ParameterArmIdMixin):
     """Put all Visp parameters parsed from the input dataset document in a single property."""
 
     @property
@@ -69,7 +74,7 @@ class VispParameters(ParameterBase, ParameterWavelengthMixin):
 
     @property
     def hairline_mask_spatial_smoothing_width_px(self) -> float:
-        """Amount to smooth the hairling mask in the spatial direction.
+        """Amount to smooth the hairline mask in the spatial direction.
 
         This helps capture the higher-flux wings of the hairlines that would otherwise require a `hairline_fraction`
         that was so low it captures other optical features.
@@ -134,9 +139,34 @@ class VispParameters(ParameterBase, ParameterWavelengthMixin):
         return self._find_most_recent_past_value("visp_geo_poly_fit_order")
 
     @property
-    def solar_spectral_avg_window(self):
+    def geo_zone_prominence(self):
+        """Relative peak prominence threshold used to identify strong spectral features."""
+        return self._find_parameter_closest_wavelength("visp_geo_zone_prominence")
+
+    @property
+    def geo_zone_width(self):
+        """Pixel width used to search for strong spectral features."""
+        return self._find_parameter_closest_wavelength("visp_geo_zone_width")
+
+    @property
+    def geo_zone_bg_order(self):
+        """Order of polynomial fit used to remove continuum when identifying strong spectral features."""
+        return self._find_parameter_closest_wavelength("visp_geo_zone_bg_order")
+
+    @property
+    def geo_zone_normalization_percentile(self):
+        """Fraction of CDF to use for normalizing spectrum when search for strong features."""
+        return self._find_parameter_closest_wavelength("visp_geo_zone_normalization_percentile")
+
+    @property
+    def geo_zone_rel_height(self):
+        """Relative height at which to compute the width of strong spectral features."""
+        return self._find_most_recent_past_value("visp_geo_zone_rel_height")
+
+    @property
+    def solar_spatial_median_filter_width_px(self):
         """Pixel width of spatial median filter used to compute characteristic solar spectra."""
-        return self._find_parameter_closest_wavelength("visp_solar_spectral_avg_window")
+        return self._find_parameter_closest_wavelength("visp_solar_spatial_median_filter_width_px")
 
     @property
     def solar_characteristic_spatial_normalization_percentile(self) -> float:
@@ -146,29 +176,108 @@ class VispParameters(ParameterBase, ParameterWavelengthMixin):
         )
 
     @property
-    def solar_zone_prominence(self):
-        """Relative peak prominence threshold used to identify strong spectral features."""
-        return self._find_parameter_closest_wavelength("visp_solar_zone_prominence")
+    def solar_vignette_initial_continuum_poly_fit_order(self) -> int:
+        """
+        Define the order of polynomial to use when fitting the initial continuum function.
+
+        Note that "initial" in this context does not refer to an initial guess in the wavecal fitter, but rather the
+        fact that this represents the initial estimate of the vignette signal.
+        """
+        return self._find_most_recent_past_value(
+            "visp_solar_vignette_initial_continuum_poly_fit_order"
+        )
 
     @property
-    def solar_zone_width(self):
-        """Pixel width used to search for strong spectral features."""
-        return self._find_parameter_closest_wavelength("visp_solar_zone_width")
+    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_zone_bg_order(self):
-        """Order of polynomial fit used to remove continuum when identifying strong spectral features."""
-        return self._find_parameter_closest_wavelength("visp_solar_zone_bg_order")
+    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_zone_normalization_percentile(self):
-        """Fraction of CDF to use for normalzing spectrum when search for strong features."""
-        return self._find_parameter_closest_wavelength("visp_solar_zone_normalization_percentile")
+    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
 
     @property
-    def solar_zone_rel_height(self):
-        """Relative height at which to compute the width of strong spectral features."""
-        return self._find_most_recent_past_value("visp_solar_zone_rel_height")
+    def solar_vignette_spectral_poly_fit_order(self) -> int:
+        """Define the order of spectral polynomial used when computing the full, 2D vignette signal."""
+        return self._find_most_recent_past_value("visp_solar_vignette_spectral_poly_fit_order")
+
+    @property
+    def solar_vignette_min_samples(self) -> float:
+        """Return fractional number of samples required for the RANSAC regressor used to fit the 2D vignette signal."""
+        return self._find_most_recent_past_value("visp_solar_vignette_min_samples")
+
+    @property
+    def wavecal_camera_lens_parameters(self) -> list[u.Quantity]:
+        r"""
+        Define the 2nd order polynomial coefficients for computing the total camera focal length as a function of wavelength.
+
+        The total focal length of the lens is :math:`f = a_0 + a_1\lambda + a_2\lambda^2` where this property is
+        :math:`[a_0, a_1, a_2]`
+        """
+        value_list = self._find_parameter_for_arm("visp_wavecal_camera_lens_parameters")
+        unit_list = [u.m, u.m / u.nm, u.m / u.nm**2]
+        return [v * u for v, u in zip(value_list, unit_list)]
+
+    @property
+    def wavecal_pixel_pitch_micron_per_pix(self) -> u.Quantity:
+        """Define the physical size of ViSP detector pixels."""
+        return (
+            self._find_most_recent_past_value("visp_wavecal_pixel_pitch_micron_per_pix")
+            * u.micron
+            / u.pix
+        )
+
+    @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("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."""
+        return self._find_most_recent_past_value("visp_wavecal_init_resolving_power")
+
+    @property
+    def wavecal_init_straylight_fraction(self) -> float:
+        """Define the initial guess for straylight fraction in wavecal fits."""
+        return self._find_most_recent_past_value("visp_wavecal_init_straylight_fraction")
+
+    @property
+    def wavecal_init_opacity_factor(self) -> float:
+        """Define the initial guess for opacity factor in wavecal fits."""
+        return self._find_most_recent_past_value("visp_wavecal_init_opacity_factor")
 
     @property
     def polcal_spatial_median_filter_width_px(self) -> int: