envtopo

envtopo(data, weights, *, chanlocs=None, icawinv=None, timerange=None, limcontrib=None, compnums=None, compsplot=7, subcomps=0, sortvar='mp', envmode='avg', sumenv='fill', vert=None, plotchans=None, title='', topoplot_options=None)

Rank component contributions to a data epoch and plot their envelopes/maps.

Left-clicking the envelope panel or a scalp map enlarges it in a pop-up window.

Parameters:

• data (Any) – Channels x frames, or channels x frames x epochs (epochs averaged).

• weights (Any) – ICA unmixing matrix icaweights @ icasphere (components x channels).

• chanlocs (Any) – Channel locations for the scalp maps, or None to skip the maps.

• icawinv (Any) – ICA mixing matrix (channels x components); defaults to pinv(weights).

• timerange (Any) – [min max] epoch latencies in ms used to label the time axis.

• limcontrib (Any) – [min max] ms window in which contributions are ranked.

• compnums (Any) – 1-based candidate components to rank; defaults to all.

• compsplot (int) – Number of largest contributors to plot (capped at 20).

• subcomps (Any) – 1-based components to remove before plotting; 0 removes none, [] removes all but compnums.

• sortvar (str) – Ranking metric 'mp' (default), 'pv', 'pp' or 'rp'.

• envmode (str) – 'avg' (max/min envelope) or 'rms'.

• sumenv (str) – Summed-contribution envelope: 'fill' (default), 'on' (lines only) or 'off'.

• vert (Any) – Latencies (ms) at which to draw vertical dashed marker lines.

• plotchans (Any) – 1-based channels used for envelopes and maps; defaults to all.

• title (str) – Figure title.

• topoplot_options (dict[str, Any] | None) – Extra keyword arguments forwarded to topoplot().

Returns:

ranking outputs and the matplotlib figure.

Return type:

EnvtopoResult