diff --git a/bec_widgets/cli/client.py b/bec_widgets/cli/client.py index 24ce5cb6..475ff5cb 100644 --- a/bec_widgets/cli/client.py +++ b/bec_widgets/cli/client.py @@ -1564,6 +1564,48 @@ class Heatmap(RPCBase): Enable the full colorbar. """ + @property + @rpc_call + def interpolation_method(self) -> "str": + """ + The interpolation method used for the heatmap. + """ + + @interpolation_method.setter + @rpc_call + def interpolation_method(self) -> "str": + """ + The interpolation method used for the heatmap. + """ + + @property + @rpc_call + def oversampling_factor(self) -> "float": + """ + The oversampling factor for grid resolution. + """ + + @oversampling_factor.setter + @rpc_call + def oversampling_factor(self) -> "float": + """ + The oversampling factor for grid resolution. + """ + + @property + @rpc_call + def enforce_interpolation(self) -> "bool": + """ + Whether to enforce interpolation even for grid scans. + """ + + @enforce_interpolation.setter + @rpc_call + def enforce_interpolation(self) -> "bool": + """ + Whether to enforce interpolation even for grid scans. + """ + @property @rpc_call def fft(self) -> "bool": @@ -1649,12 +1691,32 @@ class Heatmap(RPCBase): y_entry: "None | str" = None, z_entry: "None | str" = None, color_map: "str | None" = "plasma", - label: "str | None" = None, validate_bec: "bool" = True, + interpolation: "Literal['linear', 'nearest'] | None" = None, + enforce_interpolation: "bool | None" = None, + oversampling_factor: "float | None" = None, + lock_aspect_ratio: "bool | None" = None, + show_config_label: "bool | None" = None, reload: "bool" = False, ): """ Plot the heatmap with the given x, y, and z data. + + Args: + x_name (str): The name of the x-axis signal. + y_name (str): The name of the y-axis signal. + z_name (str): The name of the z-axis signal. + x_entry (str | None): The entry for the x-axis signal. + y_entry (str | None): The entry for the y-axis signal. + z_entry (str | None): The entry for the z-axis signal. + color_map (str | None): The color map to use for the heatmap. + validate_bec (bool): Whether to validate the entries against BEC signals. + interpolation (Literal["linear", "nearest"] | None): The interpolation method to use. + enforce_interpolation (bool | None): Whether to enforce interpolation even for grid scans. + oversampling_factor (float | None): Factor to oversample the grid resolution. + lock_aspect_ratio (bool | None): Whether to lock the aspect ratio of the image. + show_config_label (bool | None): Whether to show the configuration label in the heatmap. + reload (bool): Whether to reload the heatmap with new data. """ diff --git a/bec_widgets/widgets/plots/heatmap/heatmap.py b/bec_widgets/widgets/plots/heatmap/heatmap.py index 0e9fed45..df8fa8cc 100644 --- a/bec_widgets/widgets/plots/heatmap/heatmap.py +++ b/bec_widgets/widgets/plots/heatmap/heatmap.py @@ -1,6 +1,5 @@ from __future__ import annotations -import functools import json from typing import Literal @@ -11,7 +10,11 @@ from bec_lib.endpoints import MessageEndpoints from pydantic import BaseModel, Field, field_validator from qtpy.QtCore import QTimer, Signal from qtpy.QtGui import QTransform -from scipy.interpolate import LinearNDInterpolator +from scipy.interpolate import ( + CloughTocher2DInterpolator, + LinearNDInterpolator, + NearestNDInterpolator, +) from scipy.spatial import cKDTree from toolz import partition @@ -44,6 +47,19 @@ class HeatmapConfig(ConnectionConfig): color_bar: Literal["full", "simple"] | None = Field( None, description="The type of the color bar." ) + interpolation: Literal["linear", "nearest", "clough"] = Field( + "linear", description="The interpolation method for the heatmap." + ) + oversampling_factor: float = Field( + 1.0, + description="Factor to oversample the grid resolution (1.0 = no oversampling, 2.0 = 2x resolution).", + ) + show_config_label: bool = Field( + True, description="Whether to show the configuration label in the heatmap." + ) + enforce_interpolation: bool = Field( + False, description="Whether to use the interpolation mode even for grid scans." + ) lock_aspect_ratio: bool = Field( False, description="Whether to lock the aspect ratio of the image." ) @@ -119,6 +135,12 @@ class Heatmap(ImageBase): "enable_simple_colorbar.setter", "enable_full_colorbar", "enable_full_colorbar.setter", + "interpolation_method", + "interpolation_method.setter", + "oversampling_factor", + "oversampling_factor.setter", + "enforce_interpolation", + "enforce_interpolation.setter", "fft", "fft.setter", "log", @@ -141,8 +163,19 @@ class Heatmap(ImageBase): def __init__(self, parent=None, config: HeatmapConfig | None = None, **kwargs): if config is None: - config = HeatmapConfig(widget_class=self.__class__.__name__) - super().__init__(parent=parent, config=config, **kwargs) + config = HeatmapConfig( + widget_class=self.__class__.__name__, + parent_id=None, + color_map="plasma", + color_bar=None, + interpolation="linear", + oversampling_factor=1.0, + lock_aspect_ratio=False, + x_device=None, + y_device=None, + z_device=None, + ) + super().__init__(parent=parent, config=config, theme_update=True, **kwargs) self._image_config = config self.scan_id = None self.old_scan_id = None @@ -150,9 +183,16 @@ class Heatmap(ImageBase): self.status_message = None self._grid_index = None self.heatmap_dialog = None + bg_color = pg.mkColor((240, 240, 240, 150)) + self.config_label = pg.LegendItem( + labelTextColor=(0, 0, 0), offset=(-30, 1), brush=pg.mkBrush(bg_color), horSpacing=0 + ) + self.config_label.setParentItem(self.plot_item.vb) + self.config_label.setVisible(False) self.reload = False self.bec_dispatcher.connect_slot(self.on_scan_status, MessageEndpoints.scan_status()) self.bec_dispatcher.connect_slot(self.on_scan_progress, MessageEndpoints.scan_progress()) + self.heatmap_property_changed.connect(lambda: self.sync_signal_update.emit()) self.proxy_update_sync = pg.SignalProxy( self.sync_signal_update, rateLimit=5, slot=self.update_plot @@ -168,6 +208,7 @@ class Heatmap(ImageBase): "image_colorbar", "image_processing", "axis_popup", + "interpolation_info", ] ) @@ -180,6 +221,23 @@ class Heatmap(ImageBase): # Widget Specific GUI interactions ################################################################################ + @SafeSlot(str) + def apply_theme(self, theme: str): + """ + Apply the current theme to the heatmap widget. + """ + super().apply_theme(theme) + if theme == "dark": + brush = pg.mkBrush(pg.mkColor(50, 50, 50, 150)) + color = pg.mkColor(255, 255, 255) + else: + brush = pg.mkBrush(pg.mkColor(240, 240, 240, 150)) + color = pg.mkColor(0, 0, 0) + if hasattr(self, "config_label"): + self.config_label.setBrush(brush) + self.config_label.setLabelTextColor(color) + self.redraw_config_label() + @SafeSlot(popup_error=True) def plot( self, @@ -190,12 +248,32 @@ class Heatmap(ImageBase): y_entry: None | str = None, z_entry: None | str = None, color_map: str | None = "plasma", - label: str | None = None, validate_bec: bool = True, + interpolation: Literal["linear", "nearest"] | None = None, + enforce_interpolation: bool | None = None, + oversampling_factor: float | None = None, + lock_aspect_ratio: bool | None = None, + show_config_label: bool | None = None, reload: bool = False, ): """ Plot the heatmap with the given x, y, and z data. + + Args: + x_name (str): The name of the x-axis signal. + y_name (str): The name of the y-axis signal. + z_name (str): The name of the z-axis signal. + x_entry (str | None): The entry for the x-axis signal. + y_entry (str | None): The entry for the y-axis signal. + z_entry (str | None): The entry for the z-axis signal. + color_map (str | None): The color map to use for the heatmap. + validate_bec (bool): Whether to validate the entries against BEC signals. + interpolation (Literal["linear", "nearest"] | None): The interpolation method to use. + enforce_interpolation (bool | None): Whether to enforce interpolation even for grid scans. + oversampling_factor (float | None): Factor to oversample the grid resolution. + lock_aspect_ratio (bool | None): Whether to lock the aspect ratio of the image. + show_config_label (bool | None): Whether to show the configuration label in the heatmap. + reload (bool): Whether to reload the heatmap with new data. """ if validate_bec: x_entry = self.entry_validator.validate_signal(x_name, x_entry) @@ -207,12 +285,33 @@ class Heatmap(ImageBase): if x_name is None or y_name is None or z_name is None: raise ValueError("x, y, and z names must be provided.") + if interpolation is None: + interpolation = self._image_config.interpolation + + if oversampling_factor is None: + oversampling_factor = self._image_config.oversampling_factor + + if enforce_interpolation is None: + enforce_interpolation = self._image_config.enforce_interpolation + + if lock_aspect_ratio is None: + lock_aspect_ratio = self._image_config.lock_aspect_ratio + + if show_config_label is None: + show_config_label = self._image_config.show_config_label + self._image_config = HeatmapConfig( parent_id=self.gui_id, x_device=HeatmapDeviceSignal(name=x_name, entry=x_entry), y_device=HeatmapDeviceSignal(name=y_name, entry=y_entry), z_device=HeatmapDeviceSignal(name=z_name, entry=z_entry), color_map=color_map, + color_bar=None, + interpolation=interpolation, + oversampling_factor=oversampling_factor, + enforce_interpolation=enforce_interpolation, + lock_aspect_ratio=lock_aspect_ratio, + show_config_label=show_config_label, ) self.color_map = color_map self.reload = reload @@ -230,7 +329,6 @@ class Heatmap(ImageBase): self.scan_item = self.client.history[-1] self.scan_id = self.client.history._scan_ids[-1] self.old_scan_id = None - self.update_plot() def update_labels(self): """ @@ -279,6 +377,19 @@ class Heatmap(ImageBase): if name not in ["image_processing_fft", "image_processing_log"]: action().action.setVisible(False) + self.toolbar.add_action( + "interpolation_info", + MaterialIconAction( + icon_name="info", tooltip="Show Interpolation Info", checkable=True, parent=self + ), + ) + self.toolbar.components.get_action("interpolation_info").action.triggered.connect( + self.toggle_interpolation_info + ) + self.toolbar.components.get_action("interpolation_info").action.setChecked( + self._image_config.show_config_label + ) + def show_heatmap_settings(self): """ Show the heatmap settings dialog. @@ -289,7 +400,7 @@ class Heatmap(ImageBase): self.heatmap_dialog = SettingsDialog( self, settings_widget=heatmap_settings, window_title="Heatmap Settings", modal=False ) - self.heatmap_dialog.resize(620, 200) + self.heatmap_dialog.resize(700, 350) # When the dialog is closed, update the toolbar icon and clear the reference self.heatmap_dialog.finished.connect(self._heatmap_dialog_closed) self.heatmap_dialog.show() @@ -300,6 +411,16 @@ class Heatmap(ImageBase): self.heatmap_dialog.activateWindow() heatmap_settings_action.setChecked(True) # keep it toggled + def toggle_interpolation_info(self): + """ + Toggle the visibility of the interpolation info label. + """ + self._image_config.show_config_label = not self._image_config.show_config_label + self.toolbar.components.get_action("interpolation_info").action.setChecked( + self._image_config.show_config_label + ) + self.redraw_config_label() + def _heatmap_dialog_closed(self): """ Slot for when the heatmap settings dialog is closed. @@ -397,6 +518,7 @@ class Heatmap(ImageBase): scan_id = metadata["scan_id"] scan_name = metadata["scan_name"] scan_type = metadata["scan_type"] + scan_number = metadata["scan_number"] request_inputs = metadata["request_inputs"] if "arg_bundle" in request_inputs and isinstance(request_inputs["arg_bundle"], str): # Convert the arg_bundle from a JSON string to a dictionary @@ -408,6 +530,7 @@ class Heatmap(ImageBase): status=status, scan_id=scan_id, scan_name=scan_name, + scan_number=scan_number, scan_type=scan_type, request_inputs=request_inputs, info={"positions": positions}, @@ -420,6 +543,9 @@ class Heatmap(ImageBase): return self.status_message = scan_msg + if self._image_config.show_config_label: + self.redraw_config_label() + img, transform = self.get_image_data(x_data=x_data, y_data=y_data, z_data=z_data) if img is None: logger.warning("Image data is None; skipping update.") @@ -434,6 +560,25 @@ class Heatmap(ImageBase): if self.crosshair is not None: self.crosshair.update_markers_on_image_change() + def redraw_config_label(self): + scan_msg = self.status_message + if scan_msg is None: + return + if not self._image_config.show_config_label: + self.config_label.setVisible(False) + return + self.config_label.setVisible(True) + self.config_label.clear() + self.config_label.addItem(self.plot_item, f"Scan: {scan_msg.scan_number}") + self.config_label.addItem(self.plot_item, f"Scan Name: {scan_msg.scan_name}") + if scan_msg.scan_name != "grid_scan" or self._image_config.enforce_interpolation: + self.config_label.addItem( + self.plot_item, f"Interpolation: {self._image_config.interpolation}" + ) + self.config_label.addItem( + self.plot_item, f"Oversampling: {self._image_config.oversampling_factor}x" + ) + def get_image_data( self, x_data: list[float] | None = None, @@ -458,7 +603,7 @@ class Heatmap(ImageBase): logger.warning("x, y, or z data is None; skipping update.") return None, None - if msg.scan_name == "grid_scan": + if msg.scan_name == "grid_scan" and not self._image_config.enforce_interpolation: # We only support the grid scan mode if both scanning motors # are configured in the heatmap config. device_x = self._image_config.x_device.entry @@ -571,7 +716,16 @@ class Heatmap(ImageBase): grid_x, grid_y, transform = self.get_image_grid(xy_data) # Interpolate the z data onto the grid - interp = LinearNDInterpolator(xy_data, z_data) + if self._image_config.interpolation == "linear": + interp = LinearNDInterpolator(xy_data, z_data) + elif self._image_config.interpolation == "nearest": + interp = NearestNDInterpolator(xy_data, z_data) + elif self._image_config.interpolation == "clough": + interp = CloughTocher2DInterpolator(xy_data, z_data) + else: + raise ValueError( + "Interpolation method must be either 'linear', 'nearest', or 'clough'." + ) grid_z = interp(grid_x, grid_y) return grid_z, transform @@ -587,20 +741,24 @@ class Heatmap(ImageBase): Returns: tuple[np.ndarray, np.ndarray, QTransform]: The grid x and y coordinates and the QTransform. """ + base_width, base_height = self.estimate_image_resolution(positions) - width, height = self.estimate_image_resolution(positions) + # Apply oversampling factor + factor = self._image_config.oversampling_factor - # Create a grid of points for interpolation + # Apply oversampling + width = int(base_width * factor) + height = int(base_height * factor) + + # Create grid grid_x, grid_y = np.mgrid[ min(positions[:, 0]) : max(positions[:, 0]) : width * 1j, min(positions[:, 1]) : max(positions[:, 1]) : height * 1j, ] - # Calculate the QTransform to put (0,0) at the axis origin - x_min = min(positions[:, 0]) - y_min = min(positions[:, 1]) - x_max = max(positions[:, 0]) - y_max = max(positions[:, 1]) + # Calculate transform + x_min, x_max = min(positions[:, 0]), max(positions[:, 0]) + y_min, y_max = min(positions[:, 1]), max(positions[:, 1]) x_range = x_max - x_min y_range = y_max - y_min x_scale = x_range / width @@ -670,7 +828,7 @@ class Heatmap(ImageBase): # Optionally fetch the latest from history if nothing is set # self.update_with_scan_history(-1) if self.scan_item is None: - logger.info("No scan executed so far; skipping device curves categorisation.") + logger.info("No scan executed so far; skipping update.") return "none", "none" if hasattr(self.scan_item, "live_data"): @@ -688,6 +846,62 @@ class Heatmap(ImageBase): self.crosshair.reset() super().reset() + @SafeProperty(str) + def interpolation_method(self) -> str: + """ + The interpolation method used for the heatmap. + """ + return self._image_config.interpolation + + @interpolation_method.setter + def interpolation_method(self, value: str): + """ + Set the interpolation method for the heatmap. + Args: + value(str): The interpolation method, either 'linear' or 'nearest'. + """ + if value not in ["linear", "nearest"]: + raise ValueError("Interpolation method must be either 'linear' or 'nearest'.") + self._image_config.interpolation = value + self.heatmap_property_changed.emit() + + @SafeProperty(float) + def oversampling_factor(self) -> float: + """ + The oversampling factor for grid resolution. + """ + return self._image_config.oversampling_factor + + @oversampling_factor.setter + def oversampling_factor(self, value: float): + """ + Set the oversampling factor for grid resolution. + Args: + value(float): The oversampling factor (1.0 = no oversampling, 2.0 = 2x resolution). + """ + if value <= 0: + raise ValueError("Oversampling factor must be greater than 0.") + self._image_config.oversampling_factor = value + self.heatmap_property_changed.emit() + + @SafeProperty(bool) + def enforce_interpolation(self) -> bool: + """ + Whether to enforce interpolation even for grid scans. + """ + return self._image_config.enforce_interpolation + + @enforce_interpolation.setter + def enforce_interpolation(self, value: bool): + """ + Set whether to enforce interpolation even for grid scans. + + Args: + value(bool): Whether to enforce interpolation. + """ + self._image_config.enforce_interpolation = value + self.heatmap_property_changed.emit() + ################################################################################ # Post Processing ################################################################################ @@ -768,6 +982,6 @@ if __name__ == "__main__": # pragma: no cover app = QApplication(sys.argv) heatmap = Heatmap() - heatmap.plot(x_name="samx", y_name="samy", z_name="bpm4i") + heatmap.plot(x_name="samx", y_name="samy", z_name="bpm4i", oversampling_factor=5.0) heatmap.show() sys.exit(app.exec_()) diff --git a/bec_widgets/widgets/plots/heatmap/heatmap_plugin.py b/bec_widgets/widgets/plots/heatmap/heatmap_plugin.py index 67b5e4b6..220ec809 100644 --- a/bec_widgets/widgets/plots/heatmap/heatmap_plugin.py +++ b/bec_widgets/widgets/plots/heatmap/heatmap_plugin.py @@ -27,7 +27,7 @@ class HeatmapPlugin(QDesignerCustomWidgetInterface): # pragma: no cover return DOM_XML def group(self): - return "" + return "Plot Widgets" def icon(self): return designer_material_icon(Heatmap.ICON_NAME) diff --git a/bec_widgets/widgets/plots/heatmap/settings/heatmap_setting.py b/bec_widgets/widgets/plots/heatmap/settings/heatmap_setting.py index 974d9f71..84dfa610 100644 --- a/bec_widgets/widgets/plots/heatmap/settings/heatmap_setting.py +++ b/bec_widgets/widgets/plots/heatmap/settings/heatmap_setting.py @@ -1,4 +1,7 @@ +from __future__ import annotations + import os +from typing import TYPE_CHECKING from qtpy.QtWidgets import QFrame, QScrollArea, QVBoxLayout @@ -6,6 +9,11 @@ from bec_widgets.utils import UILoader from bec_widgets.utils.error_popups import SafeSlot from bec_widgets.utils.settings_dialog import SettingWidget +if TYPE_CHECKING: + from bec_widgets.widgets.control.device_input.signal_combobox.signal_combobox import ( + SignalComboBox, + ) + class HeatmapSettings(SettingWidget): def __init__(self, parent=None, target_widget=None, popup=False, *args, **kwargs): @@ -46,6 +54,8 @@ class HeatmapSettings(SettingWidget): if popup is False: self.ui.button_apply.clicked.connect(self.accept_changes) + self.ui.x_name.setFocus() + @SafeSlot() def fetch_all_properties(self): """ @@ -85,31 +95,66 @@ class HeatmapSettings(SettingWidget): if hasattr(self.ui, "x_name"): self.ui.x_name.set_device(x_name) if hasattr(self.ui, "x_entry") and x_entry is not None: - self.ui.x_entry.setText(x_entry) + self.ui.x_entry.set_to_obj_name(x_entry) if hasattr(self.ui, "y_name"): self.ui.y_name.set_device(y_name) if hasattr(self.ui, "y_entry") and y_entry is not None: - self.ui.y_entry.setText(y_entry) + self.ui.y_entry.set_to_obj_name(y_entry) if hasattr(self.ui, "z_name"): self.ui.z_name.set_device(z_name) if hasattr(self.ui, "z_entry") and z_entry is not None: - self.ui.z_entry.setText(z_entry) + self.ui.z_entry.set_to_obj_name(z_entry) + + if hasattr(self.ui, "interpolation"): + self.ui.interpolation.setCurrentText( + getattr(self.target_widget._image_config, "interpolation", "linear") + ) + if hasattr(self.ui, "oversampling_factor"): + self.ui.oversampling_factor.setValue( + getattr(self.target_widget._image_config, "oversampling_factor", 1.0) + ) + if hasattr(self.ui, "enforce_interpolation"): + self.ui.enforce_interpolation.setChecked( + getattr(self.target_widget._image_config, "enforce_interpolation", False) + ) + + def _get_signal_name(self, signal: SignalComboBox) -> str: + """ + Get the signal name from the signal combobox. + Args: + signal (SignalComboBox): The signal combobox to get the name from. + Returns: + str: The signal name. + """ + device_entry = signal.currentText() + index = signal.findText(device_entry) + if index == -1: + return device_entry + + device_entry_info = signal.itemData(index) + if device_entry_info: + device_entry = device_entry_info.get("obj_name", device_entry) + + return device_entry if device_entry else "" @SafeSlot() def accept_changes(self): """ Apply all properties from the settings widget to the target widget. """ - x_name = self.ui.x_name.text() - x_entry = self.ui.x_entry.text() - y_name = self.ui.y_name.text() - y_entry = self.ui.y_entry.text() - z_name = self.ui.z_name.text() - z_entry = self.ui.z_entry.text() + x_name = self.ui.x_name.currentText() + x_entry = self._get_signal_name(self.ui.x_entry) + y_name = self.ui.y_name.currentText() + y_entry = self._get_signal_name(self.ui.y_entry) + z_name = self.ui.z_name.currentText() + z_entry = self._get_signal_name(self.ui.z_entry) validate_bec = self.ui.validate_bec.checked color_map = self.ui.color_map.colormap + interpolation = self.ui.interpolation.currentText() + oversampling_factor = self.ui.oversampling_factor.value() + enforce_interpolation = self.ui.enforce_interpolation.isChecked() self.target_widget.plot( x_name=x_name, @@ -120,6 +165,9 @@ class HeatmapSettings(SettingWidget): z_entry=z_entry, color_map=color_map, validate_bec=validate_bec, + interpolation=interpolation, + oversampling_factor=oversampling_factor, + enforce_interpolation=enforce_interpolation, reload=True, ) @@ -136,3 +184,5 @@ class HeatmapSettings(SettingWidget): self.ui.z_name.deleteLater() self.ui.z_entry.close() self.ui.z_entry.deleteLater() + self.ui.interpolation.close() + self.ui.interpolation.deleteLater() diff --git a/bec_widgets/widgets/plots/heatmap/settings/heatmap_settings_horizontal.ui b/bec_widgets/widgets/plots/heatmap/settings/heatmap_settings_horizontal.ui index a61d2024..7fe057de 100644 --- a/bec_widgets/widgets/plots/heatmap/settings/heatmap_settings_horizontal.ui +++ b/bec_widgets/widgets/plots/heatmap/settings/heatmap_settings_horizontal.ui @@ -6,8 +6,8 @@ 0 0 - 604 - 166 + 826 + 300 @@ -17,20 +17,162 @@ - - - Validate BEC + + + Interpolation + + + + + Use the interpolation mode even for grid scans + + + false + + + + + + + Use the interpolation mode even for grid scans + + + Enforce Interpolation + + + + + + + 1 + + + 1.000000000000000 + + + 10.000000000000000 + + + + + + + + 100 + 26 + + + + + linear + + + + + nearest + + + + + clough + + + + + + + + Oversampling + + + + + + + + 16777215 + 50 + + + + Interpolation Method + + + + - + + + Qt::Orientation::Horizontal + + + + 40 + 16 + + + - - + + + + General + + + + + + + 16777215 + 50 + + + + Validate BEC + + + + + + + + + + + 0 + 0 + + + + + 16777215 + 50 + + + + + + + + Colormap + + + + + + + + + Qt::Orientation::Horizontal + + + @@ -46,9 +188,6 @@ - - - @@ -56,8 +195,22 @@ + + + + true + + + true + + + - + + + true + + @@ -75,9 +228,6 @@ - - - @@ -85,8 +235,22 @@ + + + + true + + + true + + + - + + + true + + @@ -111,11 +275,22 @@ - - - - + + + true + + + true + + + + + + + true + + @@ -126,9 +301,14 @@ - DeviceLineEdit - QLineEdit -
device_line_edit
+ DeviceComboBox + QComboBox +
device_combobox
+ + + SignalComboBox + QComboBox +
signal_combo_box
 ToggleSwitch @@ -143,59 +323,109 @@ x_name - x_entry y_name - y_entry z_name + x_entry + y_entry z_entry + interpolation + oversampling_factor x_name - textChanged(QString) + device_reset() x_entry - clear() + reset_selection() - 134 - 95 + 254 + 226 - 138 - 128 + 254 + 267 + + + + + x_name + currentTextChanged(QString) + x_entry + set_device(QString) + + + 254 + 226 + + + 254 + 267 y_name - textChanged(QString) + device_reset() y_entry - clear() + reset_selection() - 351 - 91 + 526 + 226 - 349 - 121 + 526 + 267 + + + + + y_name + currentTextChanged(QString) + y_entry + set_device(QString) + + + 526 + 226 + + + 526 + 267 z_name - textChanged(QString) + device_reset() z_entry - clear() + reset_selection() - 520 - 98 + 798 + 226 - 522 - 127 + 798 + 267 + + + + + z_name + currentTextChanged(QString) + z_entry + set_device(QString) + + + 798 + 226 + + + 798 + 267 diff --git a/bec_widgets/widgets/plots/heatmap/settings/heatmap_settings_vertical.ui b/bec_widgets/widgets/plots/heatmap/settings/heatmap_settings_vertical.ui index 3529de4a..2835306b 100644 --- a/bec_widgets/widgets/plots/heatmap/settings/heatmap_settings_vertical.ui +++ b/bec_widgets/widgets/plots/heatmap/settings/heatmap_settings_vertical.ui @@ -1,204 +1,374 @@ - Form - - - - 0 - 0 - 233 - 427 - - - - - 16777215 - 427 - - - - Form - - - - - - Apply - - - - - - - - - - - - Validate BEC - - - - - - - - - - - - X Device - - - - - - Name - - - - - - - - - - Signal - - - - - - - - - - - - - Y Device - - - - - - Name - - - - - - - - - - Signal - - - - - - - - - - - - - Z Device - - - - - - Name - - - - - - - - - - Signal - - - - - - - - - - + Form + + + + 0 + 0 + 305 + 629 + + + + + 16777215 + 629 + + + + Form + + + + + + Apply + - - - DeviceLineEdit - QLineEdit -
device_line_edit
- - - ToggleSwitch - QWidget -
toggle_switch
- - - BECColorMapWidget - QWidget -
bec_color_map_widget
- - - - - - x_name - textChanged(QString) - x_entry - clear() - - - 156 - 123 - - - 158 - 157 - - - - - y_name - textChanged(QString) - y_entry - clear() - - - 116 - 229 - - - 116 - 251 - - - - - z_name - textChanged(QString) - z_entry - clear() - - - 110 - 326 - - - 110 - 352 - - - - + + + + + + + + + + Validate BEC + + + + + + + true + + + + + + + + + X Device + + + + + + Name + + + + + + + Signal + + + + + + + true + + + true + + + + + + + true + + + + + + + + + + Y Device + + + + + + Name + + + + + + + Signal + + + + + + + true + + + true + + + + + + + true + + + + + + + + + + Z Device + + + + + + Name + + + + + + + true + + + true + + + + + + + true + + + + + + + Signal + + + + + + + + + + Qt::Orientation::Horizontal + + + + + + + Interpolation + + + + + + Interpolation Method + + + + + + + + linear + + + + + nearest + + + + + + + + Enforce Interpolation + + + + + + + true + + + false + + + + + + + Oversampling + + + + + + + 1.000000000000000 + + + 10.000000000000000 + + + + + + + + + + + DeviceComboBox + QComboBox +
device_combobox
+ + + SignalComboBox + QComboBox +
signal_combo_box
+ + + ToggleSwitch + QWidget +
toggle_switch
+ + + BECColorMapWidget + QWidget +
bec_color_map_widget
+ + + + x_name + y_name + z_name + button_apply + x_entry + y_entry + z_entry + + + + + x_name + device_reset() + x_entry + reset_selection() + + + 113 + 178 + + + 110 + 183 + + + + + x_name + currentTextChanged(QString) + x_entry + set_device(QString) + + + 160 + 178 + + + 159 + 188 + + + + + y_name + device_reset() + y_entry + reset_selection() + + + 92 + 278 + + + 92 + 287 + + + + + y_name + currentTextChanged(QString) + y_entry + set_device(QString) + + + 136 + 277 + + + 135 + 290 + + + + + z_name + device_reset() + z_entry + reset_selection() + + + 106 + 376 + + + 112 + 397 + + + + + z_name + currentTextChanged(QString) + z_entry + set_device(QString) + + + 164 + 376 + + + 168 + 389 + + + + diff --git a/docs/assets/widget_screenshots/heatmap_widget.png b/docs/assets/widget_screenshots/heatmap_widget.png new file mode 100644 index 00000000..cdc46ad2 Binary files /dev/null and b/docs/assets/widget_screenshots/heatmap_widget.png differ diff --git a/docs/user/widgets/heatmap/heatmap_fermat_scan.gif b/docs/user/widgets/heatmap/heatmap_fermat_scan.gif new file mode 100644 index 00000000..779ba237 Binary files /dev/null and b/docs/user/widgets/heatmap/heatmap_fermat_scan.gif differ diff --git a/docs/user/widgets/heatmap/heatmap_grid_scan.gif b/docs/user/widgets/heatmap/heatmap_grid_scan.gif new file mode 100644 index 00000000..fbea6de2 Binary files /dev/null and b/docs/user/widgets/heatmap/heatmap_grid_scan.gif differ diff --git a/docs/user/widgets/heatmap/heatmap_widget.md b/docs/user/widgets/heatmap/heatmap_widget.md new file mode 100644 index 00000000..48f05630 --- /dev/null +++ b/docs/user/widgets/heatmap/heatmap_widget.md @@ -0,0 +1,106 @@ +(user.widgets.heatmap_widget)= + +# Heatmap widget + +````{tab} Overview + +The Heatmap widget is a specialized plotting tool designed for visualizing 2D grid data with color mapping for the z-axis. It excels at displaying data from grid scans or arbitrary step scans, automatically interpolating scattered data points into a coherent 2D image. Directly integrated with the `BEC` framework, it can display live data streams from scanning experiments within the current `BEC` session. + +## Key Features: +- **Flexible Integration**: The widget can be integrated into [`BECDockArea`](user.widgets.bec_dock_area), or used as an individual component in your application through `BEC Designer`. +- **Live Grid Scan Visualization**: Real-time plotting of grid scan data with automatic positioning and color mapping based on scan parameters. +- **Dual Scan Support**: Handles both structured grid scans (with pre-allocated grids) and unstructured step scans (with interpolation). +- **Intelligent Data Interpolation**: For arbitrary step scans, the widget automatically interpolates scattered (x, y, z) data points into a smooth 2D heatmap using various interpolation methods. +- **Oversampling**: Supports oversampling to enhance the appearance of the heatmap, allowing for smoother transitions and better visual representation of data. Especially useful the for nearest-neighbor interpolation. +- **Customizable Color Maps**: Wide variety of color maps available for data visualization, with support for both simple and full color bars. +- **Real-time Image Processing**: Apply real-time processing techniques such as FFT and logarithmic scaling to enhance data visualization. +- **Interactive Controls**: Comprehensive toolbar with settings for heatmap configuration, crosshair tools, mouse interaction, and data export capabilities. + + +```{figure} ./heatmap_grid_scan.gif +:width: 60% + +Real-time heatmap visualization of a 2D grid scan showing motor positions and detector intensity +``` + +```{figure} ./heatmap_fermat_scan.gif +:width: 80% + +Real-time heatmap visualization of an (not path-optimized) scan following Fermat's spiral pattern. On the left, the heatmap widget is shown with the oversampling option set to 10 and the interpolation method set to nearest neighbor. On the right, the scatter waveform widget is shown with the same data. +``` + + +```` + +````{tab} Examples - CLI + +`HeatmapWidget` can be embedded in [`BECDockArea`](user.widgets.bec_dock_area), or used as an individual component in your application through `BEC Designer`. The command-line API is the same for all cases. + +## Example 1 - Visualizing Grid Scan Data + +In this example, we demonstrate how to add a `HeatmapWidget` to visualize live data from a 2D grid scan with motor positions and detector readout. + +```python +# Add a new dock with HeatmapWidget +dock_area = gui.new() +heatmap_widget = dock_area.new().new(gui.available_widgets.Heatmap) + +# Plot a heatmap with x and y motor positions and z detector signal +heatmap_widget.plot( + x_name='samx', # X-axis motor + y_name='samy', # Y-axis motor + z_name='bpm4i', # Z-axis detector signal + color_map='plasma' +) +heatmap_widget.title = "Grid Scan - Sample Position vs BPM Intensity" +``` + +## Example 2 - Step Scan with Custom Entries + +This example shows how to visualize data from an arbitrary step scan by specifying custom data entries for each axis. + +```python +# Add a new dock with HeatmapWidget +dock_area = gui.new() +heatmap_widget = dock_area.new().new(gui.available_widgets.Heatmap) + +# Plot heatmap with specific data entries +heatmap_widget.plot( + x_name='motor1', + y_name='motor2', + z_name='detector1', + x_entry='RBV', # Use readback value for x + y_entry='RBV', # Use readback value for y + z_entry='value', # Use main value for z + color_map='viridis', + reload=True # Force reload of data +) +``` + +## Example 3 - Real-time Processing and Customization + +The `Heatmap` widget provides real-time processing capabilities and extensive customization options for enhanced data visualization. + +```python +# Configure heatmap appearance and processing +heatmap_widget.color_map = 'plasma' +heatmap_widget.lock_aspect_ratio = True + +# Apply real-time processing +heatmap_widget.fft = True # Apply FFT to the data +heatmap_widget.log = True # Use logarithmic scaling + +# Configure color bar and range +heatmap_widget.enable_full_colorbar = True +heatmap_widget.v_min = 0 +heatmap_widget.v_max = 1000 + +``` + +```` + +````{tab} API +```{eval-rst} +.. include:: /api_reference/_autosummary/bec_widgets.widgets.plots.heatmap.heatmap.Heatmap.rst +``` +```` diff --git a/docs/user/widgets/widgets.md b/docs/user/widgets/widgets.md index 074cf0a8..8c8adc8a 100644 --- a/docs/user/widgets/widgets.md +++ b/docs/user/widgets/widgets.md @@ -61,6 +61,14 @@ Display a 1D waveforms with a third device on the z-axis. Display signal from 2D detector. ``` +```{grid-item-card} Heatmap Widget +:link: user.widgets.heatmap_widget +:link-type: ref +:img-top: /assets/widget_screenshots/heatmap_widget.png + +Display 2D grid data with color mapping. +``` + ```{grid-item-card} Motor Map Widget :link: user.widgets.motor_map :link-type: ref @@ -275,6 +283,7 @@ waveform/waveform_widget.md scatter_waveform/scatter_waveform.md multi_waveform/multi_waveform.md image/image_widget.md +heatmap/heatmap_widget.md motor_map/motor_map.md scan_control/scan_control.md progress_bar/ring_progress_bar.md diff --git a/tests/unit_tests/test_heatmap_widget.py b/tests/unit_tests/test_heatmap_widget.py index 52ed9179..66010a0e 100644 --- a/tests/unit_tests/test_heatmap_widget.py +++ b/tests/unit_tests/test_heatmap_widget.py @@ -3,6 +3,7 @@ from unittest import mock import numpy as np import pytest from bec_lib import messages +from bec_lib.scan_history import ScanHistory from bec_widgets.widgets.plots.heatmap.heatmap import Heatmap, HeatmapConfig, HeatmapDeviceSignal @@ -323,7 +324,43 @@ def test_heatmap_settings_popup_show_settings(heatmap_widget, qtbot): # Check that the ui elements are correctly initialized assert dialog.widget.ui.color_map.colormap == heatmap_widget.color_map - assert dialog.widget.ui.x_name.text() == heatmap_widget._image_config.x_device.name + assert dialog.widget.ui.x_name.currentText() == heatmap_widget._image_config.x_device.name dialog.reject() qtbot.waitUntil(lambda: heatmap_widget.heatmap_dialog is None) + + +def test_heatmap_widget_reset(heatmap_widget): + """ + Test that the reset method clears the plot. + """ + heatmap_widget.scan_item = create_dummy_scan_item() + heatmap_widget.plot(x_name="samx", y_name="samy", z_name="bpm4i") + + heatmap_widget.reset() + assert heatmap_widget._grid_index is None + assert heatmap_widget.main_image.raw_data is None + + +def test_heatmap_widget_update_plot_with_scan_history(heatmap_widget, grid_scan_history_msg, qtbot): + """ + Test that the update_plot method updates the plot with scan history. + """ + heatmap_widget.client.history = ScanHistory(heatmap_widget.client, False) + heatmap_widget.client.history._scan_data[grid_scan_history_msg.scan_id] = grid_scan_history_msg + heatmap_widget.client.history._scan_ids.append(grid_scan_history_msg.scan_id) + heatmap_widget.client.queue.scan_storage.current_scan = None + heatmap_widget.plot( + x_name="samx", + y_name="samy", + z_name="bpm4i", + x_entry="samx", + y_entry="samy", + z_entry="bpm4i", + ) + qtbot.waitUntil(lambda: heatmap_widget.main_image.raw_data is not None) + qtbot.waitUntil(lambda: heatmap_widget.main_image.raw_data.shape == (10, 10)) + + heatmap_widget.enforce_interpolation = True + heatmap_widget.oversampling_factor = 2.0 + qtbot.waitUntil(lambda: heatmap_widget.main_image.raw_data.shape == (20, 20))