mne_bids.read_epochs_bids#

mne_bids.read_epochs_bids(bids_path, extra_params=None, *, on_ch_mismatch='raise', verbose=None)[source]#

Read epoched BIDS data (RecordingType=”epoched”) as mne.Epochs.

EEGLAB .set files are read with the dedicated MNE epochs reader. Continuous formats (.edf / .bdf / .vhdr) flagged "epoched" in the sidecar are sliced into trials of length EpochLength (from the sidecar). When events.tsv is present its onsets give the trial starts (sample / begSample / onset columns are tried in that order; trials extending past the recording are dropped with a warning); when absent, the file is uniformly tiled.

Parameters:
bids_pathBIDSPath

Same semantics as read_raw_bids().

extra_paramsNone | dict

Forwarded to the underlying MNE reader.

on_ch_mismatchstr

See read_raw_bids().

verbosebool | str | int | None

Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Returns:
epochsmne.Epochs

The epoched data with BIDS sidecar metadata applied.

Notes

This function applies the same sidecars as read_raw_bids() (channels.tsv, electrodes.tsv, coordsystem.json, scans.tsv, participants.tsv).

Examples using mne_bids.read_epochs_bids#

Read epoched BIDS data as MNE Epochs

Read epoched BIDS data as MNE Epochs