opticam.fitting.models
======================

.. py:module:: opticam.fitting.models


Functions
---------

.. autoapisummary::

   opticam.fitting.models.gaussian
   opticam.fitting.models.power_law
   opticam.fitting.models.straight_line


Module Contents
---------------

.. py:function:: gaussian(x, amp, mu, std)

   Gaussian function.

   Parameters
   ----------
   x : NDArray
       The function inputs.
   amplitude : float
       The height of the function peak.
   mu : float
       The mean of the Gaussian.
   std : float
       The standard deviation of the Gaussian.

   Returns
   -------
   NDArray
       The Gaussian evaluated at the inputs.


.. py:function:: power_law(x, norm, exp)

   Power law function.

   Parameters
   ----------
   x : NDArray
       The function inputs.
   norm : float
       The normalisation.
   exp : float
       The exponent.

   Returns
   -------
   NDArray
       The power law evaluated at the inputs.


.. py:function:: straight_line(x, m, c)

   Straight line function.

   Parameters
   ----------
   x : NDArray
       The function inputs.
   m : float
       The gradient.
   c : float
       The intercept.

   Returns
   -------
   NDArray
       The straight line evaluated at the inputs.