satlas.profiles.Voigt¶

class satlas.profiles.Voigt(fwhm=None, mu=None, amp=None, ampIsArea=False)[source]¶

A callable normalized Voigt profile.

__init__(fwhm=None, mu=None, amp=None, ampIsArea=False)[source]¶

Creates a callable object storing the fwhm, amplitude and location of a Voigt lineshape.

Parameters:	fwhm (float) – Full Width At Half Maximum, defaults to 1. mu (float) – Location of the center, defaults to 0. amp (float) – Amplitude of the profile, defaults to 1. ampIsArea (boolean) – Sets if the amplitude is the integral or the peakheight. Defaults to False.
Returns:	Callable instance, evaluates the Voigt profile in the arguments supplied.
Return type:	Voigt

__call__(x)[source]¶

Evaluates the lineshape in the given values.

Parameters:	vals (array_like) – Array of values to evaluate the lineshape in.
Returns:	Array of seperate response values of the lineshape.
Return type:	array_like

Note

The formula used is taken from the Wikipedia webpage http://en.wikipedia.org/wiki/Voigt_profile, with $w(z)$ the Faddeeva function, and the values supplied as FWHM are appropriately transformed to $\sigma$ and $\gamma$ :

$V\left(x;\mu, \sigma, \gamma\right) &= \frac{\Re\left[w\left(z\right) \right]}{\sigma\sqrt{2\pi}} z&=\frac{x+i\gamma}{\sigma\sqrt{2\pi}}$

Methods

__init__([fwhm, mu, amp, ampIsArea]) Creates a callable object storing the fwhm, amplitude and location of a Voigt lineshape.

Attributes

`amp`	Peak amplitude.
`ampIsArea`	Boolean controlling the behaviour of amp.
`fwhm`	FWHM of the peak.
`mu`	Location of the peak.

satlas.profiles.Voigt¶

Previous topic

Next topic

This Page