plot_ortho

plot_ortho(
    vol,
    coords=None,
    title=None,
    cmap="gray",
    figsize=(12, 4),
    axes=None,
    *,
    coord_space="voxel",
    unit=None,
    range="robust",
    probs=(0.02, 0.98),
    crosshair=False,
    colorbar=False,
)

Display axial, sagittal, and coronal slices at a voxel or world coordinate.

Parameters

Name Type Description Default
vol NeuroVol or array-like 3D volume. NeuroVol inputs use spatial orientation and world extents. required
coords tuple Length-3 voxel/index or world/mm coordinate. Defaults to the volume center. None
title str Figure title. None
cmap str, sequence, or Colormap Matplotlib colormap or neuroim alias. "gray"
figsize tuple Figure size in inches when axes is not supplied. (12, 4)
axes array-like of Axes Three existing axes to draw into. None
coord_space, unit str "voxel"/"index" or "world"/"mm". unit is a compatibility alias. "voxel"
range str or tuple Display range: "robust", "data", or explicit (lo, hi). "robust"
probs tuple Quantiles used for robust ranges. (0.02, 0.98)
crosshair bool Draw crosshair lines at the selected coordinate. False
colorbar bool Draw a shared colorbar. False

Returns

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