lstid_processing.cindi
======================

.. py:module:: lstid_processing.cindi

.. autoapi-nested-parse::

   TID analysis and plotting routines for CINDI data.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   lstid_processing.cindi.init_cindi_tid_data
   lstid_processing.cindi.rel_data_orbit_plot
   lstid_processing.cindi.plot_cindi_tid_orbits
   lstid_processing.cindi.identify_tid


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

.. py:function:: init_cindi_tid_data(min_period=150, max_period=300)

   
   Initialize a pysat object for loading CINDI TID data.


   :Parameters:

       **min_period** : int or float
           Minimum period in seconds, -1 for high-pass filter (default=150)

       **max_period** : int or float
           Maximum period in seconds, -1 for low-pass filter (default=300)



   :Returns:

       **cindi** : pysat.Instrument
           pysat Instrument object with additional data parameters needed for
           TID analysis







   .. seealso::

       
       :obj:`Analysis.Smooth_Data.filter_rout.pysat_rel_data_butter`
           ..
       
   .. rubric:: Notes

   Period bandpass was determined using the orbital period and the wavelength
   of LSTIDs



   ..
       !! processed by numpydoc !!

.. py:function:: rel_data_orbit_plot(cindi, rel_key, vel_keys=None, vel_rel_keys=None, vel_labels=None, fig=None, figname=None, ni_lim=None, rel_lim=None, vel_max=None, vrel_lim=None)

   
   Plot a standard figure for CINDI relative ion density.


   :Parameters:

       **cindi** : pysat.Instrument
           C/NOFS CINDI IVM data, with a single orbit loaded

       **rel_key** : str
           Data key pointing to the relative ion density

       **vel_keys** : list or NoneType
           List of data keys pointing to additonal data, meridional and
           field-aligned drifts are encouraged (default=None)

       **vel_rel_keys** : list or NoneType
           List of data keys pointing to additonal relative quantities, meridional
           and field-aligned drifts are encouraged (default=None)

       **vel_labels** : list or NoneType
           List of label strings for additonal relative quantities, of the same
           order as the vel_rel_keys and vel_keys input (default=None)

       **fig** : matplotlib.figure.Figure or NoneType
           Figure handle, or None to initialize locally (default=None)

       **figname** : str or NoneType
           Figure name for saving output or None to not save to file
           (default=None)

       **ni_lim** : tuple or NoneType
           y-axis limits for the ion density data or None to use defaults
           (default=None)

       **rel_lim** : tuple or NoneType
           y-axis limits for the relative ion density data or None to use
           defaults (default=None)

       **vel_max** : float
           y-axis limits (symmetric) for the velocity data or None to use defaults
           (default=None)

       **vrel_lim** : tuple or NoneType
           y-axis limits for the addtinal relative data or None to use defaults
           (default=None)



   :Returns:

       **fig** : matplotlib.figure.Figure or None
           Figure handle or None, if figure was closed











   ..
       !! processed by numpydoc !!

.. py:function:: plot_cindi_tid_orbits(plot_dir, stime, etime=None, min_period=150, max_period=300)

   
   Create CINDI LSTID Ni variation orbit plots.


   :Parameters:

       **plot_dir** : str or NoneType
           Plot directory or None to return all created figure handles

       **stime** : dt.datetime
           Start time

       **etime** : dt.datetime or NoneType
           End time or None if only 1 day is required (default=None)

       **min_period** : int or float
           Minimum period in seconds, -1 for high-pass filter (default=150)

       **max_period** : int or float
           Maximum period in seconds, -1 for low-pass filter (default=300)



   :Returns:

       **figs** : list
           List of figure handles (empty if all saved to file)




   :Raises:

       IOError
           If plot directory doesn't exist







   ..
       !! processed by numpydoc !!

.. py:function:: identify_tid(cindi, dens_pert_thresh=0.2, dens_quiet_thresh=0.1, vel_pert_thresh=10.0, vel_sec=60, join_sec=300, dens_var='ionDensity_rel_butter_Tmin150s_Tmax300s', vmer_var='ionVelmeridional_rel_butter_Tmin150s_Tmax300s', vpar_var='ionVelparallel_rel_butter_Tmin150s_Tmax300s')

   
   Identify periods of TID activity in CINDI IVM data.


   :Parameters:

       **cindi** : pysat.Instrument
           CINDI IVM instrument object with perturbation data

       **dens_pert_thresh** : float
           Absolute value for plasma density threshold, above which wave activity
           is present (default=0.2)

       **dens_quiet_thresh** : float
           Absolute value for plasma density threshold, below which wave activity
           is absent (default=0.1)

       **vel_pert_thresh** : float
           Absolute value for plasma velocity threshold, above which wave activity
           is present (default=10.0)

       **vel_sec** : int
           Maximum number of seconds allowed between a perturbed density
           observation and an inquiet velocity observation (default=60)

       **join_sec** : int
           Maximum number of seconds between triggers to identify a cohesive event
           period (default=300)

       **dens_var** : str
           Perturbed plasma density variable name
           (default='ionDensity_rel_butter_Tmin150s_Tmax300s')

       **vmer_var** : str
           Perturbed meridional plasma drift variable name
           (default='ionVelmeridional_rel_butter_Tmin150s_Tmax300s')

       **vpar_var** : str
           Perturbed field-aligned plasma drift variable name
           (default='ionVelparallel_rel_butter_Tmin150s_Tmax300s')



   :Returns:

       **event_start** : list
           List of TID event start times

       **event_end** : list
           List of TID event end times, same length as `event_start`











   ..
       !! processed by numpydoc !!