credit.visualization_tools
==========================

.. py:module:: credit.visualization_tools

.. autoapi-nested-parse::

   A collection of functions for visualizing the forecasts
   -------------------------------------------------------
   Functions:
       - cmap_combine(cmap1, cmap2)
       - get_projection(proj_name)
       - get_colormap(cmap_strings)
       - get_colormap_extend(var_range)
       - get_variable_range_with_rounding(data)
       - get_variable_range(var_name, conf, level=level, method='mean_std')
       - figure_panel_planner(var_num, proj)
       - cartopy_single_panel(figsize=(13, 6.5), proj=ccrs.EckertIII())
       - cartopy_panel2(figsize=(13, 8), proj=ccrs.EckertIII())
       - cartopy_panel4(var_num, figsize=(13, 6.5), proj=ccrs.EckertIII())
       - cartopy_panel6(var_num, figsize=(13, 9.75), proj=ccrs.EckertIII())
       - map_gridline_opt(AX)
       - colorbar_opt(fig, ax, cbar, cbar_extend)
       - draw_sigma_level(data, conf=None, times=None, forecast_count=None, save_location=None)
       - draw_diagnostics(data, conf=None, times=None, forecast_count=None, save_location=None)
       - draw_surface(data, conf=None, times=None, forecast_count=None, save_location=None)



Attributes
----------

.. autoapisummary::

   credit.visualization_tools.logger


Functions
---------

.. autoapisummary::

   credit.visualization_tools.cmap_combine
   credit.visualization_tools.get_projection
   credit.visualization_tools.get_colormap
   credit.visualization_tools.get_colormap_extend
   credit.visualization_tools.get_variable_range_with_rounding
   credit.visualization_tools.get_variable_range
   credit.visualization_tools.figure_panel_planner
   credit.visualization_tools.cartopy_single_panel
   credit.visualization_tools.cartopy_panel2
   credit.visualization_tools.cartopy_panel4
   credit.visualization_tools.cartopy_panel6
   credit.visualization_tools.map_gridline_opt
   credit.visualization_tools.colorbar_opt
   credit.visualization_tools.shared_mem_draw_wrapper
   credit.visualization_tools.draw_variables


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

.. py:data:: logger

.. py:function:: cmap_combine(cmap1, cmap2)

   combine two matplotlib colormaps as one.


.. py:function:: get_projection(proj_name)

   returns a cartopy projection obj


.. py:function:: get_colormap(cmap_strings)

   returns a list of colormaps from input strings.


.. py:function:: get_colormap_extend(var_range)

   return colorbar extend options based on the given value range.


.. py:function:: get_variable_range_with_rounding(data)

   Estimate pcolor value ranges based on the input data.


.. py:function:: get_variable_range(var_name, conf, level=-1, method='mean_std')

.. py:function:: figure_panel_planner(var_num, proj)

   Choose a figure layout based on the number of variables to plot.
   ! Handles up to 6 variables


.. py:function:: cartopy_single_panel(figsize=(13, 6.5), proj=ccrs.EckertIII())

   Single panel figure layout


.. py:function:: cartopy_panel2(figsize=(13, 8), proj=ccrs.EckertIII())

   Two-panel figure layout


.. py:function:: cartopy_panel4(var_num, figsize=(13, 6.5), proj=ccrs.EckertIII())

   Four-panel figure layout


.. py:function:: cartopy_panel6(var_num, figsize=(13, 9.75), proj=ccrs.EckertIII())

   Six-panel figure layout


.. py:function:: map_gridline_opt(AX)

   Customize cartopy map gridlines


.. py:function:: colorbar_opt(fig, ax, cbar, cbar_extend)

   Customize the colorbar


.. py:function:: shared_mem_draw_wrapper(shm, level, step, visualization_key, conf, save_location)

.. py:function:: draw_variables(pred, level, step, visualization_key, conf=None, save_location=None)

   This function produces figures for given variables.