bemobil_mne.preproc.make_report

bemobil_mne.preproc.make_report(raw_minimal, raw_clean, ica, ic_labels, dipoles, residuals, trans, bad_ch_dict, *, fname_out=None, event_id=None, thresh=0.7, step_timings=None, tier2=None, pre_hook_description=None, pre_hook_source=None, ica_annots=None)

Build and return an mne.Report for EEGPreprocessor outputs.

Parameters:

tier2dict | None

Tier-2 streams from MultimodalRecording (kept at native rate, not merged into raw). Each stream is plotted as a decimated envelope with timestamp gaps shaded.

pre_hook_descriptionstr | None

Short description of what the pre-hook did, recorded in the report.

pre_hook_sourcestr | None

Source code of the pre-hook callable, shown in a collapsible block.

ica_annotsmne.Annotations | None

Annotations present on the data at the time ICA was fitted (i.e. after bad-channel detection and break annotation, but before ICA). Used to plot a timeline of BAD_* segments that were excluded from the ICA fit.

Parameters:

• raw_minimal (BaseRaw)

• raw_clean (BaseRaw)

• ica (ICA)

• ic_labels (dict)

• dipoles (list)

• residuals (list)

• bad_ch_dict (dict)

• fname_out (str | Path | None)

• event_id (dict | None)

• thresh (float)

• step_timings (list[dict] | None)

• tier2 (dict[str, tuple[ndarray, ndarray]] | None)

• pre_hook_description (str | None)

• pre_hook_source (str | None)

• ica_annots (Annotations | None)

Return type:

Report