Stop ReflectometryReductionOneLiveData from re-writing the spectra map on instrument load

Framework/PythonInterface/plugins/algorithms/ReflectometryReductionOneLiveData.py

@@ -154,7 +154,7 @@ def _run_reduction_algorithm(self, alg):
 
     def _setup_instrument(self):
         """Sets the instrument name and loads the instrument on the workspace"""
-        LoadInstrument(Workspace=self._temp_ws_name, RewriteSpectraMap=True, InstrumentName=self._instrument)
+        LoadInstrument(Workspace=self._temp_ws_name, RewriteSpectraMap=False, InstrumentName=self._instrument)
 
     def _setup_sample_logs(self, liveValues):
         """Set up the sample logs based on live values from the instrument"""

Framework/PythonInterface/test/python/plugins/algorithms/ReflectometryReductionOneLiveDataTest.py

@@ -8,7 +8,7 @@
 
 from mantid.kernel import *
 from mantid.api import *
-from mantid.simpleapi import CreateWorkspace, ReflectometryReductionOneLiveData, GroupWorkspaces
+from mantid.simpleapi import CreateWorkspace, ReflectometryReductionOneLiveData, GroupWorkspaces, LoadInstrument
 from testhelpers import assertRaisesNothing, create_algorithm
 
 
@@ -139,6 +139,7 @@ class ReflectometryReductionOneLiveDataTest(unittest.TestCase):
     INPUT_WS_ERROR = "Invalid value for property InputWorkspace"
 
     def setUp(self):
+        self._instrument_name = "INTER"
         self._setup_environment()
         self._setup_workspaces()
 
@@ -186,7 +187,7 @@ def test_invalid_property(self):
             ReflectometryReductionOneLiveData,
             InputWorkspace=self._input_ws,
             OutputWorkspace="output",
-            Instrument="INTER",
+            Instrument=self._instrument_name,
             GetLiveValueAlgorithm="GetFakeLiveInstrumentValue",
             BadProperty="badvalue",
         )
@@ -219,42 +220,25 @@ def test_instrument_was_set_on_output_workspace(self):
         workspace = self._run_algorithm_with_defaults()
         self.assertEqual(workspace.getInstrument().getName(), self._instrument_name)
 
-    def test_instrument_was_not_set_on_input_workspace(self):
-        workspace = self._run_algorithm_with_defaults()
-        # The input workspace should be unchanged
-        self.assertEqual(self._input_ws.getInstrument().getName(), "")
+        load_inst_history = self._get_child_alg_history(workspace, "LoadInstrument")
+        self.assertIsNotNone(load_inst_history)
+        self.assertEqual(load_inst_history.getPropertyValue("RewriteSpectraMap"), "False")
 
     def test_sample_log_values_were_set_on_output_workspace(self):
         workspace = self._run_algorithm_with_defaults()
-
-        names = ["THETA", "S1VG", "S2VG"]
-        values = [0.5, 1.001, 0.5]
-        units = ["deg", "m", "m"]
-        logs = workspace.getRun().getProperties()
-        matched_names = list()
-        for log in logs:
-            if log.name in names:
-                matched_names.append(log.name)
-                idx = names.index(log.name)
-                self.assertEqual(log.value, values[idx])
-                self.assertEqual(log.units, units[idx])
-        self.assertEqual(sorted(matched_names), sorted(names))
+        self._check_sample_log_values(workspace)
 
     def test_sample_log_values_were_set_on_output_workspace_for_alternative_block_names(self):
         workspace = self._run_algorithm_with_alternative_names()
+        self._check_sample_log_values(workspace)
 
-        expected_names = ["THETA", "S1VG", "S2VG"]
-        expected_values = [0.5, 1.001, 0.5]
-        expected_units = ["deg", "m", "m"]
-        actual_logs = workspace.getRun().getProperties()
-        matched_names = list()
-        for log in actual_logs:
-            if log.name in expected_names:
-                matched_names.append(log.name)
-                idx = expected_names.index(log.name)
-                self.assertEqual(log.value, expected_values[idx])
-                self.assertEqual(log.units, expected_units[idx])
-        self.assertEqual(sorted(matched_names), sorted(expected_names))
+    def test_sample_log_values_are_not_set_on_input_workspace(self):
+        self._run_algorithm_with_defaults()
+
+        log_names = [log.name for log in self._input_ws.getRun().getProperties()]
+        self.assertNotIn("THETA", log_names)
+        self.assertNotIn("S1VG", log_names)
+        self.assertNotIn("S2VG", log_names)
 
     def test_algorithm_fails_for_invalid_block_names(self):
         self.assertRaisesRegex(
@@ -263,7 +247,7 @@ def test_algorithm_fails_for_invalid_block_names(self):
             ReflectometryReductionOneLiveData,
             InputWorkspace=self._input_ws,
             OutputWorkspace="output",
-            Instrument="INTER",
+            Instrument=self._instrument_name,
             GetLiveValueAlgorithm="GetFakeLiveInstrumentValueInvalidNames",
         )
 
@@ -305,7 +289,6 @@ def _setup_environment(self):
             self._old_facility = "TEST_LIVE"
         config.setFacility("ISIS")
 
-        self._instrument_name = "INTER"
         self._old_instrument = config["default.instrument"]
         config["default.instrument"] = self._instrument_name
 
@@ -318,7 +301,7 @@ def _setup_workspaces(self):
         self._default_args = {
             "InputWorkspace": self._input_ws,
             "OutputWorkspace": "output",
-            "Instrument": "INTER",
+            "Instrument": self._instrument_name,
             "GetLiveValueAlgorithm": "GetFakeLiveInstrumentValue",
         }
 
@@ -545,23 +528,23 @@ def _create_test_workspace(self, ws_name="input_ws"):
         dataY += y
 
         CreateWorkspace(NSpec=nSpec, UnitX="TOF", DataX=dataX, DataY=dataY, OutputWorkspace=ws_name)
+        LoadInstrument(Workspace=ws_name, RewriteSpectraMap=True, InstrumentName=self._instrument_name)
         return mtd[ws_name]
 
     def _run_algorithm_with_defaults(self):
-        alg = create_algorithm("ReflectometryReductionOneLiveData", **self._default_args)
-        assertRaisesNothing(self, alg.execute)
-        return mtd["output"]
+        return self._run_algorithm(self._default_args)
 
     def _run_algorithm_with_alternative_names(self):
         args = self._default_args
         args["GetLiveValueAlgorithm"] = "GetFakeLiveInstrumentValueAlternativeNames"
-        alg = create_algorithm("ReflectometryReductionOneLiveData", **args)
-        assertRaisesNothing(self, alg.execute)
-        return mtd["output"]
+        return self._run_algorithm(args)
 
     def _run_algorithm_with_zero_theta(self):
         args = self._default_args
         args["GetLiveValueAlgorithm"] = "GetFakeLiveInstrumentValuesWithZeroTheta"
+        return self._run_algorithm(args)
+
+    def _run_algorithm(self, args):
         alg = create_algorithm("ReflectometryReductionOneLiveData", **args)
         assertRaisesNothing(self, alg.execute)
         return mtd["output"]
@@ -584,6 +567,30 @@ def _check_history(self, ws, expected, unroll=True):
             algNames = [alg.name() for alg in history]
         self.assertEqual(algNames, expected)
 
+    @staticmethod
+    def _get_child_alg_history(ws, child_name):
+        history = ws.getHistory()
+        reduction_history = history.getAlgorithmHistory(history.size() - 1)
+        for child_history in reduction_history.getChildHistories():
+            if child_history.name() == child_name:
+                return child_history
+
+        return None
+
+    def _check_sample_log_values(self, workspace):
+        expected_logs = {"THETA": (0.5, "deg"), "S1VG": (1.001, "m"), "S2VG": (0.5, "m")}
+        actual_logs = workspace.getRun().getProperties()
+
+        matched_names = []
+        for log in actual_logs:
+            if log.name in expected_logs:
+                matched_names.append(log.name)
+                expected_log_details = expected_logs[log.name]
+                self.assertEqual(log.value, expected_log_details[0])
+                self.assertEqual(log.units, expected_log_details[1])
+
+        self.assertEqual(sorted(matched_names), sorted(expected_logs.keys()))
+
 
 if __name__ == "__main__":
     unittest.main()

docs/source/release/v6.12.0/Reflectometry/Bugfixes/38202.rst

@@ -0,0 +1 @@
+- Fix a bug where :ref:`algm-ReflectometryReductionOneLiveData` was re-writing the spectra map when loading the instrument into the input live data workspace.