ffrprep.reports.build_epoch_section

ffrprep.reports.build_epoch_section(epochs, *, section_id, title, extra_summary=None)[source]

Build a section descriptor from an Epochs object.

Wraps epoch_qa() to produce overview / rejection / average / drift figures, encodes them as inline data URIs, and pairs them with a summary table (n_epochs, channels, sfreq, time window). For Epochs with >= 10 trials the summary also surfaces the mean pairwise trial-to-trial Pearson correlation (ffrprep.analysis.response_consistency()); below 10 trials the metric is unstable so the row is omitted.

extra_summary is appended to the summary table after the standard metadata. Use it to surface info that isn’t on the Epochs object itself — e.g. pre-rejection counts read from a BIDS sidecar.