ephypype.interfaces.mne.LFComputation

class ephypype.interfaces.mne.LFComputation(from_file=None, resource_monitor=None, ignore_exception=False, **inputs)[source]

Compute the Lead Field matrix using MNE Python functions.

Parameters:
sbj_idstr

subject name

subjects_dirstr

Freesurfer directory

raw_filenamestr

filename of the raw data

spacingstr (default ‘ico-5’)

spacing to use to setup a source space

aseg: bool (defualt False)

if True a mixed source space will be created and the sub cortical regions defined in aseg_labels will be added to the source space

aseg_labels: list (default [])

list of substructures we want to include in the mixed source space

save_mixed_src_space: bool (default False)

if True save the mixed src space

Returns:
fwd_filenamestr

Filename of the Lead Field matrix

__init__(from_file=None, resource_monitor=None, ignore_exception=False, **inputs)

Subclasses must implement __init__

Methods

__init__([from_file, resource_monitor, ...])

Subclasses must implement __init__

aggregate_outputs([runtime, needed_outputs])

Collate expected outputs and apply output traits validation.

help([returnhelp])

Prints class help

load_inputs_from_json(json_file[, overwrite])

A convenient way to load pre-set inputs from a JSON file.

run([cwd, ignore_exception])

Execute this interface.

save_inputs_to_json(json_file)

A convenient way to save current inputs to a JSON file.

Attributes

always_run

Should the interface be always run even if the inputs were not changed? Only applies to interfaces being run within a workflow context.

can_resume

Defines if the interface can reuse partial results after interruption.

resource_monitor

version

interfaces should implement a version property