meegpype.interfaces.mne.forward module🔗

class meegpype.interfaces.mne.forward.MakeForwardSolution(from_file=None, resource_monitor=None, ignore_exception=False, **inputs)🔗

Bases: BaseInterface

Mandatory Inputs:

  • bem (a string or os.PathLike object referring to an existing file) – Filename of the BEM.

  • fname (a string or os.PathLike object) – Output file name. Use a name <dir>/<name>-fwd.fif.

  • info (a string or os.PathLike object referring to an existing file) – Path to a file with measurement information.

  • src (a string or os.PathLike object referring to an existing file) – A path to a source space file.

  • trans (a string or os.PathLike object referring to an existing file or a legal value) – The path to the head<->MRI transform *-trans.fif file produced during coregistration. Can also be ‘fsaverage’ to use the built-in fsaverage transformation. If trans is None, an identity matrix is assumed.

Optional Inputs:

  • eeg (a boolean) – If True (default), include EEG computations.

  • ignore_ref (a boolean) – If True, do not include reference channels in compensation. This option should be True for KIT files, since forward computation with reference channels is not currently supported.

  • meg (a boolean) – If True (default), include MEG computations.

  • mindist (a float) – Minimum distance of sources from inner skull surface (in mm).

  • n_jobs (an integer) – The number of jobs to run in parallel. If -1, it is set to the number of CPU cores.

  • overwrite (a boolean) – Overwrite existing files.

  • verbose (a boolean) – Enable verbose mode (printing of log messages).

Outputs:

forward (a pathlike object or string representing an existing file) – The forward solution.