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

infoinstance of Info

The measurement info.

dataarray, shape (n_channels, n_times)

The dipole data.

timesarray, shape (n_times,)

The time points.

naveint

Number of averages.

aspect_kindint

The kind of data.

firstint

First sample.

lastint

Last sample.

commentstr

The dipole comment.

verbosebool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

See also

read_dipole

Dipole

fit_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

Channel names.

Methods

__hash__(self, /)	Return hash(self).
copy(self)	Copy the DipoleFixed object.
plot(self[, show, time_unit])	Plot dipole data.
save(self, fname[, verbose])	Save dipole in a .fif file.

__hash__(self, /)

Return hash(self).

property ch_names

Channel names.

copy(self)

Copy the DipoleFixed object.

Returns

instinstance of DipoleFixed

The copy.

Notes

New in version 0.16.

plot(self, show=True, time_unit='s')

Plot dipole data.

Parameters

showbool

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

time_unitstr

The units for the time axis, can be “ms” or “s” (default).

New in version 0.16.

Returns

figinstance of matplotlib.figure.Figure

The figure containing the time courses.

save(self, fname, verbose=None)

Save dipole in a .fif file.

Parameters

fnamestr

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.

verbosebool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more). Defaults to self.verbose.