porereax.plot
=============

.. py:module:: porereax.plot

.. autoapi-nested-parse::

   Module for plotting sampled data.

   The module provides functions to plot histograms, time series, and 2D density data from sampled data.



Functions
---------

.. autoapisummary::

   porereax.plot.plot


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

.. py:function:: plot(link_data: str, axis: matplotlib.axes.Axes | None = None, identifiers: list = [], colors: list = [], std: bool = False, mean: bool = False, density: bool = False, dt: int = 50, transpose: bool = False, plot_kwargs_1d: dict = {}, plot_kwargs_2d: dict = {}) -> tuple[matplotlib.figure.Figure | None, matplotlib.axes.Axes]

   Plot sampled data from a data file.
   All types of samplers are supported. Depending on the sampler type and dimension, different types of plots will be generated.

   :param link_data: Path to the data file created by a sampler instance.
   :type link_data: str
   :param axis: Axis to plot on. If None, a new figure and axis will be created (default is None).
   :type axis: matplotlib.axes.Axes, optional
   :param identifiers: List of identifiers to plot. If empty, all identifiers will be plotted (default is []).
   :type identifiers: list, optional
   :param colors: List of colors to use for plotting. If empty, default colors will be used (default is []).
   :type colors: list, optional
   :param std: Whether to plot standard deviation shading (default is False).
   :type std: bool, optional
   :param mean: Whether to plot mean values as vertical lines (default is False).
   :type mean: bool, optional
   :param density: Whether to normalize histograms to density (default is False).
   :type density: bool, optional
   :param dt: Time step in femtoseconds for time series plots (default is 50).
   :type dt: int, optional
   :param transpose: Whether to transpose the axes for 2D density plots (default is False).
   :type transpose: bool, optional
   :param plot_kwargs_1d: Additional keyword arguments for 1D plots (default is {}).
   :type plot_kwargs_1d: dict, optional
   :param plot_kwargs_2d: Additional keyword arguments for 2D plots (default is {}).
   :type plot_kwargs_2d: dict, optional

   :returns: A tuple containing the figure and axis objects. If an axis was provided, the figure will be None.
   :rtype: tuple