sourcefinder.gaussian
=====================

.. py:module:: sourcefinder.gaussian

.. autoapi-nested-parse::

   Definition of a two-dimensional elliptical Gaussian.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   sourcefinder.gaussian.gaussian
   sourcefinder.gaussian.jac_gaussian


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

.. py:function:: gaussian(height, center_x, center_y, semimajor, semiminor, theta)

   
   Return a 2D Gaussian function with the given parameters.


   :Parameters:

       **height** : float
           (z-)value of the 2D Gaussian.

       **center_x** : float
           x center of the Gaussian.

       **center_y** : float
           y center of the Gaussian.

       **semimajor** : float
           Semi-major axis of the Gaussian.

       **semiminor** : float
           Semi-minor axis of the Gaussian.

       **theta** : float
           Angle of the 2D Gaussian in radians, measured between the semi-major
           and y axes, in counterclockwise direction.



   :Returns:

       function
           2D Gaussian function of pixel coordinates (x, y).











   ..
       !! processed by numpydoc !!

.. py:function:: jac_gaussian(gaussianargs)

   
   Return the Jacobian of a 2D anisotropic Gaussian.


   :Parameters:

       **gaussianargs** : list or tuple
           A list containing the six Gaussian parameters:
           
           - height (float): (z-)value of the 2D Gaussian.
           - center_x (float): x center of the Gaussian.
           - center_y (float): y center of the Gaussian.
           - semimajor (float): Major axis of the Gaussian.
           - semiminor (float): Minor axis of the Gaussian.
           - theta (float): Angle of the 2D Gaussian in radians, measured
             between the semi-major and y axes, in counterclockwise direction.



   :Returns:

       dict
           A dictionary containing the Jacobian of the Gaussian, i.e., the
           derivatives along each of the six parameters of the Gaussian as
           functions of pixel coordinates (x, y).











   ..
       !! processed by numpydoc !!