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.utils.all_displays

nilearn.utils.all_displays(type_filter=None)

Get a list of all ‘displays’ objects from nilearn.

Parameters:

type_filter{“slicer”, “axe”} or list of such strings, default=None

Which kind of display object should be returned. If None, no filter is applied and all objects are returned. Possible values are “slicer”, “axe” to get only these specific types, or a list of display objects that fit at least one of the types.

Returns:

displayslist of tuples

List of (name, class), where name is the display class name as string and class is the actual type of the class.