implemented EditChannelEvent, refactored ChannelEditor widget, bug fixes

Author: cudmore

src/pymapmanager/annotations/spineAnnotationsCore.py

@@ -34,25 +34,6 @@ def _buildDataFrame(self):
 
         if len(allSpinesDf) > 0:  
 
-            # abb removed 202508
-            # if 0:
-            #     # abb 202504 reduce columns to existing channel keys
-            #     # the channel keys actually in the timepoint
-            #     existingChannelKeys = self.singleTimepoint.timepointMetadata().channelKeys
-            #     existingChannelKeys = set(existingChannelKeys)
-            #     # all possible channel keys
-            #     possibleChannelKeys = self._fullMap.getMapMetadata().possibleChannelKeys
-            #     possibleChannelKeys = set(possibleChannelKeys)
-            #     # the keys to remove
-            #     _removeChannelKeys = possibleChannelKeys - existingChannelKeys
-            #     # logger.info(f'existingChannelKeys:{existingChannelKeys} possibleChannelKeys:{possibleChannelKeys} _removeChannelKeys:{_removeChannelKeys}')
-            #     # logger.info(f'before drop _ch3_ num columns:{len(allSpinesDf.columns)}')
-            #     for _removeChannelKey in _removeChannelKeys:
-            #         _regExp = f'_ch{_removeChannelKey}_'  # like _ch3_
-            #         logger.info(f'  removing columns with _regExp:{_regExp}')
-            #         allSpinesDf = allSpinesDf[allSpinesDf.columns.drop(list(allSpinesDf.filter(regex=_regExp)))]
-            #     # logger.info(f'after drop _ch3_ num columns:{len(allSpinesDf.columns)}')
-
             # when there is 1 spine, points[:] returns
             # <class 'pandas.core.series.Series'> 
             try:

src/pymapmanager/interface/stackWidgets/base/mmWidget2.py

@@ -54,17 +54,15 @@ class pmmEventType(Enum):
     autoConnectSpine = auto()
 
     setSlice = auto()
-    setColorChannel = auto()
 
     setRadius = auto() # abj
+
     updateChannelMetadata = auto()
+    setColorChannel = auto()  # when user chooses channel (1,2,3,rgb,...)
 
     # added to refresh gui after modifying the core with undo and redo
     refreshSpineEvent = auto()
 
-    # undoSpineEvent = auto()
-    # redoSpineEvent = auto()
-
     # abj 
     undoEvent = auto() # for both spines and segments
     redoEvent = auto()
@@ -75,13 +73,14 @@ class pmmEventType(Enum):
     deleteSegment = auto()
     addSegmentPoint = auto()
     deleteSegmentPoint = auto()
-
-    # setPivotPoint = auto() # abj
-    importNewChannel = auto() # abj
     setSegmentPivot = auto() # abj
+    setSegmentColor = auto()
+
     moveBackgroundRoi = auto()
 
-    setSegmentColor = auto()
+    # abb 202508, one event for all channel edits(import, delete, swap, set name, set color LUT)
+    editChannel = auto()
+    importNewChannel = auto() # abj, abb 202508 TODO: depreciate
 
     @property
     def category(self):
@@ -918,7 +917,7 @@ def slot_pmmEvent(self, event : pmmEvent):
 
         elif event.type == pmmEventType.redoEvent:
 
-            logger.info(f"test redo")
+            # logger.info(f"test redo")
             acceptEvent = self.redoEvent(event)
 
         # abb 20240906
@@ -934,7 +933,7 @@ def slot_pmmEvent(self, event : pmmEvent):
             acceptEvent = self.addedEvent(event)
 
         elif event.type == pmmEventType.delete:
-            logger.info(f"test delete")
+            # logger.info(f"test delete")
             acceptEvent = self.deletedEvent(event)
 
         elif event.type == pmmEventType.edit:
@@ -960,9 +959,6 @@ def slot_pmmEvent(self, event : pmmEvent):
         elif event.type == pmmEventType.setSlice:
             acceptEvent = self.setSliceEvent(event)
 
-        elif event.type == pmmEventType.setColorChannel:
-            acceptEvent = self.setColorChannelEvent(event)
-
         # elif event.type == pmmEventType.undoSpineEvent:
         #     acceptEvent = self.undoEvent(event)
         # elif event.type == pmmEventType.redoSpineEvent:
@@ -971,10 +967,18 @@ def slot_pmmEvent(self, event : pmmEvent):
         #abj
         elif event.type == pmmEventType.setRadius:
             acceptEvent = self.setRadiusEvent(event)
+
+        # abb 202508 add ChannelEditEvent()
+        # for import channel, delete channel, swap channel,set name, set color LUT
+        elif event.type == pmmEventType.editChannel:
+            acceptEvent = self.editChannelEvent(event)
+
+        # not used?
         elif event.type == pmmEventType.updateChannelMetadata:
             acceptEvent = self.updateChannelMetadataEvent(event)
+        elif event.type == pmmEventType.setColorChannel:
+            acceptEvent = self.setColorChannelEvent(event)
 
-        # abb 20240716
         # segment events
         elif event.type == pmmEventType.addSegment:
             # stack widget needs to select new segment
@@ -1327,6 +1331,11 @@ def setRadiusEvent(self, event : pmmEvent):
         # logger.warning(f'{self.getClassName()} base class called')
         pass
 
+    # channel event
+    def editChannelEvent(self, event : pmmEvent):
+        pass
+    
+    # TODO: depreciate
     def updateChannelMetadataEvent(self, event: pmmEvent):
         pass
 

src/pymapmanager/interface/stackWidgets/base/stacktoolbar.py

@@ -2,7 +2,7 @@
 
 from qtpy import QtGui, QtCore, QtWidgets
 
-from pymapmanager.interface.stackWidgets.base.mmWidget2 import pmmEvent
+# from pymapmanager.interface.stackWidgets.base.mmWidget2 import pmmEvent
 from pymapmanager.stack import stack
 
 from pymapmanager._logger import logger
@@ -18,44 +18,30 @@ class StackToolBar(QtWidgets.QToolBar):
     signalRadiusChanged = QtCore.Signal(object)  # dict : {checked, upDownSlices}
     signalPlotCheckBoxChanged = QtCore.Signal(object)  # str: plot name being checked/ unchecked
     def __init__(self,
-					myStack,
+					myStack: stack,
 					displayOptionsDict : dict,
+                    channelKey,  # the channel to init with
                     parent=None):
         """
         Parameters:
         myStack : pymapmanager.stack
         """
         super().__init__(parent)
 
-        self._myStack = myStack
+        self._myStack:stack = myStack
         self._displayOptionsDict = displayOptionsDict
 
-        # list of channel strings 1,2,3,...
-        # self._channelList = [str(x+1) for x in range(self._myStack.numChannels+1)]
-        self._channelList = self._myStack.getChannelKeys()
-
-        self._currentChannel = None # abj
-
-        # iconsFolderPath = ''  # TODO: get from canvas.util'
+        self._currentChannel = channelKey
 
         self.setWindowTitle('Stack Toolbar')
 
         self.setFloatable(False)
         self.setMovable(False)
 
-        #self.setOrientation(QtCore.Qt.Vertical);
-        #self.setOrientation(QtCore.Qt.Horizontal);
-
-        #myIconSize = 12 #32
-        #self.setIconSize(QtCore.QSize(myIconSize,myIconSize))
         self.setToolButtonStyle( QtCore.Qt.ToolButtonTextUnderIcon )
 
-        # myFontSize = 10
-        # myFont = self.font();
-        # myFont.setPointSize(myFontSize);
-        # self.setFont(myFont)
-
-        self._buildUI()
+        # set in _setStack
+        # self._buildUI()
 
         # refresh interface
         self._setStack(self._myStack)
@@ -64,6 +50,7 @@ def _setStack(self, theStack: stack):
         """Set the state of the interface based on a stack.
         
         Parameters:
+        -----------
         theStack :pymapmanager.stack
             The stack to dislpay in the widget
         """
@@ -78,10 +65,10 @@ def _setStack(self, theStack: stack):
             actionWidget.setVisible(False)
 
         # for channelIdx in range(self._myStack.numChannels):
-        for channelIdx in self._myStack.getChannelKeys():
+        for channelKey in self._myStack.getChannelKeys():
             # logger.info(f"channelIdx visible {channelIdx} ")
-            self._actionDict[channelIdx].setDisabled(False)
-            self._actionDict[channelIdx].setVisible(True)
+            self._actionDict[channelKey].setDisabled(False)
+            self._actionDict[channelKey].setVisible(True)
 
         if self._myStack.numChannels > 1:
             self._actionDict['rgb'].setDisabled(False)
@@ -100,7 +87,8 @@ def _on_channel_callback(self, toolNameStr : str, checked : bool):
         if toolNameStr == 'rgb':
             pass
         else:
-            toolNameStr = int(toolNameStr)
+            # toolNameStr = int(toolNameStr)  # TODO: don't cast int() here, do it in signal slot
+            pass
 
         self.slot_setChannel(toolNameStr)
 
@@ -145,30 +133,30 @@ def _on_slidingz_value_changed(self, value):
         }
         self.signalSlidingZChanged.emit(d)
 
-    def slot_setChannel(self, channelIdx: int):
+    def slot_setChannel(self, channelKey):
         """Turn on button for selected channel.
         
         These are a disjoint list, only one can be active. Others automatically disable.
         """
-        logger.info(f'channelIdx:{channelIdx} {type(channelIdx)}')
+        logger.info(f'channelIdx:{channelKey} {type(channelKey)}')
 
         # turn off sliding z
         # slidingEnabled = channelIdx != 'rgb'
         # self.slidingCheckbox.setEnabled(slidingEnabled)
         # self.slidingUpDown.setEnabled(slidingEnabled)
 
         # TODO: use stack metadata channels to determine type
-        if channelIdx == 'rgb':
+        if channelKey == 'rgb':
             pass
         else:
-            channelIdx = int(channelIdx)
+            channelKey = int(channelKey)
 
         # logger.info(f'  is now {channelIdx} {type(channelIdx)}')
 
         # activate one action in [1, 2, 3, rgb]
-        self._actionDict[channelIdx].setChecked(True)
+        self._actionDict[channelKey].setChecked(True)
 
-        self.setCurrentChannel(channelIdx) # abj
+        self.setCurrentChannel(channelKey) # abj
 
         # self.signalChannelChange.emit(channelIdx)  # channel can be 'rgb'
 
@@ -177,37 +165,35 @@ def _buildUI(self):
         # used when we update stack after changing channels
         self.clear()
 
+        # abb 202508 this is problematic as we do not know the type of channelKey
         # see: https://stackoverflow.com/questions/45511056/pyqt-how-to-make-a-toolbar-button-appeared-as-pressed
-        _defaultChannel = self._displayOptionsDict['windowState']['defaultChannel']
+        # _defaultChannel = self._displayOptionsDict['windowState']['defaultChannel']
 
         self._actionDict = {}
 
         # make ['1', '2', '3', 'rgb'] disjoint selections
         self.channelActionGroup = QtWidgets.QActionGroup(self)
 
-        if len(self._myStack.getChannelKeys()) > 0:
-            logger.info(f"channel keys {self._myStack.getChannelKeys()}")
-            for channelIdx in self._myStack.getChannelKeys():
-                iconPath = ''  # use toolName to get from canvas.util
-                theIcon = QtGui.QIcon(iconPath)
-
-                # toolNameStr = str(int(channelIdx) + 1)
-                toolNameStr = str(channelIdx)
-
-                theAction = QtWidgets.QAction(theIcon, toolNameStr)
-                theAction.setCheckable(True)
-                if toolNameStr == str(_defaultChannel):
-                    theAction.setChecked(True)
-                    self.setCurrentChannel(_defaultChannel) # abj
-                # do not set shortcut, handled by main stack widget
-                #theAction.setShortcut('1')# or 'Ctrl+r' or '&r' for alt+r
-                theAction.setToolTip(f'View Channel {toolNameStr}')
-                theAction.triggered.connect(partial(self._on_channel_callback, toolNameStr))
-
-                # add action
-                self.addAction(theAction)
-                self.channelActionGroup.addAction(theAction)
-                self._actionDict[channelIdx] = theAction
+        for channelKey in self._myStack.getChannelKeys():
+            iconPath = ''  # use toolName to get from canvas.util
+            theIcon = QtGui.QIcon(iconPath)
+
+            toolNameStr = str(channelKey)  # dangerous but should usually work?
+
+            theAction = QtWidgets.QAction(theIcon, toolNameStr)
+            theAction.setCheckable(True)
+            if toolNameStr == str(self.getCurrentChannel()):
+                theAction.setChecked(True)
+                # self.setCurrentChannel(_defaultChannel) # abj
+            # do not set shortcut, handled by main stack widget
+            #theAction.setShortcut('1')# or 'Ctrl+r' or '&r' for alt+r
+            theAction.setToolTip(f'View Channel {toolNameStr}')
+            theAction.triggered.connect(partial(self._on_channel_callback, toolNameStr))
+
+            # add action
+            self.addAction(theAction)
+            self.channelActionGroup.addAction(theAction)
+            self._actionDict[channelKey] = theAction
 
         #
         toolNameStr = 'rgb'
@@ -351,11 +337,11 @@ def plotMenuChange(self, action):
         plotName = action.text()
         self.signalPlotCheckBoxChanged.emit(plotName)
 
-    def setCurrentChannel(self, channelIdx):
+    def setCurrentChannel(self, channelKey):
         """ set current channel selected
         """
-        logger.info(f"setCurrentChannel {channelIdx} {type(channelIdx)}")
-        self._currentChannel = channelIdx
+        logger.info(f"setCurrentChannel {channelKey} {type(channelKey)}")
+        self._currentChannel = channelKey
 
     def getCurrentChannel(self):
         """ Get current channel selected