interface building clean-up

added methods for adding several widgets and making solo groups much more cleanly + cleaned up code with them

Author: C-Achard

docs/res/code/interface.rst

@@ -18,6 +18,9 @@ make_group
 **************************************
 .. autofunction:: napari_cellseg3d.interface::make_group
 
+add_to_group
+**************************************
+.. autofunction:: napari_cellseg3d.interface::add_to_group
 
 make_container
 **************************************

napari_cellseg3d/interface.py

@@ -46,7 +46,7 @@
 napari_grey = "#262930"  # napari background color (grey)
 
 
-def add_blank(widget, layout):
+def add_blank(widget, layout=None):
     """
     Adds a space between consecutive buttons/labels in a layout when building a widget
 
@@ -58,7 +58,8 @@ def add_blank(widget, layout):
         QLabel : blank label
     """
     blank = QLabel("", widget)
-    layout.addWidget(blank, alignment=ABS_AL)
+    if layout is not None:
+        layout.addWidget(blank, alignment=ABS_AL)
     return blank
 
 
@@ -201,35 +202,42 @@ def make_n_spinboxes(
     return boxes
 
 
-def make_group(title, L=7, T=20, R=7, B=11, solo_dict=None):
-    """Creates a group with a header (`title`) and content margins for top/left/right/bottom `L, T, R, B` (in pixels)
+def add_to_group(title, widget, layout, L=7, T=20, R=7, B=11):
+    """Adds a single widget to a layout as a named group with margins specified.
+
+    Args:
+        title: title of the group
+        widget: widget to add in the group
+        layout: layout to add the group in
+        L: left margin (in pixels)
+        T: top margin (in pixels)
+        R: right margin (in pixels)
+        B: bottom margin (in pixels)
+
+    """
+    group, layout_internal = make_group(title, L, T, R, B)
+    layout_internal.addWidget(widget)
+    group.setLayout(layout_internal)
+    layout.addWidget(group)
+
+
+def make_group(title, L=7, T=20, R=7, B=11):
+    """Creates a group widget and layout, with a header (`title`) and content margins for top/left/right/bottom `L, T, R, B` (in pixels)
     Group widget and layout returned will have a Fixed size policy.
-    If solo_dict is not None, adds specified widget to specified layout and returns None.
 
     Args:
         title (str): Title of the group
         L (int): left margin
         T (int): top margin
         R (int): right margin
         B (int): bottom margin
-        solo_dict (dict): shortcut if only one widget is to be added to the group. Should contain "widget" (QWidget) and "layout" (Qlayout), widget will be added to layout. Defaults to None
     """
     group = QGroupBox(title)
     group.setSizePolicy(QSizePolicy.Fixed, QSizePolicy.Fixed)
     layout = QVBoxLayout()
     layout.setContentsMargins(L, T, R, B)
     layout.setSizeConstraint(QLayout.SetFixedSize)
 
-    if (
-        solo_dict is not None
-    ):  # use the dict to directly add a widget if it is alone in the group
-        external_lay = solo_dict["layout"]
-        external_wid = solo_dict["widget"]
-        layout.addWidget(external_wid)  # , alignment=LEFT_AL)
-        group.setLayout(layout)
-        external_lay.addWidget(group)
-        return
-
     return group, layout
 
 
@@ -331,6 +339,22 @@ def make_combobox(
     return menu
 
 
+def add_widgets(layout, widgets, alignment=LEFT_AL):
+    """Adds all widgets in the list to layout, with the specified alignment.
+    If alignment is None, no alignment is set.
+    Args:
+        layout: layout to add widgets in
+        widgets: list of QWidgets to add to layout
+        alignment: any valid Qt.AlignmentFlag, see aliases at beginning of interface.py. If None, uses default of addWidget
+    """
+    if alignment is None:
+        for w in widgets:
+            layout.addWidget(w)
+    else:
+        for w in widgets:
+            layout.addWidget(w, alignment=alignment)
+
+
 def make_checkbox(
     title: str = None,
     func: callable = None,

napari_cellseg3d/model_framework.py

@@ -207,15 +207,12 @@ def display_status_report(self):
             self.log.clear()
         elif not self.container_docked:
 
-            self.container_report_layout.addWidget(  # DO NOT USE alignment here, it will break auto-resizing
-                self.progress  # , alignment=ui.CENTER_AL
-            )
-            self.container_report_layout.addWidget(
-                self.log
-            )  # , alignment=ui.CENTER_AL
-            self.container_report_layout.addWidget(
-                self.btn_save_log  # , alignment=ui.CENTER_AL
+            ui.add_widgets(
+                self.container_report_layout,
+                [self.progress, self.log, self.btn_save_log],
+                alignment=None,
             )
+
             self.container_report.setLayout(self.container_report_layout)
 
             report_dock = self._viewer.window.add_dock_widget(

napari_cellseg3d/plugin_convert.py

@@ -88,9 +88,10 @@ def build(self):
             min_spacing=70,
         )
 
-        ui.make_group(
+        ui.add_to_group(
             "Results",
-            solo_dict={"widget": results_widget, "layout": layout},
+            results_widget,
+            layout,
             L=3,
             T=11,
             R=3,
@@ -108,14 +109,16 @@ def build(self):
                 right_or_below=self.btn_label_files,
                 left_or_above=self.lbl_label_files,
                 min_spacing=70,
-            ),
-            alignment=ui.LEFT_AL,
-        )
-        folder_group_l.addWidget(
-            self.btn_convert_folder_instance, alignment=ui.HCENTER_AL
+            )
         )
-        folder_group_l.addWidget(
-            self.btn_convert_folder_semantic, alignment=ui.HCENTER_AL
+
+        ui.add_widgets(
+            folder_group_l,
+            [
+                self.btn_convert_folder_instance,
+                self.btn_convert_folder_semantic,
+            ],
+            ui.HCENTER_AL,
         )
 
         folder_group_w.setLayout(folder_group_l)
@@ -127,11 +130,10 @@ def build(self):
             "Convert selected layer", l, t, r, b
         )
 
-        layer_group_l.addWidget(
-            self.btn_convert_layer_instance, alignment=ui.HCENTER_AL
-        )
-        layer_group_l.addWidget(
-            self.btn_convert_layer_semantic, alignment=ui.HCENTER_AL
+        ui.add_widgets(
+            layer_group_l,
+            [self.btn_convert_layer_instance, self.btn_convert_layer_semantic],
+            ui.HCENTER_AL,
         )
 
         layer_group_w.setLayout(layer_group_l)
@@ -143,24 +145,26 @@ def build(self):
             "Remove small objects", l, t, r, b
         )
 
-        small_group_l.addWidget(
-            self.small_object_thresh_choice, alignment=ui.HCENTER_AL
-        )
-        small_group_l.addWidget(
-            self.btn_remove_small_layer, alignment=ui.HCENTER_AL
-        )
-        small_group_l.addWidget(
-            self.btn_remove_small_folder, alignment=ui.HCENTER_AL
+        ui.add_widgets(
+            small_group_l,
+            [
+                self.small_object_thresh_choice,
+                self.btn_remove_small_layer,
+                self.btn_remove_small_folder,
+            ],
+            ui.HCENTER_AL,
         )
 
         small_group_w.setLayout(small_group_l)
         layout.addWidget(small_group_w)
         #############################################################
-        ui.add_blank(layout=layout, widget=self)
-        layout.addWidget(self.make_close_button())
 
-        ui.add_blank(layout=layout, widget=self)
-        layout.addWidget(self.lbl_error)
+        ui.add_widgets(layout, [
+            ui.add_blank(self),
+            self.make_close_button(),
+            ui.add_blank(self),
+            self.lbl_error
+        ])
 
         ui.make_scrollable(layout, self, min_wh=[230, 400], base_wh=[230, 450])
 

napari_cellseg3d/plugin_crop.py

@@ -100,24 +100,21 @@ def build(self):
         w, layout = ui.make_container(0, 0, 1, 11)
 
         data_group_w, data_group_l = ui.make_group("Data")
-        data_group_l.addWidget(
-            ui.combine_blocks(self.btn_image, self.lbl_image),
-            alignment=ui.LEFT_AL,
+
+        ui.add_widgets(
+            data_group_l,
+            [
+                ui.combine_blocks(self.btn_image, self.lbl_image),
+                self.crop_label_choice,  # whether to crop labels or no
+                ui.combine_blocks(self.btn_label, self.lbl_label),
+                self.file_handling_box,
+                self.filetype_choice,
+            ],
         )
-        data_group_l.addWidget(
-            self.crop_label_choice,
-            alignment=ui.LEFT_AL,
-        )  # whether to crop labels or no
+
         self.crop_label_choice.toggle()
         self.toggle_label_path()
 
-        data_group_l.addWidget(
-            ui.combine_blocks(self.btn_label, self.lbl_label),
-            alignment=ui.LEFT_AL,
-        )
-
-        data_group_l.addWidget(self.file_handling_box, alignment=ui.LEFT_AL)
-        data_group_l.addWidget(self.filetype_choice, alignment=ui.LEFT_AL)
         self.filetype_choice.setVisible(False)
 
         data_group_w.setLayout(data_group_l)
@@ -133,10 +130,18 @@ def build(self):
         ]
         dim_group_w.setLayout(dim_group_l)
         layout.addWidget(dim_group_w)
-
+        #####################
+        #####################
         ui.add_blank(self, layout)
-        layout.addWidget(self.btn_start, alignment=ui.LEFT_AL)
-        layout.addWidget(self.btn_close, alignment=ui.LEFT_AL)
+        #####################
+        #####################
+        ui.add_widgets(
+            layout,
+            [
+                self.btn_start,
+                self.btn_close,
+            ],
+        )
 
         ui.make_scrollable(layout, self, min_wh=[180, 100])
 

napari_cellseg3d/plugin_helper.py

@@ -51,11 +51,15 @@ def __init__(self, viewer: "napari.viewer.Viewer"):
 
     def build(self):
         vbox = QVBoxLayout()
-        vbox.addWidget(self.btn1, alignment=ui.LEFT_AL)
-        vbox.addWidget(self.btn2, alignment=ui.LEFT_AL)
-        vbox.addWidget(self.btnc, alignment=ui.LEFT_AL)
+
+        widgets = [
+            self.btn1,
+            self.btn2,
+            self.btnc,
+        ]
         if self.test:
-            vbox.addWidget(self.epoch, alignment=ui.ABS_AL)
+            widgets.append(self.epoch)
+        ui.add_widgets(vbox, widgets)
         self.setLayout(vbox)
         # self.show()
         # self._viewer.window.add_dock_widget(self, name="Help/About...", area="right")

napari_cellseg3d/plugin_metrics.py

@@ -83,47 +83,44 @@ def build(self):
 
         metrics_group_w, metrics_group_l = ui.make_group("Data")
 
-        self.lbl_image_files.setText("Ground truth")
-
-        metrics_group_l.addWidget(
+        ui.add_widgets(metrics_group_l, [
             ui.combine_blocks(
                 right_or_below=self.btn_image_files,
                 left_or_above=self.lbl_image_files,
                 min_spacing=70,
-            ),
-            alignment=ui.LEFT_AL,
-        )
-
-        self.lbl_label_files.setText("Prediction")
-
-        metrics_group_l.addWidget(
+            ), # images -> ground truth
             ui.combine_blocks(
                 right_or_below=self.btn_label_files,
                 left_or_above=self.lbl_label_files,
                 min_spacing=70,
-            ),
-            alignment=ui.LEFT_AL,
-        )
+            ), # labels -> prediction
+        ])
+
+        self.lbl_image_files.setText("Ground truth")
+
+        self.lbl_label_files.setText("Prediction")
 
         metrics_group_w.setLayout(metrics_group_l)
         ############################
         ui.add_blank(self, self.layout)
         ############################
         param_group_w, param_group_l = ui.make_group("Parameters")
 
-        param_group_l.addWidget(self.threshold_box)
-        param_group_l.addWidget(self.rotate_choice)
+        ui.add_widgets(param_group_l, [self.threshold_box, self.rotate_choice], None)
 
         param_group_w.setLayout(param_group_l)
+        ##############################
+        ui.add_widgets(
+            self.layout,
+            [
+                metrics_group_w,
+                param_group_w,
+                self.btn_compute_dice,
+                self.make_close_button(),
+                self.btn_reset_plot,
+            ],
+        )
 
-        self.layout.addWidget(metrics_group_w)
-        self.layout.addWidget(param_group_w)
-
-        self.layout.addWidget(self.btn_compute_dice, alignment=ui.LEFT_AL)
-
-        self.layout.addWidget(self.make_close_button(), alignment=ui.LEFT_AL)
-
-        self.layout.addWidget(self.btn_reset_plot, alignment=ui.LEFT_AL)
         self.btn_reset_plot.setVisible(False)
 
         ui.make_scrollable(self.layout, self)