Move background detect settings into SlideScan

src/openflexure_microscope_server/things/scan_workflows.py

@@ -44,6 +44,7 @@ from openflexure_microscope_server.ui import (
     Accordion,
     HTMLBlock,
     UIElementList,
+    action_button_for,
     property_control_for,
 )
 
@@ -560,6 +561,28 @@ class HistoScanWorkflow(RectGridWorkflow[HistoScanSettingsModel]):
 
         return imaged, focus_height
 
+    @lt.action
+    def check_background(self) -> str:
+        """Check if sample is background.
+
+        This action is a pre-run check for feeding back to the user.
+        """
+        image_array = self._cam.grab_as_array(stream_name="lores")
+        is_sample, bg_message = self._background_detector.image_is_sample(image_array)
+        label = "sample" if is_sample else "background"
+
+        return f"Current image is {label} ({bg_message})"
+
+    @lt.action
+    def set_background(self) -> None:
+        """Set the background for this background detector.
+
+        This sets the background for this workflows background detector as opposed to
+        the active background detector for the camera.
+        """
+        image_array = self._cam.grab_as_array(stream_name="lores")
+        self._background_detector.set_background(image_array)
+
     @lt.endpoint("get", "settings_ui", responses=UI_ELEMENT_RESPONSE)
     def settings_ui(self) -> UIElementList:
         """Return the UI for the workflow's settings in the scan tab."""
@@ -593,13 +616,32 @@ class HistoScanWorkflow(RectGridWorkflow[HistoScanSettingsModel]):
                 ),
             ]
         )
+        background_ui = self._background_detector.settings_ui()
+        set_bg_button = action_button_for(
+            self,
+            "set_background",
+            poll_interval=0.1,
+            submit_label="Set Background",
+            can_terminate=False,
+            notify_on_success=True,
+            success_message="Background image has been updated",
+        )
+        check_bg_button = action_button_for(
+            self,
+            "check_background",
+            poll_interval=0.1,
+            submit_label="Check Current Image",
+            can_terminate=False,
+            notify_on_success=True,
+            response_is_success_message=True,
+        )
+
+        background_ui.root += [set_bg_button, check_bg_button]
+
         return UIElementList(
             [
                 HTMLBlock(html=f"<h4>{self.display_name}</h4><p>{self.ui_blurb}<p>"),
-                Accordion(
-                    title="Background Detect",
-                    children=self._background_detector.settings_ui(),
-                ),
+                Accordion(title="Background Detect", children=background_ui),
                 Accordion(
                     title="Scan Settings",
                     children=scan_settings,

src/openflexure_microscope_server/ui.py

@@ -140,7 +140,7 @@ class ActionButton(BaseModel):
     action: str
     """The name of the action to be triggered."""
 
-    poll_interval: int = 1
+    poll_interval: float = 1
     """The interval for polling in seconds."""
 
     submit_label: str = "Submit"
@@ -171,6 +171,12 @@ class ActionButton(BaseModel):
     notify_on_success: bool = False
     """Specify whether to a notification on successful completion."""
 
+    response_is_success_message: bool = False
+    """Set True to use the action response as the success message.
+
+    If set ``success_message`` has is never used.
+    """
+
     success_message: str = "Success!"
     """The message to show on successful completion."""