opticam.models.fittable_models
==============================

.. py:module:: opticam.models.fittable_models


Functions
---------

.. autoapisummary::

   opticam.models.fittable_models.gaussian


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

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

   One dimensional 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 function evaluated at the inputs.