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)[source]¶ Bases:
fsleyes.controls.controlpanel.ControlToolBar
The
OverlyDisplyaToolBar
is aControlToolBar
containing controls which allow the user to change the display settings of the currently selected overlay (as defined by theDisplayContext.selectedOverlay
property). The display settings for an overlay are contained in theDisplay
andDisplayOpts
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:Creates and returns a collection of controls for editing properties of the given
Display
instance.Creates and returns a collection of controls for editing properties of the given
VolumeOpts
instance.Creates and returns a collection of controls for editing properties of the given
MaskOpts
instance.Creates and returns a collection of controls for editing properties of the given
LabelOpts
instance.Creates and returns a collection of controls for editing properties of the given
VectorOpts
instance.Creates and returns a collection of controls for editing properties of the given
RGBVectorOpts
instance.Creates and returns a collection of controls for editing properties of the given
LineVectorOpts
instance.Creates and returns a collection of controls for editing properties of the given
MeshOpts
instance.Creates and returns a collection of controls for editing properties of the given
GiftiOpts
instance.Creates and returns a collection of controls for editing properties of the given
FreesurferOpts
instance.Creates and returns a collection of controls for editing properties of the given
TensorOpts
instance.Creates and returns a collection of controls for editing properties of the given
SHOpts
instance.Creates and returns a collection of controls for editing properties of the given
MIPOpts
instance.-
__init__
(parent, overlayList, displayCtx, frame, viewPanel)[source]¶ 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 thisOverlayDisplayToolBar
is owned by.
-
destroy
()[source]¶ Must be called when this
OverlyDisplyaToolBar
is no longer needed. Removes some property listeners, and calls theControlToolBar.destroy()
method.
-
static
supportedViews
()[source]¶ Overrides
ControlMixin.supportedViews()
. TheOverlayDisplayToolBar
is only intended to be added toOrthoPanel
,LightBoxPanel
, orScene3DPanel
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 thisOverlayDisplayToolBar
accordingly.
-
_OverlayDisplayToolBar__selectedOverlayChanged
(*a)¶ Called when the
DisplayContext.selectedOverlay
orOverlayList
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)[source]¶ Used to generate labels for the
VectorOpts.modulateImage
,VectorOpts.clipImage
, and otherImage
-based choice properties.
-
fsleyes.controls.overlaydisplaytoolbar.
_TOOLTIPS
= <MagicMock name='mock.utils.typedict.TypeDict()' id='140225911633040'>¶ This dictionary contains tooltips for
Display
andDisplayOpts
properties. It is referenced in the_TOOLBAR_PROPS
dictionary definition.
-
fsleyes.controls.overlaydisplaytoolbar.
_TOOLBAR_PROPS
= <MagicMock name='mock.utils.typedict.TypeDict()' id='140225911633040'>¶ This dictionary defines specifications for all controls shown on an
OverlayDisplayToolBar
.