Plot Event Related Potential / Fields image. Parameters ---------- epochs : instance of Epochs The epochs. %(picks_good_data)s ``picks`` interacts with ``group_by`` and ``combine`` to determine the number of figures generated; see Notes. sigma : float
(
epochs,
picks=None,
sigma=0.0,
vmin=None,
vmax=None,
colorbar=True,
order=None,
show=True,
units=None,
scalings=None,
cmap=None,
fig=None,
axes=None,
overlay_times=None,
combine=None,
group_by=None,
evoked=True,
ts_args=None,
title=None,
clear=False,
)
| 41 | |
| 42 | @fill_doc |
| 43 | def plot_epochs_image( |
| 44 | epochs, |
| 45 | picks=None, |
| 46 | sigma=0.0, |
| 47 | vmin=None, |
| 48 | vmax=None, |
| 49 | colorbar=True, |
| 50 | order=None, |
| 51 | show=True, |
| 52 | units=None, |
| 53 | scalings=None, |
| 54 | cmap=None, |
| 55 | fig=None, |
| 56 | axes=None, |
| 57 | overlay_times=None, |
| 58 | combine=None, |
| 59 | group_by=None, |
| 60 | evoked=True, |
| 61 | ts_args=None, |
| 62 | title=None, |
| 63 | clear=False, |
| 64 | ): |
| 65 | """Plot Event Related Potential / Fields image. |
| 66 | |
| 67 | Parameters |
| 68 | ---------- |
| 69 | epochs : instance of Epochs |
| 70 | The epochs. |
| 71 | %(picks_good_data)s |
| 72 | ``picks`` interacts with ``group_by`` and ``combine`` to determine the |
| 73 | number of figures generated; see Notes. |
| 74 | sigma : float |
| 75 | The standard deviation of a Gaussian smoothing window applied along |
| 76 | the epochs axis of the image. If 0, no smoothing is applied. |
| 77 | Defaults to 0. |
| 78 | vmin : None | float | callable |
| 79 | The min value in the image (and the ER[P/F]). The unit is µV for |
| 80 | EEG channels, fT for magnetometers and fT/cm for gradiometers. |
| 81 | If vmin is None and multiple plots are returned, the limit is |
| 82 | equalized within channel types. |
| 83 | Hint: to specify the lower limit of the data, use |
| 84 | ``vmin=lambda data: data.min()``. |
| 85 | vmax : None | float | callable |
| 86 | The max value in the image (and the ER[P/F]). The unit is µV for |
| 87 | EEG channels, fT for magnetometers and fT/cm for gradiometers. |
| 88 | If vmin is None and multiple plots are returned, the limit is |
| 89 | equalized within channel types. |
| 90 | colorbar : bool |
| 91 | Display or not a colorbar. |
| 92 | order : None | array of int | callable |
| 93 | If not ``None``, order is used to reorder the epochs along the y-axis |
| 94 | of the image. If it is an array of :class:`int`, its length should |
| 95 | match the number of good epochs. If it is a callable it should accept |
| 96 | two positional parameters (``times`` and ``data``, where |
| 97 | ``data.shape == (len(good_epochs), len(times))``) and return an |
| 98 | :class:`array <numpy.ndarray>` of indices that will sort ``data`` along |
| 99 | its first axis. |
| 100 | show : bool |
no test coverage detected