Merge pull request #236 from zhujun98/add_meter_bar_to_plot_area

Add meter bar to plot area

Author: zhujun98

extra_foam/gui/image_tool/azimuthal_integ_1d_view.py

@@ -23,7 +23,7 @@ class AzimuthalInteg1dPlot(PlotWidgetF):
     """
     def __init__(self, *, parent=None):
         """Initialization."""
-        super().__init__(parent=parent, show_indicator=True)
+        super().__init__(parent=parent)
 
         x_label, y_label = plot_labels[AnalysisType.AZIMUTHAL_INTEG]
         self.setLabel('bottom', x_label)

extra_foam/gui/image_tool/corrected_view.py

@@ -31,7 +31,7 @@ class RoiProjPlot(PlotWidgetF):
     """
     def __init__(self, *, parent=None):
         """Initialization."""
-        super().__init__(parent=parent, show_indicator=True)
+        super().__init__(parent=parent)
 
         x_label, y_label = plot_labels[AnalysisType.ROI_PROJ]
         self.setLabel('bottom', x_label)

extra_foam/gui/plot_widgets/graphics_widgets.py

@@ -185,7 +185,13 @@ class PlotArea(pg.GraphicsWidget):
     # Emitted when the ViewBox X range has changed
     sigXRangeChanged = pyqtSignal(object, object)
 
-    def __init__(self, name=None, parent=None):
+    cross_toggled_sgn = pyqtSignal(bool)
+
+    _METER_ROW = 0
+    _TITLE_ROW = 1
+
+    def __init__(self, name=None, *,
+                 enable_meter=True, enable_transform=True, parent=None):
         super().__init__(parent=parent)
 
         self.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
@@ -200,9 +206,13 @@ def __init__(self, name=None, parent=None):
 
         self._legend = None
         self._axes = {}
+        self._meter = pg.LabelItem(
+            '', size='11pt', justify='left', color='6A3D9A', parent=self)
         self._title = pg.LabelItem('', size='11pt', parent=self)
 
         # context menu
+        self._show_cross_cb = QCheckBox("Cross cursor")
+
         self._show_x_grid_cb = QCheckBox("Show X Grid")
         self._show_y_grid_cb = QCheckBox("Show Y Grid")
         self._grid_opacity_sld = QSlider(Qt.Horizontal)
@@ -215,7 +225,10 @@ def __init__(self, name=None, parent=None):
         self._log_y_cb = QCheckBox("Log Y")
 
         self._menu = None
-        self._enable_log_menu = True
+        self._enable_transform = enable_transform
+        self._enable_meter = enable_meter
+
+        self._show_meter = False
 
         self._layout = QGraphicsGridLayout()
 
@@ -229,13 +242,11 @@ def initUI(self):
         layout.setHorizontalSpacing(0)
         layout.setVerticalSpacing(0)
 
-        layout.addItem(self._title, 0, 1)
-        layout.addItem(self._vb, 2, 1)
-
-        self._initAxisItems()
-        self.setTitle()
+        layout.addItem(self._meter, self._METER_ROW, 1)
+        layout.addItem(self._title, self._TITLE_ROW, 1)
+        layout.addItem(self._vb, 3, 1)
 
-        for i in range(4):
+        for i in range(5):
             layout.setRowPreferredHeight(i, 0)
             layout.setRowMinimumHeight(i, 0)
             layout.setRowSpacing(i, 0)
@@ -252,13 +263,19 @@ def initUI(self):
 
         self.setLayout(layout)
 
+        self._initAxisItems()
+        self.setTitle()
+        self.showMeter(self._show_meter)
+
         self._initContextMenu()
 
     def initConnections(self):
         self._vb.sigRangeChanged.connect(self.range_changed_sgn)
         self._vb.sigXRangeChanged.connect(self.sigXRangeChanged)
         self._vb.sigYRangeChanged.connect(self.sigYRangeChanged)
 
+        self._show_cross_cb.toggled.connect(self._onShowCrossChanged)
+
         self._show_x_grid_cb.toggled.connect(self._onShowGridChanged)
         self._show_y_grid_cb.toggled.connect(self._onShowGridChanged)
         self._grid_opacity_sld.sliderReleased.connect(self._onShowGridChanged)
@@ -268,11 +285,17 @@ def initConnections(self):
 
     def _initContextMenu(self):
         self._menu = [
+            QMenu("Meter"),
             QMenu("Grid"),
             QMenu("Transform")
         ]
 
-        grid_menu = self._menu[0]
+        meter_menu = self._menu[0]
+        cross_act = QWidgetAction(meter_menu)
+        cross_act.setDefaultWidget(self._show_cross_cb)
+        meter_menu.addAction(cross_act)
+
+        grid_menu = self._menu[1]
         show_x_act = QWidgetAction(grid_menu)
         show_x_act.setDefaultWidget(self._show_x_grid_cb)
         grid_menu.addAction(show_x_act)
@@ -288,7 +311,7 @@ def _initContextMenu(self):
         opacity_act.setDefaultWidget(widget)
         grid_menu.addAction(opacity_act)
 
-        transform_menu = self._menu[1]
+        transform_menu = self._menu[2]
         log_x_act = QWidgetAction(transform_menu)
         log_x_act.setDefaultWidget(self._log_x_cb)
         transform_menu.addAction(log_x_act)
@@ -297,10 +320,10 @@ def _initContextMenu(self):
         transform_menu.addAction(log_y_act)
 
     def _initAxisItems(self):
-        for orient, pos in (('top', (1, 1)),
-                            ('bottom', (3, 1)),
-                            ('left', (2, 0)),
-                            ('right', (2, 2))):
+        for orient, pos in (('top', (2, 1)),
+                            ('bottom', (4, 1)),
+                            ('left', (3, 0)),
+                            ('right', (3, 2))):
             axis = pg.AxisItem(orientation=orient, parent=self)
 
             axis.linkToView(self._vb)
@@ -320,6 +343,11 @@ def clearAllPlotItems(self):
             # TODO: introduce a method which set empty data
             item.setData([], [])
 
+    @pyqtSlot(bool)
+    def _onShowCrossChanged(self, state):
+        self.showMeter(state)
+        self.cross_toggled_sgn.emit(state)
+
     @pyqtSlot()
     def _onShowGridChanged(self):
         alpha = self._grid_opacity_sld.value()
@@ -385,12 +413,13 @@ def removeAllItems(self):
 
     def getContextMenus(self, event):
         """Override."""
-        if self._enable_log_menu:
-            return self._menu
-        return self._menu[:-1]
-
-    def enableLogMenu(self, enable):
-        self._enable_log_menu = enable
+        start = 0
+        end = len(self._menu)
+        if not self._enable_transform:
+            end -= 1
+        if not self._enable_meter:
+            start += 1
+        return self._menu[start:end]
 
     def getAxis(self, axis):
         """Return the specified AxisItem.
@@ -449,18 +478,47 @@ def showLabel(self, axis, show=True):
         """
         self.getAxis(axis).showLabel(show)
 
+    def showMeter(self, show=True):
+        """Show or hide the meter bar.
+
+        :param bool show: whether to show the meter bar.
+        """
+        row = self._METER_ROW
+        if not show:
+            self._meter.setMaximumHeight(0)
+            self._layout.setRowFixedHeight(row, 0)
+            self._meter.setVisible(False)
+        else:
+            self._meter.setMaximumHeight(30)
+            self._layout.setRowFixedHeight(row, 30)
+            self._meter.setVisible(True)
+
+        self._show_meter = show
+
+    def setMeter(self, pos):
+        """Set the meter of the plot."""
+        if not self._show_meter:
+            return
+
+        if pos is None:
+            self._meter.setText("")
+        else:
+            x, y = pos
+            self._meter.setText(f"x = {x}, y = {y}")
+
     def setTitle(self, title=None, **args):
         """Set the title of the plot.
 
         :param str title: text to display along the axis. HTML allowed.
         """
+        row = self._TITLE_ROW
         if title is None:
             self._title.setMaximumHeight(0)
-            self._layout.setRowFixedHeight(0, 0)
+            self._layout.setRowFixedHeight(row, 0)
             self._title.setVisible(False)
         else:
             self._title.setMaximumHeight(30)
-            self._layout.setRowFixedHeight(0, 30)
+            self._layout.setRowFixedHeight(row, 30)
             self._title.setText(title, **args)
             self._title.setVisible(True)
 
@@ -472,3 +530,6 @@ def invertY(self, *args, **kwargs):
 
     def invertX(self, *args, **kwargs):
         self._vb.invertX(*args, **kwargs)
+
+    def mapSceneToView(self, *args, **kwargs):
+        return self._vb.mapSceneToView(*args, **kwargs)

extra_foam/gui/plot_widgets/image_view_base.py

@@ -81,8 +81,8 @@ def __init__(self, *,
         if has_roi:
             self._initializeROIs(roi_position, roi_size)
 
-        self._plot_widget = PlotWidgetF()
-        self._plot_widget.disableLogMenu()
+        self._plot_widget = PlotWidgetF(enable_meter=False,
+                                        enable_transform=False)
 
         self._cached_title = None
         # use the public interface for caching

extra_foam/gui/plot_widgets/plot_widget_base.py

@@ -11,7 +11,7 @@
 
 import numpy as np
 
-from PyQt5.QtCore import pyqtSignal, QTimer
+from PyQt5.QtCore import pyqtSignal, pyqtSlot, QTimer
 from PyQt5.QtWidgets import QSizePolicy
 
 from .. import pyqtgraph as pg
@@ -40,7 +40,9 @@ class PlotWidgetF(pg.GraphicsView):
     sigTransformChanged = pyqtSignal(object)
 
     def __init__(self, parent=None, *,
-                 background='default', show_indicator=False, **kargs):
+                 background='default',
+                 enable_meter=True,
+                 enable_transform=True):
         """Initialization."""
         super().__init__(parent, background=background)
 
@@ -49,23 +51,20 @@ def __init__(self, parent=None, *,
 
         self._title = ""
 
-        self._plot_area = PlotArea(**kargs)
+        self._plot_area = PlotArea(enable_meter=enable_meter,
+                                   enable_transform=enable_transform)
         self.setCentralWidget(self._plot_area)
+        self._plot_area.cross_toggled_sgn.connect(self.onCrossToggled)
 
-        # TODO: improve indicator implementation
-        # Move Indicator to PlotArea
-        self._show_indicator = show_indicator
-        if show_indicator:
+        self._v_line = None
+        self._h_line = None
+        if enable_meter:
             self._v_line = pg.InfiniteLine(angle=90, movable=False)
             self._h_line = pg.InfiniteLine(angle=0, movable=False)
-            self._indicator = pg.TextItem(color=FColor.k)
             self._v_line.hide()
             self._h_line.hide()
-            self._indicator.hide()
             self._plot_area.addItem(self._v_line, ignore_bounds=True)
             self._plot_area.addItem(self._h_line, ignore_bounds=True)
-            self._plot_area.scene().addItem(self._indicator)
-
             # rateLimit should be fast enough to be able to capture
             # the leaveEvent
             self._proxy = pg.SignalProxy(self._plot_area.scene().sigMouseMoved,
@@ -218,39 +217,24 @@ def showLegend(self):
         """Show legend."""
         self._plot_area.showLegend(True)
 
-    def disableLogMenu(self):
-        """Disable log X/Y context menu."""
-        self._plot_area.enableLogMenu(False)
-
     def viewRangeChanged(self, view, range):
         self.sigRangeChanged.emit(self, range)
 
-    def onMouseMoved(self, ev):
-        pos = ev[0]
-        y_shift = 45  # move text to the top of the mouse cursor
-        self._indicator.setPos(pos.x(), pos.y() - y_shift)
-
-        # TODO: improve
-        m_pos = self._plot_area._vb.mapSceneToView(pos)
-        x, y = m_pos.x(), m_pos.y()
-        self._v_line.setPos(x)
-        self._h_line.setPos(y)
-
-        self._indicator.setText(f"x={x}\ny={y}")
-
-    def enterEvent(self, ev):
-        """Override."""
-        if self._show_indicator:
+    @pyqtSlot(bool)
+    def onCrossToggled(self, state):
+        if state:
             self._v_line.show()
             self._h_line.show()
-            self._indicator.show()
-
-    def leaveEvent(self, ev):
-        """Override."""
-        if self._show_indicator:
+        else:
             self._v_line.hide()
             self._h_line.hide()
-            self._indicator.hide()
+
+    def onMouseMoved(self, pos):
+        m_pos = self._plot_area.mapSceneToView(pos[0])
+        x, y = m_pos.x(), m_pos.y()
+        self._v_line.setPos(x)
+        self._h_line.setPos(y)
+        self._plot_area.setMeter((x, y))
 
     def closeEvent(self, event):
         """Override."""