Merge branch 'doc/update-guiqwt-migration' into develop

Author: ThomasMalletCodra

doc/dev/guiqwt_to_plotpy.csv

@@ -2,7 +2,13 @@ guiqwt v4,PlotPy v2,API changes
 ``guiqwt.events``,``plotpy.events``
 ``guiqwt.interfaces``,``plotpy.interfaces``
 ``guiqwt.io``,``plotpy.io``
-``guiqwt.io.eliminate_outliers``,*removed*
+``guiqwt.io.eliminate_outliers``,*removed*,"Use ``numpy.histogram``, ``plotpy.lutrange.hist_range_threshold`` and ``numpy.clip``"
+``guiqwt.config``,``plotpy.config``
+``guiqwt.transitional``,``qwt``,Import Qwt classes directly from the ``qwt`` package (PythonQwt)
+``guiqwt.signals``,*removed*,"Signals are attributes of the emitting classes (e.g. ``BasePlot.SIG_ITEM_REMOVED``)"
+``guiqwt.builder``,``plotpy.builder``
+``guiqwt.builder.PlotItemBuilder``,``plotpy.builder.PlotBuilder``,See `New options added to plot builder`_
+``guiqwt.panels``,``plotpy.panels``
 ``guiqwt.annotations``,``plotpy.items``
 ``guiqwt.curve``,``plotpy.items``
 ``guiqwt.image``,``plotpy.items``
@@ -13,20 +19,28 @@ guiqwt v4,PlotPy v2,API changes
 ``guiqwt.histogram.hist_range_threshold``,``plotpy.lutrange.hist_range_threshold``
 ``guiqwt.histogram.lut_range_threshold``,``plotpy.lutrange.lut_range_threshold``
 ``guiqwt.histogram.ContrastAdjustment``,``plotpy.panels.contrastadjustment.ContrastAdjustment``
+``guiqwt.histogram.LevelsHistogram``,``plotpy.panels.contrastadjustment.LevelsHistogram``
 ``guiqwt.image.get_items_in_rectangle``,``plotpy.items.get_items_in_rectangle``
 ``guiqwt.curve.PlotItemList``,``plotpy.panels.itemlist.PlotItemList``
+``guiqwt.cross_section.CrossSectionWidget``,``plotpy.panels.csection.cswidget.CrossSectionWidget``
 ``guiqwt.cross_section.XCrossSection``,``plotpy.panels.csection.cswidget.XCrossSection``
 ``guiqwt.cross_section.YCrossSection``,``plotpy.panels.csection.cswidget.YCrossSection``
 ``guiqwt.cross_section.ObliqueCrossSection``,``plotpy.panels.csection.cswidget.ObliqueCrossSection``
 ``guiqwt.plot.PlotManager``,``plotpy.plot.PlotManager``
 ``guiqwt.plot.CurveWindow``,``plotpy.plot.PlotWindow``,See `Generic PlotWidgets`_
-``guiqwt.plot.BaseImageWidget``,``plotpy.plot.BasePlotWidget``,See `Generic PlotWidgets`_
+``guiqwt.plot.ImageWindow``,``plotpy.plot.PlotWindow``,See `Generic PlotWidgets`_
+``guiqwt.plot.BaseImageWidget``,``plotpy.plot.plotwidget.BasePlotWidget``,See `Generic PlotWidgets`_
 ``guiqwt.plot.CurveWidget``,``plotpy.plot.PlotWidget``,See `Generic PlotWidgets`_
-``guiqwt.plot.CurveWidgetMixin``,``*removed*``,See `Generic PlotWidgets`_
+``guiqwt.plot.ImageWidget``,``plotpy.plot.PlotWidget``,See `Generic PlotWidgets`_
+``guiqwt.plot.CurveWidgetMixin``,*removed*,See `Generic PlotWidgets`_
+``guiqwt.plot.ImageWidgetMixin``,*removed*,See `Generic PlotWidgets`_
 ``guiqwt.plot.CurveDialog``,``plotpy.plot.PlotDialog``,See `Generic PlotWidgets`_
-``guiqwt.curve.CurvePlot``,``plotpy.plot.baseplot.BasePlot``,See `Generic PlotWidgets`_
-``guiqwt.curve.CurvePlot.canvas2plotitem``,*removed*
-``guiqwt.curve.CurvePlot.plotitem2canvas``,*removed*
+``guiqwt.plot.ImageDialog``,``plotpy.plot.PlotDialog``,See `Generic PlotWidgets`_
+``guiqwt.baseplot.BasePlot``,``plotpy.plot.BasePlot``
+``guiqwt.curve.CurvePlot``,``plotpy.plot.BasePlot``,See `Generic PlotWidgets`_
+``guiqwt.image.ImagePlot``,``plotpy.plot.BasePlot``,See `Generic PlotWidgets`_
+``guiqwt.curve.CurvePlot.canvas2plotitem``,``plotpy.coords.canvas_to_axes``,"``canvas2plotitem(item, x, y)`` becomes ``canvas_to_axes(item, QPointF(x, y))``"
+``guiqwt.curve.CurvePlot.plotitem2canvas``,``plotpy.coords.axes_to_canvas``,"``plotitem2canvas(item, x, y)`` becomes ``axes_to_canvas(item, x, y)``"
 ``guiqwt.plot.SubplotWidget``,``plotpy.plot.SubplotWidget``
 ``guiqwt.pyplot``,``plotpy.pyplot``
 ``guiqwt.styles``,``plotpy.styles``
@@ -36,16 +50,17 @@ guiqwt v4,PlotPy v2,API changes
 ``guiqwt.qthelpers.exec_image_save_dialog``,``plotpy.widgets.imagefile.exec_image_save_dialog``
 ``guiqwt.qthelpers.exec_image_open_dialog``,``plotpy.widgets.imagefile.exec_image_open_dialog``
 ``guiqwt.qthelpers.exec_images_open_dialog``,``plotpy.widgets.imagefile.exec_images_open_dialog``
-``guiqwt.qthelpers.mimedata2url``,*removed*
+``guiqwt.qthelpers.mimedata2url``,``guidata.qthelpers.mimedata2url``
 ``guiqwt.scaler``,``plotpy.mathutils.scaler``
 ``guiqwt.debug``,*removed*
 ``guiqwt.debug.buttons_to_str``,``plotpy.events.buttons_to_str``
 ``guiqwt.debug.evt_type_to_str``,``plotpy.events.evt_type_to_str``
 ``guiqwt.debug.print_event``,*removed*
 ``guiqwt.debug.qimage_format``,*removed*
 ``guiqwt.debug.qimage_to_str``,*removed*
+``guiqwt.widgets.base``,``plotpy.widgets.basetransform``
 ``guiqwt.widgets.fit``,``plotpy.widgets.fit``
-``guiqwt.widgets.rotatecrop``,``plotpy.widgets.rotatecrop``
 ``guiqwt.widgets.fliprotate``,``plotpy.widgets.fliprotate``
+``guiqwt.widgets.resizedialog``,``plotpy.widgets.resizedialog``
 ``guiqwt.widgets.rotatecrop``,``plotpy.widgets.rotatecrop``
 ``guiqwt.qtdesigner``,``plotpy.widgets.qtdesigner``

doc/dev/guiqwt_to_plotpy.rst

@@ -70,15 +70,16 @@ to the `Generic PlotWidgets`_ may require some minor adaptation of your code:
   pass ``except_grid=False`` to your
   :py:meth:`.BasePlot.del_all_items` calls.
 
-* Some arguments were added to the constructor of the :py:class:`.BasePlot` class
-  (the arguments of the constructors of the old classes ``CurvePlot`` and
-  ``ImagePlot`` have been merged): the new `type` of the plot
-  (see `Generic PlotWidgets`_), and the arguments of the ``ImagePlot``
-  constructor that the ``CurvePlot`` constructor missed : ``zlabel``, ``zunit``,
-  ``yreverse``, ``aspect_ratio``, ``lock_aspect_ratio`` and ``force_colorbar_enabled``.
-  As a consequence, if you did not use keywords, but positional-only arguments when
-  instantiating a ``CurvePlot`` or ``ImagePlot``, you should adapt the new calls to the
-  :py:class:`.BasePlot` constructor to meet the new arguments list.
+* The constructor of the :py:class:`.BasePlot` class now only takes ``parent``
+  and ``options`` arguments. The arguments of the constructors of the old classes
+  ``CurvePlot`` and ``ImagePlot`` (``title``, ``xlabel``, ``ylabel``, ``xunit``,
+  ``yunit``, ``gridparam``, ``section``, ``axes_synchronised``, ``zlabel``,
+  ``zunit``, ``yreverse``, ``aspect_ratio``, ``lock_aspect_ratio``) have been
+  merged into the :py:class:`.BasePlotOptions` dataclass, together with the new
+  ``type`` (see `Generic PlotWidgets`_) and ``force_colorbar_enabled`` options.
+  As a consequence, you should pass these settings through the ``options``
+  argument, e.g. ``BasePlot(options=BasePlotOptions(title="My plot", type="image"))``
+  (a dictionary is also accepted).
 
 Renamed update_curve and update_image methods
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -147,7 +148,7 @@ algorithm provided by the `scikit-image` library.
 As a consequence, the applications that previously depended on `matplotlib` only for
 contour detection can now drop this dependency.
 
-See demo script `tests/items/test_contour.py`.
+See demo script `tests/items/test_contours.py`.
 
 MaskedXYImages
 ~~~~~~~~~~~~~~
@@ -176,7 +177,7 @@ New methods for creating ready-to-use plots have been added to the class:
 The method :py:meth:`.PlotBuilder.contours` has been added, in order to create
 contour curves. It returns a list of :py:class:`plotpy.items.ContourItem` objects.
 
-See demo script `tests/items/test_contour.py`.
+See demo script `tests/items/test_contours.py`.
 
 The new keyword parameter ``alpha_function`` has been added to the methods
 :py:meth:`.PlotBuilder.image`, :py:meth:`.PlotBuilder.xyimage`,

doc/release_notes/release_2.11.md

@@ -1,5 +1,19 @@
 # Version 2.11 #
 
+## PlotPy Version 2.11.1 ##
+
+🛠️ Bug fixes:
+
+* **`hist_range_threshold` documentation** — Fixed the docstring of `plotpy.lutrange.hist_range_threshold`, which stated that `percent` was the share of the histogram mass to *retain*, whereas it is the share to *eliminate* (half on each side). The error message raised for an out-of-range `percent` now matches the accepted range `[0, 100]`
+
+📚 Documentation:
+
+* **Migrating from guiqwt** — Updated the migration guide to match the current API:
+  * Fixed outdated targets (`BasePlotWidget`, `BasePlot`) and the contour demo script path
+  * Updated the `BasePlot` constructor section: all configuration settings now go through `BasePlotOptions`
+  * Added equivalents for `canvas2plotitem`/`plotitem2canvas` (`plotpy.coords`), `mimedata2url` (`guidata.qthelpers`), `guiqwt.transitional` (`qwt` package) and guidance for `eliminate_outliers` and `guiqwt.signals`
+  * Completed the compatibility table with missing guiqwt modules and classes (`builder`, `panels`, `config`, `ImagePlot`, `ImageWidget`, `ImageDialog`, `ImageWindow`, ...)
+
 ## PlotPy Version 2.11.0 ##
 
 ✨ New features:

plotpy/__init__.py

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

plotpy/locale/fr/LC_MESSAGES/plotpy.po

@@ -364,6 +364,21 @@ msgstr "linéaire"
 msgid "date/time"
 msgstr "date/heure"
 
+msgid "Autoscale strategy"
+msgstr "Stratégie d'autoscale"
+
+msgid "Auto"
+msgstr "Automatique"
+
+msgid "Fixed range"
+msgstr "Plage fixe"
+
+msgid "Disabled"
+msgstr "Désactivée"
+
+msgid "Strategy used by the AutoScale action for this axis: 'Auto' computes bounds from items, 'Fixed range' applies the Min/Max values defined above, 'Disabled' leaves the axis untouched."
+msgstr "Stratégie utilisée par l'action AutoScale pour cet axe : « Automatique » calcule les bornes à partir des éléments, « Plage fixe » applique les valeurs Min/Max définies ci-dessus, « Désactivée » laisse l'axe inchangé."
+
 msgid "Lower axis limit"
 msgstr "Borne inférieure de l'axe"
 
@@ -544,6 +559,9 @@ msgstr "Taille"
 msgid "Border"
 msgstr "Bordure"
 
+msgid "Border width"
+msgstr "Largueur de bordure"
+
 msgid "Background color"
 msgstr "Couleur du fond"
 
@@ -1422,11 +1440,12 @@ msgid ""
 "<b>Keyboard/mouse shortcuts:</b><br><br>\n"
 "  - <u>single left-click</u>: item (curve, image, ...) selection<br>\n"
 "  - <u>single right-click</u>: context-menu relative to selected item<br>\n"
-"  - <u>shift</u>: on-active-curve (or image) cursor<br>\n"
-"  - <u>shift + control</u>: on-active-curve cursor (maintained visible)<br>\n"
+"  - <u>shift</u>: on-active-curve (or image) cursor (+ <u>control</u> to maintain\n"
+"cursor visible)<br>\n"
+"  - <u>shift + control</u>: on-active-curve cursor (+ <u>control</u> to maintain\n"
+"cursor visible)<br>\n"
 "  - <u>alt</u>: free cursor<br>\n"
 "  - <u>left-click + mouse move</u>: move item (when available)<br>\n"
-"  - <u>control + left-click + mouse move</u>: move label on markers and range selections<br>\n"
 "  - <u>middle-click + mouse move</u>: pan<br>\n"
 "  - <u>right-click + mouse move</u>: zoom"
 msgstr ""
@@ -1685,45 +1704,3 @@ msgstr "Rotation et rognage"
 
 msgid "Show cropping rectangle"
 msgstr "Afficher le rectangle de rognage"
-
-#, fuzzy
-msgid "Border width"
-msgstr "Bordure"
-
-msgid ""
-"<b>Keyboard/mouse shortcuts:</b><br><br>\n"
-"  - <u>single left-click</u>: item (curve, image, ...) selection<br>\n"
-"  - <u>single right-click</u>: context-menu relative to selected item<br>\n"
-"  - <u>shift</u>: on-active-curve (or image) cursor (+ <u>control</u> to maintain\n"
-"cursor visible)<br>\n"
-"  - <u>shift + control</u>: on-active-curve cursor (+ <u>control</u> to maintain\n"
-"cursor visible)<br>\n"
-"  - <u>alt</u>: free cursor<br>\n"
-"  - <u>left-click + mouse move</u>: move item (when available)<br>\n"
-"  - <u>middle-click + mouse move</u>: pan<br>\n"
-"  - <u>right-click + mouse move</u>: zoom"
-msgstr ""
-"<b>Raccourcis clavier et souris :</b><br><br>\n"
-"  - <u>clique gauche</u> : sélection d'un objet (courbe, image, ...)<br>\n"
-"  - <u>clique droit</u> : menu contextuel relatif à l'objet sélectionné<br>\n"
-"  - <u>shift</u> : curseur sur la courbe (ou l'image) active (+ <u>control</u> pour maintenir le curseur visible)<br>\n"
-"  - <u>shift + control</u> : curseur sur la courbe (ou l'image) active (+ <u>control</u> pour maintenir le curseur visible)<br>\n"
-"  - <u>alt</u> : curseur libre<br>\n"
-"  - <u>clique gauche + déplacement souris</u> : déplacement de l'objet actif (si possible)<br>\n"
-"  - <u>clique du milieu + déplacement souris</u> : translation dans le plan ('pan')<br>\n"
-"  - <u>clique droit + déplacement souris</u> : agrandissement ('zoom')"
-
-msgid "Autoscale strategy"
-msgstr "Stratégie d'autoscale"
-
-msgid "Auto"
-msgstr "Automatique"
-
-msgid "Fixed range"
-msgstr "Plage fixe"
-
-msgid "Disabled"
-msgstr "Désactivée"
-
-msgid "Strategy used by the AutoScale action for this axis: 'Auto' computes bounds from items, 'Fixed range' applies the Min/Max values defined above, 'Disabled' leaves the axis untouched."
-msgstr "Stratégie utilisée par l'action AutoScale pour cet axe : « Automatique » calcule les bornes à partir des éléments, « Plage fixe » applique les valeurs Min/Max définies ci-dessus, « Désactivée » laisse l'axe inchangé."

plotpy/lutrange.py

@@ -29,8 +29,9 @@
 def hist_range_threshold(
     hist: np.ndarray, bin_edges: np.ndarray, percent: float
 ) -> tuple[float, float]:
-    """Return the range corresponding to the central `percent` of the histogram mass.
-    This can be used to eliminate outliers symmetrically, e.g. for contrast adjustment.
+    """Return the range obtained by removing `percent` of the histogram mass.
+    Outliers are eliminated symmetrically (`percent / 2` on each side),
+    e.g. for contrast adjustment.
 
     Notes:
         - If the histogram comes from an image with integer values (e.g. 0-255),
@@ -40,14 +41,14 @@ def hist_range_threshold(
     Args:
         hist: The histogram (length N)
         bin_edges: The bin edges (length N+1)
-        percent: Percent of histogram mass to retain (between 0 and 100)
+        percent: Percent of histogram mass to eliminate (between 0 and 100)
 
     Returns:
         A tuple containing the minimum and maximum values of the range
-        corresponding to the central `percent` of the histogram mass.
+        remaining after removing `percent` of the histogram mass.
     """
     if not (0 <= percent <= 100):
-        raise ValueError("percent must be in (0, 100]")
+        raise ValueError("percent must be in [0, 100]")
 
     hist_len = len(hist)
     i_offset = 0