eelbrain.plot.UTSClusters

class eelbrain.plot.UTSClusters(res, pmax=0.05, ptrend=0.1, axtitle=True, cm=None, overlay=False, xticklabels='bottom', yticklabels='left', **kwargs)

Plot permutation cluster test results

Parameters

  • res (testnd.ANOVA) – ANOVA with permutation cluster test result object.

  • pmax (scalar) – Maximum p-value of clusters to plot as solid.

  • ptrend (scalar) – Maximum p-value of clusters to plot as trend.

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

  • cm (str) – Colormap to use for coloring different effects.

  • overlay (bool) – Plot epochs (time course for different effects) on top of each other (as opposed to on separate axes).

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

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

  • .. – Also accepts General layout parameters.

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

close()

Close the figure.

draw()

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

draw_crosshairs([enable])

Draw crosshairs under the cursor

image([name, format, close])

Create FMTXT Image from the figure

save(*args, **kwargs)

Short-cut for Matplotlib’s savefig()

set_name(name)

Set the figure window title

set_pmax([pmax, ptrend])

Set the threshold p-value for clusters to be displayed

set_xlabel(label[, ax])

Set the label for the x-axis

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