pyIntensityFeatures.proc.intensity
==================================

.. py:module:: pyIntensityFeatures.proc.intensity

.. autoapi-nested-parse::

   Functions for intensity processing.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   pyIntensityFeatures.proc.intensity.find_intensity_boundaries


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

.. py:function:: find_intensity_boundaries(intensity, glat, glon, sweep_times, alt, min_mlat_base, max_coeff, method='ALLOWTRACE', mlat_inc=1.0, mlt_inc=0.5, un_threshold=1.25, dayglow_threshold=300.0, strict_fit=False)

   
   Find the PALBs and EALBs for a slice of intensity data.


   :Parameters:

       **intensity** : array-like
           Array with dimensions of time x sweep-locations containing the
           rectified intensity at the auroral daytime pierce point

       **glat** : array-like
           Array with dimensions of time x sweep-locations containing the
           geodetic latitude

       **glon** : array-like
           Array with dimensions of time x sweep-locations containing the
           geographic longitude

       **sweep_times** : array-like
           Array with the starting and ending times of the auroral sweep. Gives
           the start and end times searched if no sweep is found.

       **alt** : float or array-like
           Altitude for the intensity data

       **min_mlat_base** : float
           Base minimum co-latitude for intensity profiles.

       **max_coeff** : int
           Maximum number of coefficients.

       **method** : str
           Method for converting between geographic and magnetic coordinates.
           (default='ALLOWTRACE')

       **mlat_inc** : float
           Magnetic latitude increment for gridding intensity. (default=1.0)

       **mlt_inc** : float
           Magnetic local time increment for gridding intensity. (default=0.5)

       **un_threshold** : float
           Maximum acceptable uncertainty value in degrees (default=1.25)

       **dayglow_threshold** : float
           Maximum allowable background intensity value in Rayleighs (default=300)

       **strict_fit** : bool
           Enforce positive values for the x-offsets in quadratic-Gaussian fits
           (default=False)



   :Returns:

       **sweep_end** : dt.datetime
           End time of the data

       **out_data** : dict or NoneType
           Dict with desired boundary data, if data was found.  None otherwise.

       **max_coeff** : int
           Maximum number of coefficients.







   .. seealso::

       
       :obj:`utils.coords.convert_geo_to_mag`
           ..
       



   ..
       !! processed by numpydoc !!