pybaselines.utils.gaussian

pybaselines.utils.gaussian(x, height=1.0, center=0.0, sigma=1.0)[source]

Generates a Gaussian distribution based on height, center, and sigma.

Parameters:
xnumpy.ndarray

The x-values at which to evaluate the distribution.

heightfloat, optional

The maximum height of the distribution. Default is 1.0.

centerfloat, optional

The center of the distribution. Default is 0.0.

sigmafloat, optional

The standard deviation of the distribution. Default is 1.0.

Returns:
numpy.ndarray

The Gaussian distribution evaluated with x.

Raises:
ValueError

Raised if sigma is not greater than 0.