mne.
Dipole
(times, pos, amplitude, ori, gof, name=None, conf=None, khi2=None, nfree=None)[source]¶Dipole class for sequential dipole fits.
Note
This class should usually not be instantiated directly,
instead mne.read_dipole()
should be used.
Used to store positions, orientations, amplitudes, times, goodness of fit of dipoles, typically obtained with Neuromag/xfit, mne_dipole_fit or certain inverse solvers. Note that dipole position vectors are given in the head coordinate frame.
Parameters: |
|
---|
See also
Notes
This class is for sequential dipole fits, where the position
changes as a function of time. For fixed dipole fits, where the
position is fixed as a function of time, use mne.DipoleFixed
.
Methods
__getitem__ (item) |
Get a time slice. |
__hash__ ($self, /) |
Return hash(self). |
__len__ () |
Return the number of dipoles. |
copy () |
Copy the Dipoles object. |
crop ([tmin, tmax]) |
Crop data to a given time interval. |
plot_amplitudes ([color, show]) |
Plot the dipole amplitudes as a function of time. |
plot_locations (trans, subject[, …]) |
Plot dipole locations in 3d. |
save (fname) |
Save dipole in a .dip file. |
__getitem__
(item)[source]¶Get a time slice.
Parameters: |
|
---|---|
Returns: |
|
__hash__
($self, /)¶Return hash(self).
__len__
()[source]¶Return the number of dipoles.
Returns: |
|
---|
Examples
This can be used as:
>>> len(dipoles)
10
copy
()[source]¶Copy the Dipoles object.
Returns: |
|
---|
crop
(tmin=None, tmax=None)[source]¶Crop data to a given time interval.
Parameters: |
|
---|---|
Returns: |
|
plot_amplitudes
(color='k', show=True)[source]¶Plot the dipole amplitudes as a function of time.
Parameters: |
|
---|---|
Returns: |
|
plot_locations
(trans, subject, subjects_dir=None, mode='orthoview', coord_frame='mri', idx='gof', show_all=True, ax=None, block=False, show=True, verbose=None)[source]¶Plot dipole locations in 3d.
Parameters: |
|
---|---|
Returns: |
|
Notes
New in version 0.9.0.