Merge pull request #37635 from mantidproject/37577-error-in-isis-sans-gui-when-scaling-merged-reduction-with-fit-while-plot-results-is-selected

- Temporarily hide plot results checkbox by default to prevent issues during ISIS SANS merge reduction

Author: rbauststfc

docs/source/concepts/PropertiesFile.rst

@@ -382,6 +382,15 @@ Plotting Settings
 |``plots.images.ColorBarScale``   |Default colorbar scale for image plots                            |``Linear``           |
 +---------------------------------+------------------------------------------------------------------+---------------------+
 
+ISIS SANS Interface GUI Settings
+*********************************
+
++---------------------------------+------------------------------------------------------------------+---------------------+
+|Property                         |Description                                                       |Example value        |
++=================================+==================================================================+=====================+
+|``sans.isis_sans.plotResults``   |Whether to show or hide plot results checkbox                     | ``On``, ``Off``     |
++---------------------------------+------------------------------------------------------------------+---------------------+
+
 Getting access to Mantid properties
 ***********************************
 

docs/source/interfaces/isis_sans/Runs Tab.rst

@@ -171,6 +171,7 @@ Save Options
    :align: center
    :width: 500px
 
+
 +--------------------------+-----------------------------------------------------------------------------------------+
 | **Save Other**           | Opens up the save a dialog box :ref:`Save Other <save-other>` which allows users        |
 |                          | to manually save processed data                                                         |
@@ -190,4 +191,8 @@ Save Options
 |                          | for each run in the table, speeding up processing considerably.                         |
 +--------------------------+-----------------------------------------------------------------------------------------+
 | **Plot results**         | If enabled, data is automatically plotted on a graph as it is processed.                |
+|                          | The check box is hidden by default, and can be enabled by adding                        |
+|                          | `sans.isis_sans.plotResults=On` in your mantid.user.properties, see                     |
+|                          | :ref:`Properties File` for more information                                             |
 +--------------------------+-----------------------------------------------------------------------------------------+
+

docs/source/release/v6.11.0/SANS/Bugfixes/37577.rst

@@ -0,0 +1 @@
+- The plot results checkbox is now hidden by default to prevent issues when both scaling and plot results are enabled. You can enable it via your properties file if needed. This change will help us decide whether to keep it hidden or fix the underlying issue.

scripts/Interface/ui/sans_isis/sans_data_processor_gui.py

@@ -1001,6 +1001,9 @@ def is_background_subtraction(self):
     def set_background_subtraction_mode(self, mode):
         self.background_subtraction_checkbox.setChecked(mode)
 
+    def set_plot_results_checkbox_visibility(self, visibility):
+        self.plot_results_checkbox.setVisible(visibility)
+
     # $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
     # $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
     # START ACCESSORS

scripts/SANS/sans/gui_logic/presenter/run_tab_presenter.py

@@ -340,6 +340,8 @@ def set_view(self, view):
 
         self._view.setup_layout()
 
+        self.hide_or_show_plot_results_checkbox_based_on_user_properties()
+
         self._view.set_out_file_directory(ConfigService.Instance().getString("defaultsave.directory"))
 
         self._view.set_out_default_output_mode()
@@ -423,6 +425,19 @@ def on_user_file_load(self):
             traceback.print_exc()
             self._on_user_file_load_failure(other_error, "Unknown error in loading user file.", use_error_name=True)
 
+    def hide_or_show_plot_results_checkbox_based_on_user_properties(self):
+        """
+        Hide the plot results checkbox if it has not been explicitly enabled in the user properties file.
+
+        When performing merged reduction, if both the scale option and the plot result option are selected,
+        it causes an issue. The agreed temporary fix is to hide the plot result checkbox by default since
+        the functionality is rarely used. Users can enable the visibility of the plot result checkbox
+        from their properties file if needed. This experiment will help us determine whether to
+        permanently hide the checkbox or fix the underlying issue.
+        """
+        visibility = ConfigService.getString("sans.isis_sans.plotResults")
+        self._view.set_plot_results_checkbox_visibility(visibility == "On")
+
     def _on_user_file_load_failure(self, e, message, use_error_name=False):
         self._setup_instrument_specific_settings(SANSInstrument.NO_INSTRUMENT)
         self._view.instrument = SANSInstrument.NO_INSTRUMENT

scripts/test/SANS/gui_logic/test_run_tab_presenter.py

@@ -83,6 +83,7 @@ def setUp(self):
         self._backup_instrument = config["default.instrument"]
         self._backup_datasearch_dirs = config["datasearch.directories"]
         self._backup_save_dir = config["defaultsave.directory"]
+        self._backup_sans_plot_results = config["sans.isis_sans.plotResults"]
 
         config["default.facility"] = "ISIS"
 
@@ -121,6 +122,7 @@ def tearDown(self):
         config["default.instrument"] = self._backup_instrument
         config["datasearch.directories"] = self._backup_datasearch_dirs
         config["defaultsave.directory2"] = self._backup_save_dir
+        config["sans.isis_sans.plotResults"] = self._backup_sans_plot_results
 
     def test_that_will_load_user_file(self):
         # Setup self.presenter.and mock view
@@ -768,6 +770,23 @@ def test_that_on_reduction_mode_changed_calls_update_rear_if_selection_is_LAB(se
         self.presenter.on_reduction_mode_selection_has_changed("rear-detector")
         self.presenter._beam_centre_presenter.update_rear_selected.assert_called_once_with()
 
+    def test_plot_results_visibility_on(self):
+        self._test_plot_results_visibility("On", True)
+
+    def test_plot_results_visibility_off(self):
+        self._test_plot_results_visibility("Off", False)
+
+    def test_plot_results_visibility_when_not_set(self):
+        self._test_plot_results_visibility("", False)
+
+    def _test_plot_results_visibility(self, config_value, expected_visibility):
+        config.setString("sans.isis_sans.plotResults", config_value)
+
+        self.presenter._view.set_plot_results_checkbox_visibility = mock.Mock()
+        self.presenter.hide_or_show_plot_results_checkbox_based_on_user_properties()
+
+        self.presenter._view.set_plot_results_checkbox_visibility.assert_called_once_with(expected_visibility)
+
     @staticmethod
     def _clear_property_manager_data_service():
         for element in PropertyManagerDataService.getObjectNames():