fsleyes.controls.overlayinfopanel

This module provides the OverlayInfoPanel class, a FSLeyes control panel which displays information about the currently selected overlay.

fsleyes.controls.overlayinfopanel.USE_HTML2 = False

Toggle this flag to switch between the simple wx.html renderer, and the webkit-backed wx.html2 renderer. Webkit is not necessarily present on all systems, and there’s no neat way to dynamically test whether wx.html2 will work. So I’m sticking with wx.html for now.

class fsleyes.controls.overlayinfopanel.OverlayInfoPanel(parent, overlayList, displayCtx, frame)

Bases: fsleyes.controls.controlpanel.ControlPanel

An OverlayInfoPanel is a ControlPanel which displays information about the currently selected overlay in a wx.html.HtmlWindow. The currently selected overlay is defined by the DisplayContext.selectedOverlay property. An OverlayInfoPanel looks something like the following:

_images/overlayinfopanel.png

Slightly different information is shown depending on the overlay type, and is generated by the following methods:

Image __getImageInfo()
FEATImage __getFEATImageInfo()
MelodicImage __getMelodicImageInfo()
DTIFitTensor __getDTIFitTensorInfo()
Mesh __getMeshInfo()
VTKMesh __getVTKMeshInfo()
GiftiMesh __getGiftiMeshInfo()
FreesurferMesh __getFreesurferMeshInfo()
__init__(parent, overlayList, displayCtx, frame)

Create an OverlayInfoPanel.

Parameters:
destroy()

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

_optProps = <MagicMock name='mock.utils.typedict.TypeDict()' id='139845843052696'>

This dictionary contains a list of DisplayOpts properties that, when changed, should result in the information being refreshed. It is used by the __registerOverlay() and __deregisterOverlay() methods.

_OverlayInfoPanel__deregisterOverlay()

De-registers property listeners from the overlay that was previously registered via __registerOverlay().

_OverlayInfoPanel__formatArray(array)

Creates and returns a string containing a HTML table which formats the data in the given numpy.array.

_OverlayInfoPanel__formatOverlayInfo(info)

Creates and returns a string containing some HTML which formats the information in the given OverlayInfo instance.

_OverlayInfoPanel__getDTIFitTensorInfo(overlay, display)

Creates and returns an OverlayInfo object containing information about the given DTIFitTensor overlay.

Parameters:
  • overlay – A DTIFitTensor instance.
  • display – The Display instance assocated with the DTIFitTensor.
_OverlayInfoPanel__getDicomImageInfo(overlay, display)

Creates and returns an OverlayInfo object containing information about the given DicomImage overlay.

Parameters:
  • overlay – A DicomImage instance.
  • display – The Display instance assocated with the DicomImage.
_OverlayInfoPanel__getFEATImageInfo(overlay, display)

Creates and returns an OverlayInfo object containing information about the given FEATImage overlay.

Parameters:
  • overlay – A FEATImage instance.
  • display – The Display instance assocated with the FEATImage.
_OverlayInfoPanel__getFreesurferMeshInfo(overlay, display)

Creates and returns an OverlayInfo object containing information about the given FreesurferMesh overlay.

Parameters:
  • overlay – A FreesurferMesh instance.
  • display – The Display instance assocated with the FreesurferMesh.
_OverlayInfoPanel__getGiftiMeshInfo(overlay, display)

Creates and returns an OverlayInfo object containing information about the given GiftiMesh overlay.

Parameters:
  • overlay – A GiftiMesh instance.
  • display – The Display instance assocated with the GiftiMesh.
_OverlayInfoPanel__getImageInfo(overlay, display, title=None)

Creates and returns an OverlayInfo object containing information about the given Image overlay.

Parameters:
  • overlay – A Image instance.
  • display – The Display instance assocated with the Image.
_OverlayInfoPanel__getMGHImageInfo(overlay, display)

Creates and returns an OverlayInfo object containing information about the given MGHImage overlay.

Parameters:
  • overlay – A MGHImage instance.
  • display – The Display instance assocated with the DicomImage.
_OverlayInfoPanel__getMelodicImageInfo(overlay, display)

Creates and returns an OverlayInfo object containing information about the given MelodicImage overlay.

Parameters:
  • overlay – A MelodicImage instance.
  • display – The Display instance assocated with the MelodicImage.
_OverlayInfoPanel__getMeshInfo(overlay, display)

Creates and returns an OverlayInfo object containing information about the given Mesh overlay.

Parameters:
  • overlay – A Mesh instance.
  • display – The Display instance assocated with the Mesh.
_OverlayInfoPanel__getVTKMeshInfo(overlay, display)

Creates and returns an OverlayInfo object containing information about the given VTKMesh overlay.

Parameters:
  • overlay – A VTKMesh instance.
  • display – The Display instance assocated with the VTKMesh.
_OverlayInfoPanel__overlayNameChanged(*a)

Called when the Display.name for the current overlay changes. Updates the information display.

_OverlayInfoPanel__overlayOptsChanged(*a)

Called when any DisplayOpts properties for the current overlay change. Updates the information display. The properties that trigger a refresh are defined in the _optProps dictionary.

_OverlayInfoPanel__overlayTypeChanged(*a)

Called when the Display.overlayType for the current overlay changes. Re-registers with the Display and DisplayOpts instances associated with the overlay.

_OverlayInfoPanel__registerOverlay(overlay)

Registers property listeners with the given overlay so the information can be refreshed when necessary.

_OverlayInfoPanel__selectedOverlayChanged(*a)

Called when the OverlayList or DisplayContext.selectedOverlay changes. Refreshes the information shown on this OverlayInfoPanel.

_OverlayInfoPanel__updateInformation()

Refreshes the information shown on this OverlayInfoPanel. Called by the __selectedOverlayChanged() and __overlayNameChanged() methods.

__module__ = 'fsleyes.controls.overlayinfopanel'
class fsleyes.controls.overlayinfopanel.OverlayInfo(title)

Bases: object

A little class which encapsulates human-readable information about one overlay. OverlayInfo objects are created and returned by the OverlayInfoPanel.__get*Info methods.

The information stored in an OverlayInfo instance is organised into sections. Within each section, information is organised into key-value pairs. The order in which both OverlayInfo sections, and information, is ultimately output, is the order in which the sections/information are added, via the addSection() and addInfo() methods.

__init__(title)

Create an OverlayInfo instance.

Parameters:title – The OverlaytInfo title.
__dict__ = mappingproxy({'__module__': 'fsleyes.controls.overlayinfopanel', '__doc__': 'A little class which encapsulates human-readable information about\n one overlay. ``OverlayInfo`` objects are created and returned by the\n ``OverlayInfoPanel.__get*Info`` methods.\n\n The information stored in an ``OverlayInfo`` instance is organised into\n *sections*. Within each section, information is organised into key-value\n pairs. The order in which both ``OverlayInfo`` sections, and information,\n is ultimately output, is the order in which the sections/information are\n added, via the :meth:`addSection` and :meth:`addInfo` methods.\n ', '__init__': <function OverlayInfo.__init__>, 'addSection': <function OverlayInfo.addSection>, 'addInfo': <function OverlayInfo.addInfo>, '__dict__': <attribute '__dict__' of 'OverlayInfo' objects>, '__weakref__': <attribute '__weakref__' of 'OverlayInfo' objects>})
__module__ = 'fsleyes.controls.overlayinfopanel'
__weakref__

list of weak references to the object (if defined)

addSection(section)

Add a section to this OverlayInfo instance.

Parameters:section – The section name.
addInfo(name, info, section=None)

Add some information to this OverlayInfo instance.

Parameters:
  • name – The information name.
  • info – The information value.
  • section – Section to place the information in.