Move general plot options to sidebar

Author: MagnusSletten

src/ert/gui/plotting/customization_dialog/default_customization_view.py

@@ -1,7 +1,5 @@
 from typing import TYPE_CHECKING, override
 
-from ert.gui.utils import is_everest_application
-
 from .customization_view import CustomizationView, WidgetProperty
 
 if TYPE_CHECKING:
@@ -24,10 +22,6 @@ class DefaultCustomizationView(CustomizationView):
     title = WidgetProperty()
     x_label = WidgetProperty()
     y_label = WidgetProperty()
-    legend = WidgetProperty()
-    grid = WidgetProperty()
-    history = WidgetProperty()
-    observations = WidgetProperty()
 
     def __init__(self) -> None:
         CustomizationView.__init__(self)
@@ -51,30 +45,13 @@ def __init__(self) -> None:
             f"The label of the y-axis. {_label_msg('label')}",
             placeholder="y-label",
         )
-        self.add_spacing()
-        self.add_check_box("legend", "Legend", "Toggle legend visibility.")
-        self.add_check_box("grid", "Grid", "Toggle grid visibility.")
-
-        self.is_everest = is_everest_application()
-        if not self.is_everest:
-            self.add_check_box("history", "History", "Toggle history visibility.")
-            self.add_check_box(
-                "observations", "Observations", "Toggle observations visibility."
-            )
 
     @override
     def apply_customization(self, plot_config: "PlotConfig") -> None:
         plot_config.set_title(self.title)
-
         plot_config.set_x_label(self.x_label)
         plot_config.set_y_label(self.y_label)
 
-        plot_config.set_legend_enabled(self.legend)
-        plot_config.set_grid_enabled(self.grid)
-        if not self.is_everest:
-            plot_config.set_history_enabled(self.history)
-            plot_config.set_observations_enabled(self.observations)
-
     @override
     def revert_customization(self, plot_config: "PlotConfig") -> None:
         if not plot_config.is_unnamed():
@@ -84,9 +61,3 @@ def revert_customization(self, plot_config: "PlotConfig") -> None:
 
         self.x_label = plot_config.x_label()
         self.y_label = plot_config.y_label()
-
-        self.legend = plot_config.is_legend_enabled()
-        self.grid = plot_config.is_grid_enabled()
-        if not self.is_everest:
-            self.history = plot_config.is_history_enabled()
-            self.observations = plot_config.is_observations_enabled()

src/ert/gui/plotting/plot_window.py

@@ -26,7 +26,9 @@
 )
 
 from ert.config import BreakthroughConfig
+from ert.config.distribution import ConstSettings
 from ert.config.field import Field
+from ert.config.gen_kw_config import GenKwConfig
 from ert.dark_storage.common import get_storage_api_version
 from ert.gui.ertwidgets import CopyButton, showWaitCursorWhileWaiting
 from ert.gui.plotting.ert_plots import (
@@ -58,7 +60,11 @@
 from .utils.qt_creator import create_group_box, create_group_layout, create_side_panel
 from .widgets.data_type_keys_widget import DataTypeKeysWidget
 from .widgets.everest_control_selection_widget import EverestControlSelectionWidget
-from .widgets.plot_controls import EverestControlsPlotOptions, MisfitsOptions
+from .widgets.plot_controls import (
+    EverestControlsPlotOptions,
+    GeneralOptions,
+    MisfitsOptions,
+)
 from .widgets.plot_ensemble_selection_widget import EnsembleSelectionWidget
 from .widgets.plot_widget import Plotter, PlotWidget
 
@@ -324,12 +330,17 @@ def __init__(
                 self.updatePlot
             )
 
+            self._general_options = GeneralOptions(
+                self.updatePlot,
+                is_everest=self.is_everest,
+            )
             self._misfits_options = MisfitsOptions(self.updatePlot)
 
             right_container = QWidget()
             right_layout = create_group_layout(
                 [
                     self._ensemble_group,
+                    self._general_options.get_widget(),
                     self._everest_controls_plot_options.get_widget(),
                     self._everest_controls_group,
                     self._misfits_options.get_widget(),
@@ -355,6 +366,32 @@ def __init__(
             if self.getSelectedKey() is None:
                 self._show_no_data_message()
 
+    def _sync_log_scale_option(
+        self,
+        selected_tab: str,
+        log_scale_valid_values: bool,
+        key_def: PlotApiKeyDefinition | None = None,
+    ) -> None:
+        if (
+            selected_tab
+            in {
+                HISTOGRAM,
+                DISTRIBUTION,
+                GAUSSIAN_KDE,
+            }
+            and log_scale_valid_values
+        ):
+            if key_def is not None:
+                a = key_def.parameter
+                if isinstance(a, GenKwConfig) and isinstance(
+                    a.distribution, ConstSettings
+                ):
+                    self._general_options.set_log_visible(False)
+                    return
+            self._general_options.set_log_visible(True)
+        else:
+            self._general_options.set_log_visible(False)
+
     def _show_no_data_message(self) -> None:
         current_widget = self._central_tab.currentWidget()
         if not isinstance(current_widget, PlotWidget):
@@ -549,6 +586,16 @@ def fetch_data(
             plot_config = PlotConfig.create_copy(
                 self._plot_customizer.get_plot_config()
             )
+            plot_config.set_legend_enabled(self._general_options.legend_checkbox_state)
+            plot_config.set_grid_enabled(self._general_options.grid_checkbox_state)
+            if not self.is_everest:
+                plot_config.set_history_enabled(
+                    self._general_options.history_checkbox_state
+                )
+                plot_config.set_observations_enabled(
+                    self._general_options.observations_checkbox_state
+                )
+
             plot_context = PlotContext(
                 plot_config,
                 selected_ensembles,
@@ -563,6 +610,14 @@ def fetch_data(
             plot_context.scatter_plot = self._misfits_options.scatter_checkbox_state
             plot_context.box_plot = self._misfits_options.box_checkbox_state
             plot_context.mean = self._misfits_options.mean_checkbox_state
+            self._sync_log_scale_option(selected_tab, log_scale_valid_values, key_def)
+
+            plot_context.log_scale = (
+                self._general_options.is_log_visible()
+                and self._general_options.log_checkbox_state
+                and log_scale_valid_values
+            )
+
             plot_context.outliers = self._misfits_options.outliers_checkbox_state
 
             # Check if key is a history key.
@@ -650,7 +705,6 @@ def addPlotWidget(
         plot_widget = PlotWidget(name, plotter)
         plot_widget.customizationTriggered.connect(self.toggleCustomizeDialog)
         plot_widget.layerIndexChanged.connect(self.layerIndexChanged)
-        plot_widget.plotUpdateRequested.connect(self.updatePlot)
 
         index = self._central_tab.addTab(plot_widget, name)
         self._plot_widgets.append(plot_widget)

src/ert/gui/plotting/utils/plot_config.py

@@ -179,10 +179,10 @@ def legend_items(self) -> list[Any]:
     def legend_labels(self) -> list[str]:
         return self._legend_labels
 
-    def set_x_label(self, label: str) -> None:
+    def set_x_label(self, label: str | None) -> None:
         self._x_label = label
 
-    def set_y_label(self, label: str) -> None:
+    def set_y_label(self, label: str | None) -> None:
         self._y_label = label
 
     def set_observations_enabled(self, enabled: bool) -> None:

src/ert/gui/plotting/utils/plot_context.py

@@ -134,10 +134,10 @@ def plot_type(self) -> PlotType | None:
     def plot_type(self, value: PlotType) -> None:
         self._plot_type = value
 
-    def setXLabel(self, value: str) -> None:
+    def setXLabel(self, value: str | None) -> None:
         self._plot_config.set_x_label(value)
 
-    def setYLabel(self, value: str) -> None:
+    def setYLabel(self, value: str | None) -> None:
         self._plot_config.set_y_label(value)
 
     @property

src/ert/gui/plotting/widgets/plot_controls/__init__.py

@@ -1,7 +1,9 @@
 from .everest_controls_plot_options import EverestControlsPlotOptions
+from .general_options import GeneralOptions
 from .misfits_options import MisfitsOptions
 
 __all__ = [
     "EverestControlsPlotOptions",
+    "GeneralOptions",
     "MisfitsOptions",
 ]

src/ert/gui/plotting/widgets/plot_controls/general_options.py

@@ -0,0 +1,96 @@
+import logging
+from collections.abc import Callable
+
+from PyQt6.QtWidgets import (
+    QCheckBox,
+    QGroupBox,
+    QWidget,
+)
+
+from ert.gui.plotting.utils.qt_creator import create_group_box, create_group_layout
+
+logger = logging.getLogger(__name__)
+
+
+class GeneralOptions:
+    def __init__(
+        self, connection_point: Callable[..., object], *, is_everest: bool
+    ) -> None:
+        def refresh_plot(_state: int) -> None:
+            connection_point()
+
+        self._toggle_legend = QCheckBox("Legend")
+        self._toggle_legend.setChecked(True)
+        self._toggle_legend.stateChanged.connect(refresh_plot)
+
+        self._toggle_grid = QCheckBox("Grid")
+        self._toggle_grid.setChecked(True)
+        self._toggle_grid.stateChanged.connect(refresh_plot)
+
+        self._toggle_history = QCheckBox("History")
+        self._toggle_history.setChecked(True)
+        self._toggle_history.stateChanged.connect(refresh_plot)
+
+        self._toggle_observations = QCheckBox("Observations")
+        self._toggle_observations.setChecked(True)
+        self._toggle_observations.stateChanged.connect(refresh_plot)
+
+        self._toggle_log_scale = QCheckBox("Log scale")
+        self._toggle_log_scale.setObjectName("log_scale_checkbox")
+        self._toggle_log_scale.setChecked(False)
+        self._toggle_log_scale.setVisible(False)
+
+        def _on_log_scale_toggled(_state: int) -> None:
+            logger.info("Plot sidebar option used: 'Log scale'")
+            self._toggle_log_scale.stateChanged.disconnect(_on_log_scale_toggled)
+            self._toggle_log_scale.stateChanged.connect(refresh_plot)
+            connection_point()
+
+        self._toggle_log_scale.stateChanged.connect(_on_log_scale_toggled)
+
+        widgets: list[QWidget] = [
+            self._toggle_legend,
+            self._toggle_grid,
+            self._toggle_log_scale,
+        ]
+        if not is_everest:
+            widgets.extend(
+                [
+                    self._toggle_history,
+                    self._toggle_observations,
+                ]
+            )
+
+        self._general_options = create_group_box(
+            "General options",
+            create_group_layout(widgets),
+        )
+
+    def get_widget(self) -> QGroupBox:
+        return self._general_options
+
+    @property
+    def legend_checkbox_state(self) -> bool:
+        return self._toggle_legend.isChecked()
+
+    @property
+    def grid_checkbox_state(self) -> bool:
+        return self._toggle_grid.isChecked()
+
+    @property
+    def history_checkbox_state(self) -> bool:
+        return self._toggle_history.isChecked()
+
+    @property
+    def observations_checkbox_state(self) -> bool:
+        return self._toggle_observations.isChecked()
+
+    @property
+    def log_checkbox_state(self) -> bool:
+        return self._toggle_log_scale.isChecked()
+
+    def set_log_visible(self, visible: bool) -> None:
+        self._toggle_log_scale.setVisible(visible)
+
+    def is_log_visible(self) -> bool:
+        return self._toggle_log_scale.isVisible()