Function _write_annotations_txt

mne/annotations.py:1759–1794

(fname, annot)

def _write_annotations_txt(fname, annot):
    content = "# MNE-Annotations\n"
    if annot.orig_time is not None:
        # for backward compat, we do not write tzinfo (assumed UTC)
        content += f"# orig_time : {annot.orig_time.replace(tzinfo=None)}\n"
    content += "# onset, duration, description"
    n_cols = 3
    data = [annot.onset, annot.duration, annot.description]
    if annot._any_ch_names():
        n_cols += 1
        content += ", ch_names"
        data.append(
            [
                _safe_name_list(ch, "write", f"annot.ch_names[{ci}]")
                for ci, ch in enumerate(annot.ch_names)
            ]
        )
    if len(extras_columns := annot._extras_columns) > 0:
        n_cols += len(extras_columns)
        for column in extras_columns:
            content += f", {column}"
            values = [extra.get(column, None) for extra in annot.extras]
            if len(dtypes := set(type(v) for v in values)) > 1:
                warn(
                    f"Extra field '{column}' contains heterogeneous dtypes ({dtypes}). "
                    "Loading these TXT annotations may not return the original dtypes."
                )
            data.append([val if val is not None else "" for val in values])
    content += "\n"
    data = np.array(data, dtype=str).T
    assert data.ndim == 2
    assert data.shape[0] == len(annot.onset)
    assert data.shape[1] == n_cols
    with open(fname, "wb") as fid:
        fid.write(content.encode())
        np.savetxt(fid, data, delimiter=",", fmt="%s")


@fill_doc