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)

Plot a two-panel metric trade-off summary.

Parameters:

• data (mapping of str to array-like) – Columnar data mapping with aligned 1D columns.

• group_col (str) – Group column name.

• subject_col (str) – Subject column name used for paired metric comparison.

• x_col (str) – Metric columns used for trade-off scatter axes.

• y_col (str) – Metric columns used for trade-off scatter axes.

• metric_col (str) – Metric column used for the right-panel comparison.

• x_label (str | None) – Optional axis labels.

• y_label (str | None) – Optional axis labels.

• metric_label (str | None) – Optional axis labels.

• group_order (sequence of str | None) – Optional group display order.

• group_colors (mapping | None) – Optional color/label overrides keyed by group.

• group_labels (mapping | None) – Optional color/label overrides keyed by group.

• tradeoff_title (str) – Panel and figure titles.

• metric_title (str) – Panel and figure titles.

• suptitle (str) – Panel and figure titles.

• reference_x (float | None) – Optional reference lines.

• reference_y (float | None) – Optional reference lines.

• reference_value (float | None) – Optional reference lines.

• reference_label (str) – Label for the metric reference line.

• show (bool) – Whether to display the figure.

• fname (path-like | None) – Optional output path.

Returns:

fig – Figure handle.

Return type:

matplotlib.figure.Figure

Notes

This is a composition wrapper around: - mne_denoise.viz.plot_tradeoff_scatter() - mne_denoise.viz.plot_metric_comparison()