fsleyes.views.colourbarpanel

This module provides the ColourBarPanel, a FSLeyesPanel which renders a colour bar.

class fsleyes.views.colourbarpanel.ColourBarPanel(parent, overlayList, displayCtx, frame)

Bases: fsleyes.panel.FSLeyesPanel

The ColourBarPanel is a panel which shows a colour bar, depicting the data range of the currently selected overlay (if applicable). A ColourBarCanvas is used to render the colour bar.

Note

Currently, the ColourBarPanel will only display a colour bar for overlays which are associated with a ColourMapOpts instance.

__init__(parent, overlayList, displayCtx, frame)

Create a ColourBarPanel.

Parameters

• parent – The wx parent object.

• overlayList – The OverlayList instance.

• displayCtx – The DisplayContext instance.

• frame – The FSLeyesFrame.

getCanvas()

Returns the ColourBarCanvas which displays the rendered colour bar.

property canvas

Returns the ColourBarCanvas which displays the rendered colour bar.

property colourBar

Returns the ColourBar which generates the colour bar bitmap.

destroy()

Must be called when this ColourBarPanel is no longer needed.

__layout(*a)

Called when this ColourBarPanel needs to be laid out. Sets the panel size, and calls the __refreshColourBar() method.

__module__ = 'fsleyes.views.colourbarpanel'