mne.read_dipole#

mne.read_dipole(fname, verbose=None)[source]#

Read .dip file from Neuromag/xfit or MNE.

Parameters
fnamestr

The name of the .dip or .fif file.

verbosebool | str | int | None

Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Returns
dipoleinstance of Dipole | list of Dipole

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.Dipole instances.

Notes

Changed in version 0.20: Support for reading bdip (Xfit binary) format.

Examples using mne.read_dipole#

Plotting with ``mne.viz.Brain``

Plotting with mne.viz.Brain

Plotting with ``mne.viz.Brain``
Computing source timecourses with an XFit-like multi-dipole model

Computing source timecourses with an XFit-like multi-dipole model

Computing source timecourses with an XFit-like multi-dipole model