mne_denoise.viz.plot_metric_tradeoff_summary#

mne_denoise.viz.plot_metric_tradeoff_summary(data, *, group_col, subject_col, x_col, y_col, metric_col, x_label=None, y_label=None, metric_label=None, group_order=None, group_colors=None, group_labels=None, tradeoff_title='Metric Trade-off', metric_title='Metric Comparison', reference_x=None, reference_y=None, reference_value=None, reference_label='Reference', suptitle='Trade-off Analysis', show=True, fname=None)[source]#

Plot a two-panel metric trade-off summary.

Parameters:

datamapping of str to array-like: Columnar data mapping with aligned 1D columns.
group_colstr: Group column name.
subject_colstr: Subject column name used for paired metric comparison.
x_colstr: Metric column used for the trade-off scatter x-axis.
y_colstr: Metric column used for the trade-off scatter y-axis.
metric_colstr: Metric column used for the right-panel comparison.
x_labelstr | None, default=None: Optional trade-off x-axis label.
y_labelstr | None, default=None: Optional trade-off y-axis label.
metric_labelstr | None, default=None: Optional comparison-panel label.
group_ordersequence of str | None, default=None: Optional group display order.
group_colorsmapping | None, default=None: Optional color overrides keyed by group.
group_labelsmapping | None, default=None: Optional display-label overrides keyed by group.
tradeoff_titlestr, default=”Metric Trade-off”: Trade-off panel title.
metric_titlestr, default=”Metric Comparison”: Metric comparison panel title.
suptitlestr, default=”Trade-off Analysis”: Figure title.
reference_xfloat | None, default=None: Optional vertical reference line in the trade-off panel.
reference_yfloat | None, default=None: Optional horizontal reference line in the trade-off panel.
reference_valuefloat | None, default=None: Optional reference line in the metric panel.
reference_labelstr: Label for the metric reference line.
showbool: Whether to display the figure.
fnamepath-like | None: Optional output path.

Returns:

figmatplotlib.figure.Figure: Figure handle.