mne.time_frequency.
AverageTFR
(info, data, times, freqs, nave, comment=None, method=None, verbose=None)¶Container for Time-Frequency data
Can for example store induced power at sensor level or inter-trial coherence.
Parameters: | info : Info
data : ndarray, shape (n_channels, n_freqs, n_times)
times : ndarray, shape (n_times,)
freqs : ndarray, shape (n_freqs,)
nave : int
comment : str | None, defaults to None
method : str | None, defaults to None
verbose : bool, str, int, or None
|
---|
Attributes
ch_names | (list) The names of the channels. |
Methods
__add__ (tfr) |
|
__contains__ (ch_type) |
Check channel type membership |
__hash__ () |
Hash the object |
__sub__ (tfr) |
|
add_channels (add_list[, force_update_info]) |
Append new channels to the instance. |
apply_baseline (baseline[, mode, verbose]) |
Baseline correct the data |
copy () |
Return a copy of the instance. |
crop ([tmin, tmax]) |
Crop data to a given time interval in place |
drop_channels (ch_names) |
Drop some channels |
pick_channels (ch_names) |
Pick some channels |
pick_types ([meg, eeg, stim, eog, ecg, emg, ...]) |
Pick some channels by type and names |
plot (picks[, baseline, mode, tmin, tmax, ...]) |
Plot TFRs in a topography with images |
plot_topo ([picks, baseline, mode, tmin, ...]) |
Plot TFRs in a topography with images |
plot_topomap ([tmin, tmax, fmin, fmax, ...]) |
Plot topographic maps of time-frequency intervals of TFR data |
save (fname[, overwrite]) |
Save TFR object to hdf5 file |
__contains__
(ch_type)¶Check channel type membership
Parameters: | ch_type : str
|
---|---|
Returns: | in : bool
|
Examples
Channel type membership can be tested as:
>>> 'meg' in inst
True
>>> 'seeg' in inst
False
__hash__
()¶Hash the object
Returns: | hash : int
|
---|
add_channels
(add_list, force_update_info=False)¶Append new channels to the instance.
Parameters: | add_list : list
force_update_info : bool
|
---|---|
Returns: | inst : instance of Raw, Epochs, or Evoked
|
apply_baseline
(baseline, mode='mean', verbose=None)¶Baseline correct the data
Parameters: | baseline : tuple or list of length 2
mode : None | ‘ratio’ | ‘zscore’ | ‘mean’ | ‘percent’ | ‘logratio’ | ‘zlogratio’
verbose : bool, str, int, or None
|
---|---|
Returns: | inst : instance of AverageTFR
|
compensation_grade
¶The current gradient compensation grade
copy
()¶Return a copy of the instance.
crop
(tmin=None, tmax=None)¶Crop data to a given time interval in place
Parameters: | tmin : float | None
tmax : float | None
|
---|---|
Returns: | inst : instance of AverageTFR
|
drop_channels
(ch_names)¶Drop some channels
Parameters: | ch_names : list
|
---|---|
Returns: | inst : instance of Raw, Epochs, or Evoked
|
See also
Notes
New in version 0.9.0.
pick_channels
(ch_names)¶Pick some channels
Parameters: | ch_names : list
|
---|---|
Returns: | inst : instance of Raw, Epochs, or Evoked
|
See also
Notes
New in version 0.9.0.
pick_types
(meg=True, eeg=False, stim=False, eog=False, ecg=False, emg=False, ref_meg='auto', misc=False, resp=False, chpi=False, exci=False, ias=False, syst=False, seeg=False, dipole=False, gof=False, bio=False, ecog=False, fnirs=False, include=[], exclude='bads', selection=None)¶Pick some channels by type and names
Parameters: | meg : bool | str
eeg : bool
stim : bool
eog : bool
ecg : bool
emg : bool
ref_meg: bool | str
misc : bool
resp : bool
chpi : bool
exci : bool
ias : bool
syst : bool
seeg : bool
dipole : bool
gof : bool
bio : bool
ecog : bool
fnirs : bool | str
include : list of string
exclude : list of string | str
selection : list of string
|
---|---|
Returns: | inst : instance of Raw, Epochs, or Evoked
|
Notes
New in version 0.9.0.
plot
(picks, baseline=None, mode='mean', tmin=None, tmax=None, fmin=None, fmax=None, vmin=None, vmax=None, cmap='RdBu_r', dB=False, colorbar=True, show=True, title=None, axes=None, layout=None, verbose=None)¶Plot TFRs in a topography with images
Parameters: | picks : array-like of int
baseline : None (default) or tuple of length 2
mode : None | ‘ratio’ | ‘zscore’ | ‘mean’ | ‘percent’ | ‘logratio’ | ‘zlogratio’
tmin : None | float
tmax : None | float
fmin : None | float
fmax : None | float
vmin : float | None
vmax : float | None
cmap : matplotlib colormap | ‘interactive’ | (colormap, bool)
dB : bool
colorbar : bool
show : bool
title : str | None
axes : instance of Axes | list | None
layout : Layout | None
verbose : bool, str, int, or None
|
---|---|
Returns: | fig : matplotlib.figure.Figure
|
plot_topo
(picks=None, baseline=None, mode='mean', tmin=None, tmax=None, fmin=None, fmax=None, vmin=None, vmax=None, layout=None, cmap='RdBu_r', title=None, dB=False, colorbar=True, layout_scale=0.945, show=True, border='none', fig_facecolor='k', fig_background=None, font_color='w')¶Plot TFRs in a topography with images
Parameters: | picks : array-like of int | None
baseline : None (default) or tuple of length 2
mode : None | ‘ratio’ | ‘zscore’ | ‘mean’ | ‘percent’ | ‘logratio’ | ‘zlogratio’
tmin : None | float
tmax : None | float
fmin : None | float
fmax : None | float
vmin : float | None
vmax : float | None
layout : Layout | None
cmap : matplotlib colormap | str
title : str
dB : bool
colorbar : bool
layout_scale : float
show : bool
border : str
fig_facecolor : str | obj
fig_background : None | array
font_color: str | obj
|
---|---|
Returns: | fig : matplotlib.figure.Figure
|
plot_topomap
(tmin=None, tmax=None, fmin=None, fmax=None, ch_type=None, baseline=None, mode='mean', layout=None, vmin=None, vmax=None, cmap=None, sensors=True, colorbar=True, unit=None, res=64, size=2, cbar_fmt='%1.1e', show_names=False, title=None, axes=None, show=True, outlines='head', head_pos=None)¶Plot topographic maps of time-frequency intervals of TFR data
Parameters: | tmin : None | float
tmax : None | float
fmin : None | float
fmax : None | float
ch_type : ‘mag’ | ‘grad’ | ‘planar1’ | ‘planar2’ | ‘eeg’ | None
baseline : tuple or list of length 2
mode : None | ‘ratio’ | ‘zscore’ | ‘mean’ | ‘percent’ | ‘logratio’ | ‘zlogratio’
layout : None | Layout
vmin : float | callable | None
vmax : float | callable | None
cmap : matplotlib colormap | (colormap, bool) | ‘interactive’ | None
sensors : bool | str
colorbar : bool
unit : dict | str | None
res : int
size : float
cbar_fmt : str
show_names : bool | callable
title : str | None
axes : instance of Axes | None
show : bool
outlines : ‘head’ | ‘skirt’ | dict | None
head_pos : dict | None
|
---|---|
Returns: | fig : matplotlib.figure.Figure
|
save
(fname, overwrite=False)¶Save TFR object to hdf5 file
Parameters: | fname : str
overwrite : bool
|
---|