lstid_processing.plot_rout
==========================

.. py:module:: lstid_processing.plot_rout

.. autoapi-nested-parse::

   Functions that support diagnostic plotting.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   lstid_processing.plot_rout.close_figures
   lstid_processing.plot_rout.nrl_colors
   lstid_processing.plot_rout.get_marker
   lstid_processing.plot_rout.add_colorbar
   lstid_processing.plot_rout.add_magnetic_equator


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

.. py:function:: close_figures(figs)

   
   Close a list of figures, freeing up memory


   :Parameters:

       **figs** : list-like
           List of figure handles














   ..
       !! processed by numpydoc !!

.. py:function:: nrl_colors(num)

   
   Determine color codes for NRL in a standard order


   :Parameters:

       **num** : int
           Index number, will cycle to select an index between 0 and 10



   :Returns:

       **color** : str
           HEX string or named color (for unofficial colors)











   ..
       !! processed by numpydoc !!

.. py:function:: get_marker(num, small=False, line=None)

   
   Select a matplotlib standard plotting marker in a specified order.


   :Parameters:

       **num** : int
           Index number, starting at zero

       **small** : bool
           Use the small markers (default=False)

       **line** : bool or NoneType
           Replace marker with line (True), add marker to line (False), or
           do not include any line (None) (default=None)



   :Returns:

       **marker** : str
           String denoting a marker to be used in matplotlib formatting











   ..
       !! processed by numpydoc !!

.. py:function:: add_colorbar(figure_handle, contour_handle, zmin, zmax, zinc=6, name=None, units=None, orient='vertical', scale='linear', width=1, loc=[0.9, 0.1, 0.03, 0.8], overflow='neither', ticks=None, ax=None, pad=0.05)

   
   Create a colorbar and add it to a figure.


   :Parameters:

       **figure_handle** : matplotlib.figure.Figure
           handle to the figure

       **contour_handle** : matplotlib.collections.PathCollection
           handle to the plotted contour collection

       **zmin** : float
           minimum z value

       **zmax** : float
           maximum z value

       **zinc** : int
           z tick incriment (default=6)

       **name** : str or NoneType
           z variable name (default=None)

       **units** : str or NoneType
           z variable units (default=None)

       **orient** : str
           bar orientation, see mpl.colorbar (default='vertical')

       **scale** : str
           Tick scaling type, one of 'default', 'linear', 'datetime',
           'scientific', 'log', or 'exponential' (default='linear')

       **width** : float
           fraction of width (0-1), (default=1)

       **loc** : list-like
           location of colorbar in figure coordinates, see also mpl.colorbar
           (default=[0.95, 0.1, 0.03, 0.8])

       **overflow** : str
           include triangles showing overflow colors? Options include 'neither',
           'both', more? (default="neither")

       **ticks** : list-like or NoneType
           List of custom tick values, only used if value is not None
           (default=None)

       **ax** : matplotlib.axes._subplots.AxesSubplot or NoneType
           Axis to which the colorbar will be attached or None to create
           a unique axis for the colorbar (default=None)

       **pad** : float
           If `ax` is not None, fraction of the original Axes between the colorbar
           and new image Axes (default=0.05)



   :Returns:

       **ax2** : matplotlib.axes._subplots.AxesSubplot
           Handle to the colorbar axis

       **cb** : matplotlib.colorbar.Colorbar
           Handle to the colorbar











   ..
       !! processed by numpydoc !!

.. py:function:: add_magnetic_equator(ax, meq_file=None, line_style='-', line_width=2, line_color='k')

   
   Add a line showing the location of the magnetic equator.


   :Parameters:

       **ax** : matplotlib.axes._subplots.AxesSubplot
           Subplot handle

       **meq_file** : str or NoneType
           Name of file containing location of magnetic equator with longitude in
           the first column and latitude in the second, or None to use local file
           (default=None)

       **line_style** : str
           Line style to use (default='-')

       **line_width** : int
           Line width to plot (default=2)

       **line_color** : str
           Line color to plot, may use named colors (default='k')







   :Raises:

       IOError
           If unable to find or open provided filename







   ..
       !! processed by numpydoc !!