plot_montage

plot_montage(
    vol,
    axis=2,
    n_slices=16,
    cmap="gray",
    ncols=4,
    title=None,
    figsize=None,
    axes=None,
    *,
    zlevels=None,
    along=None,
    range="robust",
    probs=(0.02, 0.98),
    colorbar=False,
)

Show multiple world-oriented slices along one axis in a grid.

Parameters

Name Type Description Default
vol NeuroVol or array-like 3D volume to display. NeuroVol inputs use spatial orientation and world extents. required
axis int or str Slice axis: 0/"x", 1/"y", or 2/"z". 2
n_slices int Number of evenly spaced slices when zlevels is omitted. 16
cmap str, sequence, or Colormap Matplotlib colormap or neuroim alias. "gray"
ncols int Number of columns in the grid. 4
title str Figure title. None
figsize tuple Figure size. Computed from panel count when omitted. None
axes array-like of Axes Existing axes. Must contain at least the number of displayed slices. None
zlevels sequence of int Python slice indices to display. None
along int neuroim2-style one-based slice axis. Overrides axis when provided. None
range str or tuple Display range: "robust", "data", or explicit (lo, hi). "robust"
probs tuple Quantiles used for robust ranges. (0.02, 0.98)
colorbar bool Draw a shared colorbar. False

Returns

Name Type Description
(fig, axes) tuple Matplotlib Figure and grid Axes.
Back to top