mne.DipoleFixed

class mne.DipoleFixed(info, data, times, nave, aspect_kind, first, last, comment, verbose=None)

Dipole class for fixed-position dipole fits

Note

This class should usually not be instantiated directly, instead mne.read_dipole() should be used.

Parameters:

info : instance of Info

The measurement info.

data : array, shape (n_channels, n_times)

The dipole data.

times : array, shape (n_times,)

The time points.

nave : int

Number of averages.

aspect_kind : int

The kind of data.

first : int

First sample.

last : int

Last sample.

comment : str

The dipole comment.

verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose).

See also

read_dipole, Dipole

Notes

This class is for fixed-position dipole fits, where the position (and maybe orientation) is static over time. For sequential dipole fits, where the position can change a function of time, use mne.Dipole.

New in version 0.12.

Attributes

ch_names

Methods

__hash__() <==> hash(x)
plot([show]) Plot dipole data
save(fname[, verbose]) Save dipole in a .fif file
__hash__() <==> hash(x)
plot(show=True)

Plot dipole data

Parameters:

show : bool

Call pyplot.show() at the end or not.

Returns:

fig : instance of matplotlib.figure.Figure

The figure containing the time courses.

save(fname, verbose=None)

Save dipole in a .fif file

Parameters:

fname : str

The name of the .fif file. Must end with '.fif' or '.fif.gz' to make it explicit that the file contains dipole information in FIF format.

verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose).