mne_hfo.io.read_annotations#

mne_hfo.io.read_annotations(fname, root=None)[source]#

Read annotations.tsv Derivative file.

Annotations are part of the BIDS-Derivatives for Common Electrophysiological derivatives [1].

Return type:

DataFrame

Parameters:
fnamestr | pathlib.Path

The BIDS file path for the *annotations.tsv|json files.

rootstr | pathlib.Path | None

The root of the BIDS dataset. If None (default), will try to infer the BIDS root from the fname argument.

Returns:
annot_tsvpd.DataFrame

The DataFrame for the annotations.tsv with extra columns appended to make sense of the sample data.

References