opticam.fitting.models

Functions

gaussian(x, amp, mu, std)

Gaussian function.

power_law(x, norm, exp)

Power law function.

straight_line(x, m, c)

Straight line function.

Module Contents

opticam.fitting.models.gaussian(x, amp, mu, std)

Gaussian function.

Parameters

xNDArray

The function inputs.

amplitudefloat

The height of the function peak.

mufloat

The mean of the Gaussian.

stdfloat

The standard deviation of the Gaussian.

Returns

NDArray

The Gaussian evaluated at the inputs.

Parameters:
  • x (numpy.typing.NDArray)

  • amp (float)

  • mu (float)

  • std (float)

Return type:

numpy.typing.NDArray

opticam.fitting.models.power_law(x, norm, exp)

Power law function.

Parameters

xNDArray

The function inputs.

normfloat

The normalisation.

expfloat

The exponent.

Returns

NDArray

The power law evaluated at the inputs.

Parameters:
  • x (numpy.typing.NDArray)

  • norm (float)

  • exp (float)

Return type:

numpy.typing.NDArray

opticam.fitting.models.straight_line(x, m, c)

Straight line function.

Parameters

xNDArray

The function inputs.

mfloat

The gradient.

cfloat

The intercept.

Returns

NDArray

The straight line evaluated at the inputs.

Parameters:
  • x (numpy.typing.NDArray)

  • m (float)

  • c (float)

Return type:

numpy.typing.NDArray