spotter.doppler
===============

.. py:module:: spotter.doppler

.. autoapi-nested-parse::

   Doppler and spectral calculations for rotating stars.

   This module provides functions to compute disk-integrated spectra, radial velocity
   maps, and related quantities for stars with non-uniform surfaces.



Functions
---------

.. autoapisummary::

   spotter.doppler.spectrum
   spotter.doppler.transit_spectrum
   spotter.doppler.rv_design_matrix
   spotter.doppler.radial_velocity


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

.. py:function:: spectrum(star: spotter.star.Star, time: jax.typing.ArrayLike, normalize: bool = True) -> jax.typing.ArrayLike

   Compute the integrated spectrum of a rotating Star.

   :param star: Star object.
   :type star: Star
   :param time: Time in days.
   :type time: ArrayLike
   :param normalize:
   :type normalize: bool, optional

   :returns: **spectrum** -- Integrated spectrum.
   :rtype: ndarray


.. py:function:: transit_spectrum(star: spotter.star.Star, time: float, x: float, y: float, z: float, r: float, normalize: bool = True) -> jax.typing.ArrayLike

   Compute the integrated spectrum of a rotating Star.

   :param star: Star object.
   :type star: Star
   :param time: Time in days.
   :type time: float
   :param normalize:
   :type normalize: bool, optional

   :returns: **spectrum** -- Integrated spectrum.
   :rtype: ndarray


.. py:function:: rv_design_matrix(star: spotter.star.Star, time: float) -> jax.typing.ArrayLike

   Compute the radial velocity design matrix for a Star.

   :param star: Star object.
   :type star: Star
   :param time: Time in days.
   :type time: float

   :returns: **matrix** -- Radial velocity design matrix.
   :rtype: ndarray


.. py:function:: radial_velocity(star: spotter.star.Star, time: float) -> jax.typing.ArrayLike

   Compute the disk-integrated radial velocity of a Star.

   :param star: Star object.
   :type star: Star
   :param time: Time in days.
   :type time: float

   :returns: **rv** -- Disk-integrated radial velocity.
   :rtype: ndarray