pyIntensityFeatures.utils.distributions
=======================================

.. py:module:: pyIntensityFeatures.utils.distributions

.. autoapi-nested-parse::

   Functions providing data distribtuions.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   pyIntensityFeatures.utils.distributions.calc_quadratic
   pyIntensityFeatures.utils.distributions.gauss
   pyIntensityFeatures.utils.distributions.mult_gauss
   pyIntensityFeatures.utils.distributions.single_gauss_quad
   pyIntensityFeatures.utils.distributions.mult_gauss_quad


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

.. py:function:: calc_quadratic(x, c, b, a)

   
   Calculate the quadratic value at a specified location.


   :Parameters:

       **x** : float or array-like
           Location(s) at which the quadratic background will be calculated

       **c** : float
           Constant term in the quadratic equation

       **b** : float
           Multipler for the x-term in the quadratic equation

       **a** : float
           Multiplier for the x-squared term in the quadratic equation



   :Returns:

       **y** : float or array-like
           Amplitude value(s) at the input location(s)











   ..
       !! processed by numpydoc !!

.. py:function:: gauss(x, amp, mu, sigma, const)

   
   Provide results for a simple Gaussian function.


   :Parameters:

       **x** : (float or array-like)
           Dependent variable

       **amp** : float
           Amplitude

       **mu** : float
           Mean, or x-offset

       **sigma** : float
           Sigma, or exponential scalar

       **const** : float
           Additive constant



   :Returns:

       **y** : (float or array-like)
           Normal value at `x`











   ..
       !! processed by numpydoc !!

.. py:function:: mult_gauss(x, amps, mus, sigmas, const)

   
   Provide results for a double-peaked Gaussian function.


   :Parameters:

       **x** : float or array-like
           Dependent variable

       **amps** : array-like
           Amplitudes

       **mus** : array-like
           Means, or x-offsets

       **sigmas** : array-like
           Sigmas, or exponential scalars

       **const** : float
           Additive constant



   :Returns:

       **y** : (float or array-like)
           Normal value at `x`




   :Raises:

       ValueError
           If the number of input parameters is wrong







   ..
       !! processed by numpydoc !!

.. py:function:: single_gauss_quad(x, c, b, a, amp, mu, sigma)

   
   Provide results for a single Gaussian with a quadratic background.


   :Parameters:

       **x** : (float or array-like)
           Dependent variable

       **c** : float
           Constant term in the quadratic equation

       **b** : float
           Multipler for the x-term in the quadratic equation

       **a** : float
           Multiplier for the x-squared term in the quadratic equation

       **amp** : float
           Amplitude

       **mu** : float
           Mean, or x-offset

       **sigma** : float
           Sigma, or exponential scalar



   :Returns:

       **y** : (float or array-like)
           Normal value at `x`











   ..
       !! processed by numpydoc !!

.. py:function:: mult_gauss_quad(x, *param)

   
   Provide results for a multiple Gaussian with a quadratic background.


   :Parameters:

       **x** : float or array-like
           Dependent variable

       **param** : set
           Set containing: constant, quadratic multiplier for x, quadratic
           multiplier for x^2, and Gaussian amplitudes, x offsets, and exponential
           scalers for each Gaussian. The number of each Gaussian group must be
           the same; e.g., there must be two of each amplitude, x offset, and
           exponential scalers, but only one constant and quadratic multipliers.



   :Returns:

       **y** : float or array-like
           Normal value at `x`




   :Raises:

       ValueError
           If the correct number of inputs are not supplied to `param`







   ..
       !! processed by numpydoc !!