satlas.profiles.Lorentzian¶

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

A callable normalized Lorentzian profile.

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

Creates a callable object storing the fwhm, amplitude and location of a Lorentzian 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 Lorentzian profile in the arguments supplied.
Return type:	Lorentzian

__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 MathWorld webpage http://mathworld.wolfram.com/LorentzianFunction.html:

$\mathcal{L}\left(x; \mu, \gamma\right) &= \frac{\gamma} {\pi\left(\left(x-\mu\right)^2+\gamma^2\right)} FWHM &= 2\gamma$

Methods

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

Attributes

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