fsleyes.controls.colourbar

This module provides the ColourBar class, which generates a bitmap rendering of a colour bar.

fsleyes.controls.colourbar.colourBarMinorAxisSize(fontSize)

Calculates a good size for the minor axis of a colour bar.

The minor axis is the axis perpendicular to the colour bar axis.

Parameters

fontSize – Font size of colour bar labels, in points.

class fsleyes.controls.colourbar.ColourBar(overlayList, displayCtx)

Bases: __main__.MockClass, __main__.MockClass

A ColourBar is an object which listens to the properties of a ColourMapOpts instance, and automatically generates a colour bar bitmap representing the current colour map properties.

Whenever the colour bar is refreshed, a notification is emitted via the Notifier interface.

orientation = <MagicMock name='mock.Choice()' id='140127690793744'>

Whether the colour bar should be vertical or horizontal.

labelSide = <MagicMock name='mock.Choice()' id='140127690793744'>

Whether the colour bar labels should be on the top/left, or bottom/right of the colour bar (depending upon whether the colour bar orientation is horizontal/vertical).

textColour = <MagicMock name='mock.Colour()' id='140127688258320'>

Colour to use for the colour bar label.

bgColour = <MagicMock name='mock.Colour()' id='140127688258320'>

Colour to use for the background.

showLabel = <MagicMock name='mock.Boolean()' id='140127691212880'>

Toggle the colour bar label (the Display.name property).

showTicks = <MagicMock name='mock.Boolean()' id='140127691212880'>

Toggle the tick labels (the ColourMapOpts.displayRange).

fontSize = <MagicMock name='mock.Int()' id='140127690867088'>

Size of the font used for the text on the colour bar.

__init__(overlayList, displayCtx)

Create a ColourBar.

Parameters
_ColourBar__clearColourBar(*a)

Clears any previously generated colour bar bitmap.

_ColourBar__deregisterOverlay()

Called when the selected overlay changes. De-registers property listeners from any previously-registered ColourMapOpts instance.

_ColourBar__registerOverlay()

Called when the selected overlay changes. Registers property listeners with the ColourMapOpts instance associated with the newly selected overlay.

_ColourBar__selectedOverlayChanged(*a)

Called when the OverlayList or the DisplayContext.selectedOverlay changes.

If the newly selected overlay is being displayed with a ColourMapOpts instance, various property listeners are registered, and the colour bar is refreshed.

__module__ = 'fsleyes.controls.colourbar'
property name

Return the name of this ColourBar, used internally for registering property listeners.

destroy()

Must be called when this ColourBar is no longer needed.

Removes all registered listeners from the OverlayList, DisplayContext, and foom individual overlays.

colourBar(w, h, scale=1)

Returns a bitmap containing the rendered colour bar, rendering it if necessary.

Parameters
  • w – Width in pixels

  • h – Height in pixels

  • scale – DPI scaling factor, if applicable.