Plot topographic patterns of components. The patterns explain how the measured data was generated from the neural sources (a.k.a. the forward model). Parameters ---------- %(info_not_none)s Used for fitting. If not available, consider using :func
(
self,
info,
components=None,
*,
ch_type=None,
scalings=None,
sensors=True,
show_names=False,
mask=None,
mask_params=None,
contours=6,
outlines="head",
sphere=None,
image_interp=_INTERPOLATION_DEFAULT,
extrapolate=_EXTRAPOLATE_DEFAULT,
border=_BORDER_DEFAULT,
res=64,
size=1,
cmap="RdBu_r",
vlim=(None, None),
cnorm=None,
colorbar=True,
cbar_fmt="%3.1f",
units=None,
axes=None,
name_format="CSP%01d",
nrows=1,
ncols="auto",
show=True,
)
| 360 | @legacy(alt="get_spatial_filter_from_estimator(clf, info=info).plot_patterns()") |
| 361 | @fill_doc |
| 362 | def plot_patterns( |
| 363 | self, |
| 364 | info, |
| 365 | components=None, |
| 366 | *, |
| 367 | ch_type=None, |
| 368 | scalings=None, |
| 369 | sensors=True, |
| 370 | show_names=False, |
| 371 | mask=None, |
| 372 | mask_params=None, |
| 373 | contours=6, |
| 374 | outlines="head", |
| 375 | sphere=None, |
| 376 | image_interp=_INTERPOLATION_DEFAULT, |
| 377 | extrapolate=_EXTRAPOLATE_DEFAULT, |
| 378 | border=_BORDER_DEFAULT, |
| 379 | res=64, |
| 380 | size=1, |
| 381 | cmap="RdBu_r", |
| 382 | vlim=(None, None), |
| 383 | cnorm=None, |
| 384 | colorbar=True, |
| 385 | cbar_fmt="%3.1f", |
| 386 | units=None, |
| 387 | axes=None, |
| 388 | name_format="CSP%01d", |
| 389 | nrows=1, |
| 390 | ncols="auto", |
| 391 | show=True, |
| 392 | ): |
| 393 | """Plot topographic patterns of components. |
| 394 | |
| 395 | The patterns explain how the measured data was generated from the |
| 396 | neural sources (a.k.a. the forward model). |
| 397 | |
| 398 | Parameters |
| 399 | ---------- |
| 400 | %(info_not_none)s Used for fitting. If not available, consider using |
| 401 | :func:`mne.create_info`. |
| 402 | components : float | array of float | None |
| 403 | The patterns to plot. If ``None``, all components will be shown. |
| 404 | %(ch_type_topomap)s |
| 405 | scalings : dict | float | None |
| 406 | The scalings of the channel types to be applied for plotting. |
| 407 | If None, defaults to ``dict(eeg=1e6, grad=1e13, mag=1e15)``. |
| 408 | %(sensors_topomap)s |
| 409 | %(show_names_topomap)s |
| 410 | %(mask_patterns_topomap)s |
| 411 | %(mask_params_topomap)s |
| 412 | %(contours_topomap)s |
| 413 | %(outlines_topomap)s |
| 414 | %(sphere_topomap_auto)s |
| 415 | %(image_interp_topomap)s |
| 416 | %(extrapolate_topomap)s |
| 417 | |
| 418 | .. versionadded:: 1.3 |
| 419 | %(border_topomap)s |