ffrprep.reports.build_evoked_section¶

ffrprep.reports.build_evoked_section(evoked, *, section_id, title, label=None, extra_summary=None, extra_figures=None, response_window=(0.1, 0.2))[source]¶

Build a section descriptor from an Evoked object.

Summary table includes the standard metadata plus two FFR-specific scalar metrics: RMS SNR over response_window and average band power across 90-110 Hz over the same window (via ffrprep.analysis.rms_snr() and ffrprep.analysis.compute_power()).

extra_summary is folded into the summary table last, so caller- supplied keys override any same-named defaults (e.g. for surfacing corr_stim_to_resp scalars computed at the CLI layer where the BIDS events.tsv + stimulus files are accessible). extra_figures is appended to the figures list after the built-in evoked_qa output; entries must already be section- figure dicts ({"title", "caption", "data_uri"}).

Parameters:: response_window (tuple of (float, float), default=(0.100, 0.200)) – (start, end) of the response window, in seconds relative to the Evoked time axis, used for both the RMS SNR and band power summary metrics.