opticam.fitting.psf_models
==========================

.. py:module:: opticam.fitting.psf_models


Functions
---------

.. autoapisummary::

   opticam.fitting.psf_models.gaussian


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

.. py:function:: gaussian(shape, x0, y0, theta, amplitude, sigma_major, sigma_minor)

   Gaussian PSF.

   Parameters
   ----------
   shape : tuple[int, int]
       The shape of the array.
   x0 : float
       The x location of the PSF maximum.
   y0 : float
       The y location of the PSF maximum.
   theta : float
       The orientation of the PSF in radians.
   amplitude : float
       The amplitude of the peak of the PSF.
   sigma_major : float
       The semi-major standard deviation.
   sigma_minor : float
       The semi-minor standard deviation.

   Returns
   -------
   NDArray[np.float64]
       The PSF model.