`fsleyes.views.histogrampanel`¶

This module provides the HistogramPanel, which is a FSLeyes view that plots the histogram of data from Image overlays.

class fsleyes.views.histogrampanel.HistogramPanel(parent, overlayList, displayCtx, frame)[source]¶

An OverlayPlotPanel which plots histograms from Image overlay data. A HistogramPanel looks something like this:

A HistogramPanel plots one or more HistogramSeries instances, each of which encapsulate histogram data from an Image overlay.

A couple of control panels may be shown on a HistogramPanel, via ViewPanel.togglePanel():

`PlotListPanel`	The `PlotListPanel` is a FSLeyes control panel for use with `OverlayPlotPanel` views.
`HistogramControlPanel`	The `HistogramControlPanel` is a FSLeyes control panel which allows the user to configure a `HistogramPanel`.

histType = <MagicMock name='mock.Choice()' id='4117029600'>¶

The histogram type:

`count`	The y axis represents the absolute number of values within each bin
`probability`	The y axis represents the number of values within each bin, divided by the total number of values.

plotType = <MagicMock name='mock.Choice()' id='4117029600'>¶

How histograms are plotted:

`centre`	Plot one data point at the centre of each bin
`edge`	Plot one data point at each bin edge - this produces a “stepped” plot.

static defaultLayout()[source]¶: Returns a list of control panel types to be added for the default histogram panel layout.

static controlOrder()[source]¶: Returns a list of control panel names, specifying the order in which they should appear in the FSLeyes ortho panel settings menu.

__init__(parent, overlayList, displayCtx, frame)[source]¶

Create a HistogramPanel.

Parameters

destroy()[source]¶: Removes some property listeners, and calls PlotPanel.destroy().

toggleHistogramOverlay()[source]¶: Toggles the value of the HistogramSeries.showOverlay for the currently selected overlay (if possible).

getActions()[source]¶: Overrides ActionProvider.getActions(). Returns all of the actions that are defined on this HistogramPanel.

draw(*a)[source]¶: Overrides PlotPanel.draw(). Passes some HistogramSeries instances to the PlotPanel.drawDataSeries() method.

createDataSeries(overlay)[source]¶: Creates a HistogramSeries instance for the specified overlay.

prepareDataSeries(hs)[source]¶

Performs some pre-processing on the data contained in the given HistogramSeries instance.

__selectedOverlayChanged(*a)¶: Called when the OverlayList or the DisplayContext.selectedOverlay changes. Configures the toggleHistogramOverlay() action.

fsleyes.views.histogrampanel¶