functions package

Submodules

functions.voigtprofile module

functions.voigtprofile.voigt_profile(x, sigma, gamma)[source]

Function to return the value of a (normalized) Voigt profile centered at x=0 and with (Gaussian) width sigma and Lorentz damping (=HWHM) gamma.

The Voigt profile is computed using the scipy.special.wofz, which returns the value of the Faddeeva function.

WARNING scipy.special.wofz is not compaible with np.float128 type parameters.

Parameters:
  • x (float64) – Scalar or array of x-values

  • sigma (float64) – Gaussian sigma component

  • gamma (float64) – Lorentzian gamma (=HWHM) component

Returns:

Flux array for given input

Return type:

ndarray

Module contents