piel.visual.plot.signals.time
=============================

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


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/piel/visual/plot/signals/time/basic/index
   /autoapi/piel/visual/plot/signals/time/overlay/index
   /autoapi/piel/visual/plot/signals/time/separate/index


Functions
---------

.. autoapisummary::

   piel.visual.plot.signals.time.plot_multi_data_time_signal_equivalent
   piel.visual.plot.signals.time.plot_multi_data_time_signal_different
   piel.visual.plot.signals.time.plot_time_signal_data


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

.. py:function:: plot_multi_data_time_signal_equivalent(multi_signal: piel.types.MultiTimeSignalData, fig: Any = None, axs: Any = None, subplots_kwargs: dict = None, xlabel: str | piel.types.Unit = None, ylabel: str | piel.types.Unit = None, **kwargs)

   Plots all rising edge signals on the same figure with a shared x-axis.

   :param multi_signal: List of rising edge signals.
   :type multi_signal: List[TimeSignalData]
   :param subplots_kwargs: Keyword arguments to pass to create_axes_per_figure.
   :type subplots_kwargs: dict

   :returns: None


.. py:function:: plot_multi_data_time_signal_different(multi_signal: piel.types.MultiTimeSignalData, fig: Any = None, axs: Any = None, subplots_kwargs: dict = None, xlabel: str | piel.types.Unit | list[piel.types.Unit] = None, ylabel: str | piel.types.Unit | list[piel.types.Unit] | list = None, title: str | piel.types.Unit | list = None, time_range_s: Tuple[float, float] = None, labels: list[str] = None, **kwargs)

   Plots all rising edge signals on the same figure, but with a shared x-axis and multiple y-axes.

   :param multi_signal: List of rising edge signals.
   :type multi_signal: MultiTimeSignalData
   :param fig: Figure object.
   :type fig: Any
   :param axs: Axes object.
   :type axs: Any
   :param subplots_kwargs: Keyword arguments to pass to create_axes_per_figure.
   :type subplots_kwargs: dict
   :param xlabel: Label for x-axis.
   :type xlabel: str | Unit | list[Unit]
   :param ylabel: Label for y-axis.
   :type ylabel: str | Unit | list[Unit] | list
   :param title: Title for the plot.
   :type title: str | Unit | list
   :param time_range_s: Tuple indicating the (start, end) time for the x-axis range.
   :type time_range_s: Tuple[float, float]

   :returns: Figure and Axes objects.
   :rtype: fig (Any), axs (Any)


.. py:function:: plot_time_signal_data(signal: piel.types.TimeSignalData, fig: Any = None, axs: Any = None, subplots_kwargs: dict = None, xlabel: str | piel.types.Unit = None, ylabel: str | piel.types.Unit = None, title: str | piel.types.Unit = None, **kwargs)

   Plots a single time signal on a figure.

   :param signal: The time signal to plot.
   :type signal: TimeSignalData
   :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