fsleyes.controls.overlaydisplaytoolbar

This module provides the OverlyDisplyaToolBar, a ControlToolBar containing controls for changing the display settings of the currently selected overlay.

class fsleyes.controls.overlaydisplaytoolbar.OverlayDisplayToolBar(parent, overlayList, displayCtx, frame, viewPanel)

Bases: fsleyes.controls.controlpanel.ControlToolBar

The OverlyDisplyaToolBar is a ControlToolBar containing controls which allow the user to change the display settings of the currently selected overlay (as defined by the DisplayContext.selectedOverlay property). The display settings for an overlay are contained in the Display and DisplayOpts instances that are associated with that overlay.

An OverlyDisplyaToolBar looks something like the following:

The specific controls which are displayed are defined in the _TOOLBAR_PROPS dictionary, and are created by the following methods:

_OverlayDisplayToolBar__makeDisplayTools	Creates and returns a collection of controls for editing properties of the given Display instance.
_OverlayDisplayToolBar__makeVolumeOptsTools	Creates and returns a collection of controls for editing properties of the given VolumeOpts instance.
_OverlayDisplayToolBar__makeMaskOptsTools	Creates and returns a collection of controls for editing properties of the given MaskOpts instance.
_OverlayDisplayToolBar__makeLabelOptsTools	Creates and returns a collection of controls for editing properties of the given LabelOpts instance.
_OverlayDisplayToolBar__makeVectorOptsTools	Creates and returns a collection of controls for editing properties of the given VectorOpts instance.
_OverlayDisplayToolBar__makeRGBVectorOptsTools	Creates and returns a collection of controls for editing properties of the given RGBVectorOpts instance.
_OverlayDisplayToolBar__makeLineVectorOptsTools	Creates and returns a collection of controls for editing properties of the given LineVectorOpts instance.
_OverlayDisplayToolBar__makeMeshOptsTools	Creates and returns a collection of controls for editing properties of the given MeshOpts instance.
_OverlayDisplayToolBar__makeGiftiOptsTools	Creates and returns a collection of controls for editing properties of the given GiftiOpts instance.
_OverlayDisplayToolBar__makeFreesurferOptsTools	Creates and returns a collection of controls for editing properties of the given FreesurferOpts instance.
_OverlayDisplayToolBar__makeTensorOptsTools	Creates and returns a collection of controls for editing properties of the given TensorOpts instance.
_OverlayDisplayToolBar__makeSHOptsTools	Creates and returns a collection of controls for editing properties of the given SHOpts instance.
_OverlayDisplayToolBar__makeMIPOptsTools	Creates and returns a collection of controls for editing properties of the given MIPOpts instance.

__init__(parent, overlayList, displayCtx, frame, viewPanel)

Create an OverlyDisplyaToolBar.

Parameters

• parent – The wx parent object.

• overlayList – The OverlayList instance.

• displayCtx – The DisplayContext instance.

• frame – The FSLeyesFrame instance.

• viewPanel – The ViewPanel which this OverlayDisplayToolBar is owned by.

destroy()

Must be called when this OverlyDisplyaToolBar is no longer needed. Removes some property listeners, and calls the ControlToolBar.destroy() method.

static supportedViews()

Overrides ControlMixin.supportedViews(). The OverlayDisplayToolBar is only intended to be added to OrthoPanel, LightBoxPanel, or Scene3DPanel views.

_OverlayDisplayToolBar__makeComplexOptsTools(opts)

Creates and returns a collection of controls for editing properties of the given ComplexOpts instance.

_OverlayDisplayToolBar__makeDisplayTools(display)

Creates and returns a collection of controls for editing properties of the given Display instance.

_OverlayDisplayToolBar__makeFreesurferOptsTools(opts)

Creates and returns a collection of controls for editing properties of the given FreesurferOpts instance.

_OverlayDisplayToolBar__makeGiftiOptsTools(opts)

Creates and returns a collection of controls for editing properties of the given GiftiOpts instance.

_OverlayDisplayToolBar__makeLabelOptsTools(opts)

Creates and returns a collection of controls for editing properties of the given LabelOpts instance.

_OverlayDisplayToolBar__makeLineVectorOptsTools(opts)

Creates and returns a collection of controls for editing properties of the given LineVectorOpts instance.

_OverlayDisplayToolBar__makeMIPOptsTools(opts)

Creates and returns a collection of controls for editing properties of the given MIPOpts instance.

_OverlayDisplayToolBar__makeMaskOptsTools(opts)

Creates and returns a collection of controls for editing properties of the given MaskOpts instance.

_OverlayDisplayToolBar__makeMeshOptsTools(opts)

Creates and returns a collection of controls for editing properties of the given MeshOpts instance.

_OverlayDisplayToolBar__makeRGBVectorOptsTools(opts)

Creates and returns a collection of controls for editing properties of the given RGBVectorOpts instance.

_OverlayDisplayToolBar__makeSHOptsTools(opts)

Creates and returns a collection of controls for editing properties of the given SHOpts instance.

_OverlayDisplayToolBar__makeTensorOptsTools(opts)

Creates and returns a collection of controls for editing properties of the given TensorOpts instance.

_OverlayDisplayToolBar__makeVectorOptsTools(opts)

Creates and returns a collection of controls for editing properties of the given VectorOpts instance.

_OverlayDisplayToolBar__makeVolumeOptsTools(opts)

Creates and returns a collection of controls for editing properties of the given VolumeOpts instance.

_OverlayDisplayToolBar__overlayEnableChanged(*a)

Called when the Display.enabled property for the currently selected overlay changes. Enables/disables this OverlayDisplayToolBar accordingly.

_OverlayDisplayToolBar__selectedOverlayChanged(*a)

Called when the DisplayContext.selectedOverlay or OverlayList changes. Ensures that controls for the currently selected overlay are being shown.

_OverlayDisplayToolBar__showTools(overlay)

Creates and shows a set of controls allowing the user to change the display settings of the specified overlay.

__module__ = 'fsleyes.controls.overlaydisplaytoolbar'

fsleyes.controls.overlaydisplaytoolbar._imageLabel(img)

Used to generate labels for the VectorOpts.modulateImage, VectorOpts.clipImage, and other Image-based choice properties.

fsleyes.controls.overlaydisplaytoolbar._pathLabel(p)

fsleyes.controls.overlaydisplaytoolbar._TOOLTIPS = <MagicMock name='mock.utils.typedict.TypeDict()' id='281473492539520'>

This dictionary contains tooltips for Display and DisplayOpts properties. It is referenced in the _TOOLBAR_PROPS dictionary definition.

fsleyes.controls.overlaydisplaytoolbar._TOOLBAR_PROPS = <MagicMock name='mock.utils.typedict.TypeDict()' id='281473492539520'>

This dictionary defines specifications for all controls shown on an OverlayDisplayToolBar.