mne_hfo.io.read_annotations

mne_hfo.io.read_annotations(fname, root=None)

Read annotations.tsv Derivative file.

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

Parameters

fname : str | pathlib.Path

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

root : str | 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_tsv : pd.DataFrame

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

References

1

https://docs.google.com/document/d/1PmcVs7vg7Th-cGC-UrX8rAhKUHIzOI-uIOh69_mvdlw/edit# # noqa

Return type

DataFrame

Examples using mne_hfo.io.read_annotations

mne_hfo.io.events_to_annotations mne_hfo.io.write_annotations