cortex.quickflat.composite.add_colorbar

cortex.quickflat.composite.add_colorbar(fig: Figure, cimg: AxesImage, colorbar_ticks: ArrayLike | None = None, colorbar_location: tuple[float, float, float, float] = (0.4, 0.07, 0.2, 0.04), orientation: str = 'horizontal') → Axes

Add a colorbar to a flatmap plot

Parameters:

figmatplotlib Figure object

Figure into which to insert colormap

cimgmatplotlib.image.AxesImage object

Image for which to create colorbar. For reference, matplotlib.image.AxesImage is the output of imshow()

colorbar_ticksarray-like

values for colorbar ticks

colorbar_locationarray-like

Four-long list, tuple, or array that specifies location for colorbar axes [left, top, width, height] (?)

orientationstring

‘vertical’ or ‘horizontal’