pyValEIA.plots.mad_diagnostic_plots
===================================

.. py:module:: pyValEIA.plots.mad_diagnostic_plots

.. autoapi-nested-parse::

   Functions for plotting Madrigal TEC data and evaluating EIA detection.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   pyValEIA.plots.mad_diagnostic_plots.madrigal_model_world_maps
   pyValEIA.plots.mad_diagnostic_plots.mad_model_single_plot
   pyValEIA.plots.mad_diagnostic_plots.model_mad_daily_file


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

.. py:function:: madrigal_model_world_maps(stime, mad_dc, mod_map)

   
   Plot world maps for both model data and Madrigal TEC.


   :Parameters:

       **stime** : datetime object
           Universal time for the tec data and solar terminator

       **mad_dc** : dict
           Madrigal data input

       **mod_map** : dict
           NIMO data input



   :Returns:

       **fig** : figure
           matplotlib figure with 2 panels (Madrigal (top) NIMO (bottom))











   ..
       !! processed by numpydoc !!

.. py:function:: mad_model_single_plot(mad_dc, mod_dc, lon_start, stime, mlat_val, model_name='NIMO', max_nan=20, fosi=14)

   
   Create one Madrigal TEC vs model data plot.


   :Parameters:

       **mad_dc** : dict
           dict of Madrigal TEC data

       **mod_dc** : dict
           dict of model data

       **lon_start** : int
           starting longitude for plot. i.e. 90

       **stime** : datetime
           datetime for plot

       **mlat_val** : int
           magnetic latitude cutoff

       **model_name** : str
           Name of model (default='NIMO')

       **max_nan** : float
           Maximum acceptable percent nan values in a pass (default=20)

       **fosi** : int
           font size (default=14)



   :Returns:

       **fig** : mpl.Figure
           Fingle figure of madrigal and input model, not automatically saved











   ..
       !! processed by numpydoc !!

.. py:function:: model_mad_daily_file(start_day, mad_file_dir, mod_file_dir, mod_name_format, model_name='NIMO', mod_load_func=io.load.load_nimo, mlat_val=30, lon_start=-90, file_save_dir='', fig_on=True, fig_save_dir='', max_nan=20, mad_filt='barrel_average', mad_interpolate=2, mad_envelope=False, mad_barrel=3, mad_window=3, mod_filt='', mod_interpolate=2, mod_envelope=False, mod_barrel=3, mod_window=3, fosi=15, ne_var='dene', lon_var='lon', lat_var='lat', alt_var='alt', hr_var='hour', min_var='minute', tec_var='tec', hmf2_var='hmf2', nmf2_var='nmf2', mod_cadence=15, max_tdif=20)

   
   Create daily files for Madrigal/model and daily plots.


   :Parameters:

       **start_day** : datetime
           day of desired files

       **mad_file_dir** : str
           Madrigal file directory

       **mod_file_dir** : str
           NIMO file directory

       **mod_name_format** : str
           prefix of NIMO file including date format before .nc extension, e.g.,
           'NIMO_AQ_%Y%j'

       **model_name** : str
           Model name (default='NIMO')

       **mod_load_func** : function
           Function for loading model data (default=`io.load.load_nimo`)

       **mlat_val: int**
           magnetic latitude cutoff (default=30)

       **lon_start** : int
           longitude of desired region, e.g., -90 will span -90 to -30 degrees
           (default=-90)

       **file_save_dir** : str
           directory to save file to (default='')

       **fig_on: bool**
           if True, plot will be made, if False, plot will not be made
           (default=True)

       **fig_save_dir** : str
           directory to save figure (default='')

       **max_nan** : int or float
           Maximum acceptable percent nan values in a pass (default=20)

       **mad_filt** : str
           Desired Filter for madrigal data (default='barrel_average')

       **mad_interpolate** : int
           int that determines the number of data points in interpolation
           new length will be len(density) x interpolate (default=2)

       **mad_envelope** : bool
           if True, barrel roll will include points inside an envelope, if False,
           no envelope will be used (default=False)

       **mad_barrel** : float
           latitudinal radius of barrel for madrigal (default=3)

       **mad_window** : float
           latitudinal width of moving window (default=3)

       **mod_filt** : str
           Desired Filter for nimo data (default='')

       **mod_interpolate** : int
           int that determines the number of data points in interpolation
           new length will be len(density) x interpolate (default=2)

       **mod_envelope** : bool
           if True, barrel roll will include points inside an envelope, if False,
           no envelope will be used (default=False)

       **mod_barrel** : float
           latitudinal radius of barrel for swarm (default=3)

       **mod_window** : float
           latitudinal width of moving window (default=3)

       **fosi** : int
           fontsize for plot, with title being `fosi` + 10 (default=15)

       **ne_var** : str
           Electron denstiy variable in the model file (default='dene')

       **lon_var** : str
           Longitude variable in the model file (default='lon')

       **lat_var** : str
           Latitude variable in the model file (default='lat')

       **alt_var** : str
           Altitude variable in the model file (default='alt')

       **hr_var** : str
           Hour of day variable in the model file (default='hour')

       **min_var** : str
           Minute of hour variable in the model file (default='minute')

       **tec_var** : str
           TEC variable in the model file (default='tec')

       **hmf2_var** : str
           hmF2 variable in the model file (default='hmf2')

       **nmf2_var** : str
           NmF2 variable in the model file (default='nmf2')

       **mod_cadence** : int
           Time cadence of Model data in minutes (default=15)

       **max_tdif** : float
           Maximum allowed time in minutes between a model and Swarm conjunction
           (default=20)



   :Returns:

       **df** : pd.DataFrame
           DataFrame with Madrigal and model data for the desired longitude sector

       **fig** : mpl.Figure
           Saved not opened











   ..
       !! processed by numpydoc !!