consume CharEvents s and w in viewers

CHANGES.md

@@ -1,6 +1,8 @@
 # ChangeLog
 
 ## vx.x.x
+* Consume events 's' and 'w' in viewers to avoid render changes between wireframe and surface
+* Added argument parser to idvc command. This allows the user to specify the debugging level.
 * Add setting to set the number of OpenMP threads to use during DVC analysis
 * Use os.path.join to create all filepaths, previously in some cases we were forcing "\" or "/" to be in some paths
 * renames input files with names reference and correlate for the relative images, if data are copied in the session.

src/idvc/idvc.py

@@ -1,8 +1,22 @@
 import PySide2
 from PySide2 import QtWidgets, QtGui
 import os, sys
+import logging
+import argparse
+
 
 def main():
+
+    parser = argparse.ArgumentParser(description='iDVC - Digital Volume Correlation Software')
+
+    parser.add_argument('--debug', type=str)
+    args = parser.parse_args()
+
+    if args.debug in ['debug', 'info', 'warning', 'error', 'critical']:
+        level = eval(f'logging.{args.debug.upper()}')
+        logging.basicConfig(level=level)
+        logging.info(f"iDVC: Setting debugging level to {args.debug.upper()}")
+
     app = QtWidgets.QApplication([])
 
     file_dir = os.path.dirname(__file__)
@@ -23,6 +37,8 @@ def main():
     window.show()
     splash.finish(window)
 
+
+
     sys.exit(app.exec_())
 
 if __name__ == "__main__":

src/idvc/ui/windows.py

@@ -2,7 +2,7 @@
 import os
 
 import ccpi.viewer.viewerLinker as vlink
-import PySide2
+
 import vtk
 from ccpi.viewer import viewer2D, viewer3D
 from ccpi.viewer.CILViewer2D import (SLICE_ORIENTATION_XY,
@@ -19,6 +19,7 @@
 from idvc.ui.widgets import *
 
 from idvc.utilities import RunResults
+import logging 
 
 
 class VisualisationWindow(QtWidgets.QMainWindow):
@@ -41,6 +42,7 @@ def __init__(self, parent, viewer=viewer2D, interactorStyle=vlink.Linked2DIntera
         self.interactorStyle = interactorStyle
         self.createEmptyFrame()
         self.threadpool = QThreadPool()
+        self._consume_CharEvent = ['s', 'w']
 
     def getViewer(self):
         return self.frame.viewer
@@ -99,6 +101,10 @@ def displayImageData(self):
                 vs_widgets['coords_combobox'].setEnabled(False)
                 vs_widgets['coords_combobox'].setCurrentIndex(0)
 
+        # consume 's' and 'w' events
+        # https://github.com/vais-ral/CILViewer/issues/332#issuecomment-1888940327
+        self.getInteractor().AddObserver('CharEvent', self.consumeCharEvent, 10.)
+
         self.frame.viewer.setInput3DData(self.image_data)  
         interactor = self.frame.viewer.getInteractor()
 
@@ -150,6 +156,15 @@ def setImageData(self, image_data):
     def getImageData(self):
         return self.image_data
 
+    def consumeCharEvent(self, interactor, event):
+        '''Changes the event in self._consume_CharEvent to "" so that the event is not processed by the viewer.
+
+        This prevents the viewer from changing the rendered scene to surface or wireframe mode when the user presses 's' or 'w' respectively.
+        '''
+        if interactor.GetKeyCode() in self._consume_CharEvent:
+            logging.info("Consuming event: " + interactor.GetKeyCode())
+            interactor.SetKeyCode("")
+
 class GraphsWindow(QMainWindow):
     '''creates a new window with graphs from results saved in the selected run folder.
     '''