mne.read_forward_solution

mne.read_forward_solution(fname, include=(), exclude=(), verbose=None)[source]

Read a forward solution a.k.a. lead field.

Parameters
fnamestr

The file name, which should end with -fwd.fif or -fwd.fif.gz.

includelist, optional

List of names of channels to include. If empty all channels are included.

excludelist, optional

List of names of channels to exclude. If empty include all channels.

verbosebool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more). If used, it should be passed as a keyword-argument only.

Returns
fwdinstance of Forward

The forward solution.

See also

write_forward_solution, make_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. To apply any transformation to the forward operator (surface orientation, fixed orientation) please apply convert_forward_solution() after reading the forward solution with 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 read_forward_solution().

Examples using mne.read_forward_solution