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_df : pd.DataFrame

The annotations DataFrame.

fname : str | pathlib.Path

The BIDS filename to write annotations to.

intended_for : str | pathlib.Path | BIDSPath

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

root : str | pathlib.Path

The root of the BIDS dataset.

description : str | None

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

:rtype: :py:obj:`None`

Examples using mne_hfo.io.write_annotations

mne_hfo.io.read_annotations mne_hfo.match_detected_annotations