PlotPy 2.3.5__tar.gz → 2.4.1__tar.gz

{plotpy-2.3.5 → plotpy-2.4.1}/CHANGELOG.md

@@ -1,5 +1,75 @@
 # Changelog #
 
+## Version 2.4.1 ##
+
+In this release, test coverage is 79%.
+
+🛠️ Bug fixes:
+
+* Contrast adjustment panel:
+  * A regression was introduced in V2.0.0: levels histogram was no longer removed from
+    contrast adjustment panel when the associated image was removed from the plot
+  * This is now fixed: when an image is removed, the histogram is removed as well and
+    the contrast panel is refreshed (which was not the case even before the regression)
+
+## 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
@@ -83,7 +153,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.5/PlotPy.egg-info → plotpy-2.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PlotPy
-Version: 2.3.5
+Version: 2.4.1
 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.5 → plotpy-2.4.1/PlotPy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PlotPy
-Version: 2.3.5
+Version: 2.4.1
 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.5 → plotpy-2.4.1}/PlotPy.egg-info/SOURCES.txt

@@ -73,6 +73,8 @@ doc/features/tools/overview.rst
 doc/features/tools/reference.rst
 doc/images/my_plot_manager.png
 doc/images/my_plot_manager.svg
+doc/images/panorama-vertical.png
+doc/images/panorama-vertical.svg
 doc/images/panorama.png
 doc/images/panorama.svg
 doc/images/plot_widgets.png
@@ -199,6 +201,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
@@ -432,6 +435,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.3.5 → plotpy-2.4.1}/doc/features/items/examples.rst

@@ -66,7 +66,7 @@ using :py:class:`.PlotWidget` and :py:class:`.PlotOptions`::
 
     >>> import guidata
     >>> app = guidata.qapplication()
-    >>> from plotpy.widgets.baseplot import PlotWidget, PlotOptions
+    >>> from plotpy.plot import PlotWidget, PlotOptions
     >>> plot = PlotWidget(options=PlotOptions(title="Example", type="image"))
 
 ...or using the :py:class:`.PlotBuilder` (see :py:attr:`plotpy.builder.make`)::

plotpy-2.4.1/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.5 → plotpy-2.4.1}/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