eelbrain.plot.UTSStat.set_clusters

UTSStat.set_clusters(clusters, pmax=0.05, ptrend=None, color='.7', ax=None, y=None, dy=None, **kwargs)

Add clusters from a cluster test to the plot (as shaded area).

Parameters
  • clusters (Optional[Dataset]) – The clusters, as stored in test results’ clusters. Use None to remove the clusters plotted on a given axis.

  • pmax (float) – Only plot clusters with p <= pmax.

  • ptrend (Optional[float]) – Maximum p-value of clusters to plot as trend.

  • color (matplotlib color | dict) – Color for the clusters, or a {effect: color} dict.

  • ax (None | int) – Index of the axes to which the clusters are to be added. If None, add the clusters to all axes.

  • y (Union[float, Dict, None]) – Y level at which to plot clusters (default is boxes spanning the whole y-axis).

  • dy (Optional[float]) – Height of bars.

  • ... – Additional arguments for the matplotlib artists (e.g., zorder).