mne.
Dipole
(times, pos, amplitude, ori, gof, name=None)¶Dipole class
Used to store positions, orientations, amplitudes, times, goodness of fit of dipoles, typically obtained with Neuromag/xfit, mne_dipole_fit or certain inverse solvers.
Parameters: | times : array, shape (n_dipoles,)
pos : array, shape (n_dipoles, 3)
amplitude : array, shape (n_dipoles,)
ori : array, shape (n_dipoles, 3)
gof : array, shape (n_dipoles,)
name : str | None
|
---|
Methods
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 as arrows |
save (fname) |
Save dipole in a .dip file |
__init__
(times, pos, amplitude, ori, gof, name=None)¶copy
()¶Copy the Dipoles object
Returns: | dip : instance of Dipole
|
---|
crop
(tmin=None, tmax=None)¶Crop data to a given time interval
Parameters: | tmin : float | None
tmax : float | None
|
---|
plot_amplitudes
(color='k', show=True)¶Plot the dipole amplitudes as a function of time
Parameters: | color: matplotlib Color :
show : bool
|
---|---|
Returns: | fig : matplotlib.figure.Figure
|
plot_locations
(trans, subject, subjects_dir=None, bgcolor=(1, 1, 1), opacity=0.3, brain_color=(0.7, 0.7, 0.7), mesh_color=(1, 1, 0), fig_name=None, fig_size=(600, 600), mode='cone', scale_factor=0.01, colors=None, verbose=None)¶Plot dipole locations as arrows
Parameters: | trans : dict
subject : str
subjects_dir : None | str
bgcolor : tuple of length 3
opacity : float in [0, 1]
brain_color : tuple of length 3
mesh_color : tuple of length 3
fig_name : tuple of length 2
fig_size : tuple of length 2
mode : str
scale_factor : float
colors: list of colors | None :
verbose : bool, str, int, or None
|
---|---|
Returns: | fig : instance of mlab.Figure
|
save
(fname)¶Save dipole in a .dip file
Parameters: | fname : str
|
---|