Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.

nilearn.plotting.displays.get_slicer

nilearn.plotting.displays.get_slicer(display_mode)

Retrieve a slicer from a given display mode.

Parameters:

display_modestr

The desired display mode. Possible options are:

• “ortho”: Three cuts are performed in orthogonal directions.

• “tiled”: Three cuts are performed and arranged in a 2x2 grid.

• “mosaic”: Three cuts are performed along multiple rows and columns.

• “x”: Sagittal

• “y”: Coronal

• “z”: Axial

• “xz”: Sagittal + Axial

• “yz”: Coronal + Axial

• “yx”: Coronal + Sagittal

Returns:

slicerAn instance of one of the subclasses of BaseSlicer

The slicer corresponding to the requested display mode:

• “ortho”: Returns an

  OrthoSlicer.

• “tiled”: Returns a

  TiledSlicer.

• “mosaic”: Returns a

  MosaicSlicer.

• “xz”: Returns a

  XZSlicer.

• “yz”: Returns a

  YZSlicer.

• “yx”: Returns a

  YZSlicer.

• “x”: Returns a

  XSlicer.

• “y”: Returns a

  YSlicer.

• “z”: Returns a

  ZSlicer.