phys_581.plotting
=================

.. py:module:: phys_581.plotting

.. autoapi-nested-parse::

   Tools for plotting.



Attributes
----------

.. autoapisummary::

   phys_581.plotting.sp


Functions
---------

.. autoapisummary::

   phys_581.plotting.corner_plot


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

.. py:data:: sp

.. py:function:: corner_plot(a, C=None, labels=None, levels=None, sigmas=(1, 2, 3, 4), axes=None, fig=None, Nxy=(100, 101), contour_kw=None)

   Make a corner-plot of the variables `a`.

   :param a: Parameter values.  These can be `ufloat` values from the :py:mod:`uncertainties`
             package.
   :type a: [float] or [uncertainties.ufloat]
   :param C: Covariance matrix.  If `a` is a list of `ufloat`s, then the correlation matrix
             will be computed with `C = uncertainties.covariance_matrix(a)` if not provided.
   :type C: array-like, optional
   :param labels: Labels for plot.  If not provided, then if `a._fields` exists, these will be
                  used, otherwise, they will be labelled `a_n`.
   :type labels: [str], optional
   :param levels: Contours to draw.  If not, then we will assume the variables are gaussian and
                  use the ``nu=2`` degree-of-freedom chi square distribution to convert from
                  `sigmas`.
   :type levels: array-like, optional
   :param sigmas: If provided and `levels` is `None`, then use to generate levels.
   :type sigmas: array-like, optional
   :param axes: If provided, then the we will draw in these.
   :type axes: array of Axes, optional
   :param Nxy: Size of grid for contour plot.
   :type Nxy: (int, int)
   :param contour_kw:  Additional arguments for :py:meth:`matplotlib.axes.Axes.contour` like
                      `linestyles`, and `colors`.
   :type contour_kw: dict, optional