xyzpy.plot.core
===============

.. py:module:: xyzpy.plot.core

.. autoapi-nested-parse::

   Helper functions for preparing data to be plotted.



Attributes
----------

.. autoapisummary::

   xyzpy.plot.core.PLOTTER_DEFAULTS
   xyzpy.plot.core._PLOTTER_OPTS


Classes
-------

.. autoapisummary::

   xyzpy.plot.core.Plotter
   xyzpy.plot.core.AbstractLinePlot
   xyzpy.plot.core.AbstractScatter
   xyzpy.plot.core.AbstractHistogram
   xyzpy.plot.core.AbstractHeatMap


Functions
---------

.. autoapisummary::

   xyzpy.plot.core.check_excess_dims
   xyzpy.plot.core.calc_row_col_datasets
   xyzpy.plot.core.intercept_call_arg
   xyzpy.plot.core.prettify


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

.. py:data:: PLOTTER_DEFAULTS

.. py:data:: _PLOTTER_OPTS
   :value: ['backend', 'figsize', 'axes_loc', 'axes_rloc', 'add_to_axes', 'add_to_xaxes', 'add_to_fig',...


.. py:function:: check_excess_dims(ds, var, valid_dims, mode='lineplot')

.. py:class:: Plotter(ds, x, y, z=None, c=None, y_err=None, x_err=None, **kwargs)

   .. py:attribute:: x_coo


   .. py:attribute:: y_coo


   .. py:attribute:: z_coo
      :value: None



   .. py:attribute:: c_coo
      :value: None



   .. py:attribute:: y_err
      :value: None



   .. py:attribute:: x_err
      :value: None



   .. py:attribute:: _data_range_calculated
      :value: False



   .. py:attribute:: _c_cols
      :value: []



   .. py:method:: _get_ds()


   .. py:method:: _set_ds(ds)


   .. py:method:: _del_ds()


   .. py:attribute:: ds


   .. py:method:: prepare_axes_labels()

      Work out what the axes titles should be.



   .. py:method:: prepare_z_vals(mode='lineplot', grid=False)

      Work out what the 'z-coordinate', if any, should be.

      :param mode:
      :type mode: {'lineplot', 'scatter', 'histogram'}



   .. py:method:: prepare_z_labels()

      Work out what the labels for the z-coordinate should be.



   .. py:method:: calc_use_legend_or_colorbar()

      Work out whether to use a legend.



   .. py:method:: prepare_xy_vals_lineplot(mode='lineplot')

      Select and flatten the data appropriately to iterate over.



   .. py:method:: prepare_x_vals_histogram()


   .. py:method:: prepare_heatmap_data(grid=False)

      Prepare the data to go into a heatmap.



   .. py:method:: calc_color_norm()


   .. py:method:: calc_line_colors()

      Helper function for calculating what the colormapped color of each
      line should be.



   .. py:method:: prepare_colors()

      Prepare the colors for the lines, based on the z-coordinate.



   .. py:method:: prepare_markers()

      Prepare the markers to be used for each line.



   .. py:method:: prepare_line_styles()

      Line widths and styles.



   .. py:method:: prepare_zorders()

      What order lines appear over one another



   .. py:method:: calc_data_range(force=False)


   .. py:method:: calc_plot_range()

      Logic for processing limits and padding into plot ranges.



.. py:class:: AbstractLinePlot

   .. py:method:: prepare_data_single()


   .. py:method:: prepare_data_multi_grid()


.. py:class:: AbstractScatter

   .. py:method:: prepare_data_single()


   .. py:method:: prepare_data_multi_grid()


.. py:class:: AbstractHistogram

   .. py:method:: prepare_data_single()


   .. py:method:: prepare_data_multi_grid()


.. py:class:: AbstractHeatMap

   .. py:method:: prepare_data_single()


   .. py:method:: prepare_data_multi_grid()


.. py:function:: calc_row_col_datasets(ds, row=None, col=None)

.. py:function:: intercept_call_arg(fn)

.. py:function:: prettify(x)