pyemgpipeline.plots
Summary
Class
Parameters of EMG plots |
Functions
Plot EMG signals on a created matplotlib figure |
|
Plot EMG signals on a created matplotlib figure, overlapping trials of the same channel |
EMGPlotParams
- class pyemgpipeline.plots.EMGPlotParams(n_rows=None, n_cols=None, fig_kwargs=None, line2d_kwargs=None)
Parameters of EMG plots
- Parameters
n_rows (int, default None) – Number of rows to plot all channels. See function emg_plot for more details when considering together with data.
n_cols (int, default None) – Number of columns to plot all channels. See function emg_plot for more details when considering together with data.
fig_kwargs (dict, default None) – Parameters to control the figures. They are parameters of class matplotlib.figure.Figure, including figsize, dpi, facecolor, edgecolor, linewidth, frameon, subplotpars, tight_layout, constrained_layout, etc. (See https://matplotlib.org/stable/api/figure_api.html).
line2d_kwargs (dict, default None) – Parameters to control the plot. They are certain parameters of class matplotlib.lines.Line2D, including linewidth, linestyle, color, marker, markersize, fillstyle, and more. (See https://matplotlib.org/stable/api/_as_gen/matplotlib.lines.Line2D.html).
plot_emg
- pyemgpipeline.plots.plot_emg(x, timestamp, channel_names=None, main_title=None, emg_plot_params=None)
Plot EMG signals on a created matplotlib figure
- Parameters
x (ndarray) – Shape (n_samples,) or (n_samples, n_channels). Signal data to be processed.
timestamp (ndarray) – Shape (n_samples,). The timestamp corresponding to the signal.
channel_names (list or None, default None) – If list, elements are str and its length should be equal to n_channels. Channel names to be shown in plots.
main_title (str or None, default None) – The main title of the plot.
emg_plot_params (EMGPlotParams or None, default None) – If this is not None, then for its n_rows and n_cols, (1) If n_rows and n_cols both have values, n_rows times n_cols should be no less than n_channels. (2) If exactly one of n_rows and n_cols is None, it will get the smallest number to fit in all channels. (3) If both n_rows and n_cols are None, default setting will be used: use one column when n_channels <= 3; use two columns when n_channels <= 10; otherwise use three columns.
- Returns
- Return type
None
plot_emg_overlapping_trials
- pyemgpipeline.plots.plot_emg_overlapping_trials(all_data, all_timestamp, trial_indices_for_plot, legend_labels, channel_names=None, main_title=None, emg_plot_params=None, cycled_colors=None, is_hide_legend=False, legend_kwargs=None, axes_pos_adjust=None)
Plot EMG signals on a created matplotlib figure, overlapping trials of the same channel
- Parameters
all_data (list) – Elements of all_data are signal data of the trials. Signal data of each trial should be ndarray of shape (n_samples,) or (n_samples, n_channels). Dimensions and n_channels (if 2-dim) of all trials should be the same.
all_timestamp (list) – The length of all_timestamp should be the same as the length of all_data. Elements of all_timestamp are ndarray of shape (n_samples,).
trial_indices_for_plot (list of integer) – A list of selected indices of all_data, indicating which trials of the data to be plotted.
legend_labels (list) – The legend labels identify the trials which are overlapped in the plots.
channel_names (list or None, default None) – If list, elements are str and its length should be equal to n_channels. Channel names to be shown in plots.
main_title (str or None, default None) – The main title of the plot.
emg_plot_params (EMGPlotParams or None, default None) – If this is not None, then for its n_rows and n_cols, (1) If n_rows and n_cols both have values, n_rows times n_cols should be no less than n_channels. (2) If exactly one of n_rows and n_cols is None, it will get the smallest number to fit in all channels. (3) If both n_rows and n_cols are None, default setting will be used: use one column when n_channels <= 3; use two columns when n_channels <= 10; otherwise use three columns.
cycled_colors (list or None, default None) – The colors for plotting overlapped trials data.
is_hide_legend (bool, default False) – Whether or not to hide legend.
legend_kwargs (dict or None, default None) – Parameters to control the legend display. They are the “other parameters” of method matplotlib.axes.Axes.legend, including loc, bbox_to_anchor, ncol, prop, fontsize, etc. (See https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.legend.html).
axes_pos_adjust (4-tuple or None, default None) – Parameters to adjust the axes position (i.e., plot position) when legend is displayed to prevent legend overlaying the plot. The 4-tuple represents: [0] shift of left position relative to width, [1] shift of bottom position relative to height, [2] proportion of width, [3] proportion of height. If None, no adjustment is applied, i.e., the value (0, 0, 1, 1) is applied.
- Returns
- Return type
None