petitRADTRANS.retrieval.covariance
==================================

.. py:module:: petitRADTRANS.retrieval.covariance

.. autoapi-nested-parse::

   See Greco & Brandt 2016, Nasedkin et al 2023 and Rotman et al 2025 for more information on
   covariance matrices and fitting.

   Rotman et al. 2025: 10.3847/1538-4357/adef04



Attributes
----------

.. autoapisummary::

   petitRADTRANS.retrieval.covariance._GLOBAL_KERNEL_ALIASES
   petitRADTRANS.retrieval.covariance._LOCAL_KERNEL_ALIASES
   petitRADTRANS.retrieval.covariance._MODE_ALIASES


Functions
---------

.. autoapisummary::

   petitRADTRANS.retrieval.covariance.normalize_covariance_mode
   petitRADTRANS.retrieval.covariance.normalize_global_kernel_name
   petitRADTRANS.retrieval.covariance.normalize_local_kernel_name
   petitRADTRANS.retrieval.covariance._as_wavelength_vector
   petitRADTRANS.retrieval.covariance._pairwise_separations
   petitRADTRANS.retrieval.covariance.squared_exponential_kernel
   petitRADTRANS.retrieval.covariance.matern32_kernel
   petitRADTRANS.retrieval.covariance.localized_squared_exponential_kernel
   petitRADTRANS.retrieval.covariance.build_global_covariance_kernel
   petitRADTRANS.retrieval.covariance.build_local_covariance_kernel


Module Contents
---------------

.. py:data:: _GLOBAL_KERNEL_ALIASES

.. py:data:: _LOCAL_KERNEL_ALIASES

.. py:data:: _MODE_ALIASES

.. py:function:: normalize_covariance_mode(mode: str | None) -> str

.. py:function:: normalize_global_kernel_name(kernel_name: str | None) -> str

.. py:function:: normalize_local_kernel_name(kernel_name: str | None) -> str

.. py:function:: _as_wavelength_vector(wavelengths: jax.typing.ArrayLike) -> jax.numpy.ndarray

.. py:function:: _pairwise_separations(wavelengths: jax.typing.ArrayLike) -> jax.numpy.ndarray

.. py:function:: squared_exponential_kernel(wavelengths: jax.typing.ArrayLike, amplitude: jax.typing.ArrayLike, length_scale: jax.typing.ArrayLike) -> jax.numpy.ndarray

.. py:function:: matern32_kernel(wavelengths: jax.typing.ArrayLike, amplitude: jax.typing.ArrayLike, length_scale: jax.typing.ArrayLike) -> jax.numpy.ndarray

.. py:function:: localized_squared_exponential_kernel(wavelengths: jax.typing.ArrayLike, amplitude: jax.typing.ArrayLike, length_scale: jax.typing.ArrayLike, center: jax.typing.ArrayLike) -> jax.numpy.ndarray

.. py:function:: build_global_covariance_kernel(wavelengths: jax.typing.ArrayLike, amplitude: jax.typing.ArrayLike, length_scale: jax.typing.ArrayLike, kernel_name: str = 'squared_exponential') -> jax.numpy.ndarray

.. py:function:: build_local_covariance_kernel(wavelengths: jax.typing.ArrayLike, amplitude: jax.typing.ArrayLike, length_scale: jax.typing.ArrayLike, center: jax.typing.ArrayLike, kernel_name: str = 'squared_exponential') -> jax.numpy.ndarray