mne_denoise.viz.plot_forest#

mne_denoise.viz.plot_forest(data, metric_col, ci_col=None, se_col=None, group_col='group', subject_col='subject', target_group=None, baseline_group=None, group_colors=None, group_labels=None, metric_label=None, reference_line=0.0, suptitle=None, figsize=None, fname=None, show=True)[source]#

Plot per-subject point estimates with confidence intervals.

Parameters:

datamapping of str to array-like: Columnar mapping with group, subject, and metric columns.
metric_colstr: Metric column to display on the x-axis.
ci_colstr | None: Optional half-width CI column for each subject estimate.
se_colstr | None: Optional SE column. If provided and ci_col is absent, CI is approximated as 1.96 * SE.
group_colstr: Grouping column name.
subject_colstr: Subject identifier column name.
target_groupstr | None: Group to plot as primary forest series. Defaults to the last first-seen group.
baseline_groupstr | None: Optional baseline group to overlay with faint points and mean marker.
group_colorsdict | None, default=None: Optional color overrides keyed by group.
group_labelsdict | None, default=None: Optional display-label overrides keyed by group.
metric_labelstr | None, default=None: X-axis label. If None, derived from metric_col.
reference_linefloat | None: Optional vertical reference line value.
suptitlestr | None, default=None: Figure title override.
figsizetuple | None, default=None: Figure size in inches.
fnamepath-like | None, default=None: Optional output path.
showbool, default=True: Whether to display the figure.

Returns:

figmatplotlib.figure.Figure: Figure handle.