fsleyes.plugins.controls.clusterpanel

This module provides the ClusterPanel class, a FSLeyes control panel for viewing cluster results from a FEAT analysis.

class fsleyes.plugins.controls.clusterpanel.ClusterPanel(*args, **kwargs)[source]

Bases: ControlPanel

The ClusterPanel shows a table of cluster results from the analysis associated with a FEATImage overlay. A ClusterPanel looks something like the following:

_images/clusterpanel.png

The ClusterPanel contains controls which allow the user to:

  • Select the COPE or f-test for which cluster results are displayed

  • Add a Z statistic overlay for the currently displayed COPE/f-test

  • Add a cluster mask overlay for the currently displayed COPE/f-test

  • Navigate to the Z maximum location, Z centre-of-gravity location, or COPE maximum location, for a specific cluster.

When an overlay is selected (detected via the DisplayContext.selectedOverlay property), a ClusterPanel tries to identify the FEAT analysis associated with the overlay. If the overlay is a FEATImage, then no work needs to be done. Otherwise, the ClusterPanel uses functions in the featanalysis module to identify the FEAT directory. Ultimately, a reference to a FEATImage associated with the currently selected overlay is obtained, so the ClusterPanel can retrieve contrast and cluster information.

A ClusterPanel uses a WidgetGrid to display information about the clusters associated with a contrast. Because creating all of the widgets contained in the WidgetGrid is expensive, a ClusterPanel creates (on demand) and caches WidgetGrid instances for all FEATImage overlay and contrasts. This means that when the user changes the currently selected overlay, or the current contrast, the displayed cluster information is updated quickly.

static supportedViews()[source]

The ClusterPanel is restricted for use with OrthoPanel, LightBoxPanel and Scene3DPanel views.

static defaultLayout()[source]

Returns a dictionary containing layout settings to be passed to ViewPanel.togglePanel.

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

Create a ClusterPanel.

Parameters:
destroy()[source]

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

property statSelect

Return a reference to the wx.Choice widget used to select the current contrast/f-test.

property addZStats

Return a reference to the wx.Button widget used to add the Z-statistic image for the current test to the overlay list.

property addClustMask

Return a reference to the wx.Button widget used to add the cluster mask image for the current test to the overlay list.

__calcMinSize()

Figures out the minimum size that this ClusterPanel should have. Called by __init__().

When the ClusterPanel is created, the COPE combo box is not populated, so has no minimum size. Here, we figure out a good minimum size for it. We can then calculate a good minimum size for the entire panel.

__disable(message)

Disables the ClusterPanel, and displays the given message. Called when the selected overlay is not associated with a FEAT analysis, or when cluster results cannot be displayed for some reason.

__enable()

Enables the ClusterPanel. This amounts to hiding the disabled message panel, and showing the appropriate WidgetGrid for the currently selected overlay / contrast. The appropriate WidgetGrid is assumed to have already been created.

__statSelected(ev=None)

Called when a COPE is selected. Retrieves a cached WidgetGrid, or creates a new one (via the __genClusterGrid() method) which displays information about the clusters associated with the currently selected contrast or f-test.

__addZStatsClick(ev)

Called when the Add Z statistics button is pushed. Retrieves the Z statistic image for the current COPE (see the FEATImage.getZStats() method), and adds it as an overlay to the OverlayList.

__addClustMaskClick(ev)

Called when the Add cluster mask button is pushed. Retrieves the cluster mask image for the currewnt contrast (see the FEATImage.getClusterMask() method)

__genClusterGrid(overlay, featImage, testidx)

Creates and returns a WidgetGrid which contains the given list of clusters, which are related to the given contrast.

Note

This method assumes that the given overlay is an Image which has the same voxel dimensions as, and shares the the same world coordinate system as the featImage.

Parameters:

  • overlay – The overlay for which clusters are currently being displayed.

  • featImage – The FEATImage to which the clusters are related.

  • testidx – The internal index identifying the contrast/f-test.

__overlayListChanged(*a)

Called when the OverlayList changes. Destroys any cached WidgetGrid instances as needed, updates the Add Z statistic and Add cluster mask buttons, in case the user removed them, and calls __selectedOverlayChanged().

__enableOverlayButtons()

Enables/disables the Add Z statistic and Add cluster mask buttons depending on whether the corresponding overlays are in the OverlayList. The buttons are only enabled if the corresponding overlays are not already loaded.

__selectedOverlayChanged(*a)

Called when the DisplayContext.selectedOverlay changes, and by the __overlayListChanged() method.

If the newly selected overlay is a FEATImage (or is otherwise associated with a FEAT analysis) which has cluster results, they are loaded in, and displayed on a WidgetGrid.

__lookupFEATImage(overlay)

Searches for a FEATImage for the FEAT analysis that overlay is associated with. Loads and caches if if necessary. Returns None if overlay is not associated with a FEAT analysis.

__loadClusterResults(featImage)

Loads cluster results for all contrasts and f-tests from the FEAT analysis for featImage. Returns a list of tuples, with each tuple containing:

  • The test index, starting from 0, relative to the total number of contrasts/f-tests. Contrasts and f-tests are indexed separately.

  • A boolean indicating whether the test is a contrast or an f-test

  • The test name

  • A list of cluster results (see featanalysis.loadClusterResults()). This will be None if the results could not be loaded for some reason.

__annotations__ = {}
__module__ = 'fsleyes.plugins.controls.clusterpanel'