Function read_fiducials

mne/_fiff/meas_info.py:2211–2232

Read fiducials from a fiff file. Parameters ---------- fname : path-like The filename to read. %(verbose)s Returns ------- pts : list of dict List of digitizer points (each point in a dict). coord_frame : int The coordinate frame of the point

(fname, *, verbose=None)

@verbose
def read_fiducials(fname, *, verbose=None):
    """Read fiducials from a fiff file.

    Parameters
    ----------
    fname : path-like
        The filename to read.
    %(verbose)s

    Returns
    -------
    pts : list of dict
        List of digitizer points (each point in a dict).
    coord_frame : int
        The coordinate frame of the points (one of
        ``mne.io.constants.FIFF.FIFFV_COORD_...``).
    """
    fname = _check_fname(fname=fname, overwrite="read", must_exist=True)
    fid, tree, _ = fiff_open(fname)
    with fid:
        pts = _read_dig_fif(fid, tree)
    return pts, pts[0]["coord_frame"]


@verbose