pyIntensityFeatures.instruments.satellites
==========================================

.. py:module:: pyIntensityFeatures.instruments.satellites

.. autoapi-nested-parse::

   Satellite instrument support functions.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   pyIntensityFeatures.instruments.satellites.get_auroral_slice


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

.. py:function:: get_auroral_slice(time_data, glat_data, glon_data, int_data, clean_mask=None, start_time=None, hemisphere=1, min_colat=45)

   
   Retrieve an auroral image slice that spans the desired lat range.


   :Parameters:

       **time_data** : array-like
           1D array of time indexes

       **glat_data** : array-like
           2D array of geographic latitudes

       **glon_data** : array-like
           2D array of geographic longitudes

       **int_data** : array-like
           2D array of intensity values

       **clean_mask** : array-like or NoneType
           None to create a mask of finite values or 2D mask array specifying
           good values (default=None)

       **start_time** : dt.datetime or NoneType
           Start time to search from or None to start from beginning of
           available data (default=None)

       **hemisphere** : int
           Hemisphere to consider, where 1 is North and -1 is South (default=1)

       **min_colat** : int or float
           Absolute value of the most equatorward latitude to include (default=45)



   :Returns:

       **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.




   :Raises:

       ValueError
           If imager data does not have the same shape







   ..
       !! processed by numpydoc !!