MCPcopy
hub / github.com/mne-tools/mne-python / plot_evoked_topomap

Function plot_evoked_topomap

mne/viz/topomap.py:2074–2546  ·  view source on GitHub ↗

Plot topographic maps of specific time points of evoked data. Parameters ---------- evoked : Evoked The Evoked object. times : float | array of float | "auto" | "peaks" | "interactive" The time point(s) to plot. If "auto", the number of ``axes`` determines th

(
    evoked,
    times="auto",
    *,
    average=None,
    ch_type=None,
    scalings=None,
    proj=False,
    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=None,
    vlim=(None, None),
    cnorm=None,
    colorbar=True,
    cbar_fmt="%3.1f",
    units=None,
    axes=None,
    time_unit="s",
    time_format=None,
    nrows=1,
    ncols="auto",
    show=True,
)

Source from the content-addressed store, hash-verified

2072
2073@fill_doc
2074def plot_evoked_topomap(
2075 evoked,
2076 times="auto",
2077 *,
2078 average=None,
2079 ch_type=None,
2080 scalings=None,
2081 proj=False,
2082 sensors=True,
2083 show_names=False,
2084 mask=None,
2085 mask_params=None,
2086 contours=6,
2087 outlines="head",
2088 sphere=None,
2089 image_interp=_INTERPOLATION_DEFAULT,
2090 extrapolate=_EXTRAPOLATE_DEFAULT,
2091 border=_BORDER_DEFAULT,
2092 res=64,
2093 size=1,
2094 cmap=None,
2095 vlim=(None, None),
2096 cnorm=None,
2097 colorbar=True,
2098 cbar_fmt="%3.1f",
2099 units=None,
2100 axes=None,
2101 time_unit="s",
2102 time_format=None,
2103 nrows=1,
2104 ncols="auto",
2105 show=True,
2106):
2107 """Plot topographic maps of specific time points of evoked data.
2108
2109 Parameters
2110 ----------
2111 evoked : Evoked
2112 The Evoked object.
2113 times : float | array of float | "auto" | "peaks" | "interactive"
2114 The time point(s) to plot. If "auto", the number of ``axes`` determines
2115 the amount of time point(s). If ``axes`` is also None, at most 10
2116 topographies will be shown with a regular time spacing between the
2117 first and last time instant. If "peaks", finds time points
2118 automatically by checking for local maxima in global field power. If
2119 "interactive", the time can be set interactively at run-time by using a
2120 slider.
2121 %(average_plot_evoked_topomap)s
2122 %(ch_type_topomap)s
2123 %(scalings_topomap)s
2124 %(proj_plot)s
2125 %(sensors_topomap)s
2126 %(show_names_topomap)s
2127 %(mask_evoked_topomap)s
2128 %(mask_params_topomap)s
2129 %(contours_topomap)s
2130 %(outlines_topomap)s
2131 %(sphere_topomap_auto)s

Callers 2

test_plot_topomap_basicFunction · 0.90
plot_topomapMethod · 0.85

Calls 15

BrowserParamsClass · 0.90
_validate_typeFunction · 0.85
_get_plot_ch_typeFunction · 0.85
_check_time_unitFunction · 0.85
_handle_defaultFunction · 0.85
_prepare_topomap_plotFunction · 0.85
_make_head_outlinesFunction · 0.85
_prepare_sensor_namesFunction · 0.85
_check_optionFunction · 0.85
_process_timesFunction · 0.85
figure_nobarFunction · 0.85
_prepare_trellisFunction · 0.85

Tested by 1

test_plot_topomap_basicFunction · 0.72