stimpyp.plot.plot_signal_diff

stimpyp.plot.plot_signal_diff(t, alpha=0.6, label=None, ax=None, **kwargs)

Plots the reciprocal of the difference of subsequent elements in the input array t. This is commonly used for visualizing a derived signal or property based on the change between consecutive data points in the input array. Additional configurations can be applied to the plot via keyword arguments (**kwargs).

Parameters:

• t (ndarray) – Input array representing the signal or data points. The function computes the reciprocal of the difference between consecutive elements.

• alpha (float) – Transparency of the plot.

• label (str | None) – Label for the plot.

• ax (Axes | None) – Matplotlib Axes object to be used for plotting. If None is provided, a new Axes instance will be created.

• kwargs – Additional keyword arguments for customizing the plot. These are passed to the set() method of the Axes object.

Returns:

The Axes object containing the plot. If a new Axes instance was created internally, it is returned here.