fsleyes.plugins.controls.melodicclassificationpanel.melodicclassificationpanel

This module provides the MelodicClassificationPanel class, a FSLeyes control panel which allows the user to classify the components of a MelodicImage.

class fsleyes.plugins.controls.melodicclassificationpanel.melodicclassificationpanel.MelodicClassificationPanel(parent, overlayList, displayCtx, canvasPanel)[source]

Bases: fsleyes.controls.controlpanel.ControlPanel

The MelodicClassificationPanel allows the user to view and modify classification labels associated with the volumes of an Image, most typically the components of a MelodicImage (but any 4D image will work).

A MelodicClassificationPanel displays two lists:

  • The ComponentGrid contains list of components, and the labels associated with each.

  • The LabelGrid contains list of labels, and the components associated with each.

And a handful of buttons which allow the user to:

  • Load a label file

  • Save the current labels to a file

  • Clear/reset the current labels

Internally, a VolumeLabels object is used to keep track of the component - label mappings. The VolumeLabels instance associated with each overlay is stored in the OverlayList via its OverlayList.setData() method.

static supportedViews()[source]

The MelodicClassificationPanel is restricted for use with OrthoPanel, LightBoxPanel and Scene3DPanel viewws.

static defaultLayout()[source]

Returns a dictionary of arguments to be passed to the ViewPanel.togglePanel() method.

__init__(parent, overlayList, displayCtx, canvasPanel)[source]

Create a MelodicClassificationPanel.

Parameters

  • parent – The wx parent object.

  • overlayList – The OverlayList.

  • displayCtx – The DisplayContext instance.

  • canvasPanel – The CanvasPanel that owns this classification panel.

destroy()[source]

Must be called when this MelodicClassificaiionPanel is no longer used. Removes listeners, and destroys widgets.

__enable(enable=True, message='')

Called internally. Enables/disables this MelodicClassificationPanel.

__deregisterOverlay()

Called by __selectedOverlayChanged(). Deregisters from the currently selected overlay.

__registerOverlay(overlay)

Called by __selectedOverlayChanged(). Registers with the given overlay.

Returns the VolumeLabels instance associated with the overlay (creating it if necessary).

__selectedOverlayChanged(*a)

Called when the DisplayContext.selectedOverlay or OverlayList.overlays changes.

The overlay is passed to the ComponentGrid.setOverlay() and LabelGrid.setOverlay() methods.

If the newly selected overlay is not a MelodicImage, this panel is disabled (via __enable()).

__volumeChanged(*a)

Called when the NiftiOpts.volume property of the currently selected overlay changes. Calls __updateTextAnnotation()

Note

This method is only called if the view panel that owns this MelodicClassificationPanel is a LightBoxPanel.

__labelsChanged(*a)

Called when the VolumeLabels object associated with the currently selected overlay changes. Calls __updateTextAnnotation()

Note

This method is only called if the view panel that owns this MelodicClassificationPanel is a LightBoxPanel.

__updateTextAnnotation()

Updates a text annotation on the LightBoxPanel canvas to display the labels associated with the volume (i.e. the current component).

__onLoadButton(ev)

Called when the Load labels button is pushed. Prompts the user to select a label file to load, then does the following:

  1. If the selected label file refers to the currently selected melodic_IC overlay, the labels are applied to the overlay.

  2. If the selected label file refers to a different melodic_IC overlay, the user is asked whether they want to load the different melodic_IC file (the default), or whether they want the labels applied to the existing overlay.

  3. If the selected label file does not refer to any overlay (it only contains the bad component list), the user is asked whether they want the labels applied to the current melodic_IC overlay.

If the number of labels in the file is less than the number of melodic_IC components, the remaining components are labelled as unknown. If the number of labels in the file is greater than the number of melodic_IC components, an error is shown, and nothing is done.

__onSaveButton(ev)

Called when the user pushe the Save labels button. Asks the user where they’d like the label saved, then saves said labels.

__onClearButton(ev)

Called when the user pushes the Clear labels button. Resets all of the labels (sets the label for every component to 'Unknown').

__module__ = 'fsleyes.plugins.controls.melodicclassificationpanel.melodicclassificationpanel'