Cthulhu.Voigt
=============

.. py:module:: Cthulhu.Voigt


Attributes
----------

.. autoapisummary::

   Cthulhu.Voigt.version
   Cthulhu.Voigt.dots
   Cthulhu.Voigt.positions
   Cthulhu.Voigt.version
   Cthulhu.Voigt.version


Functions
---------

.. autoapisummary::

   Cthulhu.Voigt.prior_index
   Cthulhu.Voigt.Voigt_HWHM
   Cthulhu.Voigt.Voigt_HWHM_arr
   Cthulhu.Voigt.Voigt_and_derivatives
   Cthulhu.Voigt.Voigt_function
   Cthulhu.Voigt.Voigt_function_vector
   Cthulhu.Voigt.Voigt_function_sub_Lorentzian
   Cthulhu.Voigt.Voigt_function_sub_Lorentzian_vector
   Cthulhu.Voigt.Generate_Voigt_atoms
   Cthulhu.Voigt.Generate_Voigt_grid_atoms
   Cthulhu.Voigt.Generate_Voigt_grid_molecules
   Cthulhu.Voigt.precompute_atoms
   Cthulhu.Voigt.precompute_molecules


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

.. py:data:: version

.. py:data:: dots

.. py:data:: positions

.. py:data:: version

.. py:data:: version

.. py:function:: prior_index(val, grid_start, grid_end, N_grid)

.. py:function:: Voigt_HWHM(gamma_L, alpha_D)

.. py:function:: Voigt_HWHM_arr(gamma_L, alpha_D)

.. py:function:: Voigt_and_derivatives(nu, gamma, alpha, norm)

.. py:function:: Voigt_function(nu, gamma, alpha)

.. py:function:: Voigt_function_vector(nu, gamma, alpha)

.. py:function:: Voigt_function_sub_Lorentzian(nu, gamma, alpha, nu_detune, nu_F, T)

.. py:function:: Voigt_function_sub_Lorentzian_vector(nu, gamma, alpha, nu_detune, nu_F, T)

.. py:function:: Generate_Voigt_atoms(nu_0, nu_detune, gamma, alpha, T, cutoff, N, species_ID)

.. py:function:: Generate_Voigt_grid_atoms(Voigt_arr, atom, nu_compute, nu_0, nu_detune, nu_F, T, gamma, alpha, idx_left, idx_right, N_Voigt)

.. py:function:: Generate_Voigt_grid_molecules(Voigt_arr, dV_da_arr, dV_dnu_arr, gamma_arr, alpha_arr, cutoffs, N_Voigt)

.. py:function:: precompute_atoms(atom, nu_compute, m, T, gamma, nu_0, Voigt_cutoff, cut_max)

.. py:function:: precompute_molecules(nu_compute, dnu_out, m, T, Voigt_sub_spacing, Voigt_cutoff, N_alpha_samples, gamma_L, cut_max)

   Pre-compute Voigt profiles and derivatives, for use in the Perturbed
   Template Voigt (PTB) method of molecular cross section computation.

   :param nu_compute: DESCRIPTION.
   :type nu_compute: TYPE
   :param dnu_out: DESCRIPTION.
   :type dnu_out: TYPE
   :param m: DESCRIPTION.
   :type m: TYPE
   :param T: DESCRIPTION.
   :type T: TYPE
   :param Voigt_sub_spacing: DESCRIPTION.
   :type Voigt_sub_spacing: TYPE
   :param Voigt_cutoff: DESCRIPTION.
   :type Voigt_cutoff: TYPE
   :param N_alpha_samples: DESCRIPTION.
   :type N_alpha_samples: TYPE
   :param gamma_L: DESCRIPTION.
   :type gamma_L: TYPE
   :param cut_max: DESCRIPTION.
   :type cut_max: TYPE

   :returns: * **nu_sampled** (*TYPE*) -- DESCRIPTION.
             * **alpha_sampled** (*TYPE*) -- DESCRIPTION.
             * **cutoffs** (*TYPE*) -- DESCRIPTION.
             * **N_Voigt** (*TYPE*) -- DESCRIPTION.
             * **Voigt_arr** (*TYPE*) -- DESCRIPTION.
             * **dV_da_arr** (*TYPE*) -- DESCRIPTION.
             * **dV_dnu_arr** (*TYPE*) -- DESCRIPTION.
             * **dnu_Voigt** (*TYPE*) -- DESCRIPTION.