Add virtual fit log messages to status bar (#139)

Author: ebrahimebrahim

OpenLIFUData/OpenLIFUData.py

@@ -40,7 +40,7 @@
     display_errors,
     create_noneditable_QStandardItem,
     ensure_list,
-    add_slicer_log_handler,
+    add_slicer_log_handler_for_openlifu_object,
     BusyCursor,
 )
 
@@ -1474,7 +1474,7 @@ def load_database(self, path: Path) -> Sequence[Tuple[str,str]]:
         self._subjects = {}
 
         self.db = openlifu_lz().Database(path)
-        add_slicer_log_handler(self.db)
+        add_slicer_log_handler_for_openlifu_object(self.db)
 
         subject_ids : List[str] = ensure_list(self.db.get_subject_ids())
         self._subjects = {

OpenLIFULib/OpenLIFULib/util.py

@@ -54,7 +54,10 @@ def emit(self, record):
             method_to_use = self.handle_warning
         else: # info or any other unaccounted for log message level
             method_to_use = self.handle_info
+        
+        slicer.app.processEvents()
         method_to_use(self.format(record))
+        slicer.app.processEvents()
 
     def handle_error(self, msg):
         slicer.util.errorDisplay(f"{self.name_to_print}: {msg}")
@@ -65,9 +68,26 @@ def handle_warning(self, msg):
     def handle_info(self, msg):
         slicer.util.showStatusMessage(f"{self.name_to_print}: {msg}")
 
-def add_slicer_log_handler(openlifu_object: Any):
+def add_slicer_log_handler(logger_name : str, name_to_print : str):
+    """Adds a SlicerLogHandler to the logger of a given name,
+    and only doing so if that logger doesn't already have a SlicerLogHandler.
+
+    Args:
+        logger_name: The name of the logger that should receive Slicer log handling
+        name_to_print: The display name of the logger to put on Slicer messages and 
+            dialogs to indicate which logger the messages are coming from.
+    """
+    logger : logging.Logger = logging.getLogger(logger_name)
+    if not any(isinstance(h, SlicerLogHandler) for h in logger.handlers):
+        handler = SlicerLogHandler(name_to_print)
+        logger.addHandler(handler)
+
+def add_slicer_log_handler_for_openlifu_object(openlifu_object: Any):
     """Adds an appropriately named SlicerLogHandler to the logger of an openlifu object,
-    and only doing so if that logger doesn't already have a SlicerLogHandler"""
+    and only doing so if that logger doesn't already have a SlicerLogHandler.
+    This is designed to work with those openlifu classes that have a `logger` attribute,
+    a common pattern in the openlifu python codebase.
+    """
     if not hasattr(openlifu_object, "logger"):
         raise ValueError("This object does not have a logger attribute.")
     if not hasattr(openlifu_object, "__class__"):

OpenLIFUPrePlanning/OpenLIFUPrePlanning.py

@@ -22,7 +22,7 @@
     SlicerOpenLIFUProtocol,
     SlicerOpenLIFUTransducer,
 )
-from OpenLIFULib.util import replace_widget, BusyCursor
+from OpenLIFULib.util import replace_widget, BusyCursor, add_slicer_log_handler
 from OpenLIFULib.virtual_fit_results import (
     add_virtual_fit_result,
     clear_virtual_fit_results,
@@ -556,6 +556,8 @@ def virtual_fit(
             target: vtkMRMLMarkupsFiducialNode,
         ) -> Optional[vtkMRMLTransformNode]:
 
+        add_slicer_log_handler("VirtualFit", "Virtual fitting")
+
         # TODO: Many quantities are hard-coded here will not have to be when these two issues are done:
         # https://github.com/OpenwaterHealth/OpenLIFU-python/issues/166
         # https://github.com/OpenwaterHealth/OpenLIFU-python/issues/165
@@ -578,7 +580,6 @@ def virtual_fit(
                 (-50, 50), # ax
             ),
         )
-        # TODO: add log handler for this
 
         session = get_openlifu_data_parameter_node().loaded_session
         session_id : Optional[str] = session.get_session_id() if session is not None else None