Voigt Profile model¶
Module API¶
- pyspeckit.spectrum.models.inherited_voigtfitter.voigt(xarr, amp, xcen, sigma, gamma, normalized=False)[source] [github] [bitbucket]¶
Normalized Voigt profile
z = (x+i*gam)/(sig*sqrt(2)) V(x,sig,gam) = Re(w(z))/(sig*sqrt(2*pi))
The area of V in this definition is 1. If normalized=False, then you can divide the integral of V by sigma*sqrt(2*pi) to get the area.
Original implementation converted from http://mail.scipy.org/pipermail/scipy-user/2011-January/028327.html (had an incorrect normalization and strange treatment of the input parameters)
Modified implementation taken from wikipedia, using the definition. http://en.wikipedia.org/wiki/Voigt_profile
- Parameters
xarr : np.ndarray
The X values over which to compute the Voigt profile
amp : float
Amplitude of the voigt profile if normalized = True, amp is the AREA
xcen : float
The X-offset of the profile
sigma : float
The width / sigma parameter of the Gaussian distribution
gamma : float
The width / shape parameter of the Lorentzian distribution
normalized : bool
Determines whether “amp” refers to the area or the peak of the voigt profile
- pyspeckit.spectrum.models.inherited_voigtfitter.voigt_fitter()[source] [github] [bitbucket]¶
Generator for voigt fitter class
- pyspeckit.spectrum.models.inherited_voigtfitter.voigt_fwhm(sigma, gamma)[source] [github] [bitbucket]¶
Approximation to the Voigt FWHM from wikipedia
http://en.wikipedia.org/wiki/Voigt_profile
- Parameters
sigma : float
The width / sigma parameter of the Gaussian distribution
gamma : float
The width / shape parameter of the Lorentzian distribution
- pyspeckit.spectrum.models.inherited_voigtfitter.voigt_moments(self, *args, **kwargs)[source] [github] [bitbucket]¶
Get the spectral moments from the moments package. Use the gaussian width for the lorentzian width (not a great guess!)