eelbrain.plot.UTS

class eelbrain.plot.UTS(y, xax=None, axtitle=True, ds=None, sub=None, xlabel=True, ylabel=True, xticklabels='bottom', yticklabels='left', bottom=None, top=None, legend=None, labels=None, xlim=None, clip=None, colors=None, color=None, stem=False, **kwargs)

Value by time plot for UTS data

Parameters
  • y ((list of) NDVar) – Uts data to plot.

  • xax (categorial) – Make separate axes for each category in this categorial model.

  • 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.

  • ds (Dataset) – If a Dataset is specified, all data-objects can be specified as names of Dataset variables.

  • sub (str | array) – Specify a subset of the data.

  • xlabel (Union[bool, str]) – X-axis label. By default the label is inferred from the data.

  • ylabel (Union[bool, str]) – Y-axis label. By default the label is inferred from the data.

  • xticklabels (Union[str, int, Sequence[int]]) – Specify which axes should be annotated with x-axis tick labels. Use int for a single axis, a sequence of int for multiple specific axes, or one of 'left' | 'bottom' | 'all' | 'none'.

  • yticklabels (Union[str, int, Sequence[int]]) – Specify which axes should be annotated with y-axis tick labels. Use int for a single axis, a sequence of int for multiple specific axes, or one of 'left' | 'bottom' | 'all' | 'none'.

  • bottom (Optional[float]) – The lower end of the plot’s y axis.

  • top (Optional[float]) – The upper end of the plot’s y axis.

  • legend (Union[str, int, Tuple[float, float], bool, None]) – Matplotlib figure legend location argument or ‘fig’ to plot the legend in a separate figure.

  • labels (Optional[Dict[Union[str, Tuple[str, ...]], str]]) – Alternative labels for legend as {cell: label} dictionary (preserves order).

  • xlim (Union[float, Tuple[float, float], None]) – Initial x-axis view limits as (left, right) tuple or as length scalar (default is the full x-axis in the data).

  • clip (Optional[bool]) – Clip lines outside of axes (the default depends on whether frame is closed or open).

  • colors (Union[Any, dict, None]) – Dictionary mapping y names to color, or a single color to use for all lines.

  • stem (bool) – Plot as stem-plot (default is a line-plot).

  • tight (bool) – Use matplotlib’s tight_layout to expand all axes to fill the figure (default True)

  • ... – Also accepts General layout parameters.

Notes

Navigation:
  • : scroll up

  • : scroll down

  • : scroll left

  • : scroll right

  • home: scroll to beginning

  • end: scroll to end

  • f: x-axis zoom in (reduce x axis range)

  • d: x-axis zoom out (increase x axis range)

  • r: y-axis zoom in (reduce y-axis range)

  • c: y-axis zoom out (increase y-axis range)

Methods

add_hline(y[, axes])

Draw a horizontal line on one or more axes

add_hspan(bottom, top[, axes])

Draw a horizontal bar on one or more axes

add_vline(x[, axes])

Draw a vertical line on one or more axes

add_vspan(xmin, xmax[, axes])

Draw a vertical bar on one or more axes

add_vspans(intervals[, axes])

Draw vertical bars over axes

close()

Close the figure.

draw()

(Re-)draw the figure (after making manual changes).

draw_crosshairs([enable])

Draw crosshairs under the cursor

draw_outline([color])

Draw the outline of the figure

get_time()

Retrieve the current time

get_xlim()

get_ylim()

image([name, format, close])

Create FMTXT Image from the figure

link_time_axis(other)

Link the time axis of this figure with another figure

play_movie([time_dilation])

Cycle through the time axis

plot_legend([loc, labels])

Plot the legend (or remove it from the figure).

save(*args, **kwargs)

Short-cut for Matplotlib's savefig()

save_legend(*args, **kwargs)

Save the legend as image file

save_movie([filename, time_dilation])

Save the figure with moving time axis as movie

set_name(name)

Set the figure window title

set_time(time)

Set the time point to display

set_xlabel(label[, ax])

Set the label for the x-axis

set_xlim([left, right])

Set the x-axis limits for all axes

set_xtick_rotation(rotation)

Rotate every x-axis tick-label by an angle (counterclockwise, in degrees)

set_ylabel(label[, ax])

Set the label for the y-axis

set_ylim([bottom, top])

Set the y-axis limits