class eelbrain.plot.Topomap(y, xax=None, ds=None, sub=None, vmax=None, vmin=None, cmap=None, contours=None, proj='default', res=None, interpolation=None, clip='even', clip_distance=0.05, head_radius=None, head_pos=0, im_interpolation=None, sensorlabels=None, mark=None, mcolor=None, axtitle=True, xlabel=None, margins=None, **kwargs)

Plot individual topogeraphies

y : (list of) NDVar, dims = ([case,] sensor,)

Data to plot.

xax : None | categorial

Create a separate plot for each cell in this model.

ds : None | Dataset

If a Dataset is provided, data can be specified as strings.

sub : str | array

Specify a subset of the data.

vmax : scalar

Upper limits for the colormap (default is determined from data).

vmin : scalar

Lower limit for the colormap (default -vmax).

cmap : str

Colormap (default depends on the data).

contours : int | sequence | dict

Contours to draw on topomaps. Can be an int (number of contours, including vmin/vmax), a sequence (values at which to draw contours), or a **kwargs dict (must contain at least the “levels” key). Default is no contours.

proj : str | list of str

The sensor projection to use for topomaps (or one projection per plot).

res : int

Resolution of the topomaps (width = height = res).

interpolation : ‘nearest’ | ‘linear’ | ‘spline’

Method for interpolating topo-map between sensors (default is based on mne-python).

clip : bool | ‘even’ | ‘circle’

Outline for clipping topomaps: ‘even’ to clip at a constant distance (default), ‘circle’ to clip using a circle.

clip_distance : scalar

How far from sensor locations to clip (1 is the axes height/width).

head_radius : scalar | tuple

Radius of the head outline drawn over sensors (on sensor plots with normalized positions, 0.45 is the outline of the topomap); 0 to plot no outline; tuple for separate (right, anterior) radius. The default is determined automatically.

head_pos : scalar

Head outline position along the anterior axis (0 is the center, 0.5 is the top end of the plot).

im_interpolation : str

Topomap image interpolation (see Matplotlib’s imshow()). Matplotlib 1.5.3’s SVG output can’t handle uneven aspect with interpolation='none', use interpolation='nearest' instead.

sensorlabels : ‘none’ | ‘index’ | ‘name’ | ‘fullname’

Show sensor labels. For ‘name’, any prefix common to all names is removed; with ‘fullname’, the full name is shown.

mark : Sensor index

Sensors which to mark.

mcolor : matplotlib color

Color for marked sensors.

axtitle : bool | sequence of str

Title for the individual axes. The default is to show the names of the epochs, but only if multiple axes are plotted.

xlabel : str

Label below the topomaps (default is no label).

margins : dict

Layout parameter.

Also accepts General layout parameters.


  • t: open a Topomap plot for the region under the mouse pointer.
  • T: open a larger Topomap plot with visible sensor names for the map under the mouse pointer.


add_contour(self, level[, color, meas]) Add a contour line
add_hline(self, y[, axes]) Draw a horizontal line on one or more axes
add_hspan(self, bottom, top[, axes]) Draw a horizontal bar on one or more axes
add_vline(self, x[, axes]) Draw a vertical line on one or more axes
add_vspan(self, xmin, xmax[, axes]) Draw a vertical bar on one or more axes
close(self) Close the figure.
draw(self) (Re-)draw the figure (after making manual changes).
draw_crosshairs(self[, enable]) Draw crosshairs under the cursor
get_vlim(self[, meas]) Retrieve colormap value limits as (vmin, vmax) tuple
image(self[, name, format]) Create FMTXT Image from the figure
mark_sensors(self, sensors[, axis, s, c, marker]) Mark given sensors on the plots
plot_colorbar(self[, label, label_position, …]) Plot a colorbar corresponding to the displayed data
save(self, *args, **kwargs) Short-cut for Matplotlib’s savefig()
separate_labels(self[, pad]) Move overlapping labels apart along the x axis
set_cmap(self, cmap[, meas]) Change the colormap in the array plots
set_label_color(self[, color])
set_label_text(self[, text]) Add/remove sensor labels
set_name(self, name) Set the figure window title
set_vlim(self[, v, vmax, meas]) Change the colormap limits
set_xlabel(self, label[, ax]) Set the label for the x-axis
set_xtick_rotation(self, rotation) Rotate every x-axis tick-label by an angle (counterclockwise, in degrees)
set_ylabel(self, label[, ax]) Set the label for the y-axis