reggae.psdmodel
===============

.. py:module:: reggae.psdmodel


Classes
-------

.. autoapisummary::

   reggae.psdmodel.PSDModel


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

.. py:class:: PSDModel(f, n_orders, lw=1 / 200, nu_0=None, nu_2=None, *args, **kwargs)

   Bases: :py:obj:`reggae.reggae.reggae`, :py:obj:`reggae.asymptotic.asymptotic`


   .. py:method:: get_nu_0(theta_asy)

      Return the l=0 p-mode frequencies

      Parameters
      ----------
      theta_asy: data class
          Data class containing the asymptotic parameters for p-modes. 

      Returns
      -------
      nu0: array-like
          l=0 mode frequencies.



   .. py:method:: get_nu_2(theta_asy)

      Get the l=2 mode frequencies

      Returns
      -------
      nu0: array-like
          l=2 mode frequencies



   .. py:method:: get_d02(theta_asy)

      Compute the l=0,2 separation

      Parameters
      ----------
      theta_asy: data class
          Data class of asymtotic p-mode parameters

      Returns
      -------
      d02: float
          Array of local frequency differences between l=0 and l=2 modes



   .. py:method:: getl1(theta_asy, theta_reg, **kwargs)

      Get the mixed l=1 mode frequencies.

      Parameters
      ----------
      theta_asy: data class
          Data class containing the asymptotic p-mode parameters.
      theta_reg: data class
          Data class containing the g-mode and mixing parameters.

      Returns
      -------
      nu_1: array-like
          An array of n_g + n_p mode frequencies.



   .. py:method:: _l1model(theta_asy, theta_reg, update_n_g=False, amps=None, dnu_p=0, dnu_g=0)

      Compute l=1 spectrum model.

      Parameters
      ----------
      theta_asy: data class
          Data class containing the asymptotic p-mode parameters.
      theta_reg: data class
          Data class containing the g-mode and mixing parameters.
      update_n_g: bool, opitonal
          Whether or not to update the list of n_g at each sample. Default is False.
      amps: array-like, optional
          Array of mode amplitude. Default is None.
      dnu_p: float, optional
          Small frequency offset for the p-modes. Default is 0.
      dnu_g: float, optional
          Small frequency offset for the g-mode. Default is 0.
      Returns
      -------




   .. py:method:: l1model(theta_asy, theta_reg, **kwargs)

      Create an l=1 multiplet

      Constructs a triplet of m=-1, 0, and 1, split by a linear combination of
      the core and envelope rotational splitting. The relative power density is 
      modulated the inclination of the stellar rotation axis.

      Parameters
      ----------
      theta_asy: data class
          Data class containing a sample of the asymptotic parameters for the p-modes.
      theta_reg: data class
          Data class containing a sample of l=1 mixing model parameters.
      kwargs : dict
          Additional keyword arguments to be passed to _l1model. 

      Returns
      -------
      l1model : jnp.array
          The spectrum model of a single l=1 multiplet.