New YRangeCursorTool

Fix #45

Author: PierreRaybaut

CHANGELOG.md

@@ -4,10 +4,9 @@
 
 💥 New features / Enhancements:
 
-* [Issue #45](https://github.com/PlotPyStack/PlotPy/issues/45) - Add support for new curve statistics tools: `XCurveStatsTool` and `YCurveStatsTool`
-  * These tools are similar to the existing `CurveStatsTool`, but they compute statistics for the X and Y coordinates of the curve points, respectively
-  * They can be added to the plot widget using `plot_widget.manager.add_tool(XCurveStatsTool)` or `plot_widget.manager.add_tool(YCurveStatsTool)`
-  * The tools display a table with the computed statistics (mean, median, standard deviation, etc.) for the X or Y coordinates of the curve points
+* [Issue #45](https://github.com/PlotPyStack/PlotPy/issues/45) - Add support for new curve Y-range cursor tool `YRangeCursorTool`:
+  * This tool is similar to the existing `CurveStatsTool`, but it simply shows the Y-range values (min, max and interval).
+  * It can be added to the plot widget using `plot_widget.manager.add_tool(YRangeCursorTool)`
 
 🛠️ Bug fixes:
 

doc/features/items/overview.rst

@@ -86,6 +86,7 @@ The following label items are available:
 * :py:class:`.LabelItem`
 * :py:class:`.LegendBoxItem`
 * :py:class:`.SelectedLegendBoxItem`
-* :py:class:`.RangeComputation`
+* :py:class:`.XRangeComputation`
+* :py:class:`.YRangeComputation`
 * :py:class:`.RangeComputation2d`
 * :py:class:`.DataInfoLabel`

doc/features/items/reference.rst

@@ -138,7 +138,9 @@ Labels
    :members:
 .. autoclass:: plotpy.items.SelectedLegendBoxItem
    :members:
-.. autoclass:: plotpy.items.RangeComputation
+.. autoclass:: plotpy.items.XRangeComputation
+   :members:
+.. autoclass:: plotpy.items.YRangeComputation
    :members:
 .. autoclass:: plotpy.items.RangeComputation2d
    :members:

doc/features/tools/reference.rst

@@ -92,9 +92,9 @@ Shape tools
 Curve tools
 ^^^^^^^^^^^
 
-.. autoclass:: plotpy.tools.XCurveStatsTool
+.. autoclass:: plotpy.tools.CurveStatsTool
    :members:
-.. autoclass:: plotpy.tools.YCurveStatsTool
+.. autoclass:: plotpy.tools.YRangeCursorTool
    :members:
 .. autoclass:: plotpy.tools.SelectPointTool
    :members:

plotpy/builder/label.py

@@ -29,12 +29,13 @@
     ImageItem,
     LabelItem,
     LegendBoxItem,
-    RangeComputation,
     RangeComputation2d,
     RangeInfo,
     RectangleShape,
     SelectedLegendBoxItem,
+    XRangeComputation,
     XRangeSelection,
+    YRangeComputation,
     YRangeSelection,
 )
 from plotpy.styles import LabelParam, LabelParamWithContents, LegendParam
@@ -137,13 +138,17 @@ def legend(
             return SelectedLegendBoxItem(param, restrict_items)
 
     def info_label(
-        self, anchor: str, comps: list, title: str | None = None
+        self,
+        anchor: str,
+        comps: list[XRangeSelection] | list[YRangeSelection],
+        title: str | None = None,
     ) -> DataInfoLabel:
         """Make an info label `plot item`
 
         Args:
             anchor: anchor position. See :py:class:`.LabelParam` for details
-            comps: list of :py:class:`.label.RangeComputation` objects
+            comps: list of :py:class:`.label.XRangeComputation` or
+             :py:class:`.label.YRangeComputation` objects
             title: label name. Default is None
 
         Returns:
@@ -203,8 +208,8 @@ def computation(
         range: XRangeSelection | YRangeSelection,
         anchor: str,
         label: str,
-        curve: CurveItem,
-        function: Callable,
+        curve: CurveItem | None = None,
+        function: Callable | None = None,
         title: str | None = None,
     ) -> DataInfoLabel:
         """Make a computation label `plot item`
@@ -213,7 +218,7 @@ def computation(
             range: range selection object
             anchor: anchor position. See :py:class:`.LabelParam` for details
             label: label name. See :py:class:`.DataInfoLabel` for details
-            curve: curve item
+            curve: curve item (not used for `YRangeSelection`)
             function: function to apply to the range selection object
              Default is None (default function is `lambda x, dx: (x, dx)`)
 
@@ -222,37 +227,59 @@ def computation(
         """
         if title is None:
             title = curve.param.label
-        return self.computations(range, anchor, [(curve, label, function)], title=title)
+        if isinstance(range, XRangeSelection):
+            specs = [(curve, label, function)]
+        elif isinstance(range, YRangeSelection):
+            specs = [(label, function)]
+        else:
+            raise TypeError(
+                "Invalid range selection type: "
+                f"{type(range).__name__}. "
+                "Expected XRangeSelection or YRangeSelection."
+            )
+        return self.computations(range, anchor, specs, title=title)
 
     def computations(
         self,
-        range: XRangeSelection | YRangeSelection,
+        rangeselection: XRangeSelection | YRangeSelection,
         anchor: str,
-        specs: list,
+        specs: list[tuple[CurveItem, str, Callable]] | list[tuple[str, Callable]],
         title: str | None = None,
     ) -> DataInfoLabel:
         """Make computation labels  `plot item`
 
         Args:
-            range: range selection object
+            rangeselection: range selection object
             anchor: anchor position. See :py:class:`.LabelParam` for details
-            specs: list of (curve, label, function) tuples
+            specs: list of (curve, label, function) tuples for `XRangeComputation`,
+             list of (label, function) tuples for `YRangeComputation`
             title: label name. Default is None
 
         Returns:
             Data info label object
         """
         comps = []
-        same_curve = True
-        curve0 = None
-        for curve, label, function in specs:
-            comp = RangeComputation(label, curve, range, function)
-            comps.append(comp)
-            if curve0 is None:
-                curve0 = curve
-            same_curve = same_curve and curve is curve0
-        if title is None and same_curve:
-            title = curve.param.label
+        if isinstance(rangeselection, XRangeSelection):
+            same_curve = True
+            curve0 = None
+            for curve, label, function in specs:
+                comp = XRangeComputation(label, curve, rangeselection, function)
+                comps.append(comp)
+                if curve0 is None:
+                    curve0 = curve
+                same_curve = same_curve and curve is curve0
+            if title is None and same_curve:
+                title = curve.param.label
+        elif isinstance(rangeselection, YRangeSelection):
+            for label, function in specs:
+                comp = YRangeComputation(label, rangeselection, function)
+                comps.append(comp)
+        else:
+            raise TypeError(
+                "Invalid range selection type: "
+                f"{type(rangeselection).__name__}. "
+                "Expected XRangeSelection or YRangeSelection."
+            )
         return self.info_label(anchor, comps, title=title)
 
     def computation2d(

plotpy/items/__init__.py

@@ -46,6 +46,8 @@
     LegendBoxItem,
     ObjectInfo,
     RangeComputation,
+    XRangeComputation,
+    YRangeComputation,
     RangeComputation2d,
     RangeInfo,
     SelectedLegendBoxItem,

plotpy/items/label.py

@@ -948,23 +948,25 @@ def get_text(self) -> str:
         return self.label % self.func(v, dv)
 
 
-class RangeComputation(ObjectInfo):
+class XRangeComputation(ObjectInfo):
     """ObjectInfo showing curve computations relative to a `XRangeSelection`
-    or `YRangeSelection` shape
+    shape
 
     Args:
         label: formatted string
         curve: CurveItem object
-        xrangeselection: `XRangeSelection` or `YRangeSelection` object
-        function: input arguments are x, y arrays (extraction of arrays
-         corresponding to the xrangeselection X-axis range)
+        rangeselection: `XRangeSelection` object
+        function: callback function to compute the text to be displayed depending on the
+         range and eventually the curve data. Input arguments are x, y arrays
+        (extraction of associated curve data corresponding to the `rangeselection`
+        X-axis range).
     """
 
     def __init__(
         self,
         label: str,
         curve: CurveItem,
-        rangeselection: XRangeSelection | YRangeSelection,
+        rangeselection: XRangeSelection,
         function: Callable | None = None,
     ) -> None:
         self.label = str(label)
@@ -987,14 +989,11 @@ def set_curve(self, curve: CurveItem) -> None:
 
     def get_text(self) -> str:
         """Return the text to be displayed"""
-        # pylint: disable=import-outside-toplevel
-        from plotpy.items import XRangeSelection
-
-        v0, v1 = self.range.get_range()
+        x0, x1 = self.range.get_range()
         data = self.curve.get_data()
-        vdata = data[0 if isinstance(self.range, XRangeSelection) else 1]
-        i0 = vdata.searchsorted(v0)
-        i1 = vdata.searchsorted(v1)
+        xdata = data[0]
+        i0 = xdata.searchsorted(x0)
+        i1 = xdata.searchsorted(x1)
         if i0 > i1:
             i0, i1 = i1, i0
         vectors = []
@@ -1008,6 +1007,45 @@ def get_text(self) -> str:
         return self.label % self.func(*vectors)
 
 
+RangeComputation = XRangeComputation  # For backward compatibility
+
+
+class YRangeComputation(ObjectInfo):
+    """ObjectInfo showing computations relative to a `YRangeSelection` shape
+
+    Args:
+        label: formatted string
+        rangeselection: `YRangeSelection` object
+        function: callback function to compute the text to be displayed.
+
+    .. note::
+
+        Unlike the `XRangeSelection`, the `YRangeSelection` does not depend on any
+        curve data, the input arguments of the callback function are simply ymin, ymax
+        values (extraction of the `rangeselection` Y-axis range).
+    """
+
+    def __init__(
+        self,
+        label: str,
+        rangeselection: YRangeSelection,
+        function: Callable,
+    ) -> None:
+        self.label = str(label)
+        self.range = rangeselection
+        if function is None:
+
+            def function(v, dv):
+                return v, dv
+
+        self.func = function
+
+    def get_text(self) -> str:
+        """Return the text to be displayed"""
+        y0, y1 = self.range.get_range()
+        return self.label % self.func(y0, y1)
+
+
 class RangeComputation2d(ObjectInfo):
     """ObjectInfo showing image computations relative to a rectangular area
 

plotpy/locale/fr/LC_MESSAGES/plotpy.po

@@ -6,7 +6,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: plotpy 2.7.4\n"
 "Report-Msgid-Bugs-To: [email protected]\n"
-"POT-Creation-Date: 2025-06-22 12:17+0200\n"
+"POT-Creation-Date: 2025-06-22 16:58+0200\n"
 "PO-Revision-Date: 2025-06-02 11:14+0200\n"
 "Last-Translator: Christophe Debonnel <[email protected]>\n"
 "Language: fr\n"
@@ -1189,6 +1189,9 @@ msgstr "Curseur croix"
 msgid "Signal statistics"
 msgstr "Statistiques du signal"
 
+msgid "Y-range"
+msgstr "Intervalle en Y"
+
 msgid "Antialiasing (curves)"
 msgstr "Anticrénelage (courbes)"
 
@@ -1675,4 +1678,3 @@ msgstr "Rotation et rognage"
 
 msgid "Show cropping rectangle"
 msgstr "Afficher le rectangle de rognage"
-

plotpy/locale/plotpy.pot

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: plotpy VERSION\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2025-06-22 12:17+0200\n"
+"POT-Creation-Date: 2025-06-22 16:58+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -1176,6 +1176,9 @@ msgstr ""
 msgid "Signal statistics"
 msgstr ""
 
+msgid "Y-range"
+msgstr ""
+
 msgid "Antialiasing (curves)"
 msgstr ""
 

plotpy/plot/manager.py

@@ -549,8 +549,8 @@ def register_curve_tools(self) -> None:
         # pylint: disable=import-outside-toplevel
         import plotpy.tools as tools
 
-        self.add_tool(tools.XCurveStatsTool)
-        self.add_tool(tools.YCurveStatsTool)
+        self.add_tool(tools.CurveStatsTool)
+        self.add_tool(tools.YRangeCursorTool)
         self.add_tool(tools.AntiAliasingTool)
         self.add_tool(tools.AxisScaleTool)
         self.add_tool(tools.DownSamplingTool)

plotpy/tests/tools/test_cyclic_import.py

@@ -15,15 +15,15 @@ def test_tools_cyclic_import():
     from plotpy.tools import (
         AnnotatedPointTool,  # noqa: F401
         AverageCrossSectionTool,  # noqa: F401
+        CurveStatsTool,  # noqa: F401
         DoAutoscaleTool,  # noqa: F401
         ItemCenterTool,  # noqa: F401
         OpenImageTool,  # noqa: F401
         PointTool,  # noqa: F401
         PrintTool,  # noqa: F401
         RectangularActionTool,  # noqa: F401
         SelectTool,  # noqa: F401
-        XCurveStatsTool,  # noqa: F401
-        YCurveStatsTool,  # noqa: F401
+        YRangeCursorTool,  # noqa: F401
     )