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]¶ Bases:
fsleyes.views.plotpanel.OverlayPlotPanel
An
OverlayPlotPanel
which plots histograms fromImage
overlay data. AHistogramPanel
looks something like this:A
HistogramPanel
plots one or moreHistogramSeries
instances, each of which encapsulate histogram data from anImage
overlay.A couple of control panels may be shown on a
HistogramPanel
:The
PlotListPanel
is a FSLeyes control panel for use withOverlayPlotPanel
views.The
HistogramControlPanel
is a FSLeyes control panel which allows the user to configure aHistogramPanel
.The following
actions
are provided, in addition to those already provided by thePlotPanel
:Shows/hides a
HistogramToolBar
.Shows/hides a
HistogramControlPanel
.Some tools are also available, to do various things:
Runs an
AddROIHistogramAction
.-
histType
= <MagicMock name='mock.Choice()' id='4396606838672'>¶ 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='4396606838672'>¶ 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.
-
__init__
(parent, overlayList, displayCtx, frame)[source]¶ Create a
HistogramPanel
.- Parameters
parent – The
wx
parent.overlayList – The
OverlayList
instance.displayCtx – The
DisplayContext
instance.frame – The
FSLeyesFrame
instance.
-
destroy
()[source]¶ Removes some property listeners, and calls
PlotPanel.destroy()
.
-
toggleHistogramControl
(floatPane=False)[source]¶ Shows/hides a
HistogramControlPanel
. SeeViewPanel.togglePanel()
.
-
toggleHistogramToolBar
()[source]¶ Shows/hides a
HistogramToolBar
. SeeViewPanel.togglePanel()
.
-
toggleHistogramOverlay
()[source]¶ Toggles the value of the
HistogramSeries.showOverlay
for the currently selected overlay (if possible).
-
addROIHistogram
()[source]¶ Runs an
AddROIHistogramAction
.
-
getActions
()[source]¶ Overrides
ActionProvider.getActions()
. Returns all of theactions
that are defined on thisHistogramPanel
.
-
getTools
()[source]¶ Returns a list of tools to be added to the
FSLeyesFrame
forHistogramPanel
views.
-
draw
(*a)[source]¶ Overrides
PlotPanel.draw()
. Passes someHistogramSeries
instances to thePlotPanel.drawDataSeries()
method.
-
createDataSeries
(overlay)[source]¶ Creates a
HistogramSeries
instance for the specified overlay.
-
__module__
= 'fsleyes.views.histogrampanel'¶
-
prepareDataSeries
(hs)[source]¶ Overrides
PlotPanel.prepareDataSeries()
.Performs some pre-processing on the data contained in the given
HistogramSeries
instance.
-
__selectedOverlayChanged
(*a)¶ Called when the
OverlayList
or theDisplayContext.selectedOverlay
changes. Configures thetoggleHistogramOverlay()
action.
-