simuran.plot.signal module

Plot signals

simuran.plot.signal.plot_signals(signals, title=None, ch_names=None, lowpass=None, highpass=None, start=0, duration=100, proj=False, show=True, bad_chans=None, **kwargs)

Plot signals through MNE interface.

Directly using mne.plot() on converted data is also feasible. This function merely sets up some default values for that plot. And explicitly names some of the most commonly used kwargs.

Parameters:
  • signals (Iterable of simuran.base_signal.BaseSignal) – The signals to plot.
  • title (str, optional) – The name of the plot title, by default None
  • ch_names (Iterable of string, optional) – The names of the channels, by default None
  • lowpass (float, optional) – The lowpass of the signal, by default None
  • highpass (float, optional) – The highpass of the signal, by default None
  • start (float, optional) – Where to start the plot from (in s), by default 0
  • duration (int, optional) – How long to plot for (in s), by default 100
  • proj (bool, optional) – Whether to project the signals, by default False
  • show (bool, optional) – Whether to show the plot in interactive mode, by default True
  • bad_chans (list of int, optional) – The bad channels in the array (plotted in red) - by channel.
Keyword Arguments:
 

https (See) –

Returns:

The raw traces in a figure instance.
Return type:

matplotlib.figure.Figure