Get rid of triggerEvent and set_trigger boilerplate (#147)

Author: Baharis

src/instamatic/gui/autocred_frame.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import datetime
-import os
 import pickle
 import threading
 from pathlib import Path
@@ -14,10 +13,10 @@
 from instamatic.calibrate import CalibBeamShift
 from instamatic.calibrate.filenames import *
 
-from .base_module import BaseModule
+from .base_module import BaseModule, HasQMixin
 
 
-class ExperimentalautocRED(LabelFrame):
+class ExperimentalautocRED(LabelFrame, HasQMixin):
     """Data collection protocol for SerialRED data collection on a high-speed
     Timepix camera using automated screening and crystal tracking.
 
@@ -211,10 +210,6 @@ def init_vars(self):
         self.var_backlash = DoubleVar(value=1.0)
         self.var_rotspeed = DoubleVar(value=0.86)
 
-    def set_trigger(self, trigger=None, q=None):
-        self.triggerEvent = trigger
-        self.q = q
-
     def start_collection(self):
         self.CollectionStopButton.config(state=NORMAL)
         self.CollectionButton.config(state=DISABLED)
@@ -226,8 +221,6 @@ def start_collection(self):
         params = self.get_params()
         self.q.put(('autocred', params))
 
-        self.triggerEvent.set()
-
     def stop_collection(self, event=None):
         self.stopEvent_experiment.set()
 
@@ -314,7 +307,6 @@ def toggle_diff_defocus(self):
         difffocus = self.var_diff_defocus.get()
 
         self.q.put(('toggle_difffocus', {'value': difffocus, 'toggle': toggle}))
-        self.triggerEvent.set()
 
     def show_calib_beamshift(self):
         # TODO: use mpl_frame.ShowMatplotlibFig

src/instamatic/gui/base_module.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from queue import Queue
+
 
 class BaseModule:
     """BaseModule for the gui composition.
@@ -31,3 +33,9 @@ def initialize(self, parent):
         frame = self.tk_frame(parent, **self.kwargs)
         self.frame = frame
         return frame
+
+
+class HasQMixin:
+    """Asserts module.q remains reserved for DataCollectionController.q."""
+
+    q: Queue

src/instamatic/gui/cred_fei_frame.py

@@ -5,10 +5,10 @@
 
 from instamatic.utils.spinbox import Spinbox
 
-from .base_module import BaseModule
+from .base_module import BaseModule, HasQMixin
 
 
-class ExperimentalcRED_FEI(LabelFrame):
+class ExperimentalcRED_FEI(LabelFrame, HasQMixin):
     """Simple panel to assist cRED data collection (mainly rotation control) on
     a FEI microscope."""
 
@@ -94,10 +94,6 @@ def init_vars(self):
         self.var_save_tiff = BooleanVar(value=True)
         self.var_save_red = BooleanVar(value=True)
 
-    def set_trigger(self, trigger=None, q=None):
-        self.triggerEvent = trigger
-        self.q = q
-
     def start_collection(self):
         self.StartButton.config(state=DISABLED)
         self.FinalizeButton.config(state=NORMAL)
@@ -114,7 +110,6 @@ def start_collection(self):
                 },
             )
         )
-        self.triggerEvent.set()
 
     def stop_collection(self):
         self.StartButton.config(state=NORMAL)
@@ -123,7 +118,6 @@ def stop_collection(self):
         self.e_rotspeed.config(state=NORMAL)
         params = self.get_params(task='None')
         self.q.put(('credfei', params))
-        self.triggerEvent.set()
 
     def get_params(self, task=None):
         params = {

src/instamatic/gui/cred_frame.py

@@ -6,12 +6,12 @@
 
 from instamatic.utils.spinbox import Spinbox
 
-from .base_module import BaseModule
+from .base_module import BaseModule, HasQMixin
 
 ENABLE_FOOTFREE_OPTION = False
 
 
-class ExperimentalcRED(LabelFrame):
+class ExperimentalcRED(LabelFrame, HasQMixin):
     """GUI panel for doing cRED experiments on a Timepix camera."""
 
     def __init__(self, parent):
@@ -183,10 +183,6 @@ def init_vars(self):
         self.var_save_dials = BooleanVar(value=True)
         self.var_save_red = BooleanVar(value=True)
 
-    def set_trigger(self, trigger=None, q=None):
-        self.triggerEvent = trigger
-        self.q = q
-
     def start_collection(self):
         # TODO: make a pop up window with the STOP button?
         if self.var_toggle_diff_defocus.get():
@@ -209,8 +205,6 @@ def start_collection(self):
         params = self.get_params()
         self.q.put(('cred', params))
 
-        self.triggerEvent.set()
-
     def stop_collection(self, event=None):
         self.stopEvent.set()
 
@@ -258,7 +252,6 @@ def relax_beam(self):
         difffocus = self.var_diff_defocus.get()
 
         self.q.put(('relax_beam', {'value': difffocus}))
-        self.triggerEvent.set()
 
     def toggle_footfree(self):
         enable = self.var_toggle_footfree.get()
@@ -274,7 +267,6 @@ def toggle_diff_defocus(self):
         difffocus = self.var_diff_defocus.get()
 
         self.q.put(('toggle_difffocus', {'value': difffocus, 'toggle': toggle}))
-        self.triggerEvent.set()
 
 
 def acquire_data_cRED(controller, **kwargs):
@@ -301,7 +293,6 @@ def acquire_data_cRED(controller, **kwargs):
 
     if controller.use_indexing_server:
         controller.q.put(('autoindex', {'task': 'run', 'path': cexp.smv_path}))
-        controller.triggerEvent.set()
 
 
 module = BaseModule(

src/instamatic/gui/cred_tvips_frame.py

@@ -9,12 +9,12 @@
 from instamatic import config
 from instamatic.utils.spinbox import Spinbox
 
-from .base_module import BaseModule
+from .base_module import BaseModule, HasQMixin
 
 barrier = threading.Barrier(2, timeout=60)
 
 
-class ExperimentalTVIPS(LabelFrame):
+class ExperimentalTVIPS(LabelFrame, HasQMixin):
     """GUI panel for doing cRED / SerialRED experiments on a TVIPS camera."""
 
     def __init__(self, parent):
@@ -217,10 +217,6 @@ def init_vars(self):
 
         self.var_goniotool_tx = IntVar(value=1)
 
-    def set_trigger(self, trigger=None, q=None):
-        self.triggerEvent = trigger
-        self.q = q
-
     def invert_angle(self):
         angle = self.var_target_angle.get()
         self.var_target_angle.set(-angle)
@@ -257,7 +253,6 @@ def prime_collection(self):
         # self.e_target_angle.config(state=DISABLED)
         params = self.get_params(task='get_ready')
         self.q.put(('cred_tvips', params))
-        self.triggerEvent.set()
 
         def worker(button=None, state=None):
             barrier.wait()  # wait for experiment to be primed
@@ -272,19 +267,16 @@ def start_collection(self):
         self.AcquireButton.config(state=DISABLED)
         params = self.get_params(task='acquire')
         self.q.put(('cred_tvips', params))
-        self.triggerEvent.set()
 
     def stop_collection(self):
         self.enable_ui()
         params = self.get_params(task='stop')
         self.q.put(('cred_tvips', params))
-        self.triggerEvent.set()
 
     def serial_collection(self):
         self.disable_ui()
         params = self.get_params(task='serial')
         self.q.put(('cred_tvips', params))
-        self.triggerEvent.set()
 
     def browse_instructions(self):
         fn = filedialog.askopenfilename(
@@ -342,11 +334,9 @@ def toggle_screen(self):
 
     def start_liveview(self):
         self.q.put(('ctrl', {'task': 'cam.start_liveview'}))
-        self.triggerEvent.set()
 
     def stop_liveview(self):
         self.q.put(('ctrl', {'task': 'cam.stop_liveview'}))
-        self.triggerEvent.set()
 
     def toggle_diff_defocus(self):
         toggle = self.var_toggle_diff_defocus.get()

src/instamatic/gui/ctrl_frame.py

@@ -7,10 +7,10 @@
 from instamatic import config
 from instamatic.utils.spinbox import Spinbox
 
-from .base_module import BaseModule
+from .base_module import BaseModule, HasQMixin
 
 
-class ExperimentalCtrl(LabelFrame):
+class ExperimentalCtrl(LabelFrame, HasQMixin):
     """This panel holds some frequently used functions to control the electron
     microscope."""
 
@@ -210,17 +210,12 @@ def init_vars(self):
 
         self.var_stage_wait = BooleanVar(value=True)
 
-    def set_trigger(self, trigger=None, q=None):
-        self.triggerEvent = trigger
-        self.q = q
-
     def set_mode(self, event=None):
         self.ctrl.mode.set(self.var_mode.get())
 
     def set_brightness(self, event=None):
         self.var_brightness.set(self.var_brightness.get())
         self.q.put(('ctrl', {'task': 'brightness.set', 'value': self.var_brightness.get()}))
-        self.triggerEvent.set()
 
     def get_brightness(self, event=None):
         self.var_brightness.set(self.ctrl.brightness.get())
@@ -239,15 +234,13 @@ def reset_stage(self):
     def set_difffocus(self, event=None):
         self.var_difffocus.set(self.var_difffocus.get())
         self.q.put(('ctrl', {'task': 'difffocus.set', 'value': self.var_difffocus.get()}))
-        self.triggerEvent.set()
 
     def get_difffocus(self, event=None):
         self.var_difffocus.set(self.ctrl.difffocus.get())
 
     def _set_angle(self, var: Variable) -> None:
         kwargs = {'task': 'stage.set', 'a': var.get(), 'wait': self.var_stage_wait.get()}
         self.q.put(('ctrl', kwargs))
-        self.triggerEvent.set()
 
     def set_negative_angle(self):
         return self._set_angle(self.var_negative_angle)
@@ -280,7 +273,6 @@ def set_stage(self):
                 },
             )
         )
-        self.triggerEvent.set()
 
     def get_stage(self, event=None):
         x, y, z, _, _ = self.ctrl.stage.get()
@@ -301,17 +293,14 @@ def toggle_alpha_wobbler(self):
                     },
                 )
             )
-            self.triggerEvent.set()
         else:  # wobbler off
             self.wobble_stop_event.set()
 
     def stage_stop(self):
         self.q.put(('ctrl', {'task': 'stage.stop'}))
-        self.triggerEvent.set()
 
     def find_eucentric_height(self):
         self.q.put(('ctrl', {'task': 'find_eucentric_height'}))
-        self.triggerEvent.set()
 
     def toggle_diff_defocus(self):
         if self.var_diff_defocus_on.get():