eelbrain.load.mne.forward_operator

eelbrain.load.mne.forward_operator(fwd, src, subjects_dir=None, parc='aparc', sysname=None, adjacency=None, name=None)

Load forward operator as NDVar

Parameters:

  • fwd (str | Forward) – MNE Forward solution, or path to forward solution.

  • src (str) – Tag describing the source space. Should be a source space type indicator (one of ico|oct|vol), followed by a number indicating spacing (e.g., “ico-4” for a surface source space based on 4-fold icosahedral subdivision; “vol-7” for volume source space with 7 mm grid).

  • subjects_dir (Path | str) – Location of the MRI subjects directory.

  • parc (str) – Parcellation to load (corresponding to existing annot files; default ‘aparc’).

  • sysname (str) – Name of the sensor system to load sensor adjacency (e.g. ‘neuromag’, inferred automatically for KIT data converted with a recent version of MNE-Python).

  • adjacency (str | Sequence[Tuple[str, str]] | ndarray) –

    adjacency between elements. Can be specified as:

    • "none" for no connections

    • list of connections (e.g., [('OZ', 'O1'), ('OZ', 'O2'), ...])

    • numpy.ndarray of int, shape (n_edges, 2), to specify connections in terms of indices. Each row should specify one connection [i, j] with i < j. If the array’s dtype is uint32, property checks are disabled to improve efficiency.

    • "grid" to use adjacency in the sensor names

    If unspecified, it is inferred from sysname if possible.

  • name (str) – Name the NDVar (default is the filename if a path is provided, otherwise “fwd”).

Returns:

fwd – NDVar (sensor, source) containing the gain matrix.

Return type:

NDVar