mne_denoise.viz.plot_tradeoff_scatter

mne_denoise.viz.plot_tradeoff_scatter(data, x_col, y_col, group_col='group', group_order=None, group_colors=None, group_labels=None, x_label=None, y_label=None, title='Metric Trade-off', reference_x=None, reference_y=None, ax=None, fname=None, show=True)

Plot a grouped x/y trade-off scatter with optional group means.

Parameters:

datamapping of str to array-like

Columnar mapping with group and metric columns.

x_colstr

Metric column for the x-axis.

y_colstr

Metric column for the y-axis.

group_colstr

Grouping column name.

group_orderlist of str | None, default=None

Optional group order. If None, first-seen order is used.

group_colorsdict | None, default=None

Optional color overrides keyed by group name.

group_labelsdict | None, default=None

Optional display-label overrides keyed by group name.

x_labelstr | None, default=None

X-axis label. If None, derived from x_col.

y_labelstr | None, default=None

Y-axis label. If None, derived from y_col.

titlestr, default=”Metric Trade-off”

Axes title.

reference_xfloat | None, default=None

Optional vertical reference line.

reference_yfloat | None, default=None

Optional horizontal reference line.

axmatplotlib.axes.Axes | None, default=None

Existing axes. If None, create a new figure.

fnamepath-like | None, default=None

Optional output path when creating a new figure.

showbool, default=True

Whether to display the figure when creating a new figure.

Returns:

figmatplotlib.figure.Figure

Figure handle.