satlas.profiles.Gaussian¶

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

A callable normalized Gaussian profile.

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

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

__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 used formula is taken from the MathWorld webpage http://mathworld.wolfram.com/GaussianFunction.html:

$G(x;\mu, \sigma) &= \frac{\exp\left(-\frac{1}{2}\left(\frac{x-\mu} {\sigma}\right)^2\right)}{\sqrt{2\pi}\sigma} FWHM &= s\sqrt{2\ln\left(2\right)}\sigma$

Methods

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

Attributes

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

satlas.profiles.Gaussian¶

Previous topic

Next topic

This Page