PlotPy 2.3.4__tar.gz → 2.4.0__tar.gz

{plotpy-2.3.4 → plotpy-2.4.0}/CHANGELOG.md

@@ -1,5 +1,77 @@
 # Changelog #
 
+## Version 2.4.0 ##
+
+In this release, test coverage is 79%.
+
+💥 New features / Enhancements:
+
+* Contrast adjustment panel:
+  * New layout: the vertical toolbar (which was constrained in a small area on the
+    right side of the panel) is now a horizontal toolbar at the top of the panel,
+    beside the title
+  * New "Set range" button: allows the user to set manually the minimum and maximum
+    values of the histogram range
+* New Z-axis logarithmic scale feature:
+  * Added new tool `ZAxisLogTool` to toggle the Z-axis logarithmic scale
+  * The tool is registered by default in the plot widget, like the `ColormapTool`
+  * When enabled, the active image item is displayed after applying a base-10
+    logarithm to its pixel values
+* Curve statistics tool `CurveStatsTool` is now customizable:
+  * When adding the tool: `plot_widget.manager.add_tool(CurveStatsTool, labelfuncs=(...))`
+  * Or after: `plot_widget.manager.get_tool(CurveStatsTool).set_labelfuncs(...)`
+  * The `labelfuncs` parameter is a list of tuples `(label, func)` where `label` is the
+    label displayed in the statistics table, and `func` is a function that takes the
+    curve data and returns the corresponding statistic value (see the documentation for
+    more details)
+* Image statistics tool `ImageStatsTool` is now customizable:
+  * When adding the tool: `plot_widget.manager.add_tool(ImageStatsTool, stats_func=...)`
+  * Or after: `plot_widget.manager.get_tool(ImageStatsTool).set_stats_func(...)`
+  * The `stats_func` parameter is a function that takes the image item and selected
+    rectangle coordinates, and returns a string with the statistics to display
+* New `SIG_AXIS_PARAMETERS_CHANGED` signal emitted by `BasePlot` when the axes parameters
+  are changed (e.g. when the axes are inverted, or the scale is changed)
+* New "Reverse X axis" feature:
+  * Added new tool `ReverseXAxisTool` to toggle the X-axis direction
+  * The tool is registered by default in the plot widget, like its Y-axis counterpart
+
+🛠️ Bug fixes:
+
+* Contrast adjustment panel:
+  * Fixed histogram update issues when no image was currently selected (even if the
+    an image was displayed and was selected before)
+  * Histogram range was not updated when either the minimum or maximum value was set
+    using the "Minimum value" or "Maximum value" buttons (which have been renamed to
+    "Min." and "Max." in this release)
+  * Histogram range was not updated when the "Set full range" button was clicked
+* Image parameters: contrast range was not updated when the image Z axis bounds were
+  changed using the "Parameters" dialog
+
+🧹 API cleanup:
+
+* Deprecated `AnnotationParam.update_annotation` method: use `update_item` instead
+* Deprecated `AxesShapeParam.update_axes` method: use `update_item` instead
+* Deprecated `AxesParam.update_axes` method: use `update_item` instead
+* Deprecated `ImageAxesParam.update_axes` method: use `update_item` instead
+* Deprecated `LabelParam.update_label` method: use `update_item` instead
+* Deprecated `MarkerParam.update_marker` method: use `update_item` instead
+* Deprecated `RangeShapeParam.update_range` method: use `update_item` instead
+* Deprecated `ShapeParam.update_shape` method: use `update_item` instead
+
+## Version 2.3.5 ##
+
+This release is mainly intended to fix the Windows binary distribution, which was not
+supporting NumPy 2.0.
+
+🛠️ Bug fixes:
+
+* Moved back `conftest.py` to the `tests` folder (was in the root folder), so that
+  `pytest` can be executed with proper configuration when running the test suite
+  from the installed package
+
+* Removed benchmarks from automated test suite (not relevant for the end user):
+  added `plotpy-benchmarks` script to run the benchmarks
+
 ## Version 2.3.4 ##
 
 In this release, test coverage is 79%.
@@ -69,7 +141,6 @@ in version 2.3.1. The latter is a fugitive release that was not announced.
 * Fixed issue with oblique averaged cross section computation (`AttributeError` when
   clicking on the empty cross section plot)
 
-
 ## Version 2.3.0 ##
 
 In this release, test coverage is 75%.

{plotpy-2.3.4/PlotPy.egg-info → plotpy-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PlotPy
-Version: 2.3.4
+Version: 2.4.0
 Summary: Curve and image plotting tools for Python/Qt applications
 Author-email: Codra <p.raybaut@codra.fr>
 License: BSD 3-Clause License

{plotpy-2.3.4 → plotpy-2.4.0/PlotPy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PlotPy
-Version: 2.3.4
+Version: 2.4.0
 Summary: Curve and image plotting tools for Python/Qt applications
 Author-email: Codra <p.raybaut@codra.fr>
 License: BSD 3-Clause License

{plotpy-2.3.4 → plotpy-2.4.0}/PlotPy.egg-info/SOURCES.txt

@@ -2,7 +2,6 @@ CHANGELOG.md
 LICENSE
 MANIFEST.in
 README.md
-conftest.py
 plotpy-tests.desktop
 pyproject.toml
 requirements.txt
@@ -200,6 +199,7 @@ plotpy/data/icons/xcursor.png
 plotpy/data/icons/xmax.png
 plotpy/data/icons/xmin.png
 plotpy/data/icons/xrange.png
+plotpy/data/icons/zlog.svg
 plotpy/data/icons/curvestyles/dots.png
 plotpy/data/icons/curvestyles/lines.png
 plotpy/data/icons/curvestyles/steps.png
@@ -366,6 +366,7 @@ plotpy/styles/label.py
 plotpy/styles/polygonmap.py
 plotpy/styles/shape.py
 plotpy/tests/__init__.py
+plotpy/tests/conftest.py
 plotpy/tests/data.py
 plotpy/tests/vistools.py
 plotpy/tests/benchmarks/__init__.py
@@ -432,6 +433,8 @@ plotpy/tests/tools/test_get_rectangle.py
 plotpy/tests/tools/test_get_rectangle_with_svg.py
 plotpy/tests/tools/test_get_segment.py
 plotpy/tests/tools/test_image_plot_tools.py
+plotpy/tests/tools/test_stats_tools.py
+plotpy/tests/tools/test_zaxislog.py
 plotpy/tests/unit/__init__.py
 plotpy/tests/unit/test_annotation_tools.py
 plotpy/tests/unit/test_aspect_ratio_tool.py

plotpy-2.4.0/PlotPy.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[gui_scripts]
+plotpy-benchmarks = plotpy.tests.benchmarks:run
+plotpy-tests = plotpy.tests:run

{plotpy-2.3.4 → plotpy-2.4.0}/doc/dev/build.rst

@@ -29,11 +29,11 @@ To run the unittests, you need:
 
 Then run the following command::
 
-    pytest
+    pytest plotpy
 
 To run test with coverage support, use the following command::
 
-    pytest -v --cov --cov-report=html
+    pytest -v --cov --cov-report=html plotpy
 
 
 Code formatting

{plotpy-2.3.4 → plotpy-2.4.0}/doc/dev/contribute.rst

@@ -75,7 +75,7 @@ Before submitting a patch, please check the following points:
 
     .. code-block:: bash
 
-        pytest
+        pytest plotpy
 
 Pull request
 ~~~~~~~~~~~~

{plotpy-2.3.4 → plotpy-2.4.0}/doc/dev/platforms.rst

@@ -72,7 +72,7 @@ That's it, you can now run the tests using the following command:
 
 .. code-block:: bash
 
-    pytest
+    pytest plotpy
 
 If you want to rely on Visual Studio Code for editing and take advantage of the
 project settings and tasks, you will need to set the following environment variable:
@@ -160,4 +160,4 @@ That's it, you can now run the tests using the following command:
 
 .. code-block:: bash
 
-    pytest
+    pytest plotpy

plotpy-2.4.0/doc/features/tools/overview.rst

@@ -0,0 +1,28 @@
+Overview
+--------
+
+A `plot tool` is an object providing various features to a plotting widget
+(:py:class:`.BasePlot`):
+
+* Buttons,
+* Menus,
+* Selection tools,
+* Image I/O tools,
+* Etc.
+
+Before being used, a tool has to be registered to a plotting widget's manager,
+i.e. an instance of the :py:class:`.PlotManager` class (see :ref:`plot`
+for more details).
+
+The :py:class:`.BasePlot` widget do not provide any :py:class:`.PlotManager`:
+the manager has to be created separately. On the contrary, the ready-to-use widget
+:py:class:`.PlotWidget` are higher-level plotting widgets with
+integrated manager, tools and panels.
+
+.. seealso::
+
+    :ref:`plot`
+        Ready-to-use curve and image plotting widgets and dialog boxes
+
+    :ref:`items`
+        Plot items: curves, images, markers, etc.

{plotpy-2.3.4 → plotpy-2.4.0}/doc/features/tools/reference.rst

@@ -19,14 +19,6 @@ Base classes
 .. autoclass:: plotpy.tools.PanelTool
    :members:
 
-Selection tools
-^^^^^^^^^^^^^^^
-
-.. autoclass:: plotpy.tools.SelectTool
-   :members:
-.. autoclass:: plotpy.tools.SelectPointTool
-   :members:
-
 Plot tools
 ^^^^^^^^^^
 
@@ -44,6 +36,8 @@ Plot tools
 Item tools
 ^^^^^^^^^^
 
+.. autoclass:: plotpy.tools.SelectTool
+   :members:
 .. autoclass:: plotpy.tools.ItemListPanelTool
    :members:
 .. autoclass:: plotpy.tools.SaveItemsTool
@@ -93,13 +87,29 @@ Shape tools
 .. autoclass:: plotpy.tools.HRangeTool
    :members:
 
+Curve tools
+^^^^^^^^^^^
+
+.. autoclass:: plotpy.tools.CurveStatsTool
+   :members:
+.. autoclass:: plotpy.tools.SelectPointTool
+   :members:
+.. autoclass:: plotpy.tools.SelectPointsTool
+   :members:
+.. autoclass:: plotpy.tools.EditPointTool
+   :members:
+
 Image tools
 ^^^^^^^^^^^
 
+.. autoclass:: plotpy.tools.ImageStatsTool
+   :members:
 .. autoclass:: plotpy.tools.RotationCenterTool
    :members:
 .. autoclass:: plotpy.tools.ReverseYAxisTool
    :members:
+.. autoclass:: plotpy.tools.ZAxisLogTool
+   :members:
 .. autoclass:: plotpy.tools.AspectRatioTool
    :members:
 .. autoclass:: plotpy.tools.ContrastPanelTool

{plotpy-2.3.4 → plotpy-2.4.0}/doc/requirements.rst

@@ -9,7 +9,7 @@ The :mod:`plotpy` package requires the following Python modules:
       - Summary
     * - Python
       - >=3.8, <4
-      - 
+      - Python programming language
     * - guidata
       - >=3.4
       - Automatic GUI generation for easy dataset editing and display
@@ -41,12 +41,9 @@ Optional modules for development:
     * - Name
       - Version
       - Summary
-    * - black
-      - 
-      - The uncompromising code formatter.
-    * - isort
+    * - ruff
       - 
-      - A Python utility / library to sort Python imports.
+      - An extremely fast Python linter and code formatter, written in Rust.
     * - pylint
       - 
       - python code static checker

{plotpy-2.3.4 → plotpy-2.4.0}/plotpy/__init__.py

@@ -20,7 +20,7 @@ External resources:
 .. _GitHub: https://github.com/PierreRaybaut/plotpy
 """
 
-__version__ = "2.3.4"
+__version__ = "2.4.0"
 __VERSION__ = tuple([int(number) for number in __version__.split(".")])
 
 # --- Important note: DATAPATH and LOCALEPATH are used by guidata.configtools

plotpy-2.4.0/plotpy/data/icons/zlog.svg

@@ -0,0 +1,144 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   role="img"
+   focusable="false"
+   aria-hidden="true"
+   viewBox="0 0 14 14"
+   version="1.1"
+   id="svg3733"
+   sodipodi:docname="zlog.svg"
+   inkscape:version="0.92.4 (5da689c313, 2019-01-14)">
+  <metadata
+     id="metadata3739">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <defs
+     id="defs3737" />
+  <sodipodi:namedview
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1"
+     objecttolerance="10"
+     gridtolerance="10"
+     guidetolerance="10"
+     inkscape:pageopacity="0"
+     inkscape:pageshadow="2"
+     inkscape:window-width="1920"
+     inkscape:window-height="1017"
+     id="namedview3735"
+     showgrid="false"
+     inkscape:zoom="42.830468"
+     inkscape:cx="11.19054"
+     inkscape:cy="4.4544012"
+     inkscape:window-x="-8"
+     inkscape:window-y="-8"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg3733" />
+  <rect
+     style="fill:#d4aa00"
+     id="rect3751"
+     width="0.51365304"
+     height="13.354979"
+     x="12.132974"
+     y="0.27145514" />
+  <text
+     xml:space="preserve"
+     style="font-style:normal;font-weight:normal;font-size:40px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none"
+     x="-1.0039581"
+     y="8.723382"
+     id="text3743"><tspan
+       sodipodi:role="line"
+       id="tspan3741"
+       x="-1.0039581"
+       y="8.723382"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:9.33333302px;font-family:'Lucida Handwriting';-inkscape-font-specification:'Lucida Handwriting'">z</tspan></text>
+  <text
+     xml:space="preserve"
+     style="font-style:normal;font-weight:normal;font-size:40px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none"
+     x="4.5061374"
+     y="11.2683"
+     id="text3747"><tspan
+       sodipodi:role="line"
+       id="tspan3745"
+       x="4.5061374"
+       y="11.2683"
+       style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:3.33333325px;font-family:Tahoma;-inkscape-font-specification:'Tahoma Bold';fill:#ff6600">LOG</tspan></text>
+  <rect
+     style="fill:#d4aa00;stroke-width:0.34224674"
+     id="rect3751-2"
+     width="0.51365304"
+     height="1.5643065"
+     x="10.302919"
+     y="6.5584002"
+     transform="rotate(-30)" />
+  <rect
+     style="fill:#d4aa00;stroke-width:0.34224674"
+     id="rect3751-2-6"
+     width="0.51365304"
+     height="1.5643065"
+     x="10.643191"
+     y="-5.8313999"
+     transform="rotate(30)" />
+  <rect
+     style="fill:#d4aa00;stroke-width:0.33449677"
+     id="rect3751-8"
+     width="0.51365304"
+     height="1.4942629"
+     x="12.599127"
+     y="-13.168196"
+     transform="rotate(90)" />
+  <rect
+     style="fill:#d4aa00;stroke-width:0.33449677"
+     id="rect3751-8-5"
+     width="0.51365304"
+     height="1.4942629"
+     x="8.8401213"
+     y="-13.168196"
+     transform="rotate(90)" />
+  <rect
+     style="fill:#d4aa00;stroke-width:0.33449677"
+     id="rect3751-8-5-0"
+     width="0.51365304"
+     height="1.4942629"
+     x="5.8282475"
+     y="-13.168196"
+     transform="rotate(90)" />
+  <rect
+     style="fill:#d4aa00;stroke-width:0.33449677"
+     id="rect3751-8-5-4"
+     width="0.51365304"
+     height="1.4942629"
+     x="3.8903742"
+     y="-13.168196"
+     transform="rotate(90)" />
+  <rect
+     style="fill:#d4aa00;stroke-width:0.33449677"
+     id="rect3751-8-5-44"
+     width="0.51365304"
+     height="1.4942629"
+     x="2.9798076"
+     y="-13.168196"
+     transform="rotate(90)" />
+  <rect
+     style="fill:#d4aa00;stroke-width:0.33449677"
+     id="rect3751-8-5-5"
+     width="0.51365304"
+     height="1.4942629"
+     x="2.3027196"
+     y="-13.168196"
+     transform="rotate(90)" />
+</svg>

{plotpy-2.3.4 → plotpy-2.4.0}/plotpy/interfaces/__init__.py

@@ -16,7 +16,6 @@ from .items import (
     IItemType,
     ISerializableType,
     IShapeItemType,
-    IStatsImageItemType,
     ITrackableItemType,
     IVoiImageItemType,
 )

{plotpy-2.3.4 → plotpy-2.4.0}/plotpy/interfaces/items.py

@@ -148,31 +148,6 @@ class IExportROIImageItemType(IItemType):
         pass
 
 
-class IStatsImageItemType(IItemType):
-    """An image supporting stats computations"""
-
-    def get_stats(
-        self,
-        x0: float,
-        y0: float,
-        x1: float,
-        y1: float,
-        show_surface: bool = False,
-        show_integral: bool = False,
-    ) -> str:
-        """Return formatted string with stats on image rectangular area
-        (output should be compatible with AnnotatedShape.get_infos)
-
-        Args:
-            x0: X0
-            y0: Y0
-            x1: X1
-            y1: Y1
-            show_surface: Show surface (Default value = False)
-            show_integral: Show integral (Default value = False)
-        """
-
-
 class ICSImageItemType(IItemType):
     """An image supporting X/Y cross sections"""
 

{plotpy-2.3.4 → plotpy-2.4.0}/plotpy/items/annotation.py

@@ -75,7 +75,7 @@ class AnnotatedShape(AbstractShape):
             )
         else:
             self.annotationparam = annotationparam
-            self.annotationparam.update_annotation(self)
+            self.annotationparam.update_item(self)
         self.setIcon(get_icon("annotation.png"))
 
     def types(self) -> tuple[type[IItemType], ...]:
@@ -98,8 +98,8 @@ class AnnotatedShape(AbstractShape):
         shape, label, param = state
         self.shape = shape
         self.label = label
-        self.annotationparam = param
-        self.annotationparam.update_annotation(self)
+        self.annotationparam: AnnotationParam = param
+        self.annotationparam.update_item(self)
 
     def serialize(
         self,
@@ -125,7 +125,7 @@ class AnnotatedShape(AbstractShape):
         """
         self.annotationparam = AnnotationParam(_("Annotation"), icon="annotation.png")
         reader.read("annotationparam", instance=self.annotationparam)
-        self.annotationparam.update_annotation(self)
+        self.annotationparam.update_item(self)
         self.shape.deserialize(reader)
         self.label.deserialize(reader)
 
@@ -434,7 +434,7 @@ class AnnotatedShape(AbstractShape):
         update_dataset(
             self.annotationparam, itemparams.get("AnnotationParam"), visible_only=True
         )
-        self.annotationparam.update_annotation(self)
+        self.annotationparam.update_item(self)
         self.plot().SIG_ANNOTATION_CHANGED.emit(self)
 
     # Autoscalable types API
@@ -471,6 +471,7 @@ class AnnotatedPoint(AnnotatedShape):
 
     def __init__(self, x=0, y=0, annotationparam=None):
         AnnotatedShape.__init__(self, annotationparam)
+        self.shape: PointShape
         self.set_pos(x, y)
         self.setIcon(get_icon("point_shape.png"))
 
@@ -526,6 +527,7 @@ class AnnotatedSegment(AnnotatedShape):
 
     def __init__(self, x1=0, y1=0, x2=0, y2=0, annotationparam=None):
         AnnotatedShape.__init__(self, annotationparam)
+        self.shape: SegmentShape
         self.set_rect(x1, y1, x2, y2)
         self.setIcon(get_icon("segment.png"))
 
@@ -585,6 +587,7 @@ class AnnotatedRectangle(AnnotatedShape):
 
     def __init__(self, x1=0, y1=0, x2=0, y2=0, annotationparam=None):
         AnnotatedShape.__init__(self, annotationparam)
+        self.shape: RectangleShape
         self.set_rect(x1, y1, x2, y2)
         self.setIcon(get_icon("rectangle.png"))
 
@@ -645,6 +648,7 @@ class AnnotatedObliqueRectangle(AnnotatedRectangle):
         self, x0=0, y0=0, x1=0, y1=0, x2=0, y2=0, x3=0, y3=0, annotationparam=None
     ):
         AnnotatedShape.__init__(self, annotationparam)
+        self.shape: ObliqueRectangleShape
         self.set_rect(x0, y0, x1, y1, x2, y2, x3, y3)
         self.setIcon(get_icon("oblique_rectangle.png"))
 
@@ -740,6 +744,7 @@ class AnnotatedEllipse(AnnotatedShape):
 
     def __init__(self, x1=0, y1=0, x2=0, y2=0, annotationparam=None):
         AnnotatedShape.__init__(self, annotationparam)
+        self.shape: EllipseShape
         self.set_xdiameter(x1, y1, x2, y2)
         self.setIcon(get_icon("ellipse_shape.png"))
         self.switch_to_ellipse()

{plotpy-2.3.4 → plotpy-2.4.0}/plotpy/items/grid.py

@@ -248,7 +248,7 @@ class GridItem(QwtPlotGrid):
         Args:
             itemparams: Item parameters
         """
-        self.gridparam = itemparams.get("GridParam")
+        self.gridparam: GridParam = itemparams.get("GridParam")
         self.gridparam.update_grid(self)