line_racer.intensity_correction_precalculation
==============================================

.. py:module:: line_racer.intensity_correction_precalculation


Functions
---------

.. autoapisummary::

   line_racer.intensity_correction_precalculation.analy_voigt
   line_racer.intensity_correction_precalculation.calculate_correction_grid


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

.. py:function:: analy_voigt(grid, sigma, gamma)

   Calculate the Voigt profile using the Wofz function.

   Parameters:

   grid : array-like
       The grid of wavenumbers.
   gamma : float
       The line broadening parameter (gamma).
   sigma : float
       The Doppler width (sigma).

   Returns:

   sc_voigt : array-like
       The calculated Voigt profile.


.. py:function:: calculate_correction_grid(gamma_sigma_ratio_min, gamma_sigma_ratio_max, sigma_min, sigma_max, number_width_points, cutoff_min, cutoff_max, number_cutoff_points, use_hartmann)

   Calculate the Hartmann (Hartmann et al. 2002) and cutoff correction grid for the Voigt profile.

   Parameters:

   gamma_sigma_ratio_min : float
       Minimum value of gamma/sigma.
   gamma_sigma_ratio_max : float
       Maximum value of gamma/sigma.
   sigma_min : float
       Minimum value of sigma.
   sigma_max : float
       Maximum value of sigma.
   width_points : int
       Number of points in the gamma/sigma dimension.
   cutoff_min : float
       Minimum value of cutoff.
   cutoff_max : float
       Maximum value of cutoff.
   cutoff_points : int
       Number of points in the cutoff dimension.
   Hartmann : bool
       Whether to apply the Hartmann correction

   Returns:

   corr : numpy.ndarray
       The correction grid.
   sigma_arr : numpy.ndarray
       The array of sigma values.
   gamma_sigma_ratio_arr : numpy.ndarray
       The array of gamma/sigma values.
   cutoff_arr : numpy.ndarray
       The array of cutoff values.