satlas.profiles.AsymmLorentzian

class satlas.profiles.AsymmLorentzian(fwhm=None, mu=None, amp=None, ampIsArea=False, asymm=0)

A callable normalized Lorentzian profile with builtin asymmetry.

__init__(fwhm=None, mu=None, amp=None, ampIsArea=False, asymm=0)

Creates a callable object storing the fwhm, amplitude, location and asymmetry of a asymmetric 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.
• asymm (float) – Asymmetry parameter, default to 0.

Returns:

Callable instance, evaluates the profile in the arguments supplied.

Return type:

AsymmLorentzian

__call__(x)

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 and an empirical linewidth function:

Methods

__init__([fwhm, mu, amp, ampIsArea, asymm])	Creates a callable object storing the fwhm, amplitude, location and asymmetry of a asymmetric Lorentzian lineshape.
linewidth_function(x)	Calculates the FWHM.

Attributes

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