voigt_integrate
- mcalf.profiles.voigt.voigt_integrate(x, s, g, clib=False, **kwargs)[source]
Voigt function implementation (calculated by integrating).
The default Voigt implementation.
- Parameters:
x (numpy.ndarray) – Wavelengths to evaluate Voigt function at.
s (float) – Sigma (for Gaussian).
g (float) – Gamma (for Lorentzian).
clib (bool, optional, default=True) – Whether to use the complied C library or a slower Python version. If using the C library, the accuracy of the integration is reduced to give the code a significant speed boost. Python version can be used when speed is not a priority. Python version will remove deviations that are sometimes present around the wings due to the reduced accuracy. If the C extensions is not installed, will default to false.
- Returns:
result – The value of the Voigt function here.
- Return type:
numpy.ndarray, shape=`x.shape`
Notes
More information on the Voigt function can be found here: https://en.wikipedia.org/wiki/Voigt_profile