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_projector

nilearn.plotting.displays.get_projector(display_mode)

Retrieve a projector from a given display mode.

Parameters:

display_mode{“ortho”, “xz”, “yz”, “yx”, “x”, “y”, “z”, “lzry”, “lyrz”, “lyr”, “lzr”, “lr”, “l”, “r”}

The desired display mode.

Returns:

projectorOrthoProjector or instance of derived classes

The projector corresponding to the requested display mode:

• “ortho”: Returns an OrthoProjector.

• “xz”: Returns a XZProjector.

• “yz”: Returns a YZProjector.

• “yx”: Returns a YXProjector.

• “x”: Returns a XProjector.

• “y”: Returns a YProjector.

• “z”: Returns a ZProjector.

• “lzry”: Returns a LZRYProjector.

• “lyrz”: Returns a LYRZProjector.

• “lyr”: Returns a LYRProjector.

• “lzr”: Returns a LZRProjector.

• “lr”: Returns a LRProjector.

• “l”: Returns a LProjector.

• “z”: Returns a RProjector.