MCPcopy Index your code
hub / github.com/mne-tools/mne-python / plot_source_estimates

Function plot_source_estimates

mne/viz/_3d.py:2380–2582  ·  view source on GitHub ↗

Plot SourceEstimate. Parameters ---------- stc : SourceEstimate The source estimates to plot. %(subject_none)s If ``None``, ``stc.subject`` will be used. surface : str The type of surface (inflated, white etc.). hemi : str Hemisphere id (ie ``

(
    stc,
    subject=None,
    surface="inflated",
    hemi="lh",
    colormap="auto",
    time_label="auto",
    smoothing_steps=10,
    transparent=True,
    alpha=1.0,
    time_viewer="auto",
    *,
    subjects_dir=None,
    figure=None,
    views="auto",
    colorbar=True,
    clim="auto",
    cortex="classic",
    size=800,
    background="black",
    foreground=None,
    initial_time=None,
    time_unit="s",
    backend="auto",
    spacing="oct6",
    title=None,
    show_traces="auto",
    src=None,
    volume_options=1.0,
    view_layout="vertical",
    add_data_kwargs=None,
    brain_kwargs=None,
    verbose=None,
)

Source from the content-addressed store, hash-verified

2378
2379@verbose
2380def plot_source_estimates(
2381 stc,
2382 subject=None,
2383 surface="inflated",
2384 hemi="lh",
2385 colormap="auto",
2386 time_label="auto",
2387 smoothing_steps=10,
2388 transparent=True,
2389 alpha=1.0,
2390 time_viewer="auto",
2391 *,
2392 subjects_dir=None,
2393 figure=None,
2394 views="auto",
2395 colorbar=True,
2396 clim="auto",
2397 cortex="classic",
2398 size=800,
2399 background="black",
2400 foreground=None,
2401 initial_time=None,
2402 time_unit="s",
2403 backend="auto",
2404 spacing="oct6",
2405 title=None,
2406 show_traces="auto",
2407 src=None,
2408 volume_options=1.0,
2409 view_layout="vertical",
2410 add_data_kwargs=None,
2411 brain_kwargs=None,
2412 verbose=None,
2413):
2414 """Plot SourceEstimate.
2415
2416 Parameters
2417 ----------
2418 stc : SourceEstimate
2419 The source estimates to plot.
2420 %(subject_none)s
2421 If ``None``, ``stc.subject`` will be used.
2422 surface : str
2423 The type of surface (inflated, white etc.).
2424 hemi : str
2425 Hemisphere id (ie ``'lh'``, ``'rh'``, ``'both'``, or ``'split'``). In
2426 the case of ``'both'``, both hemispheres are shown in the same window.
2427 In the case of ``'split'`` hemispheres are displayed side-by-side
2428 in different viewing panes.
2429 %(colormap)s
2430 The default ('auto') uses ``'hot'`` for one-sided data and
2431 'mne' for two-sided data.
2432 %(time_label)s
2433 smoothing_steps : int
2434 The amount of smoothing.
2435 %(transparent)s
2436 alpha : float
2437 Alpha value to apply globally to the overlay. Has no effect with mpl

Callers 4

test_process_clim_plotFunction · 0.90
test_link_brainsFunction · 0.90
plotMethod · 0.85

Calls 10

_check_stc_srcFunction · 0.85
_validate_typeFunction · 0.85
get_subjects_dirFunction · 0.85
_check_subjectFunction · 0.85
_check_optionFunction · 0.85
_get_3d_backendFunction · 0.85
warnFunction · 0.85
_plot_mpl_stcFunction · 0.85
use_3d_backendFunction · 0.85
_plot_stcFunction · 0.85

Tested by 3

test_process_clim_plotFunction · 0.72
test_link_brainsFunction · 0.72