New curve statistics tools and YRangeSelection support

Fix #45

Author: PierreRaybaut

CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog #
 
-## Version 2.7.5 ##
+## Version 2.8.0 ##
+
+💥 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
 
 🛠️ Bug fixes:
 

doc/features/items/overview.rst

@@ -59,6 +59,7 @@ The following shape items are available:
 * :py:class:`.EllipseShape`
 * :py:class:`.Axes`
 * :py:class:`.XRangeSelection`
+* :py:class:`.YRangeSelection`
 * :py:class:`.Marker`
 * :py:class:`.RectangleSVGShape`
 * :py:class:`.SquareSVGShape`

doc/features/items/reference.rst

@@ -98,6 +98,8 @@ Shapes
    :members:
 .. autoclass:: plotpy.items.XRangeSelection
    :members:
+.. autoclass:: plotpy.items.YRangeSelection
+   :members:
 .. autoclass:: plotpy.items.Marker
    :members:
 .. autoclass:: plotpy.items.RectangleSVGShape

doc/features/tools/reference.rst

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

plotpy/builder/curvemarker.py

@@ -32,6 +32,7 @@
     HistogramItem,
     Marker,
     XRangeSelection,
+    YRangeSelection,
 )
 from plotpy.plot import BasePlot
 from plotpy.styles import (
@@ -58,6 +59,7 @@ class CurveMarkerCursorBuilder:
 
     def __init__(self):
         self.style = style_generator()
+        self.range = self.xrange  # Compatibility with old code
 
     # ---- Plot items -----------------------------------------------------------------
 
@@ -670,8 +672,8 @@ def phistogram(
         self.__set_curve_axes(hist, xaxis, yaxis)
         return hist
 
-    def range(self, xmin: float, xmax: float) -> XRangeSelection:
-        """Make a range `plot item`
+    def xrange(self, xmin: float, xmax: float) -> XRangeSelection:
+        """Make a X-range `plot item`
 
         Args:
             xmin: minimum value
@@ -682,6 +684,18 @@ def range(self, xmin: float, xmax: float) -> XRangeSelection:
         """
         return XRangeSelection(xmin, xmax)
 
+    def yrange(self, ymin: float, ymax: float) -> YRangeSelection:
+        """Make a Y-range `plot item`
+
+        Args:
+            ymin: minimum value
+            ymax: maximum value
+
+        Returns:
+            :py:class:`.YRangeSelection` object
+        """
+        return YRangeSelection(ymin, ymax)
+
     def vcursor(
         self,
         x: float,

plotpy/builder/label.py

@@ -35,6 +35,7 @@
     RectangleShape,
     SelectedLegendBoxItem,
     XRangeSelection,
+    YRangeSelection,
 )
 from plotpy.styles import LabelParam, LabelParamWithContents, LegendParam
 
@@ -166,13 +167,14 @@ def info_label(
 
     def range_info_label(
         self,
-        range: XRangeSelection,
+        range: XRangeSelection | YRangeSelection,
         anchor: str,
         label: str,
         function: Callable = None,
         title: str | None = None,
     ) -> DataInfoLabel:
-        """Make an info label `plot item` showing an XRangeSelection object infos
+        """Make an info label `plot item` showing an `XRangeSelection` or
+        `YRangeSelection` object information.
 
         Args:
             range: range selection object
@@ -189,7 +191,7 @@ def range_info_label(
 
             x = linspace(-10, 10, 10)
             y = sin(sin(sin(x)))
-            range = make.range(-2, 2)
+            range = make.xrange(-2, 2)
             disp = make.range_info_label(range, 'BL', "x = %.1f ± %.1f cm",
                                          lambda x, dx: (x, dx))
         """
@@ -198,7 +200,7 @@ def range_info_label(
 
     def computation(
         self,
-        range: XRangeSelection,
+        range: XRangeSelection | YRangeSelection,
         anchor: str,
         label: str,
         curve: CurveItem,
@@ -223,7 +225,11 @@ def computation(
         return self.computations(range, anchor, [(curve, label, function)], title=title)
 
     def computations(
-        self, range: XRangeSelection, anchor: str, specs: list, title: str | None = None
+        self,
+        range: XRangeSelection | YRangeSelection,
+        anchor: str,
+        specs: list,
+        title: str | None = None,
     ) -> DataInfoLabel:
         """Make computation labels  `plot item`
 

plotpy/config.py

@@ -595,10 +595,10 @@ def get_plotpy_defaults() -> dict[str, int | float | str | bool]:
             "range/line/color": "#ff9393",
             "range/line/width": 1,
             "range/sel_line/style": "SolidLine",
-            "range/sel_line/color": "#ff0000",
+            "range/sel_line/color": "#ff3333",
             "range/sel_line/width": 2,
-            "range/fill": "#ff0000",
-            "range/shade": 0.15,
+            "range/fill": "#ff3333",
+            "range/shade": 0.1,
             "range/symbol/marker": "Ellipse",
             "range/symbol/size": 7,
             "range/symbol/edgecolor": MAIN_BG_COLOR,
@@ -607,7 +607,7 @@ def get_plotpy_defaults() -> dict[str, int | float | str | bool]:
             "range/sel_symbol/marker": "Ellipse",
             "range/sel_symbol/size": 9,
             "range/sel_symbol/edgecolor": MAIN_BG_COLOR,
-            "range/sel_symbol/facecolor": "#ff0000",
+            "range/sel_symbol/facecolor": "#ff3333",
             "range/sel_symbol/alpha": 0.9,
             "range/multi/color": "#806060",
             # Default parameters for plot axes

plotpy/data/icons/yrange.png

@@ -606,6 +606,7 @@ def register_serializable_items(modname, classnames):
         "MaskedXYImageItem",
         "Marker",
         "XRangeSelection",
+        "YRangeSelection",
         "PolygonShape",
         "PointShape",
         "SegmentShape",

plotpy/io.py

@@ -65,4 +65,5 @@
     SegmentShape,
     SquareSVGShape,
     XRangeSelection,
+    YRangeSelection,
 )