mne_hfo.io.write_annotations

mne_hfo.io.write_annotations(annot_df, fname, intended_for, root, description=None)

Write annotations dataframe to disc.

Parameters:

annot_dfpd.DataFrame

The annotations DataFrame.

fnamestr | pathlib.Path

The BIDS filename to write annotations to.

intended_forstr | pathlib.Path | BIDSPath

The IntendedFor BIDS keyword corresponding to the Raw file that the Annotations were created from.

rootstr | pathlib.Path

The root of the BIDS dataset.

descriptionstr | None

The description of the Annotations file. If None (default), will describe it as HFO events detected using mne-hfo.