Source code for biobss.ppgtools.ppg_plot

import matplotlib.pyplot as plt
from plotly.subplots import make_subplots

from ..plottools import *
from ..preprocess.signal_normalize import *
from ..timetools import *


def plot_ppg(
    signals: dict,
    peaks: dict = None,
    sampling_rate: float = None,
    timestamps: ArrayLike = None,
    timestamp_resolution: str = None,
    method: str = "matplotlib",
    show_peaks: bool = True,
    figsize: tuple = (18.5, 10.5),
    width: float = 800,
    height: float = 440,
    rescale: bool = False,
):
    """Generates plots for PPG signal.

    Args:
        signals (dict): The dictionary of signals to be plotted.
        peaks (dict, optional): The dictionary of peaks to be plotted. Defaults to None.
        sampling_rate (float, optional): Sampling rate of the signal. Defaults to None.
        timestamps (ArrayLike, optional): Timestamp array. Defaults to None.
        timestamp_resolution (str, optional): Timestamp resolution. Defaults to None.
        method (str, optional): Package to generate plots. It can be 'matplotlib' or 'plotly'. Defaults to 'matplotlib'.
        show_peaks (bool, optional): If True, peaks are plotted. Defaults to True.
        figsize (tuple, optional): Figure size for matplotlib. Defaults to (18.5, 10.5) inches.
        width (float, optional): Figure width for Plotly. Defaults to 800 pixels.
        height (float, optional): Figure height for Plotly. Defaults to 440 pixels.

    Raises:
        ValueError: If timestamps is not None and timestamp resolution is not provided.
        ValueError: If timestamps array and PPG signal have different lengths.
        ValueError: If method is not 'matplotlib' or 'plotly'.
    """
    ppg_raw = signals.get("Raw")

    if timestamps is not None:
        if len(timestamps) != len(ppg_raw):
            raise ValueError("Timestamps and PPG signal must have the same length!")

        if timestamp_resolution is None:
            raise ValueError("Timestamp resolution must be provided if timestamps are provided!")
        else:
            timestamp_resolution = timestamp_resolution

        x_values = timestamps
        x_label = "Time (" + timestamp_resolution + ")"

    else:
        if sampling_rate is not None:
            if timestamp_resolution is None:
                timestamp_resolution = "s"

            x_values = create_timestamp_signal(
                resolution=timestamp_resolution, length=len(ppg_raw), rate=sampling_rate, start=0
            )
            x_label = "Time (" + timestamp_resolution + ")"

        else:
            x_values = np.linspace(0, len(ppg_raw), len(ppg_raw))
            x_label = "Sample"

    if peaks is None:
        if show_peaks:
            raise ValueError("Peaks must be specified if show_peaks is True.")
        else:
            peaks = {}

    if rescale:
        for signal_name, signal in signals.items():
            signals[signal_name] = normalize_signal(signal, method="minmax")

    if method == "matplotlib":
        _plot_ppg_matplotlib(
            signals=signals, peaks=peaks, x_values=x_values, x_label=x_label, figsize=figsize, show_peaks=show_peaks
        )

    elif method == "plotly":
        _plot_ppg_plotly(
            signals=signals,
            peaks=peaks,
            x_values=x_values,
            x_label=x_label,
            width=width,
            height=height,
            show_peaks=show_peaks,
        )
    else:
        raise ValueError("Undefined method.")


def _plot_ppg_matplotlib(
    signals: dict,
    peaks: dict = None,
    x_values: ArrayLike = None,
    x_label: str = "Sample",
    figsize=(18.5, 10.5),
    show_peaks=True,
):

    # Create figure
    fig, axs = plt.subplots(figsize=figsize)
    # fig.set_size_inches(*figsize)

    # Plot raw PPG, filtered PPG, peaks and onsets
    for signal_name, signal in signals.items():

        if signal_name not in peaks.keys():
            peaks[signal_name] = {}

        create_signal_plot_matplotlib(
            ax=axs,
            signal=signal,
            x_values=x_values,
            show_peaks=show_peaks,
            peaks=peaks[signal_name],
            plot_title=" ",
            signal_name=signal_name + " PPG",
            x_label=x_label,
        )

    fig.supxlabel(x_label)
    fig.supylabel("Amplitude")
    plt.title("PPG Signal")

    fig.tight_layout()
    plt.show()


def _plot_ppg_plotly(
    signals: dict,
    peaks: dict = None,
    x_values: ArrayLike = None,
    x_label: str = "Sample",
    width=800,
    height=440,
    show_peaks=True,
):

    # Create figure
    fig = make_subplots(rows=1, cols=1)

    # Plot raw PPG, filtered PPG, peaks and onsets
    for signal_name, signal in signals.items():

        if signal_name not in peaks.keys():
            peaks[signal_name] = {}

        create_signal_plot_plotly(
            fig,
            signal=signal,
            x_values=x_values,
            show_peaks=show_peaks,
            peaks=peaks[signal_name],
            plot_title=" ",
            signal_name=signal_name + " PPG",
            x_label=x_label,
            width=width,
            height=height,
            location=(1, 1),
        )

    fig.update_layout(
        {"title": {"text": "PPG Signal", "x": 0.45, "y": 0.9}}, xaxis_title=x_label, yaxis_title="Amplitude"
    )
    fig.show()