piel.visual.plot.signals.dc
===========================

.. py:module:: piel.visual.plot.signals.dc


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/piel/visual/plot/signals/dc/basic/index
   /autoapi/piel/visual/plot/signals/dc/overlay/index


Functions
---------

.. autoapisummary::

   piel.visual.plot.signals.dc.plot_signal_dc_collection
   piel.visual.plot.signals.dc.plot_signal_dc_collection_equivalent


Package Contents
----------------

.. py:function:: plot_signal_dc_collection(signal_dc_collection: piel.types.SignalDCCollection, fig: Any = None, axs: Any = None, xlabel: str | piel.types.Unit = None, ylabel: str | piel.types.Unit = None, title: str | piel.types.Unit = None, subplots_kwargs: dict = None, plot_kwargs: dict = None, **kwargs)

   Plots inputs vs outputs from a SignalDCCollection on a figure.

   :param signal_dc_collection: The collection of DC signals to plot.
   :type signal_dc_collection: SignalDCCollection
   :param fig: Existing figure to plot on. If None, a new figure is created.
   :type fig: matplotlib.figure.Figure, optional
   :param axs: Existing list of axes to plot on. If None, new axes are created. Plots on [0] by default.
   :type axs: list[matplotlib.axes.Axes, optional]
   :param subplots_kwargs: Keyword arguments to pass to create_axes_per_figure.
   :type subplots_kwargs: dict, optional
   :param xlabel: Label for the x-axis. If a Unit is provided, applies unit correction.
   :type xlabel: str | Unit, optional
   :param ylabel: Label for the y-axis. If a Unit is provided, applies unit correction.
   :type ylabel: str | Unit, optional
   :param title: Title for the plot.
   :type title: str | Unit, optional
   :param \*\*kwargs: Additional keyword arguments to pass to the save function.

   :returns: A tuple containing the figure and axes objects.
   :rtype: tuple


.. py:function:: plot_signal_dc_collection_equivalent(signal_dc_collection: piel.types.SignalDCCollection, fig: Any = None, axs: Any = None, xlabel: str | piel.types.Unit = None, ylabel: str | piel.types.Unit = None, title: str | piel.types.Unit = None, labels: list[str] = None, subplots_kwargs: dict = None, plot_kwargs: dict = None, **kwargs)

   Plots inputs vs outputs from a SignalDCCollection on a figure.

   :param signal_dc_collection: The collection of DC signals to plot.
   :type signal_dc_collection: SignalDCCollection
   :param fig: Existing figure to plot on. If None, a new figure is created.
   :type fig: matplotlib.figure.Figure, optional
   :param axs: Existing list of axes to plot on. If None, new axes are created. Plots on [0] by default.
   :type axs: list[matplotlib.axes.Axes, optional]
   :param subplots_kwargs: Keyword arguments to pass to create_axes_per_figure.
   :type subplots_kwargs: dict, optional
   :param xlabel: Label for the x-axis. If a Unit is provided, applies unit correction.
   :type xlabel: str | Unit, optional
   :param ylabel: Label for the y-axis. If a Unit is provided, applies unit correction.
   :type ylabel: str | Unit, optional
   :param title: Title for the plot.
   :type title: str | Unit, optional
   :param \*\*kwargs: Additional keyword arguments to pass to the save function.

   :returns: A tuple containing the figure and axes objects.
   :rtype: tuple