Change strategy for default plot widget size

Author: PierreRaybaut

CHANGELOG.md

@@ -5,6 +5,9 @@
 💥 New features / Enhancements:
 
 * Added support for color theme change at execution (relies on guidata V3.6)
+* Changed strategy for default plot widget size:
+  * No default size is applied to the plot widget anymore (before, the default size was 800x600 pixels)
+  * Added parameter `size` to `PlotDialog`, `PlotWindow` classes, and `make.dialog`, `make.window` functions to set the initial size of the plot widget
 
 🛠️ Bug fixes:
 

plotpy/builder/plot.py

@@ -143,6 +143,7 @@ def dialog(
         wintitle: str = "PlotPy",
         icon: str = "plotpy.svg",
         edit: bool = False,
+        size: tuple[int, int] | None = None,
         title: str | None = None,
         xlabel: str | tuple[str, str] | None = None,
         ylabel: str | tuple[str, str] | None = None,
@@ -178,6 +179,7 @@ def dialog(
             wintitle: The window title
             icon: The window icon
             edit: If True, the plot is editable
+            size: The window size
             title: The plot title
             xlabel: (bottom axis title, top axis title) or bottom axis title only
             ylabel: (left axis title, right axis title) or left axis title only
@@ -236,6 +238,7 @@ def dialog(
             title=wintitle,
             icon=icon,
             edit=edit,
+            size=size,
         )
 
     def window(
@@ -246,6 +249,7 @@ def window(
         auto_tools: bool = True,
         wintitle: str = "PlotPy",
         icon: str = "plotpy.svg",
+        size: tuple[int, int] | None = None,
         title: str | None = None,
         xlabel: str | tuple[str, str] | None = None,
         ylabel: str | tuple[str, str] | None = None,
@@ -280,6 +284,7 @@ def window(
              If False, the user must register the tools manually.
             wintitle: The window title
             icon: The window icon
+            size: The window size
             title: The plot title
             xlabel: (bottom axis title, top axis title) or bottom axis title only
             ylabel: (left axis title, right axis title) or left axis title only
@@ -337,6 +342,7 @@ def window(
             auto_tools=auto_tools,
             title=wintitle,
             icon=icon,
+            size=size,
         )
 
     def gridparam(

plotpy/plot/plotwidget.py

@@ -366,14 +366,14 @@ def configure_manager(
 
 
 def set_widget_title_icon(
-    widget: QWidget, title: str, icon: QG.QIcon, resize: tuple[int, int] | None = None
+    widget: QWidget, title: str, icon: QG.QIcon, size: tuple[int, int] | None = None
 ) -> None:
     """Setups the widget title and icon
 
     Args:
         title: The window title
         icon: The window icon
-        resize: The window size (width, height). Defaults to None (no resize)
+        size: The window size (width, height). Defaults to None (no resize)
     """
     win32_fix_title_bar_background(widget)
     widget.setWindowTitle(title)
@@ -382,8 +382,8 @@ def set_widget_title_icon(
     if icon is not None:
         widget.setWindowIcon(icon)
     widget.setMinimumSize(320, 240)
-    if resize is not None:
-        widget.resize(*resize)
+    if size is not None:
+        widget.resize(*size)
 
 
 def add_widget_to_grid_layout(
@@ -535,6 +535,7 @@ class PlotDialog(QW.QDialog, AbstractPlotDialogWindow, metaclass=PlotDialogMeta)
         title: The window title
         icon: The window icon
         edit: If True, the plot is editable
+        size: The window size (width, height). Defaults to None (no resize)
     """
 
     def __init__(
@@ -547,9 +548,10 @@ def __init__(
         title: str = "PlotPy",
         icon: str = "plotpy.svg",
         edit: bool = False,
+        size: tuple[int, int] | None = None,
     ) -> None:
         super().__init__(parent)
-        set_widget_title_icon(self, title, icon, resize=(640, 480))
+        set_widget_title_icon(self, title, icon, size)
         self.edit = edit
         self.button_box = None
         self.button_layout = None
@@ -692,6 +694,7 @@ class PlotWindow(QW.QMainWindow, AbstractPlotDialogWindow, metaclass=PlotWindowM
          If False, the user must register the tools manually.
         title: The window title
         icon: The window icon
+        size: The window size (width, height). Defaults to None (no resize)
     """
 
     def __init__(
@@ -703,9 +706,10 @@ def __init__(
         auto_tools: bool = True,
         title: str = "PlotPy",
         icon: str = "plotpy.svg",
+        size: tuple[int, int] | None = None,
     ) -> None:
         super().__init__(parent)
-        set_widget_title_icon(self, title, icon, resize=(640, 480))
+        set_widget_title_icon(self, title, icon, size)
         self.plot_layout = QW.QGridLayout()
         self.plot_widget: PlotWidget = None
         self.manager: PlotManager = None
@@ -897,6 +901,7 @@ class SyncPlotWindow(QW.QMainWindow):
          If False, the user must register the tools manually.
         title: The window title
         icon: The window icon
+        size: The window size (width, height). Defaults to None (no resize)
 
     Usage: first, create a window, then add plots to it, then call the
     :py:meth:`.SyncPlotWindow.finalize_configuration` method to add panels and
@@ -920,9 +925,10 @@ def __init__(
         auto_tools: bool = True,
         title: str = "PlotPy",
         icon: str = "plotpy.svg",
+        size: tuple[int, int] | None = None,
     ) -> None:
         super().__init__(parent)
-        set_widget_title_icon(self, title, icon)
+        set_widget_title_icon(self, title, icon, size)
         self.manager = PlotManager(None)
         self.manager.set_main(self)
         self.subplotwidget = SubplotWidget(self.manager, parent=self, options=options)

plotpy/tests/benchmarks/test_bigimages.py

@@ -15,7 +15,9 @@
 
 
 def imshow():
-    win = make.dialog(toolbar=True, title="Displaying 10 big images test")
+    win = make.dialog(
+        toolbar=True, title="Displaying 10 big images test", size=(800, 600)
+    )
     plot = win.manager.get_plot()
     for i in range(10):
         plot.add_item(make.image(compute_image(i)))

plotpy/tests/features/test_contrast.py

@@ -30,12 +30,12 @@ def __create_dialog_with_contrast(item):
         wintitle="Contrast test",
         show_contrast=True,
         type="image",
+        size=(600, 600),
     )
     plot = win.get_plot()
     plot.add_item(item)
     plot.set_active_item(item)
     item.unselect()
-    win.resize(600, 600)
     win.show()
     return win
 

plotpy/tests/features/test_dicom_image.py

@@ -30,6 +30,7 @@ def test_dicom_image():
             wintitle="DICOM I/O test",
             show_contrast=True,
             type="image",
+            size=(600, 700),
         )
         filename = get_path("mr-brain.dcm")
         image = make.image(filename=filename, title="DICOM img", colormap="gray")
@@ -38,7 +39,6 @@ def test_dicom_image():
         plot.select_item(image)
         contrast = win.manager.get_contrast_panel()
         contrast.histogram.eliminate_outliers(54.0)
-        win.resize(600, 700)
 
 
 if __name__ == "__main__":

plotpy/tests/features/test_imagefilter.py

@@ -27,6 +27,7 @@ def imshow(x, y, data, filter_area, yreverse=True):
             ylabel="y (cm)",
             yreverse=yreverse,
             type="image",
+            size=(800, 600),
         )
         image = make.xyimage(x, y, data)
         plot = win.manager.get_plot()

plotpy/tests/features/test_imagesuperp.py

@@ -24,6 +24,7 @@ def create_window():
         wintitle="Image superposition test",
         gridparam=gridparam,
         type="image",
+        size=(800, 600),
     )
     for toolklass in (RectangleTool, EllipseTool, FreeFormTool, PlaceAxesTool):
         win.manager.add_tool(toolklass)

plotpy/tests/tools/test_cross_section.py

@@ -22,8 +22,8 @@ def create_window():
         show_xsection=True,
         show_ysection=True,
         type="image",
+        size=(640, 600),
     )
-    win.resize(640, 600)
     return win
 
 

plotpy/tests/tools/test_customize_shape_tool.py

@@ -43,6 +43,7 @@ def create_window():
         wintitle="All image and plot tools test",
         gridparam=gridparam,
         type="image",
+        size=(800, 600),
     )
     for toolklass in (
         RectangleTool,