pyIntensityFeatures.utils.output
================================

.. py:module:: pyIntensityFeatures.utils.output

.. autoapi-nested-parse::

   Functions for formatting and preparing output.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   pyIntensityFeatures.utils.output.init_boundary_dicts
   pyIntensityFeatures.utils.output.update_boundary_dicts
   pyIntensityFeatures.utils.output.reshape_lat_coeff_data
   pyIntensityFeatures.utils.output.convert_boundary_dict


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

.. py:function:: init_boundary_dicts(opt_coords=None, lat_dim='lat')

   
   Initialize dict for output from multiple auroral image boundaries.


   :Parameters:

       **opt_coords** : dict or NoneType
           Dict of coordinates to include in the output or None to only have
           the required coordinates (default=None)

       **lat_dim** : str
           Name of the latitude dimension



   :Returns:

       **coord_dict** : dict
           Dictionary with required and optional coordinates

       **data_dict** : dict
           Dictionary with initialized data lists and dimensions







   .. seealso::

       
       :obj:`proc.intensity.find_intensity_boundaries`
           ..
       



   ..
       !! processed by numpydoc !!

.. py:function:: update_boundary_dicts(sweep_data, coord_dict, data_dict)

   
   Update coordinate and data dicts with boundary output.


   :Parameters:

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

       **coord_dict** : dict
           Dictionary with required and optional coordinates

       **data_dict** : dict
           Dictionary with data lists and dimensions







   :Raises:

       ValueError
           If there is a change in the magnetic local time bins.







   ..
       !! processed by numpydoc !!

.. py:function:: reshape_lat_coeff_data(coord_dict, data_dict, max_coeff, lat_dim='lat', lat_var='mlat', coeff_dim='coeff')

   
   Reshape data that depends on latitude or coefficients to be uniform.


   :Parameters:

       **coord_dict** : dict
           Dictionary for xr.Dataset coordinate input

       **data_dict** : dict
           Dictionary for xr.Dataset input

       **max_coeff** : int
           Maximum number of coefficients

       **lat_dim** : str
           Name of the latitude dimension

       **lat_var** : str
           Name of the latitude variable

       **coeff_dim** : str
           Name of the coefficient dimension



   :Returns:

       **mlat_bins** : array-like
           Updated magnetic latitude bins.

       **data_dict** : array-like
           Updated data dictionary, with consistent dimensions and padded data.




   :Raises:

       ValueError
           If the latitude bins have an unexpected shape or inconsistent
           increments.  Also if the coefficients have an unexpected shape.







   ..
       !! processed by numpydoc !!

.. py:function:: convert_boundary_dict(coord_dict, data_dict, max_coeff, lat_dim='lat', lat_var='mlat', coeff_dim='coeff', attr_dict=None)

   
   Convert coordinate and data dictionaries to an xarray Dataset.


   :Parameters:

       **coord_dict** : dict
           Dictionary for xr.Dataset coordinate input

       **data_dict** : dict
           Dictionary for xr.Dataset input

       **max_coeff** : int
           Maximum number of coefficients

       **lat_dim** : str
           Name of the latitude dimension

       **lat_var** : str
           Name of the latitude variable

       **coeff_dim** : str
           Name of the coefficient dimension

       **attr_dict** : dict or NoneType
           Dict containing global attributes or None to omit (default=None)



   :Returns:

       **out_data** : xr.Dataset
           Dataset with coordinates, values, and dimensions supplied by the
           input dictionaries (reshaped to have consistent dimensions).




   :Raises:

       ValueError
           If the latitude bins have an unexpected shape or inconsistent
           increments.  Also if the coefficients have an unexpected shape.







   ..
       !! processed by numpydoc !!