mne.DipoleFixed¶

class mne.DipoleFixed(info, data, times, nave, aspect_kind, comment='', verbose=None)[source]¶

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.
commentstr: The dipole comment.
verbosebool, str, int, or None: If not None, override default verbose level (see mne.verbose() and Logging documentation for more). If used, it should be passed as a keyword-argument only.

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__`(/)	Return hash(self).
`copy`()	Copy the DipoleFixed object.
`plot`([show, time_unit])	Plot dipole data.
`save`(fname[, verbose])	Save dipole in a .fif file.
`shift_time`(tshift[, relative])	Shift time scale in epoched or evoked data.

property ch_names¶: Channel names.

copy()[source]¶

Copy the DipoleFixed object.

Returns

instinstance of DipoleFixed: The copy.

Notes

New in version 0.16.

plot(show=True, time_unit='s')[source]¶

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.

Examples using plot:

save(fname, verbose=None)[source]¶

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). If used, it should be passed as a keyword-argument only. Defaults to self.verbose.

shift_time(tshift, relative=True)[source]¶

Shift time scale in epoched or evoked data.

Parameters

tshiftfloat: The (absolute or relative) time shift in seconds. If relative is True, positive tshift increases the time value associated with each sample, while negative tshift decreases it.
relativebool: If True, increase or decrease time values by tshift seconds. Otherwise, shift the time values such that the time of the first sample equals tshift.

Returns

epochsinstance of Epochs: The modified Epochs instance.

Notes

This method allows you to shift the time values associated with each data sample by an arbitrary amount. It does not resample the signal or change the data values in any way.