gauss

erwans3.utils.gauss(amp: Union[float, Quantity], x0: Union[float, Quantity], x: Union[float, ndarray, Quantity], sig: Union[float, Quantity], norm: bool = False, bkg: Optional[Union[float, Quantity]] = None) → Union[float, Quantity]

Compute the Gaussian function with optional background and normalization.

Parameters:

• amp (float or Quantity) – Amplitude of the Gaussian.

• x0 (float or Quantity) – Mean value of the Gaussian.

• x (float or ndarray or Quantity) – Input values for which to compute the Gaussian.

• sig (float or Quantity) – Standard deviation of the Gaussian.

• norm (bool, optional) – If True, normalize the Gaussian. Default is False.

• bkg (float or Quantity or :obj`~:None`, optional) – Background value to add to the Gaussian. Default is None.

Returns:

Value of the Gaussian function at input values ‘x’.

Return type:

float or Quantity