Source code for silx.gui.plot.PlotWidget
# /*##########################################################################
#
# Copyright (c) 2004-2023 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
# ###########################################################################*/
"""Qt widget providing plot API for 1D and 2D data.
The :class:`PlotWidget` implements the plot API initially provided in PyMca.
"""
from __future__ import annotations
__authors__ = ["V.A. Sole", "T. Vincent"]
__license__ = "MIT"
__date__ = "21/12/2018"
import logging
_logger = logging.getLogger(__name__)
from collections import namedtuple
from collections.abc import Sequence
from contextlib import contextmanager
from typing import Optional, Union
import datetime as dt
import itertools
import numbers
import warnings
import numpy
import silx
from silx.utils.weakref import WeakMethodProxy
try:
# Import matplotlib now to init matplotlib our way
import silx.gui.utils.matplotlib # noqa
except ImportError:
_logger.debug("matplotlib not available")
from ..colors import Colormap
from .. import colors
from . import PlotInteraction
from . import PlotEvents
from .LimitsHistory import LimitsHistory
from . import _utils
from . import items
from .items.curve import CurveStyle
from .items.axis import TickMode # noqa
from .. import qt
from ._utils.panzoom import ViewConstraints
from ...gui.plot._utils.dtime_ticklayout import timestamp
from ...utils.deprecation import deprecated_warning
"""
Object returned when requesting the data range.
"""
_PlotDataRange = namedtuple("PlotDataRange", ["x", "y", "yright"])
class _PlotWidgetSelection(qt.QObject):
"""Object managing a :class:`PlotWidget` selection.
It is a wrapper over :class:`PlotWidget`'s active items API.
:param PlotWidget parent:
"""
sigCurrentItemChanged = qt.Signal(object, object)
"""This signal is emitted whenever the current item changes.
It provides the current and previous items.
"""
sigSelectedItemsChanged = qt.Signal()
"""Signal emitted whenever the list of selected items changes."""
def __init__(self, parent):
assert isinstance(parent, PlotWidget)
super(_PlotWidgetSelection, self).__init__(parent=parent)
# Init history
self.__history = [ # Store active items from most recent to oldest
item
for item in (
parent.getActiveCurve(),
parent.getActiveImage(),
parent.getActiveScatter(),
)
if item is not None
]
self.__current = self.__mostRecentActiveItem()
parent.sigActiveImageChanged.connect(self._activeImageChanged)
parent.sigActiveCurveChanged.connect(self._activeCurveChanged)
parent.sigActiveScatterChanged.connect(self._activeScatterChanged)
def __mostRecentActiveItem(self) -> Optional[items.Item]:
"""Returns most recent active item."""
return self.__history[0] if len(self.__history) >= 1 else None
def getSelectedItems(self) -> tuple[items.Item]:
"""Returns the list of currently selected items in the :class:`PlotWidget`.
The list is given from most recently current item to oldest one."""
plot = self.parent()
if plot is None:
return ()
active = tuple(self.__history)
current = self.getCurrentItem()
if current is not None and current not in active:
# Current might not be an active item, if so add it
active = (current,) + active
return active
def getCurrentItem(self) -> Optional[items.Item]:
"""Returns the current item in the :class:`PlotWidget` or None."""
return self.__current
def setCurrentItem(self, item: Optional[items.Item]):
"""Set the current item in the :class:`PlotWidget`.
:param item:
The new item to select or None to clear the selection.
:raise ValueError: If the item is not the :class:`PlotWidget`
"""
previous = self.getCurrentItem()
if previous is item:
return
previousSelected = self.getSelectedItems()
if item is None:
self.__current = None
# Reset all PlotWidget active items
plot = self.parent()
if plot is not None:
for kind in PlotWidget._ACTIVE_ITEM_KINDS:
if plot._getActiveItem(kind) is not None:
plot._setActiveItem(kind, None)
elif isinstance(item, items.Item):
plot = self.parent()
if plot is None or item.getPlot() is not plot:
raise ValueError("Item is not in the PlotWidget: %s" % str(item))
self.__current = item
kind = plot._itemKind(item)
# Clean-up history to be safe
self.__history = [
item for item in self.__history if PlotWidget._itemKind(item) != kind
]
# Sync active item if needed
if kind in plot._ACTIVE_ITEM_KINDS and item is not plot._getActiveItem(
kind
):
plot._setActiveItem(kind, item)
else:
raise ValueError("Not an Item: %s" % str(item))
self.sigCurrentItemChanged.emit(previous, item)
if previousSelected != self.getSelectedItems():
self.sigSelectedItemsChanged.emit()
def __activeItemChanged(
self, kind: str, previous: Optional[str], legend: Optional[str]
):
"""Set current item from kind and legend"""
if previous == legend:
return # No-op for update of item
plot = self.parent()
if plot is None:
return
previousSelected = self.getSelectedItems()
# Remove items of this kind from the history
self.__history = [
item for item in self.__history if PlotWidget._itemKind(item) != kind
]
# Retrieve current item
if legend is None: # Use most recent active item
currentItem = self.__mostRecentActiveItem()
else:
currentItem = plot._getItem(kind=kind, legend=legend)
if currentItem is None: # Fallback in case something went wrong
currentItem = self.__mostRecentActiveItem()
# Update history
if currentItem is not None:
while currentItem in self.__history:
self.__history.remove(currentItem)
self.__history.insert(0, currentItem)
if currentItem != self.__current:
previousItem = self.__current
self.__current = currentItem
self.sigCurrentItemChanged.emit(previousItem, currentItem)
if previousSelected != self.getSelectedItems():
self.sigSelectedItemsChanged.emit()
def _activeImageChanged(self, previous, current):
"""Handle active image change"""
self.__activeItemChanged("image", previous, current)
def _activeCurveChanged(self, previous, current):
"""Handle active curve change"""
self.__activeItemChanged("curve", previous, current)
def _activeScatterChanged(self, previous, current):
"""Handle active scatter change"""
self.__activeItemChanged("scatter", previous, current)
[docs]
class PlotWidget(qt.QMainWindow):
"""Qt Widget providing a 1D/2D plot.
This widget is a QMainWindow.
This class implements the plot API initially provided in PyMca.
Supported backends:
- 'matplotlib' and 'mpl': Matplotlib with Qt.
- 'opengl' and 'gl': OpenGL backend (requires PyOpenGL and OpenGL >= 2.1)
- 'none': No backend, to run headless for testing purpose.
:param parent: The parent of this widget or None (default).
:param backend: The backend to use, in:
'matplotlib' (default), 'mpl', 'opengl', 'gl', 'none'
or a :class:`BackendBase.BackendBase` class
:type backend: str or :class:`BackendBase.BackendBase`
"""
# The following 2 class attributes are no longer used
# but there is no way to warn about deprecation
colorList = silx.config.DEFAULT_PLOT_CURVE_COLORS
colorDict = colors.COLORDICT
sigPlotSignal = qt.Signal(object)
"""Signal for all events of the plot.
The signal information is provided as a dict.
See the :ref:`plot signal documentation page <plot_signal>` for
information about the content of the dict
"""
sigSetKeepDataAspectRatio = qt.Signal(bool)
"""Signal emitted when plot keep aspect ratio has changed"""
sigSetGraphGrid = qt.Signal(str)
"""Signal emitted when plot grid has changed"""
sigSetGraphCursor = qt.Signal(bool)
"""Signal emitted when plot crosshair cursor has changed"""
sigSetPanWithArrowKeys = qt.Signal(bool)
"""Signal emitted when pan with arrow keys has changed"""
_sigAxesVisibilityChanged = qt.Signal(bool)
"""Signal emitted when the axes visibility changed"""
sigContentChanged = qt.Signal(str, str, str)
"""Signal emitted when the content of the plot is changed.
It provides the following information:
- action: The change of the plot: 'add' or 'remove'
- kind: The kind of primitive changed:
'curve', 'image', 'scatter', 'histogram', 'item' or 'marker'
- legend: The legend of the primitive changed.
"""
sigActiveCurveChanged = qt.Signal(object, object)
"""Signal emitted when the active curve has changed.
It provides the following information:
- previous: The legend of the previous active curve or None
- legend: The legend of the new active curve or None if no curve is active
"""
sigActiveImageChanged = qt.Signal(object, object)
"""Signal emitted when the active image has changed.
It provides the following information:
- previous: The legend of the previous active image or None
- legend: The legend of the new active image or None if no image is active
"""
sigActiveScatterChanged = qt.Signal(object, object)
"""Signal emitted when the active Scatter has changed.
It provides the following information:
- previous: The legend of the previous active scatter or None
- legend: The legend of the new active image or None if no image is active
"""
sigInteractiveModeChanged = qt.Signal(object)
"""Signal emitted when the interactive mode has changed
It provides the source as passed to :meth:`setInteractiveMode`.
"""
sigItemAdded = qt.Signal(items.Item)
"""Signal emitted when an item was just added to the plot
It provides the added item.
"""
sigItemAboutToBeRemoved = qt.Signal(items.Item)
"""Signal emitted right before an item is removed from the plot.
It provides the item that will be removed.
"""
sigItemRemoved = qt.Signal(items.Item)
"""Signal emitted right after an item was removed from the plot.
It provides the item that was removed.
"""
sigVisibilityChanged = qt.Signal(bool)
"""Signal emitted when the widget becomes visible (or invisible).
This happens when the widget is hidden or shown.
It provides the visible state.
"""
_sigDefaultContextMenu = qt.Signal(qt.QMenu)
"""Signal emitted when the default context menu of the plot is feed.
It provides the menu which will be displayed.
"""
sigBackendChanged = qt.Signal()
"""Signal emitted when the backend have changed."""
def __init__(self, parent=None, backend=None):
self._autoreplot = False
self._dirty = False
self._cursorInPlot = False
self.__muteActiveItemChanged = False
self._panWithArrowKeys = True
self._viewConstrains = None
super(PlotWidget, self).__init__(parent)
if parent is not None:
# behave as a widget
self.setWindowFlags(qt.Qt.Widget)
else:
self.setWindowTitle("PlotWidget")
# Init the backend
self._backend = self.__getBackendClass(backend)(self, self)
self.setCallback() # set _callback
# Items handling
self.__items = []
self.__itemsToUpdate = [] # Used as an OrderedSet
self.__activeItems = {"curve": None, "image": None, "scatter": None}
self._dataRange = None
# line types
self._defaultColors = None
self._styleList = ["-", "--", "-.", ":"]
self._colorIndex = 0
self._styleIndex = 0
self._activeCurveSelectionMode = "atmostone"
self._activeCurveStyle = CurveStyle(
color=silx.config.DEFAULT_PLOT_ACTIVE_CURVE_COLOR,
linewidth=silx.config.DEFAULT_PLOT_ACTIVE_CURVE_LINEWIDTH,
)
# plot colors (updated later to sync backend)
self._foregroundColor = 0.0, 0.0, 0.0, 1.0
self._gridColor = 0.7, 0.7, 0.7, 1.0
self._backgroundColor = 1.0, 1.0, 1.0, 1.0
self._dataBackgroundColor = None
# default properties
self._cursorConfiguration = None
self._xAxis = items.XAxis(self)
self._yAxis = items.YAxis(self)
self._yRightAxis = items.YRightAxis(self, self._yAxis)
self._grid = None
self._graphTitle = ""
self.__graphCursorShape = "default"
# Set axes margins
self.__axesDisplayed = True
self.__axesMargins = 0.0, 0.0, 0.0, 0.0
self.setAxesMargins(0.15, 0.1, 0.1, 0.15)
self.setGraphTitle()
self.setGraphXLabel()
self.setGraphYLabel()
self.setGraphYLabel("", axis="right")
self.setDefaultColormap() # Init default colormap
self.setDefaultPlotPoints(silx.config.DEFAULT_PLOT_CURVE_SYMBOL_MODE)
self.setDefaultPlotLines(True)
self._limitsHistory = LimitsHistory(self)
self._eventHandler = PlotInteraction.PlotInteraction(self)
self._eventHandler._setInteractiveMode("zoom", color=(0.0, 0.0, 0.0, 1.0))
self._eventHandler.sigChanged.connect(self.__interactionChanged)
self.__isInteractionSignalForwarded = True
self._previousDefaultMode = "zoom", True
self._pressedButtons = [] # Currently pressed mouse buttons
self._defaultDataMargins = (0.0, 0.0, 0.0, 0.0)
# Only activate autoreplot at the end
# This avoids errors when loaded in Qt designer
self._dirty = False
self._autoreplot = True
widget = self.getWidgetHandle()
if widget is not None:
self.setCentralWidget(widget)
else:
_logger.info("PlotWidget backend does not support widget")
self.setFocusPolicy(qt.Qt.StrongFocus)
self.setFocus(qt.Qt.OtherFocusReason)
# Set default limits
self.setGraphXLimits(0.0, 100.0)
self.setGraphYLimits(0.0, 100.0, axis="right")
self.setGraphYLimits(0.0, 100.0, axis="left")
# Sync backend colors with default ones
self._foregroundColorsUpdated()
self._backgroundColorsUpdated()
# selection handling
self.__selection = None
def __getBackendClass(self, backend):
"""Returns backend class corresponding to backend.
If multiple backends are provided, the first available one is used.
:param Union[str,BackendBase,List[Union[str,BackendBase]]] backend:
The name of the backend or its class or an iterable of those.
:rtype: BackendBase
:raise ValueError: In case the backend is not supported
:raise RuntimeError: If a backend is not available
"""
if backend is None:
backend = silx.config.DEFAULT_PLOT_BACKEND
if callable(backend):
return backend
elif isinstance(backend, str):
backend = backend.lower()
if backend in ("matplotlib", "mpl"):
try:
from .backends.BackendMatplotlib import (
BackendMatplotlibQt as backendClass,
)
except ImportError:
_logger.debug("Backtrace", exc_info=True)
raise RuntimeError("matplotlib backend is not available")
elif backend in ("gl", "opengl"):
from ..utils.glutils import isOpenGLAvailable
checkOpenGL = isOpenGLAvailable(version=(2, 1), runtimeCheck=False)
if not checkOpenGL:
_logger.debug("OpenGL check failed")
raise RuntimeError(
"OpenGL backend is not available: %s" % checkOpenGL.error
)
try:
from .backends.BackendOpenGL import BackendOpenGL as backendClass
except ImportError:
_logger.debug("Backtrace", exc_info=True)
raise RuntimeError("OpenGL backend is not available")
elif backend == "none":
from .backends.BackendBase import BackendBase as backendClass
else:
raise ValueError("Backend not supported %s" % backend)
return backendClass
elif isinstance(backend, (tuple, list)):
for b in backend:
try:
return self.__getBackendClass(b)
except RuntimeError:
pass
else: # No backend was found
raise RuntimeError("None of the request backends are available")
raise ValueError("Backend not supported %s" % str(backend))
def selection(self):
"""Returns the selection hander"""
if self.__selection is None: # Lazy initialization
self.__selection = _PlotWidgetSelection(parent=self)
return self.__selection
def setBackend(self, backend):
"""Set the backend to use for rendering.
Supported backends:
- 'matplotlib' and 'mpl': Matplotlib with Qt.
- 'opengl' and 'gl': OpenGL backend (requires PyOpenGL and OpenGL >= 2.1)
- 'none': No backend, to run headless for testing purpose.
:param Union[str,BackendBase,List[Union[str,BackendBase]]] backend:
The backend to use, in:
'matplotlib' (default), 'mpl', 'opengl', 'gl', 'none',
a :class:`BackendBase.BackendBase` class.
If multiple backends are provided, the first available one is used.
:raises ValueError: Unsupported backend descriptor
:raises RuntimeError: Error while loading a backend
"""
backend = self.__getBackendClass(backend)(self, self)
# First save state that is stored in the backend
xaxis = self.getXAxis()
xmin, xmax = xaxis.getLimits()
ymin, ymax = self.getYAxis(axis="left").getLimits()
y2min, y2max = self.getYAxis(axis="right").getLimits()
isKeepDataAspectRatio = self.isKeepDataAspectRatio()
xTimeZone = xaxis.getTimeZone()
isXAxisTimeSeries = xaxis.getTickMode() == TickMode.TIME_SERIES
isYAxisInverted = self.getYAxis().isInverted()
# Remove all items from previous backend
for item in self.getItems():
item._removeBackendRenderer(self._backend)
# Switch backend
self._backend = backend
widget = self._backend.getWidgetHandle()
self.setCentralWidget(widget)
if widget is None:
_logger.info("PlotWidget backend does not support widget")
# Mark as newly dirty
self._dirty = False
self._setDirtyPlot()
# Synchronize/restore state
self._foregroundColorsUpdated()
self._backgroundColorsUpdated()
self._backend.setGraphCursorShape(self.getGraphCursorShape())
crosshairConfig = self.getGraphCursor()
if crosshairConfig is None:
self._backend.setGraphCursor(False, "black", 1, "-")
else:
self._backend.setGraphCursor(True, *crosshairConfig)
self._backend.setGraphTitle(self.getGraphTitle())
self._backend.setGraphGrid(self.getGraphGrid())
if self.isAxesDisplayed():
self._backend.setAxesMargins(*self.getAxesMargins())
else:
self._backend.setAxesMargins(0.0, 0.0, 0.0, 0.0)
# Set axes
xaxis = self.getXAxis()
self._backend.setGraphXLabel(xaxis.getLabel())
self._backend.setXAxisTimeZone(xTimeZone)
self._backend.setXAxisTimeSeries(isXAxisTimeSeries)
self._backend.setXAxisLogarithmic(xaxis.getScale() == items.Axis.LOGARITHMIC)
for axis in ("left", "right"):
self._backend.setGraphYLabel(self.getYAxis(axis).getLabel(), axis)
self._backend.setYAxisInverted(isYAxisInverted)
self._backend.setYAxisLogarithmic(
self.getYAxis().getScale() == items.Axis.LOGARITHMIC
)
# Finally restore aspect ratio and limits
self._backend.setKeepDataAspectRatio(isKeepDataAspectRatio)
self.setLimits(xmin, xmax, ymin, ymax, y2min, y2max)
# Mark all items for update with new backend
for item in self.getItems():
item._updated()
self.sigBackendChanged.emit()
def getBackend(self):
"""Returns the backend currently used by :class:`PlotWidget`.
:rtype: ~silx.gui.plot.backend.BackendBase.BackendBase
"""
return self._backend
def _getDirtyPlot(self):
"""Return the plot dirty flag.
If False, the plot has not changed since last replot.
If True, the full plot need to be redrawn.
If 'overlay', only the overlay has changed since last replot.
It can be accessed by backend to check the dirty state.
:return: False, True, 'overlay'
"""
return self._dirty
# Default Qt context menu
def contextMenuEvent(self, event):
"""Override QWidget.contextMenuEvent to implement the context menu"""
menu = qt.QMenu(self)
from .actions.control import ZoomBackAction # Avoid cyclic import
zoomBackAction = ZoomBackAction(plot=self, parent=menu)
menu.addAction(zoomBackAction)
mode = self.getInteractiveMode()
if "shape" in mode and mode["shape"] == "polygon":
from .actions.control import (
ClosePolygonInteractionAction,
) # Avoid cyclic import
action = ClosePolygonInteractionAction(plot=self, parent=menu)
menu.addAction(action)
self._sigDefaultContextMenu.emit(menu)
# Make sure the plot is updated, especially when the plot is in
# draw interaction mode
menu.aboutToHide.connect(self.__simulateMouseMove)
menu.exec(event.globalPos())
def _setDirtyPlot(self, overlayOnly=False):
"""Mark the plot as needing redraw
:param bool overlayOnly: True to redraw only the overlay,
False to redraw everything
"""
wasDirty = self._dirty
if not self._dirty and overlayOnly:
self._dirty = "overlay"
else:
self._dirty = True
if self._autoreplot and not wasDirty and self.isVisible():
self._backend.postRedisplay()
def _foregroundColorsUpdated(self):
"""Handle change of foreground/grid color"""
if self._gridColor is None:
gridColor = self._foregroundColor
else:
gridColor = self._gridColor
self._backend.setForegroundColors(self._foregroundColor, gridColor)
self._setDirtyPlot()
def getForegroundColor(self):
"""Returns the RGBA colors used to display the foreground of this widget
:rtype: qt.QColor
"""
return qt.QColor.fromRgbF(*self._foregroundColor)
def setForegroundColor(self, color):
"""Set the foreground color of this widget.
:param Union[List[int],List[float],QColor] color:
The new RGB(A) color.
"""
color = colors.rgba(color)
if self._foregroundColor != color:
self._foregroundColor = color
self._foregroundColorsUpdated()
def getGridColor(self):
"""Returns the RGBA colors used to display the grid lines
An invalid QColor is returned if there is no grid color,
in which case the foreground color is used.
:rtype: qt.QColor
"""
if self._gridColor is None:
return qt.QColor() # An invalid color
else:
return qt.QColor.fromRgbF(*self._gridColor)
def setGridColor(self, color):
"""Set the grid lines color
:param Union[List[int],List[float],QColor,None] color:
The new RGB(A) color.
"""
if isinstance(color, qt.QColor) and not color.isValid():
color = None
if color is not None:
color = colors.rgba(color)
if self._gridColor != color:
self._gridColor = color
self._foregroundColorsUpdated()
def _backgroundColorsUpdated(self):
"""Handle change of background/data background color"""
if self._dataBackgroundColor is None:
dataBGColor = self._backgroundColor
else:
dataBGColor = self._dataBackgroundColor
self._backend.setBackgroundColors(self._backgroundColor, dataBGColor)
self._setDirtyPlot()
def getBackgroundColor(self):
"""Returns the RGBA colors used to display the background of this widget.
:rtype: qt.QColor
"""
return qt.QColor.fromRgbF(*self._backgroundColor)
def setBackgroundColor(self, color):
"""Set the background color of this widget.
:param Union[List[int],List[float],QColor] color:
The new RGB(A) color.
"""
color = colors.rgba(color)
if self._backgroundColor != color:
self._backgroundColor = color
self._backgroundColorsUpdated()
def getDataBackgroundColor(self):
"""Returns the RGBA colors used to display the background of the plot
view displaying the data.
An invalid QColor is returned if there is no data background color.
:rtype: qt.QColor
"""
if self._dataBackgroundColor is None:
# An invalid color
return qt.QColor()
else:
return qt.QColor.fromRgbF(*self._dataBackgroundColor)
def setDataBackgroundColor(self, color):
"""Set the background color of the plot area.
Set to None or an invalid QColor to use the background color.
:param Union[List[int],List[float],QColor,None] color:
The new RGB(A) color.
"""
if isinstance(color, qt.QColor) and not color.isValid():
color = None
if color is not None:
color = colors.rgba(color)
if self._dataBackgroundColor != color:
self._dataBackgroundColor = color
self._backgroundColorsUpdated()
dataBackgroundColor = qt.Property(
qt.QColor, getDataBackgroundColor, setDataBackgroundColor
)
backgroundColor = qt.Property(qt.QColor, getBackgroundColor, setBackgroundColor)
foregroundColor = qt.Property(qt.QColor, getForegroundColor, setForegroundColor)
gridColor = qt.Property(qt.QColor, getGridColor, setGridColor)
def showEvent(self, event):
if self._autoreplot and self._dirty:
self._backend.postRedisplay()
super(PlotWidget, self).showEvent(event)
self.sigVisibilityChanged.emit(True)
def hideEvent(self, event):
super(PlotWidget, self).hideEvent(event)
if qt.BINDING == "PySide6":
# Workaround RuntimeError: The SignalInstance object was already deleted
try:
self.sigVisibilityChanged.emit(False)
except RuntimeError as e:
_logger.error(f"Exception occured: {e}")
else:
self.sigVisibilityChanged.emit(False)
def _invalidateDataRange(self):
"""
Notifies this PlotWidget instance that the range has changed
and will have to be recomputed.
"""
self._dataRange = None
def _updateDataRange(self):
"""
Recomputes the range of the data displayed on this PlotWidget.
"""
xMin = yMinLeft = yMinRight = float("nan")
xMax = yMaxLeft = yMaxRight = float("nan")
for item in self.getItems():
if item.isVisible():
bounds = item.getBounds()
if bounds is not None:
with warnings.catch_warnings():
warnings.simplefilter("ignore", category=RuntimeWarning)
# Ignore All-NaN slice encountered
xMin = numpy.nanmin([xMin, bounds[0]])
xMax = numpy.nanmax([xMax, bounds[1]])
# Take care of right axis
if (
isinstance(item, items.YAxisMixIn)
and item.getYAxis() == "right"
):
with warnings.catch_warnings():
warnings.simplefilter("ignore", category=RuntimeWarning)
# Ignore All-NaN slice encountered
yMinRight = numpy.nanmin([yMinRight, bounds[2]])
yMaxRight = numpy.nanmax([yMaxRight, bounds[3]])
else:
with warnings.catch_warnings():
warnings.simplefilter("ignore", category=RuntimeWarning)
# Ignore All-NaN slice encountered
yMinLeft = numpy.nanmin([yMinLeft, bounds[2]])
yMaxLeft = numpy.nanmax([yMaxLeft, bounds[3]])
def lGetRange(x, y):
return None if numpy.isnan(x) and numpy.isnan(y) else (x, y)
xRange = lGetRange(xMin, xMax)
yLeftRange = lGetRange(yMinLeft, yMaxLeft)
yRightRange = lGetRange(yMinRight, yMaxRight)
self._dataRange = _PlotDataRange(x=xRange, y=yLeftRange, yright=yRightRange)
[docs]
def getDataRange(self):
"""
Returns this PlotWidget's data range.
:return: a namedtuple with the following members :
x, y (left y axis), yright. Each member is a tuple (min, max)
or None if no data is associated with the axis.
:rtype: namedtuple
"""
if self._dataRange is None:
self._updateDataRange()
return self._dataRange
# Content management
_KIND_TO_CLASSES = {
"curve": (items.Curve,),
"image": (items.ImageBase,),
"scatter": (items.Scatter,),
"marker": (items.MarkerBase,),
"item": (
items.Line,
items.Shape,
items.BoundingRect,
items.XAxisExtent,
items.YAxisExtent,
),
"histogram": (items.Histogram,),
}
"""Mapping kind to item classes of this kind"""
@classmethod
def _itemKind(cls, item):
"""Returns the "kind" of a given item
:param Item item: The item get the kind
:rtype: str
"""
for kind, itemClasses in cls._KIND_TO_CLASSES.items():
if isinstance(item, itemClasses):
return kind
return "other"
def _notifyContentChanged(self, item):
self.notify(
"contentChanged",
action="add",
kind=self._itemKind(item),
legend=item.getName(),
)
def _itemRequiresUpdate(self, item):
"""Called by items in the plot for asynchronous update
:param Item item: The item that required update
"""
assert item.getPlot() == self
# Put item at the end of the list
if item in self.__itemsToUpdate:
self.__itemsToUpdate.remove(item)
self.__itemsToUpdate.append(item)
self._setDirtyPlot(overlayOnly=item.isOverlay())
def addItem(self, item):
"""Add an item to the plot content.
:param ~silx.gui.plot.items.Item item: The item to add.
:raises ValueError: If item is already in the plot.
"""
if not isinstance(item, items.Item):
raise ValueError(f"argument must be a subclass of Item")
if item in self.getItems():
raise ValueError("Item already in the plot")
# Add item to plot
self.__items.append(item)
item._setPlot(self)
self._itemRequiresUpdate(item)
if isinstance(item, items.DATA_ITEMS):
self._invalidateDataRange() # TODO handle this automatically
self._notifyContentChanged(item)
self.sigItemAdded.emit(item)
def removeItem(self, item):
"""Remove the item from the plot.
:param ~silx.gui.plot.items.Item item: Item to remove from the plot.
:raises ValueError: If item is not in the plot.
"""
if not isinstance(item, items.Item):
raise ValueError("argument must be an Item")
if item not in self.getItems():
raise ValueError("Item not in the plot")
self.sigItemAboutToBeRemoved.emit(item)
kind = self._itemKind(item)
if kind in self._ACTIVE_ITEM_KINDS:
if self._getActiveItem(kind) == item:
# Reset active item
self._setActiveItem(kind, None)
# Remove item from plot
self.__items.remove(item)
if item in self.__itemsToUpdate:
self.__itemsToUpdate.remove(item)
if item.isVisible():
self._setDirtyPlot(overlayOnly=item.isOverlay())
if item.getBounds() is not None:
self._invalidateDataRange()
item._removeBackendRenderer(self._backend)
item._setPlot(None)
if kind == "curve" and not self.getAllCurves(just_legend=True, withhidden=True):
self._resetColorAndStyle()
self.sigItemRemoved.emit(item)
self.notify("contentChanged", action="remove", kind=kind, legend=item.getName())
def discardItem(self, item) -> bool:
"""Remove the item from the plot.
Same as :meth:`removeItem` but do not raise an exception.
:param ~silx.gui.plot.items.Item item: Item to remove from the plot.
:returns: True if the item was present, False otherwise.
"""
try:
self.removeItem(item)
except ValueError:
return False
else:
return True
[docs]
def getItems(self):
"""Returns the list of items in the plot
:rtype: List[silx.gui.plot.items.Item]
"""
return tuple(self.__items)
@contextmanager
def _muteActiveItemChangedSignal(self):
self.__muteActiveItemChanged = True
yield
self.__muteActiveItemChanged = False
# Add
# add * input arguments management:
# If an arg is set, then use it.
# Else:
# If a curve with the same legend exists, then use its arg value
# Else, use a default value.
# Store used value.
# This value is used when curve is updated either internally or by user.
[docs]
def addCurve(
self,
x,
y,
legend=None,
info=None,
replace=False,
color=None,
symbol=None,
linewidth=None,
linestyle=None,
xlabel=None,
ylabel=None,
yaxis=None,
xerror=None,
yerror=None,
z=None,
selectable=None,
fill=None,
resetzoom=True,
histogram=None,
copy=True,
baseline=None,
):
"""Add a 1D curve given by x an y to the graph.
Curves are uniquely identified by their legend.
To add multiple curves, call :meth:`addCurve` multiple times with
different legend argument.
To replace an existing curve, call :meth:`addCurve` with the
existing curve legend.
If you want to display the curve values as an histogram see the
histogram parameter or :meth:`addHistogram`.
When curve parameters are not provided, if a curve with the
same legend is displayed in the plot, its parameters are used.
:param numpy.ndarray x: The data corresponding to the x coordinates.
If you attempt to plot an histogram you can set edges values in x.
In this case len(x) = len(y) + 1.
If x contains datetime objects the XAxis tickMode is set to
TickMode.TIME_SERIES.
:param numpy.ndarray y: The data corresponding to the y coordinates
:param str legend: The legend to be associated to the curve (or None)
:param info: User-defined information associated to the curve
:param bool replace: True to delete already existing curves
(the default is False)
:param color: color(s) to be used
:type color: str ("#RRGGBB") or (npoints, 4) unsigned byte array or
one of the predefined color names defined in colors.py
:param str symbol: Symbol to be drawn at each (x, y) position::
- 'o' circle
- '.' point
- ',' pixel
- '+' cross
- 'x' x-cross
- 'd' diamond
- 's' square
- None (the default) to use default symbol
:param float linewidth: The width of the curve in pixels (Default: 1).
:param str linestyle: Type of line::
- ' ' no line
- '-' solid line
- '--' dashed line
- '-.' dash-dot line
- ':' dotted line
- None (the default) to use default line style
:param str xlabel: Label to show on the X axis when the curve is active
or None to keep default axis label.
:param str ylabel: Label to show on the Y axis when the curve is active
or None to keep default axis label.
:param str yaxis: The Y axis this curve is attached to.
Either 'left' (the default) or 'right'
:param xerror: Values with the uncertainties on the x values
:type xerror: A float, or a numpy.ndarray of float32.
If it is an array, it can either be a 1D array of
same length as the data or a 2D array with 2 rows
of same length as the data: row 0 for lower errors,
row 1 for upper errors.
:param yerror: Values with the uncertainties on the y values
:type yerror: A float, or a numpy.ndarray of float32. See xerror.
:param int z: Layer on which to draw the curve (default: 1)
This allows to control the overlay.
:param bool selectable: Indicate if the curve can be selected.
(Default: True)
:param bool fill: True to fill the curve, False otherwise (default).
:param bool resetzoom: True (the default) to reset the zoom.
:param str histogram: if not None then the curve will be draw as an
histogram. The step for each values of the curve can be set to the
left, center or right of the original x curve values.
If histogram is not None and len(x) == len(y)+1 then x is directly
take as edges of the histogram.
Type of histogram::
- None (default)
- 'left'
- 'right'
- 'center'
:param bool copy: True make a copy of the data (default),
False to use provided arrays.
:param baseline: curve baseline
:type: Union[None,float,numpy.ndarray]
:returns: The curve item
"""
# This is an histogram, use addHistogram
if histogram is not None:
histo = self.addHistogram(
histogram=y,
edges=x,
legend=legend,
color=color,
fill=fill,
align=histogram,
copy=copy,
)
histo.setInfo(info)
if linewidth is not None:
histo.setLineWidth(linewidth)
if linestyle is not None:
histo.setLineStyle(linestyle)
if xlabel is not None:
_logger.warning("addCurve: Histogram does not support xlabel argument")
if ylabel is not None:
_logger.warning("addCurve: Histogram does not support ylabel argument")
if yaxis is not None:
histo.setYAxis(yaxis)
if z is not None:
histo.setZValue(z)
if selectable is not None:
_logger.warning(
"addCurve: Histogram does not support selectable argument"
)
return histo
legend = "Unnamed curve 1.1" if legend is None else str(legend)
if replace:
self._resetColorAndStyle()
# Create/Update curve object
curve = self.getCurve(legend)
mustBeAdded = curve is None
if curve is None:
# No previous curve, create a default one and add it to the plot
curve = items.Curve() if histogram is None else items.Histogram()
curve.setName(legend)
# Set default color, linestyle and symbol
default_color, default_linestyle = self._getColorAndStyle()
curve.setColor(default_color)
curve.setLineStyle(default_linestyle)
curve.setSymbol(self._defaultPlotPoints)
curve._setBaseline(baseline=baseline)
# Do not emit sigActiveCurveChanged,
# it will be sent once with _setActiveItem
with self._muteActiveItemChangedSignal():
# Override previous/default values with provided ones
curve.setInfo(info)
if color is not None:
curve.setColor(
colors.rgba(color, colors=self.getDefaultColors())
if isinstance(color, str)
else color
)
if symbol is not None:
curve.setSymbol(symbol)
if linewidth is not None:
curve.setLineWidth(linewidth)
if linestyle is not None:
curve.setLineStyle(linestyle)
if xlabel is not None:
curve._setXLabel(xlabel)
if ylabel is not None:
curve._setYLabel(ylabel)
if yaxis is not None:
curve.setYAxis(yaxis)
if z is not None:
curve.setZValue(z)
if selectable is not None:
curve._setSelectable(selectable)
if fill is not None:
curve.setFill(fill)
# Set curve data
# If errors not provided, reuse previous ones
# TODO: Issue if size of data change but not that of errors
if xerror is None:
xerror = curve.getXErrorData(copy=False)
if yerror is None:
yerror = curve.getYErrorData(copy=False)
# Convert x to timestamps so that the internal representation
# remains floating points. The user is expected to set the axis'
# tickMode to TickMode.TIME_SERIES and, if necessary, set the axis
# to the correct time zone.
if len(x) > 0 and isinstance(x[0], dt.datetime):
x = [timestamp(d) for d in x]
curve.setData(x, y, xerror, yerror, baseline=baseline, copy=copy)
if replace: # Then remove all other curves
for c in self.getAllCurves(withhidden=True):
if c is not curve:
self.removeItem(c)
if mustBeAdded:
self.addItem(curve)
else:
self._notifyContentChanged(curve)
if curve is self.getActiveCurve() or (
self.getActiveCurveSelectionMode() == "legacy"
and self.getActiveCurve() is None
and len(self.getAllCurves(just_legend=True, withhidden=False)) == 1
and curve.isVisible()
):
self.setActiveCurve(curve)
if resetzoom:
# We ask for a zoom reset in order to handle the plot scaling
# if the user does not want that, autoscale of the different
# axes has to be set to off.
self.resetZoom()
return curve
[docs]
def addHistogram(
self,
histogram,
edges,
legend=None,
color=None,
fill=None,
align="center",
resetzoom=True,
copy=True,
z=None,
baseline=None,
):
"""Add an histogram to the graph.
This is NOT computing the histogram, this method takes as parameter
already computed histogram values.
Histogram are uniquely identified by their legend.
To add multiple histograms, call :meth:`addHistogram` multiple times
with different legend argument.
When histogram parameters are not provided, if an histogram with the
same legend is displayed in the plot, its parameters are used.
:param numpy.ndarray histogram: The values of the histogram.
:param numpy.ndarray edges:
The bin edges of the histogram.
If histogram and edges have the same length, the bin edges
are computed according to the align parameter.
:param str legend:
The legend to be associated to the histogram (or None)
:param color: color to be used
:type color: str ("#RRGGBB") or RGB unsigned byte array or
one of the predefined color names defined in colors.py
:param bool fill: True to fill the curve, False otherwise (default).
:param str align:
In case histogram values and edges have the same length N,
the N+1 bin edges are computed according to the alignment in:
'center' (default), 'left', 'right'.
:param bool resetzoom: True (the default) to reset the zoom.
:param bool copy: True make a copy of the data (default),
False to use provided arrays.
:param int z: Layer on which to draw the histogram
:param baseline: histogram baseline
:type: Union[None,float,numpy.ndarray]
:returns: The histogram item
"""
legend = "Unnamed histogram" if legend is None else str(legend)
# Create/Update histogram object
histo = self.getHistogram(legend)
mustBeAdded = histo is None
if histo is None:
# No previous histogram, create a default one and
# add it to the plot
histo = items.Histogram()
histo.setName(legend)
histo.setColor(self._getColorAndStyle()[0])
# Override previous/default values with provided ones
if color is not None:
histo.setColor(
colors.rgba(color, colors=self.getDefaultColors())
if isinstance(color, str)
else color
)
if fill is not None:
histo.setFill(fill)
if z is not None:
histo.setZValue(z=z)
# Set histogram data
histo.setData(
histogram=histogram, edges=edges, baseline=baseline, align=align, copy=copy
)
if mustBeAdded:
self.addItem(histo)
else:
self._notifyContentChanged(histo)
if resetzoom:
# We ask for a zoom reset in order to handle the plot scaling
# if the user does not want that, autoscale of the different
# axes has to be set to off.
self.resetZoom()
return histo
[docs]
def addImage(
self,
data,
legend=None,
info=None,
replace=False,
z=None,
selectable=None,
draggable=None,
colormap=None,
pixmap=None,
xlabel=None,
ylabel=None,
origin=None,
scale=None,
resetzoom=True,
copy=True,
):
"""Add a 2D dataset or an image to the plot.
It displays either an array of data using a colormap or a RGB(A) image.
Images are uniquely identified by their legend.
To add multiple images, call :meth:`addImage` multiple times with
different legend argument.
To replace/update an existing image, call :meth:`addImage` with the
existing image legend.
When image parameters are not provided, if an image with the
same legend is displayed in the plot, its parameters are used.
:param numpy.ndarray data:
(nrows, ncolumns) data or
(nrows, ncolumns, RGBA) ubyte array
Note: boolean values are converted to int8.
:param str legend: The legend to be associated to the image (or None)
:param info: User-defined information associated to the image
:param bool replace:
True to delete already existing images (Default: False).
:param int z: Layer on which to draw the image (default: 0)
This allows to control the overlay.
:param bool selectable: Indicate if the image can be selected.
(default: False)
:param bool draggable: Indicate if the image can be moved.
(default: False)
:param colormap: Colormap object to use (or None).
This is ignored if data is a RGB(A) image.
:type colormap: Union[~silx.gui.colors.Colormap, dict]
:param pixmap: Pixmap representation of the data (if any)
:type pixmap: (nrows, ncolumns, RGBA) ubyte array or None (default)
:param str xlabel: X axis label to show when this curve is active,
or None to keep default axis label.
:param str ylabel: Y axis label to show when this curve is active,
or None to keep default axis label.
:param origin: (origin X, origin Y) of the data.
It is possible to pass a single float if both
coordinates are equal.
Default: (0., 0.)
:type origin: float or 2-tuple of float
:param scale: (scale X, scale Y) of the data.
It is possible to pass a single float if both
coordinates are equal.
Default: (1., 1.)
:type scale: float or 2-tuple of float
:param bool resetzoom: True (the default) to reset the zoom.
:param bool copy: True make a copy of the data (default),
False to use provided arrays.
:returns: The image item
"""
legend = "Unnamed Image 1.1" if legend is None else str(legend)
data = numpy.asarray(data)
assert data.ndim in (2, 3)
image = self.getImage(legend)
if image is not None and image.getData(copy=False).ndim != data.ndim:
# Update a data image with RGBA image or the other way around:
# Remove previous image
# In this case, we don't retrieve defaults from the previous image
self.removeItem(image)
image = None
mustBeAdded = image is None
if image is None:
# No previous image, create a default one and add it to the plot
if data.ndim == 2:
image = items.ImageData()
image.setColormap(self.getDefaultColormap())
else:
image = items.ImageRgba()
image.setName(legend)
# Do not emit sigActiveImageChanged,
# it will be sent once with _setActiveItem
with self._muteActiveItemChangedSignal():
# Override previous/default values with provided ones
image.setInfo(info)
if origin is not None:
image.setOrigin(origin)
if scale is not None:
image.setScale(scale)
if z is not None:
image.setZValue(z)
if selectable is not None:
image._setSelectable(selectable)
if draggable is not None:
image._setDraggable(draggable)
if colormap is not None and isinstance(image, items.ColormapMixIn):
if isinstance(colormap, dict):
image.setColormap(Colormap._fromDict(colormap))
else:
assert isinstance(colormap, Colormap)
image.setColormap(colormap)
if xlabel is not None:
image._setXLabel(xlabel)
if ylabel is not None:
image._setYLabel(ylabel)
if data.ndim == 2:
image.setData(data, alternative=pixmap, copy=copy)
else: # RGB(A) image
if pixmap is not None:
_logger.warning(
"addImage: pixmap argument ignored when data is RGB(A)"
)
image.setData(data, copy=copy)
if replace:
for img in self.getAllImages():
if img is not image:
self.removeItem(img)
if mustBeAdded:
self.addItem(image)
else:
self._notifyContentChanged(image)
if len(self.getAllImages()) == 1 or image is self.getActiveImage():
self.setActiveImage(image)
if resetzoom:
# We ask for a zoom reset in order to handle the plot scaling
# if the user does not want that, autoscale of the different
# axes has to be set to off.
self.resetZoom()
return image
[docs]
def addScatter(
self,
x,
y,
value,
legend=None,
colormap=None,
info=None,
symbol=None,
xerror=None,
yerror=None,
z=None,
copy=True,
):
"""Add a (x, y, value) scatter to the graph.
Scatters are uniquely identified by their legend.
To add multiple scatters, call :meth:`addScatter` multiple times with
different legend argument.
To replace/update an existing scatter, call :meth:`addScatter` with the
existing scatter legend.
When scatter parameters are not provided, if a scatter with the
same legend is displayed in the plot, its parameters are used.
:param numpy.ndarray x: The data corresponding to the x coordinates.
:param numpy.ndarray y: The data corresponding to the y coordinates
:param numpy.ndarray value: The data value associated with each point
:param str legend: The legend to be associated to the scatter (or None)
:param ~silx.gui.colors.Colormap colormap:
Colormap object to be used for the scatter (or None)
:param info: User-defined information associated to the curve
:param str symbol: Symbol to be drawn at each (x, y) position::
- 'o' circle
- '.' point
- ',' pixel
- '+' cross
- 'x' x-cross
- 'd' diamond
- 's' square
- None (the default) to use default symbol
:param xerror: Values with the uncertainties on the x values
:type xerror: A float, or a numpy.ndarray of float32.
If it is an array, it can either be a 1D array of
same length as the data or a 2D array with 2 rows
of same length as the data: row 0 for lower errors,
row 1 for upper errors.
:param yerror: Values with the uncertainties on the y values
:type yerror: A float, or a numpy.ndarray of float32. See xerror.
:param int z: Layer on which to draw the scatter (default: 1)
This allows to control the overlay.
:param bool copy: True make a copy of the data (default),
False to use provided arrays.
:returns: The scatter item
"""
legend = "Unnamed scatter 1.1" if legend is None else str(legend)
# Create/Update curve object
scatter = self._getItem(kind="scatter", legend=legend)
mustBeAdded = scatter is None
if scatter is None:
# No previous scatter, create a default one and add it to the plot
scatter = items.Scatter()
scatter.setName(legend)
scatter.setColormap(self.getDefaultColormap())
# Do not emit sigActiveScatterChanged,
# it will be sent once with _setActiveItem
with self._muteActiveItemChangedSignal():
# Override previous/default values with provided ones
scatter.setInfo(info)
if symbol is not None:
scatter.setSymbol(symbol)
if z is not None:
scatter.setZValue(z)
if colormap is not None:
if isinstance(colormap, dict):
scatter.setColormap(Colormap._fromDict(colormap))
else:
assert isinstance(colormap, Colormap)
scatter.setColormap(colormap)
# Set scatter data
# If errors not provided, reuse previous ones
if xerror is None:
xerror = scatter.getXErrorData(copy=False)
if xerror is not None and len(xerror) != len(x):
xerror = None
if yerror is None:
yerror = scatter.getYErrorData(copy=False)
if yerror is not None and len(yerror) != len(y):
yerror = None
scatter.setData(x, y, value, xerror, yerror, copy=copy)
if mustBeAdded:
self.addItem(scatter)
else:
self._notifyContentChanged(scatter)
scatters = [
item
for item in self.getItems()
if isinstance(item, items.Scatter) and item.isVisible()
]
if len(scatters) == 1 or scatter is self.getActiveScatter():
self.setActiveScatter(scatter)
return scatter
def addShape(
self,
xdata,
ydata,
legend=None,
info=None,
replace=False,
shape="polygon",
color="black",
fill=True,
overlay=False,
z=None,
linestyle="-",
linewidth=1.0,
linebgcolor="deprecated",
gapcolor=None,
):
"""Add an item (i.e. a shape) to the plot.
Items are uniquely identified by their legend.
To add multiple items, call :meth:`addItem` multiple times with
different legend argument.
To replace/update an existing item, call :meth:`addItem` with the
existing item legend.
:param numpy.ndarray xdata: The X coords of the points of the shape
:param numpy.ndarray ydata: The Y coords of the points of the shape
:param str legend: The legend to be associated to the item
:param info: User-defined information associated to the item
:param bool replace: True to delete already existing items
(the default is False)
:param str shape: Type of item to be drawn in
hline, polygon (the default), rectangle, vline,
polylines
:param str color: Color of the item, e.g., 'blue', 'b', '#FF0000'
(Default: 'black')
:param bool fill: True (the default) to fill the shape
:param bool overlay: True if item is an overlay (Default: False).
This allows for rendering optimization if this
item is changed often.
:param int z: Layer on which to draw the item (default: 2)
:param str linestyle: Style of the line.
Only relevant for line markers where X or Y is None.
Value in:
- ' ' no line
- '-' solid line
- '--' dashed line
- '-.' dash-dot line
- ':' dotted line
:param float linewidth: Width of the line.
Only relevant for line markers where X or Y is None.
:param str gapcolor: Gap color of the line, e.g., 'blue', 'b',
'#FF0000'. It is used to draw dotted line using a second color.
:returns: The shape item
"""
# expected to receive the same parameters as the signal
legend = "Unnamed Item 1.1" if legend is None else str(legend)
z = int(z) if z is not None else 2
if replace:
self.remove(kind="item")
else:
self.remove(legend, kind="item")
item = items.Shape(shape)
item.setName(legend)
item.setInfo(info)
item.setColor(color)
item.setFill(fill)
item.setOverlay(overlay)
item.setZValue(z)
item.setPoints(numpy.array((xdata, ydata)).T)
item.setLineStyle(linestyle)
item.setLineWidth(linewidth)
if linebgcolor != "deprecated":
deprecated_warning(
type_="Argument",
name="linebgcolor",
replacement="gapcolor",
since_version="2.0.0",
)
gapcolor = linebgcolor if gapcolor is None else gapcolor
item.setLineGapColor(gapcolor)
self.addItem(item)
return item
[docs]
def addXMarker(
self,
x,
legend=None,
text=None,
color=None,
selectable=False,
draggable=False,
constraint=None,
yaxis="left",
):
"""Add a vertical line marker to the plot.
Markers are uniquely identified by their legend.
As opposed to curves, images and items, two calls to
:meth:`addXMarker` without legend argument adds two markers with
different identifying legends.
:param x: Position of the marker on the X axis in data coordinates
:type x: Union[None, float]
:param str legend: Legend associated to the marker to identify it
:param str text: Text to display on the marker.
:param str color: Color of the marker, e.g., 'blue', 'b', '#FF0000'
(Default: 'black')
:param bool selectable: Indicate if the marker can be selected.
(default: False)
:param bool draggable: Indicate if the marker can be moved.
(default: False)
:param constraint: A function filtering marker displacement by
dragging operations or None for no filter.
This function is called each time a marker is
moved.
This parameter is only used if draggable is True.
:type constraint: None or a callable that takes the coordinates of
the current cursor position in the plot as input
and that returns the filtered coordinates.
:param str yaxis: The Y axis this marker belongs to in: 'left', 'right'
:return: The marker item
"""
return self._addMarker(
x=x,
y=None,
legend=legend,
text=text,
color=color,
selectable=selectable,
draggable=draggable,
symbol=None,
constraint=constraint,
yaxis=yaxis,
)
[docs]
def addYMarker(
self,
y,
legend=None,
text=None,
color=None,
selectable=False,
draggable=False,
constraint=None,
yaxis="left",
):
"""Add a horizontal line marker to the plot.
Markers are uniquely identified by their legend.
As opposed to curves, images and items, two calls to
:meth:`addYMarker` without legend argument adds two markers with
different identifying legends.
:param float y: Position of the marker on the Y axis in data
coordinates
:param str legend: Legend associated to the marker to identify it
:param str text: Text to display next to the marker.
:param str color: Color of the marker, e.g., 'blue', 'b', '#FF0000'
(Default: 'black')
:param bool selectable: Indicate if the marker can be selected.
(default: False)
:param bool draggable: Indicate if the marker can be moved.
(default: False)
:param constraint: A function filtering marker displacement by
dragging operations or None for no filter.
This function is called each time a marker is
moved.
This parameter is only used if draggable is True.
:type constraint: None or a callable that takes the coordinates of
the current cursor position in the plot as input
and that returns the filtered coordinates.
:param str yaxis: The Y axis this marker belongs to in: 'left', 'right'
:return: The marker item
"""
return self._addMarker(
x=None,
y=y,
legend=legend,
text=text,
color=color,
selectable=selectable,
draggable=draggable,
symbol=None,
constraint=constraint,
yaxis=yaxis,
)
[docs]
def addMarker(
self,
x,
y,
legend=None,
text=None,
color=None,
selectable=False,
draggable=False,
symbol="+",
constraint=None,
yaxis="left",
):
"""Add a point marker to the plot.
Markers are uniquely identified by their legend.
As opposed to curves, images and items, two calls to
:meth:`addMarker` without legend argument adds two markers with
different identifying legends.
:param float x: Position of the marker on the X axis in data
coordinates
:param float y: Position of the marker on the Y axis in data
coordinates
:param str legend: Legend associated to the marker to identify it
:param str text: Text to display next to the marker
:param str color: Color of the marker, e.g., 'blue', 'b', '#FF0000'
(Default: 'black')
:param bool selectable: Indicate if the marker can be selected.
(default: False)
:param bool draggable: Indicate if the marker can be moved.
(default: False)
:param str symbol: Symbol representing the marker in::
- 'o' circle
- '.' point
- ',' pixel
- '+' cross (the default)
- 'x' x-cross
- 'd' diamond
- 's' square
:param constraint: A function filtering marker displacement by
dragging operations or None for no filter.
This function is called each time a marker is
moved.
This parameter is only used if draggable is True.
:type constraint: None or a callable that takes the coordinates of
the current cursor position in the plot as input
and that returns the filtered coordinates.
:param str yaxis: The Y axis this marker belongs to in: 'left', 'right'
:return: The marker item
"""
if x is None:
xmin, xmax = self._xAxis.getLimits()
x = 0.5 * (xmax + xmin)
if y is None:
ymin, ymax = self._yAxis.getLimits()
y = 0.5 * (ymax + ymin)
return self._addMarker(
x=x,
y=y,
legend=legend,
text=text,
color=color,
selectable=selectable,
draggable=draggable,
symbol=symbol,
constraint=constraint,
yaxis=yaxis,
)
def _addMarker(
self,
x,
y,
legend,
text,
color,
selectable,
draggable,
symbol,
constraint,
yaxis=None,
):
"""Common method for adding point, vline and hline marker.
See :meth:`addMarker` for argument documentation.
"""
assert (x, y) != (None, None)
if legend is None: # Find an unused legend
markerLegends = [
item.getName()
for item in self.getItems()
if isinstance(item, items.MarkerBase)
]
for index in itertools.count():
legend = "Unnamed Marker %d" % index
if legend not in markerLegends:
break # Keep this legend
legend = str(legend)
if x is None:
markerClass = items.YMarker
elif y is None:
markerClass = items.XMarker
else:
markerClass = items.Marker
# Create/Update marker object
marker = self._getMarker(legend)
if marker is not None and not isinstance(marker, markerClass):
_logger.warning(
"Adding marker with same legend" " but different type replaces it"
)
self.removeItem(marker)
marker = None
mustBeAdded = marker is None
if marker is None:
# No previous marker, create one
marker = markerClass()
marker.setName(legend)
if text is not None:
marker.setText(text)
if color is not None:
marker.setColor(color)
if selectable is not None:
marker._setSelectable(selectable)
if draggable is not None:
marker._setDraggable(draggable)
if symbol is not None:
marker.setSymbol(symbol)
marker.setYAxis(yaxis)
# TODO to improve, but this ensure constraint is applied
marker.setPosition(x, y)
if constraint is not None:
marker._setConstraint(constraint)
marker.setPosition(x, y)
if mustBeAdded:
self.addItem(marker)
else:
self._notifyContentChanged(marker)
return marker
# Hide
def isCurveHidden(self, legend):
"""Returns True if the curve associated to legend is hidden, else False
:param str legend: The legend key identifying the curve
:return: True if the associated curve is hidden, False otherwise
"""
curve = self._getItem("curve", legend)
return curve is not None and not curve.isVisible()
def hideCurve(self, legend, flag=True):
"""Show/Hide the curve associated to legend.
Even when hidden, the curve is kept in the list of curves.
:param str legend: The legend associated to the curve to be hidden
:param bool flag: True (default) to hide the curve, False to show it
"""
curve = self._getItem("curve", legend)
if curve is None:
_logger.warning("Curve not in plot: %s", legend)
return
isVisible = not flag
if isVisible != curve.isVisible():
curve.setVisible(isVisible)
# Remove
ITEM_KINDS = "curve", "image", "scatter", "item", "marker", "histogram"
"""List of supported kind of items in the plot."""
_ACTIVE_ITEM_KINDS = "curve", "scatter", "image"
"""List of item's kind which have a active item."""
[docs]
def remove(
self,
legend: str | items.Item | None = None,
kind: str | Sequence[str] = ITEM_KINDS,
):
"""Remove one or all element(s) of the given legend and kind.
Examples:
- ``remove()`` clears the plot
- ``remove(kind='curve')`` removes all curves from the plot
- ``remove('myCurve', kind='curve')`` removes the curve with
legend 'myCurve' from the plot.
- ``remove('myImage, kind='image')`` removes the image with
legend 'myImage' from the plot.
- ``remove('myImage')`` removes elements (for instance curve, image,
item and marker) with legend 'myImage'.
:param legend:
The legend of the item to remove or the item itself.
If None all items of given kind are removed.
:param kind: The kind of items to remove from the plot.
See :attr:`ITEM_KINDS`.
By default, it removes all kind of elements.
"""
if isinstance(legend, items.Item):
return self.removeItem(legend)
if kind == "all": # Replace all by tuple of all kinds
kind = self.ITEM_KINDS
if kind in self.ITEM_KINDS: # Kind is a str, make it a tuple
kind = (kind,)
for aKind in kind:
assert aKind in self.ITEM_KINDS
if legend is None: # This is a clear
# Clear each given kind
for aKind in kind:
for item in self.getItems():
if (
isinstance(item, self._KIND_TO_CLASSES[aKind])
and item.getPlot() is self
): # Make sure item is still in the plot
self.removeItem(item)
else: # This is removing a single element
# Remove each given kind
for aKind in kind:
item = self._getItem(aKind, legend)
if item is not None:
self.removeItem(item)
def removeCurve(self, legend: str | items.Curve | None):
"""Remove the curve associated to legend from the graph.
:param legend:
The legend of the curve to be deleted or the curve item
"""
if legend is None:
return
if isinstance(legend, items.Item):
return self.removeItem(legend)
self.remove(legend, kind="curve")
def removeImage(self, legend: str | items.ImageBase | None):
"""Remove the image associated to legend from the graph.
:param legend:
The legend of the image to be deleted or the image item
"""
if legend is None:
return
if isinstance(legend, items.Item):
return self.removeItem(legend)
self.remove(legend, kind="image")
def removeMarker(self, legend: str | items.Marker | None):
"""Remove the marker associated to legend from the graph.
:param legend:
The legend of the marker to be deleted or the marker item
"""
if legend is None:
return
if isinstance(legend, items.Item):
return self.removeItem(legend)
self.remove(legend, kind="marker")
# Clear
[docs]
def clear(self):
"""Remove everything from the plot."""
for item in self.getItems():
if item.getPlot() is self: # Make sure item is still in the plot
self.removeItem(item)
def clearCurves(self):
"""Remove all the curves from the plot."""
self.remove(kind="curve")
def clearImages(self):
"""Remove all the images from the plot."""
self.remove(kind="image")
def clearItems(self):
"""Remove all the items from the plot."""
self.remove(kind="item")
def clearMarkers(self):
"""Remove all the markers from the plot."""
self.remove(kind="marker")
# Interaction
[docs]
def getGraphCursor(self):
"""Returns the state of the crosshair cursor.
See :meth:`setGraphCursor`.
:return: None if the crosshair cursor is not active,
else a tuple (color, linewidth, linestyle).
"""
return self._cursorConfiguration
[docs]
def setGraphCursor(self, flag=False, color="black", linewidth=1, linestyle="-"):
"""Toggle the display of a crosshair cursor and set its attributes.
:param bool flag: Toggle the display of a crosshair cursor.
The crosshair cursor is hidden by default.
:param color: The color to use for the crosshair.
:type color: A string (either a predefined color name in colors.py
or "#RRGGBB")) or a 4 columns unsigned byte array
(Default: black).
:param int linewidth: The width of the lines of the crosshair
(Default: 1).
:param str linestyle: Type of line::
- ' ' no line
- '-' solid line (the default)
- '--' dashed line
- '-.' dash-dot line
- ':' dotted line
"""
if flag:
self._cursorConfiguration = color, linewidth, linestyle
else:
self._cursorConfiguration = None
self._backend.setGraphCursor(
flag=flag, color=color, linewidth=linewidth, linestyle=linestyle
)
self._setDirtyPlot()
self.notify("setGraphCursor", state=self._cursorConfiguration is not None)
def pan(self, direction, factor=0.1):
"""Pan the graph in the given direction by the given factor.
Warning: Pan of right Y axis not implemented!
:param str direction: One of 'up', 'down', 'left', 'right'.
:param float factor: Proportion of the range used to pan the graph.
Must be strictly positive.
"""
assert direction in ("up", "down", "left", "right")
assert factor > 0.0
if direction in ("left", "right"):
xFactor = factor if direction == "right" else -factor
xMin, xMax = self._xAxis.getLimits()
xMin, xMax = _utils.applyPan(
xMin, xMax, xFactor, self._xAxis.getScale() == self._xAxis.LOGARITHMIC
)
self._xAxis.setLimits(xMin, xMax)
else: # direction in ('up', 'down')
sign = -1.0 if self._yAxis.isInverted() else 1.0
yFactor = sign * (factor if direction == "up" else -factor)
yMin, yMax = self._yAxis.getLimits()
yIsLog = self._yAxis.getScale() == self._yAxis.LOGARITHMIC
yMin, yMax = _utils.applyPan(yMin, yMax, yFactor, yIsLog)
self._yAxis.setLimits(yMin, yMax)
y2Min, y2Max = self._yRightAxis.getLimits()
y2Min, y2Max = _utils.applyPan(y2Min, y2Max, yFactor, yIsLog)
self._yRightAxis.setLimits(y2Min, y2Max)
# Active Curve/Image
def isActiveCurveHandling(self):
"""Returns True if active curve selection is enabled.
:rtype: bool
"""
return self.getActiveCurveSelectionMode() != "none"
def setActiveCurveHandling(self, flag=True):
"""Enable/Disable active curve selection.
:param bool flag: True to enable 'atmostone' active curve selection,
False to disable active curve selection.
"""
self.setActiveCurveSelectionMode("atmostone" if flag else "none")
[docs]
def getActiveCurveStyle(self):
"""Returns the current style applied to active curve
:rtype: CurveStyle
"""
return self._activeCurveStyle
[docs]
def setActiveCurveStyle(
self, color=None, linewidth=None, linestyle=None, symbol=None, symbolsize=None
):
"""Set the style of active curve
:param color: Color
:param Union[str,None] linestyle: Style of the line
:param Union[float,None] linewidth: Width of the line
:param Union[str,None] symbol: Symbol of the markers
:param Union[float,None] symbolsize: Size of the symbols
"""
self._activeCurveStyle = CurveStyle(
color=color,
linewidth=linewidth,
linestyle=linestyle,
symbol=symbol,
symbolsize=symbolsize,
)
curve = self.getActiveCurve()
if curve is not None:
curve.setHighlightedStyle(self.getActiveCurveStyle())
[docs]
def getActiveCurve(self, just_legend=False):
"""Return the currently active curve.
It returns None in case of not having an active curve.
:param bool just_legend: True to get the legend of the curve,
False (the default) to get the curve data
and info.
:return: Active curve's legend or corresponding
:class:`.items.Curve`
:rtype: str or :class:`.items.Curve` or None
"""
if not self.isActiveCurveHandling():
return None
return self._getActiveItem(kind="curve", just_legend=just_legend)
[docs]
def setActiveCurve(self, legend):
"""Make the curve associated to legend the active curve.
:param legend: The legend associated to the curve
or None to have no active curve.
:type legend: str or None
"""
if not self.isActiveCurveHandling():
return
if legend is None and self.getActiveCurveSelectionMode() == "legacy":
_logger.info(
"setActiveCurve(None) ignored due to active curve selection mode"
)
return
return self._setActiveItem(kind="curve", item=legend)
[docs]
def setActiveCurveSelectionMode(self, mode):
"""Sets the current selection mode.
:param str mode: The active curve selection mode to use.
It can be: 'legacy', 'atmostone' or 'none'.
"""
assert mode in ("legacy", "atmostone", "none")
if mode != self._activeCurveSelectionMode:
self._activeCurveSelectionMode = mode
if mode == "none": # reset active curve
self._setActiveItem(kind="curve", item=None)
elif mode == "legacy" and self.getActiveCurve() is None:
# Select an active curve
curves = self.getAllCurves(just_legend=False, withhidden=False)
if len(curves) == 1:
if curves[0].isVisible():
self.setActiveCurve(curves[0].getName())
[docs]
def getActiveCurveSelectionMode(self):
"""Returns the current selection mode.
It can be "atmostone", "legacy" or "none".
:rtype: str
"""
return self._activeCurveSelectionMode
[docs]
def getActiveImage(self, just_legend=False):
"""Returns the currently active image.
It returns None in case of not having an active image.
:param bool just_legend: True to get the legend of the image,
False (the default) to get the image data
and info.
:return: Active image's legend or corresponding image object
:rtype: str, :class:`.items.ImageData`, :class:`.items.ImageRgba`
or None
"""
return self._getActiveItem(kind="image", just_legend=just_legend)
[docs]
def setActiveImage(self, legend):
"""Make the image associated to legend the active image.
:param str legend: The legend associated to the image
or None to have no active image.
"""
return self._setActiveItem(kind="image", item=legend)
def getActiveScatter(self, just_legend=False):
"""Returns the currently active scatter.
It returns None in case of not having an active scatter.
:param bool just_legend: True to get the legend of the scatter,
False (the default) to get the scatter data
and info.
:return: Active scatter's legend or corresponding scatter object
:rtype: str, :class:`.items.Scatter` or None
"""
return self._getActiveItem(kind="scatter", just_legend=just_legend)
def setActiveScatter(self, legend):
"""Make the scatter associated to legend the active scatter.
:param str legend: The legend associated to the scatter
or None to have no active scatter.
"""
return self._setActiveItem(kind="scatter", item=legend)
def _getActiveItem(
self,
kind: str | None,
just_legend: bool = False,
) -> items.Curve | items.Scatter | items.ImageBase | None:
"""Return the currently active item of given kind if any.
:param kind: Type of item: 'curve', 'scatter' or 'image'
:param just_legend:
True to get the item's legend, False (the default) to get the item
"""
assert kind in self._ACTIVE_ITEM_KINDS
item = self.__activeItems[kind]
if item is not None and just_legend:
return item.getName()
return item
def _setActiveItem(
self,
kind: str,
item: items.Curve | items.ImageBase | items.Scatter | str | None,
) -> str | None:
"""Make the given item active.
Note: There is one active item per "kind" of item.
"""
assert kind in self._ACTIVE_ITEM_KINDS
if item is None:
legend = None
elif isinstance(item, items.Item):
legend = item.getName()
else:
legend = str(item)
item = self._getItem(kind, legend)
if item is None:
_logger.warning("This %s does not exist: %s", kind, legend)
oldActiveItem = self._getActiveItem(kind=kind)
if oldActiveItem is None and item is None:
return None
if oldActiveItem is not None:
# Stop listening previous active item
oldActiveItem.sigItemChanged.disconnect(self._activeItemChanged)
# Curve specific: Reset highlight of previous active curve
if kind == "curve":
oldActiveItem.setHighlighted(False)
self.__activeItems[kind] = item
xLabel = None
yLabel = None
yRightLabel = None
if item is not None:
# Curve specific: handle highlight
if kind == "curve":
item.setHighlightedStyle(self.getActiveCurveStyle())
item.setHighlighted(True)
if isinstance(item, items.LabelsMixIn):
xLabel = item.getXLabel()
if isinstance(item, items.YAxisMixIn) and item.getYAxis() == "right":
yRightLabel = item.getYLabel()
else:
yLabel = item.getYLabel()
# Start listening new active item
item.sigItemChanged.connect(self._activeItemChanged)
# Store current labels and update plot
self._xAxis._setCurrentLabel(xLabel)
self._yAxis._setCurrentLabel(yLabel)
self._yRightAxis._setCurrentLabel(yRightLabel)
self._setDirtyPlot()
self.notify(
f"active{kind.capitalize()}Changed",
updated=oldActiveItem is not item,
previous=None if oldActiveItem is None else oldActiveItem.getName(),
legend=legend,
)
return legend
def _activeItemChanged(self, type_):
"""Listen for active item changed signal and broadcast signal
:param item.ItemChangedType type_: The type of item change
"""
if not self.__muteActiveItemChanged:
item = self.sender()
if item is not None:
kind = self._itemKind(item)
self.notify(
"active" + kind[0].upper() + kind[1:] + "Changed",
updated=False,
previous=item.getName(),
legend=item.getName(),
)
# Getters
def getAllCurves(self, just_legend=False, withhidden=False):
"""Returns all curves legend or info and data.
It returns an empty list in case of not having any curve.
If just_legend is False, it returns a list of :class:`items.Curve`
objects describing the curves.
If just_legend is True, it returns a list of curves' legend.
:param bool just_legend: True to get the legend of the curves,
False (the default) to get the curves' data
and info.
:param bool withhidden: False (default) to skip hidden curves.
:return: list of curves' legend or :class:`.items.Curve`
:rtype: list of str or list of :class:`.items.Curve`
"""
curves = [
item
for item in self.getItems()
if isinstance(item, items.Curve) and (withhidden or item.isVisible())
]
return [curve.getName() for curve in curves] if just_legend else curves
[docs]
def getCurve(self, legend: str | items.Curve | None = None) -> items.Curve:
"""Get the object describing a specific curve.
It returns None in case no matching curve is found.
:param legend:
The legend identifying the curve.
If not provided or None (the default), the active curve is returned
or if there is no active curve, the latest updated curve that is
not hidden is returned if there are curves in the plot.
:return: None or :class:`.items.Curve` object
"""
if isinstance(legend, items.Curve):
_logger.warning("getCurve call not needed: legend is already an item")
return legend
return self._getItem(kind="curve", legend=legend)
def getAllImages(self, just_legend=False):
"""Returns all images legend or objects.
It returns an empty list in case of not having any image.
If just_legend is False, it returns a list of :class:`items.ImageBase`
objects describing the images.
If just_legend is True, it returns a list of legends.
:param bool just_legend: True to get the legend of the images,
False (the default) to get the images'
object.
:return: list of images' legend or :class:`.items.ImageBase`
:rtype: list of str or list of :class:`.items.ImageBase`
"""
images = [item for item in self.getItems() if isinstance(item, items.ImageBase)]
return [image.getName() for image in images] if just_legend else images
[docs]
def getImage(self, legend: str | items.ImageBase | None = None) -> items.ImageBase:
"""Get the object describing a specific image.
It returns None in case no matching image is found.
:param legend:
The legend identifying the image.
If not provided or None (the default), the active image is returned
or if there is no active image, the latest updated image
is returned if there are images in the plot.
:return: None or :class:`.items.ImageBase` object
"""
if isinstance(legend, items.ImageBase):
_logger.warning("getImage call not needed: legend is already an item")
return legend
return self._getItem(kind="image", legend=legend)
[docs]
def getScatter(self, legend: str | items.Scatter | None = None) -> items.Scatter:
"""Get the object describing a specific scatter.
It returns None in case no matching scatter is found.
:param legend:
The legend identifying the scatter.
If not provided or None (the default), the active scatter is
returned or if there is no active scatter, the latest updated
scatter is returned if there are scatters in the plot.
:return: None or :class:`.items.Scatter` object
"""
if isinstance(legend, items.Scatter):
_logger.warning("getScatter call not needed: legend is already an item")
return legend
return self._getItem(kind="scatter", legend=legend)
[docs]
def getHistogram(
self, legend: str | items.Histogram | None = None
) -> items.Histogram:
"""Get the object describing a specific histogram.
It returns None in case no matching histogram is found.
:param legend:
The legend identifying the histogram.
If not provided or None (the default), the latest updated scatter
is returned if there are histograms in the plot.
:return: None or :class:`.items.Histogram` object
"""
if isinstance(legend, items.Histogram):
_logger.warning("getHistogram call not needed: legend is already an item")
return legend
return self._getItem(kind="histogram", legend=legend)
def _getItem(self, kind, legend=None) -> items.Item:
"""Get an item from the plot: either an image or a curve.
Returns None if no match found.
:param str kind: Type of item to retrieve,
see :attr:`ITEM_KINDS`.
:param str legend: Legend of the item or
None to get active or last item
:return: Object describing the item or None
"""
if isinstance(legend, items.Item):
_logger.warning("_getItem call not needed: legend is already an item")
return legend
assert kind in self.ITEM_KINDS
if legend is not None:
for item in self.getItems():
if item.getName() == legend and kind == self._itemKind(item):
return item
return None # No item found
if kind in self._ACTIVE_ITEM_KINDS:
item = self._getActiveItem(kind=kind)
if item is not None: # Return active item if available
return item
# Return last visible item if any
itemClasses = self._KIND_TO_CLASSES[kind]
allItems = [
item
for item in self.getItems()
if isinstance(item, itemClasses) and item.isVisible()
]
return allItems[-1] if allItems else None
# Limits
def _notifyLimitsChanged(self, emitSignal=True):
"""Send an event when plot area limits are changed."""
xRange = self._xAxis.getLimits()
yRange = self._yAxis.getLimits()
y2Range = self._yRightAxis.getLimits()
if emitSignal:
axes = self.getXAxis(), self.getYAxis(), self.getYAxis(axis="right")
ranges = xRange, yRange, y2Range
for axis, limits in zip(axes, ranges):
axis.sigLimitsChanged.emit(*limits)
event = PlotEvents.prepareLimitsChangedSignal(
id(self.getWidgetHandle()), xRange, yRange, y2Range
)
self.notify(**event)
def getLimitsHistory(self):
"""Returns the object handling the history of limits of the plot"""
return self._limitsHistory
def getGraphXLimits(self):
"""Get the graph X (bottom) limits.
:return: Minimum and maximum values of the X axis
"""
return self._backend.getGraphXLimits()
def setGraphXLimits(self, xmin, xmax):
"""Set the graph X (bottom) limits.
:param float xmin: minimum bottom axis value
:param float xmax: maximum bottom axis value
"""
self._xAxis.setLimits(xmin, xmax)
def getGraphYLimits(self, axis="left"):
"""Get the graph Y limits.
:param str axis: The axis for which to get the limits:
Either 'left' or 'right'
:return: Minimum and maximum values of the X axis
"""
assert axis in ("left", "right")
yAxis = self._yAxis if axis == "left" else self._yRightAxis
return yAxis.getLimits()
def setGraphYLimits(self, ymin, ymax, axis="left"):
"""Set the graph Y limits.
:param float ymin: minimum bottom axis value
:param float ymax: maximum bottom axis value
:param str axis: The axis for which to get the limits:
Either 'left' or 'right'
"""
assert axis in ("left", "right")
yAxis = self._yAxis if axis == "left" else self._yRightAxis
return yAxis.setLimits(ymin, ymax)
[docs]
def setLimits(
self,
xmin: float,
xmax: float,
ymin: float,
ymax: float,
y2min: Optional[float] = None,
y2max: Optional[float] = None,
margins: Union[bool, tuple[float, float, float, float]] = False,
):
"""Set the limits of the X and Y axes at once.
If y2min or y2max is None, the right Y axis limits are not updated.
:param xmin: minimum bottom axis value
:param xmax: maximum bottom axis value
:param ymin: minimum left axis value
:param ymax: maximum left axis value
:param y2min: minimum right axis value or None (the default)
:param y2max: maximum right axis value or None (the default)
:param margins:
Data margins to add to the limits or a boolean telling
whether or not to add margins from :meth:`getDataMargins`.
"""
limits = [
*self.getXAxis()._checkLimits(xmin, xmax),
*self.getYAxis()._checkLimits(ymin, ymax),
]
# Only consider y2 axis if both limits are not None
if None not in (y2min, y2max):
limits.extend(self.getYAxis(axis="right")._checkLimits(y2min, y2max))
if margins: # Add margins around limits inside the plot area
limits = list(
_utils.addMarginsToLimits(
self.getDataMargins() if margins is True else margins,
self.getXAxis()._isLogarithmic(),
self.getYAxis()._isLogarithmic(),
*limits,
)
)
if self.isKeepDataAspectRatio():
# Use limits with margins to keep ratio
xmin, xmax, ymin, ymax = limits[:4]
# Compute bbox wth figure aspect ratio
plotWidth, plotHeight = self.getPlotBoundsInPixels()[2:]
if plotWidth > 0 and plotHeight > 0:
plotRatio = plotHeight / plotWidth
dataRatio = (ymax - ymin) / (xmax - xmin)
if dataRatio < plotRatio:
# Increase y range
ycenter = 0.5 * (ymax + ymin)
yrange = (xmax - xmin) * plotRatio
limits[2] = ycenter - 0.5 * yrange
limits[3] = ycenter + 0.5 * yrange
elif dataRatio > plotRatio:
# Increase x range
xcenter = 0.5 * (xmax + xmin)
xrange_ = (ymax - ymin) / plotRatio
limits[0] = xcenter - 0.5 * xrange_
limits[1] = xcenter + 0.5 * xrange_
if self._viewConstrains:
limits[:4] = self._viewConstrains.normalize(*limits[:4])
self._backend.setLimits(*limits)
self._setDirtyPlot()
self._notifyLimitsChanged()
def _getViewConstraints(self):
"""Return the plot object managing constaints on the plot view.
:rtype: ViewConstraints
"""
if self._viewConstrains is None:
self._viewConstrains = ViewConstraints()
return self._viewConstrains
# Title and labels
[docs]
def setGraphTitle(self, title=""):
"""Set the plot main title.
:param str title: Main title of the plot (default: '')
"""
self._graphTitle = str(title)
self._backend.setGraphTitle(title)
self._setDirtyPlot()
def getGraphXLabel(self):
"""Return the current X axis label as a str."""
return self._xAxis.getLabel()
def setGraphXLabel(self, label="X"):
"""Set the plot X axis label.
The provided label can be temporarily replaced by the X label of the
active curve if any.
:param str label: The X axis label (default: 'X')
"""
self._xAxis.setLabel(label)
def getGraphYLabel(self, axis="left"):
"""Return the current Y axis label as a str.
:param str axis: The Y axis for which to get the label (left or right)
"""
assert axis in ("left", "right")
yAxis = self._yAxis if axis == "left" else self._yRightAxis
return yAxis.getLabel()
def setGraphYLabel(self, label="Y", axis="left"):
"""Set the plot Y axis label.
The provided label can be temporarily replaced by the Y label of the
active curve if any.
:param str label: The Y axis label (default: 'Y')
:param str axis: The Y axis for which to set the label (left or right)
"""
assert axis in ("left", "right")
yAxis = self._yAxis if axis == "left" else self._yRightAxis
return yAxis.setLabel(label)
# Axes
[docs]
def getXAxis(self):
"""Returns the X axis
.. versionadded:: 0.6
:rtype: :class:`.items.Axis`
"""
return self._xAxis
[docs]
def getYAxis(self, axis="left"):
"""Returns an Y axis
.. versionadded:: 0.6
:param str axis: The Y axis to return
('left' or 'right').
:rtype: :class:`.items.Axis`
"""
assert axis in ["left", "right"]
return self._yAxis if axis == "left" else self._yRightAxis
[docs]
def setAxesDisplayed(self, displayed: bool):
"""Display or not the axes.
:param bool displayed: If `True` axes are displayed. If `False` axes
are not anymore visible and the margin used for them is removed.
"""
if displayed != self.__axesDisplayed:
self.__axesDisplayed = displayed
if displayed:
self._backend.setAxesMargins(*self.__axesMargins)
else:
self._backend.setAxesMargins(0.0, 0.0, 0.0, 0.0)
self._setDirtyPlot()
self._sigAxesVisibilityChanged.emit(displayed)
[docs]
def isAxesDisplayed(self) -> bool:
"""Returns whether or not axes are currently displayed
:rtype: bool
"""
return self.__axesDisplayed
[docs]
def setAxesMargins(self, left: float, top: float, right: float, bottom: float):
"""Set ratios of margins surrounding data plot area.
All ratios must be within [0., 1.].
Sums of ratios of opposed side must be < 1.
:param float left: Left-side margin ratio.
:param float top: Top margin ratio
:param float right: Right-side margin ratio
:param float bottom: Bottom margin ratio
:raises ValueError:
"""
for value in (left, top, right, bottom):
if value < 0.0 or value > 1.0:
raise ValueError("Margin ratios must be within [0., 1.]")
if left + right >= 1.0 or top + bottom >= 1.0:
raise ValueError("Sum of ratios of opposed sides >= 1")
margins = left, top, right, bottom
if margins != self.__axesMargins:
self.__axesMargins = margins
if self.isAxesDisplayed(): # Only apply if axes are displayed
self._backend.setAxesMargins(*margins)
self._setDirtyPlot()
[docs]
def getAxesMargins(self):
"""Returns ratio of margins surrounding data plot area.
:return: (left, top, right, bottom)
:rtype: List[float]
"""
return self.__axesMargins
def setYAxisInverted(self, flag=True):
"""Set the Y axis orientation.
:param bool flag: True for Y axis going from top to bottom,
False for Y axis going from bottom to top
"""
self._yAxis.setInverted(flag)
def isYAxisInverted(self):
"""Return True if Y axis goes from top to bottom, False otherwise."""
return self._yAxis.isInverted()
def isXAxisLogarithmic(self):
"""Return True if X axis scale is logarithmic, False if linear."""
return self._xAxis._isLogarithmic()
def setXAxisLogarithmic(self, flag):
"""Set the bottom X axis scale (either linear or logarithmic).
:param bool flag: True to use a logarithmic scale, False for linear.
"""
self._xAxis._setLogarithmic(flag)
def isYAxisLogarithmic(self):
"""Return True if Y axis scale is logarithmic, False if linear."""
return self._yAxis._isLogarithmic()
def setYAxisLogarithmic(self, flag):
"""Set the Y axes scale (either linear or logarithmic).
:param bool flag: True to use a logarithmic scale, False for linear.
"""
self._yAxis._setLogarithmic(flag)
def isXAxisAutoScale(self):
"""Return True if X axis is automatically adjusting its limits."""
return self._xAxis.isAutoScale()
def setXAxisAutoScale(self, flag=True):
"""Set the X axis limits adjusting behavior of :meth:`resetZoom`.
:param bool flag: True to resize limits automatically,
False to disable it.
"""
self._xAxis.setAutoScale(flag)
def isYAxisAutoScale(self):
"""Return True if Y axes are automatically adjusting its limits."""
return self._yAxis.isAutoScale()
def setYAxisAutoScale(self, flag=True):
"""Set the Y axis limits adjusting behavior of :meth:`resetZoom`.
:param bool flag: True to resize limits automatically,
False to disable it.
"""
self._yAxis.setAutoScale(flag)
[docs]
def isKeepDataAspectRatio(self):
"""Returns whether the plot is keeping data aspect ratio or not."""
return self._backend.isKeepDataAspectRatio()
[docs]
def setKeepDataAspectRatio(self, flag=True):
"""Set whether the plot keeps data aspect ratio or not.
:param bool flag: True to respect data aspect ratio
"""
flag = bool(flag)
if flag == self.isKeepDataAspectRatio():
return
self._backend.setKeepDataAspectRatio(flag=flag)
self._setDirtyPlot()
self._forceResetZoom()
self.notify("setKeepDataAspectRatio", state=flag)
[docs]
def getGraphGrid(self):
"""Return the current grid mode, either None, 'major' or 'both'.
See :meth:`setGraphGrid`.
"""
return self._grid
[docs]
def setGraphGrid(self, which=True):
"""Set the type of grid to display.
:param which: None or False to disable the grid,
'major' or True for grid on major ticks (the default),
'both' for grid on both major and minor ticks.
:type which: str of bool
"""
assert which in (None, True, False, "both", "major")
if not which:
which = None
elif which is True:
which = "major"
self._grid = which
self._backend.setGraphGrid(which)
self._setDirtyPlot()
self.notify("setGraphGrid", which=str(which))
# Defaults
def isDefaultPlotPoints(self):
"""Return True if the default Curve symbol is set and False if not."""
return self._defaultPlotPoints == silx.config.DEFAULT_PLOT_SYMBOL
[docs]
def setDefaultPlotPoints(self, flag):
"""Set the default symbol of all curves.
When called, this reset the symbol of all existing curves.
:param bool flag: True to use 'o' as the default curve symbol,
False to use no symbol.
"""
self._defaultPlotPoints = silx.config.DEFAULT_PLOT_SYMBOL if flag else ""
# Reset symbol of all curves
curves = self.getAllCurves(just_legend=False, withhidden=True)
if curves:
for curve in curves:
curve.setSymbol(self._defaultPlotPoints)
def isDefaultPlotLines(self):
"""Return True for line as default line style, False for no line."""
return self._plotLines
[docs]
def setDefaultPlotLines(self, flag):
"""Toggle the use of lines as the default curve line style.
:param bool flag: True to use a line as the default line style,
False to use no line as the default line style.
"""
self._plotLines = bool(flag)
linestyle = "-" if self._plotLines else " "
# Reset linestyle of all curves
curves = self.getAllCurves(withhidden=True)
if curves:
for curve in curves:
curve.setLineStyle(linestyle)
[docs]
def getDefaultColormap(self):
"""Return the default colormap used by :meth:`addImage`.
:rtype: ~silx.gui.colors.Colormap
"""
return self._defaultColormap
[docs]
def setDefaultColormap(self, colormap=None):
"""Set the default colormap used by :meth:`addImage`.
Setting the default colormap do not change any currently displayed
image.
It only affects future calls to :meth:`addImage` without the colormap
parameter.
:param ~silx.gui.colors.Colormap colormap:
The description of the default colormap, or
None to set the colormap to a linear
autoscale gray colormap.
"""
if colormap is None:
colormap = Colormap(
name=silx.config.DEFAULT_COLORMAP_NAME,
normalization="linear",
vmin=None,
vmax=None,
)
if isinstance(colormap, dict):
self._defaultColormap = Colormap._fromDict(colormap)
else:
assert isinstance(colormap, Colormap)
self._defaultColormap = colormap
self.notify("defaultColormapChanged")
[docs]
@staticmethod
def getSupportedColormaps():
"""Get the supported colormap names as a tuple of str.
The list contains at least:
('gray', 'reversed gray', 'temperature', 'red', 'green', 'blue',
'magma', 'inferno', 'plasma', 'viridis')
"""
return Colormap.getSupportedColormaps()
def setDefaultColors(self, colors: Optional[Tuple[str, ...]]):
"""Set the list of colors to use as default for curves and histograms.
Set to None to use `silx.config.DEFAULT_PLOT_CURVE_COLORS`.
"""
self._defaultColors = None if colors is None else tuple(colors)
self._resetColorAndStyle()
def getDefaultColors(self) -> Tuple[str, ...]:
"""Returns the list of default colors for curves and histograms"""
if self._defaultColors is None:
return tuple(silx.config.DEFAULT_PLOT_CURVE_COLORS)
return self._defaultColors
def _resetColorAndStyle(self):
self._colorIndex = 0
self._styleIndex = 0
def _getColorAndStyle(self) -> Tuple[str, str]:
defaultColors = self.getDefaultColors()
if self._colorIndex >= len(defaultColors): # Handle list length updated
self._colorIndex = 0
color = defaultColors[self._colorIndex]
style = self._styleList[self._styleIndex]
# Loop over color and then styles
self._colorIndex += 1
if self._colorIndex >= len(defaultColors):
self._colorIndex = 0
self._styleIndex = (self._styleIndex + 1) % len(self._styleList)
# If color is the one of active curve, take the next one
if colors.rgba(color) == self.getActiveCurveStyle().getColor():
color, style = self._getColorAndStyle()
if not self._plotLines:
style = " "
return color, style
# Misc.
[docs]
def getWidgetHandle(self):
"""Return the widget the plot is displayed in.
This widget is owned by the backend.
"""
return self._backend.getWidgetHandle()
def notify(self, event, **kwargs):
"""Send an event to the listeners and send signals.
Event are passed to the registered callback as a dict with an 'event'
key for backward compatibility with PyMca.
:param str event: The type of event
:param kwargs: The information of the event.
"""
eventDict = kwargs.copy()
eventDict["event"] = event
self.sigPlotSignal.emit(eventDict)
if event == "setKeepDataAspectRatio":
self.sigSetKeepDataAspectRatio.emit(kwargs["state"])
elif event == "setGraphGrid":
self.sigSetGraphGrid.emit(kwargs["which"])
elif event == "setGraphCursor":
self.sigSetGraphCursor.emit(kwargs["state"])
elif event == "contentChanged":
self.sigContentChanged.emit(
kwargs["action"], kwargs["kind"], kwargs["legend"]
)
elif event == "activeCurveChanged":
self.sigActiveCurveChanged.emit(kwargs["previous"], kwargs["legend"])
elif event == "activeImageChanged":
self.sigActiveImageChanged.emit(kwargs["previous"], kwargs["legend"])
elif event == "activeScatterChanged":
self.sigActiveScatterChanged.emit(kwargs["previous"], kwargs["legend"])
elif event == "interactiveModeChanged":
self.sigInteractiveModeChanged.emit(kwargs["source"])
eventDict = kwargs.copy()
eventDict["event"] = event
self._callback(eventDict)
def setCallback(self, callbackFunction=None):
"""Attach a listener to the backend.
Limitation: Only one listener at a time.
:param callbackFunction: function accepting a dictionary as input
to handle the graph events
If None (default), use a default listener.
"""
# TODO allow multiple listeners
# allow register listener by event type
if callbackFunction is None:
callbackFunction = WeakMethodProxy(self.graphCallback)
self._callback = callbackFunction
def graphCallback(self, ddict=None):
"""This callback is going to receive all the events from the plot.
Those events will consist on a dictionary and among the dictionary
keys the key 'event' is mandatory to describe the type of event.
This default implementation only handles setting the active curve.
"""
if ddict is None:
ddict = {}
_logger.debug("Received dict keys = %s", str(ddict.keys()))
_logger.debug(str(ddict))
if ddict["event"] == "curveClicked":
if ddict["button"] == "left":
self.setActiveCurve(ddict["item"])
qt.QToolTip.showText(self.cursor().pos(), ddict["label"])
elif ddict["event"] == "mouseClicked" and ddict["button"] == "left":
self.setActiveCurve(None)
[docs]
def saveGraph(self, filename, fileFormat=None, dpi=None):
"""Save a snapshot of the plot.
Supported file formats depends on the backend in use.
The following file formats are always supported: "png", "svg".
The matplotlib backend supports more formats:
"pdf", "ps", "eps", "tiff", "jpeg", "jpg".
:param filename: Destination
:type filename: str, StringIO or BytesIO
:param str fileFormat: String specifying the format
:return: False if cannot save the plot, True otherwise
"""
if fileFormat is None:
if not hasattr(filename, "lower"):
_logger.warning("saveGraph cancelled, cannot define file format.")
return False
else:
fileFormat = (filename.split(".")[-1]).lower()
supportedFormats = (
"png",
"svg",
"pdf",
"ps",
"eps",
"tif",
"tiff",
"jpeg",
"jpg",
)
if fileFormat not in supportedFormats:
_logger.warning("Unsupported format %s", fileFormat)
return False
else:
self._backend.saveGraph(filename, fileFormat=fileFormat, dpi=dpi)
return True
[docs]
def getDataMargins(self) -> tuple[float, float, float, float]:
"""Get the default data margin ratios, see :meth:`setDataMargins`.
:return: The margin ratios for each side (xMin, xMax, yMin, yMax).
"""
return self._defaultDataMargins
[docs]
def setDataMargins(
self,
xMinMargin: float = 0.0,
xMaxMargin: float = 0.0,
yMinMargin: float = 0.0,
yMaxMargin: float = 0.0,
):
"""Set the default data margins to use in :meth:`resetZoom`.
Set the default ratios of margins to add around the data
inside the plot area for each side.
"""
self._defaultDataMargins = (xMinMargin, xMaxMargin, yMinMargin, yMaxMargin)
def getAutoReplot(self):
"""Return True if replot is automatically handled, False otherwise.
See :meth`setAutoReplot`.
"""
return self._autoreplot
def setAutoReplot(self, autoreplot=True):
"""Set automatic replot mode.
When enabled, the plot is redrawn automatically when changed.
When disabled, the plot is not redrawn when its content change.
Instead, it :meth:`replot` must be called.
:param bool autoreplot: True to enable it (default),
False to disable it.
"""
self._autoreplot = bool(autoreplot)
# If the plot is dirty before enabling autoreplot,
# then _backend.postRedisplay will never be called from _setDirtyPlot
if self._autoreplot and self._getDirtyPlot():
self._backend.postRedisplay()
@contextmanager
def _paintContext(self):
"""This context MUST surround backend rendering.
It is in charge of performing required PlotWidget operations
"""
for item in self.__itemsToUpdate:
item._update(self._backend)
self.__itemsToUpdate = []
yield
self._dirty = False # reset dirty flag
def replot(self):
"""Request to draw the plot."""
self._backend.replot()
def _forceResetZoom(
self,
dataMargins: Optional[tuple[float, float, float, float]] = None,
):
"""Reset the plot limits to the bounds of the data and redraw the plot.
This method forces a reset zoom and does not check axis autoscale.
Extra margins can be added around the data inside the plot area
(see :meth:`setDataMargins`).
Margins are given as one ratio of the data range per limit of the
data (xMin, xMax, yMin and yMax limits).
For log scale, extra margins are applied in log10 of the data.
:param dataMargins:
Ratios of margins to add around the data inside the plot area for each side.
If None (the default), use margins from :meth:`getDataMargins`.
"""
# Get data range
ranges = self.getDataRange()
xmin, xmax = (1.0, 100.0) if ranges.x is None else ranges.x
ymin, ymax = (1.0, 100.0) if ranges.y is None else ranges.y
if ranges.yright is None:
y2min, y2max = ymin, ymax
else:
y2min, y2max = ranges.yright
if ranges.y is None:
ymin, ymax = ranges.yright
self.setLimits(
xmin,
xmax,
ymin,
ymax,
y2min,
y2max,
margins=dataMargins if dataMargins is not None else True,
)
[docs]
def resetZoom(self, dataMargins=None):
"""Reset the plot limits to the bounds of the data and redraw the plot.
It automatically scale limits of axes that are in autoscale mode
(see :meth:`getXAxis`, :meth:`getYAxis` and :meth:`Axis.setAutoScale`).
It keeps current limits on axes that are not in autoscale mode.
Extra margins can be added around the data inside the plot area
(see :meth:`setDataMargins`).
Margins are given as one ratio of the data range per limit of the
data (xMin, xMax, yMin and yMax limits).
For log scale, extra margins are applied in log10 of the data.
:param dataMargins: Ratios of margins to add around the data inside
the plot area for each side (default: no margins).
:type dataMargins: A 4-tuple of float as (xMin, xMax, yMin, yMax).
"""
xLimits = self._xAxis.getLimits()
yLimits = self._yAxis.getLimits()
y2Limits = self._yRightAxis.getLimits()
xAuto = self._xAxis.isAutoScale()
yAuto = self._yAxis.isAutoScale()
# With log axes, autoscale if limits are <= 0
# This avoids issues with toggling log scale with matplotlib 2.1.0
if self._xAxis.getScale() == self._xAxis.LOGARITHMIC and xLimits[0] <= 0:
xAuto = True
if self._yAxis.getScale() == self._yAxis.LOGARITHMIC and (
yLimits[0] <= 0 or y2Limits[0] <= 0
):
yAuto = True
if not xAuto and not yAuto:
_logger.debug("Nothing to autoscale")
else: # Some axes to autoscale
self._forceResetZoom(dataMargins=dataMargins)
# Restore limits for axis not in autoscale
if not xAuto and yAuto:
self.setGraphXLimits(*xLimits)
elif xAuto and not yAuto:
if y2Limits is not None:
self.setGraphYLimits(y2Limits[0], y2Limits[1], axis="right")
if yLimits is not None:
self.setGraphYLimits(yLimits[0], yLimits[1], axis="left")
if (
xLimits != self._xAxis.getLimits()
or yLimits != self._yAxis.getLimits()
or y2Limits != self._yRightAxis.getLimits()
):
self._notifyLimitsChanged()
# Coord conversion
[docs]
def dataToPixel(self, x=None, y=None, axis="left", check=True):
"""Convert a position in data coordinates to a position in pixels.
:param x: The X coordinate in data space. If None (default)
the middle position of the displayed data is used.
:type x: float or 1D numpy array of float
:param y: The Y coordinate in data space. If None (default)
the middle position of the displayed data is used.
:type y: float or 1D numpy array of float
:param str axis: The Y axis to use for the conversion
('left' or 'right').
:param bool check: True to return None if outside displayed area,
False to convert to pixels anyway
:returns: The corresponding position in pixels or
None if the data position is not in the displayed area and
check is True.
:rtype: A tuple of 2 floats or 2 arrays of float: (xPixel, yPixel) or None.
"""
assert axis in ("left", "right")
xmin, xmax = self._xAxis.getLimits()
yAxis = self.getYAxis(axis=axis)
ymin, ymax = yAxis.getLimits()
if x is None:
x = 0.5 * (xmax + xmin)
if y is None:
y = 0.5 * (ymax + ymin)
if isinstance(x, numbers.Real) != isinstance(y, numbers.Real):
raise ValueError("x and y must be of the same type")
if not isinstance(x, numbers.Real) and (x.shape != y.shape or x.ndim != 1):
raise ValueError("x and y must be 1D arrays of the same length")
if check:
isOutside = numpy.logical_or(
numpy.logical_or(x > xmax, x < xmin),
numpy.logical_or(y > ymax, y < ymin),
)
if numpy.any(isOutside):
if isinstance(x, numbers.Real):
return None
else: # Filter-out points that are outside
x = numpy.array(x, copy=True, dtype=numpy.float64)
x[isOutside] = numpy.nan
y = numpy.array(y, copy=True, dtype=numpy.float64)
y[isOutside] = numpy.nan
return self._backend.dataToPixel(x, y, axis=axis)
[docs]
def pixelToData(self, x, y, axis="left", check=False):
"""Convert a position in pixels to a position in data coordinates.
:param float x: The X coordinate in pixels. If None (default)
the center of the widget is used.
:param float y: The Y coordinate in pixels. If None (default)
the center of the widget is used.
:param str axis: The Y axis to use for the conversion
('left' or 'right').
:param bool check: Toggle checking if pixel is in plot area.
If False, this method never returns None.
:returns: The corresponding position in data space or
None if the pixel position is not in the plot area.
:rtype: A tuple of 2 floats: (xData, yData) or None.
"""
assert axis in ("left", "right")
if x is None:
x = self.width() // 2
if y is None:
y = self.height() // 2
if check:
left, top, width, height = self.getPlotBoundsInPixels()
isOutside = numpy.logical_or(
numpy.logical_or(x < left, x > left + width),
numpy.logical_or(y < top, y > top + height),
)
if numpy.any(isOutside):
return None
return self._backend.pixelToData(x, y, axis)
[docs]
def getPlotBoundsInPixels(self):
"""Plot area bounds in widget coordinates in pixels.
:return: bounds as a 4-tuple of int: (left, top, width, height)
"""
return self._backend.getPlotBoundsInPixels()
# Interaction support
def getGraphCursorShape(self):
"""Returns the current cursor shape.
:rtype: str
"""
return self.__graphCursorShape
def setGraphCursorShape(self, cursor=None):
"""Set the cursor shape.
:param str cursor: Name of the cursor shape
"""
self.__graphCursorShape = cursor
self._backend.setGraphCursorShape(cursor)
def _getMarkerAt(self, x, y):
"""Return the most interactive marker at a location, else None
:param float x: X position in pixels
:param float y: Y position in pixels
:rtype: None of marker object
"""
def checkDraggable(item):
return isinstance(item, items.MarkerBase) and item.isDraggable()
def checkSelectable(item):
return isinstance(item, items.MarkerBase) and item.isSelectable()
def check(item):
return isinstance(item, items.MarkerBase)
result = self._pickTopMost(x, y, checkDraggable)
if not result:
result = self._pickTopMost(x, y, checkSelectable)
if not result:
result = self._pickTopMost(x, y, check)
marker = result.getItem() if result is not None else None
return marker
def _getMarker(self, legend=None):
"""Get the object describing a specific marker.
It returns None in case no matching marker is found
:param str legend: The legend of the marker to retrieve
:rtype: None of marker object
"""
return self._getItem(kind="marker", legend=legend)
def pickItems(self, x, y, condition=None):
"""Generator of picked items in the plot at given position.
Items are returned from front to back.
:param float x: X position in pixels
:param float y: Y position in pixels
:param callable condition:
Callable taking an item as input and returning False for items
to skip during picking. If None (default) no item is skipped.
:return: Iterable of :class:`PickingResult` objects at picked position.
Items are ordered from front to back.
"""
for item in reversed(
self._backend.getItemsFromBackToFront(condition=condition)
):
result = item.pick(x, y)
if result is not None:
yield result
def _pickTopMost(self, x, y, condition=None):
"""Returns top-most picked item in the plot at given position.
Items are checked from front to back.
:param float x: X position in pixels
:param float y: Y position in pixels
:param callable condition:
Callable taking an item as input and returning False for items
to skip during picking. If None (default) no item is skipped.
:return: :class:`PickingResult` object at picked position.
If no item is picked, it returns None
:rtype: Union[None,PickingResult]
"""
for result in self.pickItems(x, y, condition):
return result
return None
# User event handling #
def _isPositionInPlotArea(self, x, y):
"""Project position in pixel to the closest point in the plot area
:param float x: X coordinate in widget coordinate (in pixel)
:param float y: Y coordinate in widget coordinate (in pixel)
:return: (x, y) in widget coord (in pixel) in the plot area
"""
left, top, width, height = self.getPlotBoundsInPixels()
xPlot = numpy.clip(x, left, left + width)
yPlot = numpy.clip(y, top, top + height)
return xPlot, yPlot
def onMousePress(self, xPixel, yPixel, btn):
"""Handle mouse press event.
:param float xPixel: X mouse position in pixels
:param float yPixel: Y mouse position in pixels
:param str btn: Mouse button in 'left', 'middle', 'right'
"""
if self._isPositionInPlotArea(xPixel, yPixel) == (xPixel, yPixel):
self._pressedButtons.append(btn)
self._eventHandler.handleEvent("press", xPixel, yPixel, btn)
def onMouseMove(self, xPixel, yPixel):
"""Handle mouse move event.
:param float xPixel: X mouse position in pixels
:param float yPixel: Y mouse position in pixels
"""
inXPixel, inYPixel = self._isPositionInPlotArea(xPixel, yPixel)
isCursorInPlot = inXPixel == xPixel and inYPixel == yPixel
if self._cursorInPlot != isCursorInPlot:
self._cursorInPlot = isCursorInPlot
self._eventHandler.handleEvent("enter" if self._cursorInPlot else "leave")
if isCursorInPlot:
# Signal mouse move event
dataPos = self.pixelToData(inXPixel, inYPixel)
assert dataPos is not None
btn = self._pressedButtons[-1] if self._pressedButtons else None
event = PlotEvents.prepareMouseSignal(
"mouseMoved", btn, dataPos[0], dataPos[1], xPixel, yPixel
)
self.notify(**event)
# Either button was pressed in the plot or cursor is in the plot
if isCursorInPlot or self._pressedButtons:
self._eventHandler.handleEvent("move", inXPixel, inYPixel)
def onMouseRelease(self, xPixel, yPixel, btn):
"""Handle mouse release event.
:param float xPixel: X mouse position in pixels
:param float yPixel: Y mouse position in pixels
:param str btn: Mouse button in 'left', 'middle', 'right'
"""
try:
self._pressedButtons.remove(btn)
except ValueError:
pass
else:
xPixel, yPixel = self._isPositionInPlotArea(xPixel, yPixel)
self._eventHandler.handleEvent("release", xPixel, yPixel, btn)
def onMouseWheel(self, xPixel, yPixel, angleInDegrees):
"""Handle mouse wheel event.
:param float xPixel: X mouse position in pixels
:param float yPixel: Y mouse position in pixels
:param float angleInDegrees: Angle corresponding to wheel motion.
Positive for movement away from the user,
negative for movement toward the user.
"""
if self._isPositionInPlotArea(xPixel, yPixel) == (xPixel, yPixel):
self._eventHandler.handleEvent("wheel", xPixel, yPixel, angleInDegrees)
def onMouseLeaveWidget(self):
"""Handle mouse leave widget event."""
if self._cursorInPlot:
self._cursorInPlot = False
self._eventHandler.handleEvent("leave")
# Interaction modes #
[docs]
def interaction(self) -> PlotInteraction:
"""Returns the interaction handler for this PlotWidget"""
return self._eventHandler
def __interactionChanged(self):
"""Handle PlotInteraction updates"""
if self.__isInteractionSignalForwarded:
self.sigInteractiveModeChanged.emit(None)
[docs]
def getInteractiveMode(self):
"""Returns the current interactive mode as a dict.
The returned dict contains at least the key 'mode'.
Mode can be: 'draw', 'pan', 'select', 'select-draw', 'zoom'.
It can also contains extra keys (e.g., 'color') specific to a mode
as provided to :meth:`setInteractiveMode`.
"""
return self.interaction()._getInteractiveMode()
def resetInteractiveMode(self):
"""Reset the interactive mode to use the previous basic interactive
mode used.
It can be one of "zoom" or "pan".
"""
mode, zoomOnWheel = self._previousDefaultMode
self.setInteractiveMode(mode=mode, zoomOnWheel=zoomOnWheel)
[docs]
def setInteractiveMode(
self,
mode: str,
color: Union[str, Sequence[numbers.Real]] = "black",
shape: str = "polygon",
label: Optional[str] = None,
zoomOnWheel: bool = True,
source=None,
width: Optional[float] = None,
):
"""Switch the interactive mode.
:param mode: The name of the interactive mode.
In 'draw', 'pan', 'select', 'select-draw', 'zoom'.
:param color: Only for 'draw' and 'zoom' modes.
Color to use for drawing selection area. Default black.
:type color: Color description: The name as a str or
a tuple of 4 floats.
:param shape: Only for 'draw' mode. The kind of shape to draw.
In 'polygon', 'rectangle', 'line', 'vline', 'hline',
'freeline'.
Default is 'polygon'.
:param label: Only for 'draw' mode, sent in drawing events.
:param zoomOnWheel: Toggle zoom on wheel support
:param source: A user-defined object (typically the caller object)
that will be send in the interactiveModeChanged event,
to identify which object required a mode change.
Default: None
:param width: Width of the pencil. Only for draw pencil mode.
"""
self.__isInteractionSignalForwarded = False
try:
self._eventHandler._setInteractiveMode(mode, color, shape, label, width)
self._eventHandler.setZoomOnWheelEnabled(zoomOnWheel)
finally:
self.__isInteractionSignalForwarded = True
if mode in ["pan", "zoom"]:
self._previousDefaultMode = mode, zoomOnWheel
self.notify("interactiveModeChanged", source=source)
# Panning with arrow keys
[docs]
def isPanWithArrowKeys(self):
"""Returns whether or not panning the graph with arrow keys is enabled.
See :meth:`setPanWithArrowKeys`.
"""
return self._panWithArrowKeys
[docs]
def setPanWithArrowKeys(self, pan=False):
"""Enable/Disable panning the graph with arrow keys.
This grabs the keyboard.
:param bool pan: True to enable panning, False to disable.
"""
pan = bool(pan)
panHasChanged = self._panWithArrowKeys != pan
self._panWithArrowKeys = pan
if not self._panWithArrowKeys:
self.setFocusPolicy(qt.Qt.NoFocus)
else:
self.setFocusPolicy(qt.Qt.StrongFocus)
self.setFocus(qt.Qt.OtherFocusReason)
if panHasChanged:
self.sigSetPanWithArrowKeys.emit(pan)
# Dict to convert Qt arrow key code to direction str.
_ARROWS_TO_PAN_DIRECTION = {
qt.Qt.Key_Left: "left",
qt.Qt.Key_Right: "right",
qt.Qt.Key_Up: "up",
qt.Qt.Key_Down: "down",
}
def __simulateMouseMove(self):
qapp = qt.QApplication.instance()
event = qt.QMouseEvent(
qt.QEvent.MouseMove,
qt.QPointF(self.getWidgetHandle().mapFromGlobal(qt.QCursor.pos())),
qt.Qt.NoButton,
qapp.mouseButtons(),
qapp.keyboardModifiers(),
)
qapp.sendEvent(self.getWidgetHandle(), event)
def keyPressEvent(self, event):
"""Key event handler handling panning on arrow keys.
Overrides base class implementation.
"""
key = event.key()
if self._panWithArrowKeys and key in self._ARROWS_TO_PAN_DIRECTION:
self.pan(self._ARROWS_TO_PAN_DIRECTION[key], factor=0.1)
# Send a mouse move event to the plot widget to take into account
# that even if mouse didn't move on the screen, it moved relative
# to the plotted data.
self.__simulateMouseMove()
else:
# Only call base class implementation when key is not handled.
# See QWidget.keyPressEvent for details.
super(PlotWidget, self).keyPressEvent(event)