diff options
Diffstat (limited to 'src/silx/gui/plot/items/shape.py')
| -rw-r--r-- | src/silx/gui/plot/items/shape.py | 393 |
1 files changed, 393 insertions, 0 deletions
diff --git a/src/silx/gui/plot/items/shape.py b/src/silx/gui/plot/items/shape.py new file mode 100644 index 0000000..c911924 --- /dev/null +++ b/src/silx/gui/plot/items/shape.py @@ -0,0 +1,393 @@ +# /*########################################################################## +# +# Copyright (c) 2017-2022 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. +# +# ###########################################################################*/ +"""This module provides the :class:`Shape` item of the :class:`Plot`. +""" + +__authors__ = ["T. Vincent"] +__license__ = "MIT" +__date__ = "21/12/2018" + + +import logging + +import numpy + +from .core import ( + Item, + DataItem, + AlphaMixIn, + ColorMixIn, + FillMixIn, + ItemChangedType, + LineMixIn, + LineGapColorMixIn, + YAxisMixIn, +) +from ....utils.deprecation import deprecated + + +_logger = logging.getLogger(__name__) + + +class _OverlayItem(Item): + """Item with settable overlay""" + + def __init__(self): + self.__overlay = False + Item.__init__(self) + + def isOverlay(self) -> bool: + """Return true if shape is drawn as an overlay""" + return self.__overlay + + def setOverlay(self, overlay: bool): + """Set the overlay state of the shape + + :param overlay: True to make it an overlay + """ + overlay = bool(overlay) + if overlay != self.__overlay: + self.__overlay = overlay + self._updated(ItemChangedType.OVERLAY) + + +class _TwoColorsLineMixIn(LineMixIn, LineGapColorMixIn): + """Mix-in class for items with a background color for dashes""" + + def __init__(self): + LineMixIn.__init__(self) + LineGapColorMixIn.__init__(self) + + @deprecated(replacement="getLineGapColor", since_version="2.0.0") + def getLineBgColor(self): + return self.getLineGapColor() + + @deprecated(replacement="setLineGapColor", since_version="2.0.0") + def setLineBgColor(self, color, copy: bool = True): + self.setLineGapColor(color) + self._updated(ItemChangedType.LINE_BG_COLOR) + + +# TODO probably make one class for each kind of shape +# TODO check fill:polygon/polyline + fill = duplicated +class Shape(_OverlayItem, ColorMixIn, FillMixIn, _TwoColorsLineMixIn): + """Description of a shape item + + :param str type_: The type of shape in: + 'hline', 'polygon', 'rectangle', 'vline', 'polylines' + """ + + def __init__(self, type_): + _OverlayItem.__init__(self) + ColorMixIn.__init__(self) + FillMixIn.__init__(self) + _TwoColorsLineMixIn.__init__(self) + assert type_ in ("hline", "polygon", "rectangle", "vline", "polylines") + self._type = type_ + self._points = () + self._handle = None + + def _addBackendRenderer(self, backend): + """Update backend renderer""" + points = self.getPoints(copy=False) + x, y = points.T[0], points.T[1] + return backend.addShape( + x, + y, + shape=self.getType(), + color=self.getColor(), + fill=self.isFill(), + overlay=self.isOverlay(), + linestyle=self.getLineStyle(), + linewidth=self.getLineWidth(), + gapcolor=self.getLineGapColor(), + ) + + def getType(self): + """Returns the type of shape to draw. + + One of: 'hline', 'polygon', 'rectangle', 'vline', 'polylines' + + :rtype: str + """ + return self._type + + def getPoints(self, copy=True): + """Get the control points of the shape. + + :param bool copy: True (Default) to get a copy, + False to use internal representation (do not modify!) + :return: Array of point coordinates + :rtype: numpy.ndarray with 2 dimensions + """ + return numpy.array(self._points, copy=copy) + + def setPoints(self, points, copy=True): + """Set the point coordinates + + :param numpy.ndarray points: Array of point coordinates + :param bool copy: True (Default) to get a copy, + False to use internal representation (do not modify!) + :return: + """ + self._points = numpy.array(points, copy=copy) + self._updated(ItemChangedType.DATA) + + +class BoundingRect(DataItem, YAxisMixIn): + """An invisible shape which enforce the plot view to display the defined + space on autoscale. + + This item do not display anything. But if the visible property is true, + this bounding box is used by the plot, if not, the bounding box is + ignored. That's the default behaviour for plot items. + + It can be applied on the "left" or "right" axes. Not both at the same time. + """ + + def __init__(self): + DataItem.__init__(self) + YAxisMixIn.__init__(self) + self.__bounds = None + + def setBounds(self, rect): + """Set the bounding box of this item in data coordinates + + :param Union[None,List[float]] rect: (xmin, xmax, ymin, ymax) or None + """ + if rect is not None: + rect = float(rect[0]), float(rect[1]), float(rect[2]), float(rect[3]) + assert rect[0] <= rect[1] + assert rect[2] <= rect[3] + + if rect != self.__bounds: + self.__bounds = rect + self._boundsChanged() + self._updated(ItemChangedType.DATA) + + def _getBounds(self): + if self.__bounds is None: + return None + plot = self.getPlot() + if plot is not None: + xPositive = plot.getXAxis()._isLogarithmic() + yPositive = plot.getYAxis()._isLogarithmic() + if xPositive or yPositive: + bounds = list(self.__bounds) + if xPositive and bounds[1] <= 0: + return None + if xPositive and bounds[0] <= 0: + bounds[0] = bounds[1] + if yPositive and bounds[3] <= 0: + return None + if yPositive and bounds[2] <= 0: + bounds[2] = bounds[3] + return tuple(bounds) + + return self.__bounds + + +class _BaseExtent(DataItem): + """Base class for :class:`XAxisExtent` and :class:`YAxisExtent`. + + :param str axis: Either 'x' or 'y'. + """ + + def __init__(self, axis="x"): + assert axis in ("x", "y") + DataItem.__init__(self) + self.__axis = axis + self.__range = 1.0, 100.0 + + def setRange(self, min_, max_): + """Set the range of the extent of this item in data coordinates. + + :param float min_: Lower bound of the extent + :param float max_: Upper bound of the extent + :raises ValueError: If min > max or not finite bounds + """ + range_ = float(min_), float(max_) + if not numpy.all(numpy.isfinite(range_)): + raise ValueError("min_ and max_ must be finite numbers.") + if range_[0] > range_[1]: + raise ValueError("min_ must be lesser or equal to max_") + + if range_ != self.__range: + self.__range = range_ + self._boundsChanged() + self._updated(ItemChangedType.DATA) + + def getRange(self): + """Returns the range (min, max) of the extent in data coordinates. + + :rtype: List[float] + """ + return self.__range + + def _getBounds(self): + min_, max_ = self.getRange() + + plot = self.getPlot() + if plot is not None: + axis = plot.getXAxis() if self.__axis == "x" else plot.getYAxis() + if axis._isLogarithmic(): + if max_ <= 0: + return None + if min_ <= 0: + min_ = max_ + + if self.__axis == "x": + return min_, max_, float("nan"), float("nan") + else: + return float("nan"), float("nan"), min_, max_ + + +class XAxisExtent(_BaseExtent): + """Invisible item with a settable horizontal data extent. + + This item do not display anything, but it behaves as a data + item with a horizontal extent regarding plot data bounds, i.e., + :meth:`PlotWidget.resetZoom` will take this horizontal extent into account. + """ + + def __init__(self): + _BaseExtent.__init__(self, axis="x") + + +class YAxisExtent(_BaseExtent, YAxisMixIn): + """Invisible item with a settable vertical data extent. + + This item do not display anything, but it behaves as a data + item with a vertical extent regarding plot data bounds, i.e., + :meth:`PlotWidget.resetZoom` will take this vertical extent into account. + """ + + def __init__(self): + _BaseExtent.__init__(self, axis="y") + YAxisMixIn.__init__(self) + + +class Line(_OverlayItem, AlphaMixIn, ColorMixIn, _TwoColorsLineMixIn): + """Description of a infinite line item as y = slope * x + interecpt + + Warning: If slope is not finite, then the line is x = intercept. + """ + + def __init__(self, slope: float = 0, intercept: float = 0): + assert numpy.isfinite(intercept) + + _OverlayItem.__init__(self) + AlphaMixIn.__init__(self) + ColorMixIn.__init__(self) + _TwoColorsLineMixIn.__init__(self) + self.__slope = float(slope) + self.__intercept = float(intercept) + self.__coordinates = None + self._setVisibleBoundsTracking(True) + + def __updatePoints(self): + if not self.isVisible(): + return + + plot = self.getPlot() + if plot is None or not plot.isVisible(): + return + + xmin, xmax = plot.getXAxis().getLimits() + ymin, ymax = plot.getYAxis().getLimits() + + slope = self.getSlope() + intercept = self.getIntercept() + + if not numpy.isfinite(slope): + if not xmin <= intercept <= xmax: + coordinates = None + else: + coordinates = (intercept, intercept), (ymin, ymax) + else: + ycoords = slope * xmin + intercept, slope * xmax + intercept + + if min(ycoords) < ymax and max(ycoords) > ymin: + coordinates = (xmin, xmax), ycoords + else: + coordinates = None + + if coordinates != self.__coordinates: + self.__coordinates = coordinates + self._updated() + + def _visibleBoundsChanged(self, *args) -> None: + """Override method to benefit from bounds tracking""" + self.__updatePoints() + return super()._visibleBoundsChanged(*args) + + def setSlope(self, slope: float): + slope = float(slope) + if slope != self.__slope: + self.__slope = slope + self.__updatePoints() + self._updated(ItemChangedType.DATA) + + def getSlope(self) -> float: + return self.__slope + + def setIntercept(self, intercept: float): + intercept = float(intercept) + assert numpy.isfinite(intercept) + if intercept != self.__intercept: + self.__intercept = intercept + self.__updatePoints() + self._updated(ItemChangedType.DATA) + + def getIntercept(self) -> float: + return self.__intercept + + def setSlopeInterceptFromPoints(self, point0, point1): + """Set slope and intercept from 2 (x, y) points""" + x0, y0 = point0 + x1, y1 = point1 + if x0 == x1: # Special case: vertical line + self.setSlope(float("inf")) + self.setIntercept(x0) + return + + slope = (y1 - y0) / (x1 - x0) + self.setSlope(slope) + self.setIntercept(y0 - x0 * slope) + + def _addBackendRenderer(self, backend): + """Update backend renderer""" + if self.__coordinates is None: + return None + + return backend.addShape( + *self.__coordinates, + shape="polylines", + color=self.getColor(), + fill=False, + overlay=self.isOverlay(), + linestyle=self.getLineStyle(), + linewidth=self.getLineWidth(), + gapcolor=self.getLineGapColor(), + ) |