hyperspy._components.lorentzian module

class hyperspy._components.lorentzian.Lorentzian(A=1.0, gamma=1.0, centre=0.0, module='numexpr', **kwargs)

Bases: hyperspy._components.expression.Expression

Cauchy-Lorentz distribution (a.k.a. Lorentzian function) component.

f(x)=\frac{A}{\pi}\left[\frac{\gamma}{\left(x-x_{0}\right)^{2} +\gamma^{2}}\right]

Variable

Parameter

A

A

\gamma

gamma

x_0

centre
Parameters

  • A (float) – Height parameter, where A/(\gamma\pi) is the maximum of the peak.

  • gamma (float) – Scale parameter corresponding to the half-width-at-half-maximum of the peak, which corresponds to the interquartile spread.

  • centre (float) – Location of the peak maximum.

  • **kwargs – Extra keyword arguments are passed to the Expression component.

For convenience the fwhm attribute can be used to get and set the full-with-half-maximum.

property fwhm