specparam.modes.funcs.gaussian_function

specparam.modes.funcs.gaussian_function(xs, *params)[source]

Gaussian fitting function.

Parameters:
xs1d array

Input x-axis values.

*paramsfloat

Parameters that define the gaussian function. Each gaussian has 3 parameters: ctr, hgt, wid.

Returns:
ys1d array

Output values for gaussian function.

Notes

Defines a Gaussian fit function as:

\[P(F)_n = a * \frac {w^2} {(F - c)^2 + w^2}\]