mne.make_forward_dipole#
- mne.make_forward_dipole(dipole, bem, info, trans=None, n_jobs=None, *, verbose=None)[source]#
Convert dipole object to source estimate and calculate forward operator.
The instance of Dipole is converted to a discrete source space, which is then combined with a BEM or a sphere model and the sensor information in info to form a forward operator.
The source estimate object (with the forward operator) can be projected to sensor-space using
mne.simulation.simulate_evoked().Note
If the (unique) time points of the dipole object are unevenly spaced, the first output will be a list of single-timepoint source estimates.
- Parameters:
- dipoleinstance of
Dipole|listofDipole Dipole object containing position, orientation and amplitude of one or more dipoles. Multiple simultaneous dipoles may be defined by assigning them identical times. Alternatively, multiple simultaneous dipoles may also be specified as a list of Dipole objects.
Changed in version 1.1: Added support for a list of
mne.Dipoleinstances.- bem
str|dict The BEM filename (str) or a loaded sphere model (dict).
- infoinstance of
Info The measurement information dictionary. It is sensor-information etc., e.g., from a real data file.
- trans
str|None The head<->MRI transform filename. Must be provided unless BEM is a sphere model.
- n_jobs
int|None The number of jobs to run in parallel. If
-1, it is set to the number of CPU cores. Requires thejoblibpackage.None(default) is a marker for ‘unset’ that will be interpreted asn_jobs=1(sequential execution) unless the call is performed under ajoblib.parallel_backend()context manager that sets another value forn_jobs.- verbosebool |
str|int|None Control verbosity of the logging output. If
None, use the default verbosity level. See the logging documentation andmne.verbose()for details. Should only be passed as a keyword argument.
- dipoleinstance of
- Returns:
- fwdinstance of
Forward The forward solution corresponding to the source estimate(s).
- stcinstance of
VolSourceEstimate|listofVolSourceEstimate The dipoles converted to a discrete set of points and associated time courses. If the time points of the dipole are unevenly spaced, a list of single-timepoint source estimates are returned.
- fwdinstance of
See also
Notes
New in version 0.12.0.
Examples using mne.make_forward_dipole#
Source localization with equivalent current dipole (ECD) fit
Computing source timecourses with an XFit-like multi-dipole model