Function write_forward_solution

mne/forward/forward.py:858–900

Write forward solution to a file. Parameters ---------- %(fname_fwd)s fwd : Forward Forward solution. %(overwrite)s %(verbose)s See Also -------- read_forward_solution Notes ----- Forward solutions, which are derived from an original forward

(fname, fwd, overwrite=False, verbose=None)

@verbose
def write_forward_solution(fname, fwd, overwrite=False, verbose=None):
    """Write forward solution to a file.

    Parameters
    ----------
    %(fname_fwd)s
    fwd : Forward
        Forward solution.
    %(overwrite)s
    %(verbose)s

    See Also
    --------
    read_forward_solution

    Notes
    -----
    Forward solutions, which are derived from an original forward solution with
    free orientation, are always stored on disk as forward solution with free
    orientation in X/Y/Z RAS coordinates. Transformations (surface orientation,
    fixed orientation) will be reverted. To reapply any transformation to the
    forward operator please apply :func:`convert_forward_solution` after
    reading the forward solution with :func:`read_forward_solution`.

    Forward solutions, which are derived from an original forward solution with
    fixed orientation, are stored on disk as forward solution with fixed
    surface-based orientations. Please note that the transformation to
    surface-based, fixed orientation cannot be reverted after loading the
    forward solution with :func:`read_forward_solution`.
    """
    check_fname(
        fname,
        "forward",
        ("-fwd.fif", "-fwd.fif.gz", "_fwd.fif", "_fwd.fif.gz", "-fwd.h5", "_fwd.h5"),
    )

    # check for file existence and expand `~` if present
    fname = _check_fname(fname, overwrite)
    if fname.suffix == ".h5":
        _write_forward_hdf5(fname, fwd)
    else:
        with start_and_end_file(fname) as fid:
            _write_forward_solution(fid, fwd)


def _write_forward_hdf5(fname, fwd):