Merge pull request #37926 from cailafinn/37225_helium_analyser_systest

Add System Test for HeliumAnalyserEfficiency

Author: robertapplin

Testing/Data/SystemTest/ZOOM00038249.nxs.md5

@@ -0,0 +1 @@
+a7f5d18984e8e55756b4bcbb70d71bdb

Testing/Data/SystemTest/ZOOM00038253.nxs.md5

@@ -0,0 +1 @@
+11ca7e54cf2a4426db8537d332e9554b

Testing/SystemTests/tests/framework/PolarizationCorrections/DepolarizedAnalyserTransmissionTest.py

@@ -5,59 +5,26 @@
 #   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
 # SPDX - License - Identifier: GPL - 3.0 +
 
-import systemtesting
+from mantid.simpleapi import DepolarizedAnalyserTransmission
+from SANSPolarizationCorrectionsBase import SANSPolarizationCorrectionsBase
 
-from mantid.api import AnalysisDataService
-from mantid.simpleapi import *
 
+class DepolarizedAnalyzerTransmissionTest(SANSPolarizationCorrectionsBase):
+    def __init__(self):
+        SANSPolarizationCorrectionsBase.__init__(self)
 
-class DepolarizedAnalyzerTransmissionTest(systemtesting.MantidSystemTest):
-    def runTest(self):
-        Load("ZOOM00038238.nxs", OutputWorkspace="mt_run")
-        Load("ZOOM00038335.nxs", OutputWorkspace="dep_run")
-
-        mt_group = self._prepare_workspace("mt_run")
-        dep_group = self._prepare_workspace("dep_run")
+    def _run_test(self):
+        mt_group = self._prepare_workspace("ZOOM00038238.nxs")
+        dep_group = self._prepare_workspace("ZOOM00038335.nxs")
         mt = self._average_workspaces_in_group(list(mt_group))
         dep = self._average_workspaces_in_group(list(dep_group))
 
         DepolarizedAnalyserTransmission(dep, mt, OutputWorkspace="params" "", OutputFitCurves="curves")
 
-    def _prepare_workspace(self, input_ws_name):
-        converted = ConvertUnits(input_ws_name, "Wavelength", AlignBins=True, StoreInADS=False)
-        monitor_3 = CropWorkspace(converted, StartWorkspaceIndex=2, EndWorkspaceIndex=2, StoreInADS=False)
-        monitor_4 = CropWorkspace(converted, StartWorkspaceIndex=3, EndWorkspaceIndex=3, StoreInADS=False)
-        return monitor_4 / monitor_3
-
-    def _average_workspaces_in_group(self, ws_list):
-        return sum(ws_list) / 4
-
-    def validate(self):
-        self.tolerance = 1e-5
+    def _validate(self):
         result_curves = "curves"
         reference_curves = "DepolCurvesReference.nxs"
         result_params = "params"
         reference_params = "DepolParamsReference.nxs"
 
-        def validate_group(result, reference):
-            Load(Filename=reference, OutputWorkspace=reference)
-            compare_alg = AlgorithmManager.create("CompareWorkspaces")
-            compare_alg.setPropertyValue("Workspace1", result)
-            compare_alg.setPropertyValue("Workspace2", reference)
-            compare_alg.setPropertyValue("Tolerance", str(self.tolerance))
-            compare_alg.setChild(True)
-
-            compare_alg.execute()
-            if compare_alg.getPropertyValue("Result") != "1":
-                print("Workspaces do not match.")
-                print(self.__class__.__name__)
-                SaveNexus(InputWorkspace=result, Filename=f"{self.__class__.__name__}-{result}-mismatch.nxs")
-                return False
-            return True
-
-        is_curves_match = validate_group(result_curves, reference_curves)
-        is_params_match = validate_group(result_params, reference_params)
-        return is_curves_match and is_params_match
-
-    def cleanup(self):
-        AnalysisDataService.clear()
+        return result_curves, reference_curves, result_params, reference_params

Testing/SystemTests/tests/framework/PolarizationCorrections/HeliumAnalyserEfficiencyTest.py

@@ -0,0 +1,67 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2024 ISIS Rutherford Appleton Laboratory UKRI,
+#   NScD Oak Ridge National Laboratory, European Spallation Source,
+#   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
+# SPDX - License - Identifier: GPL - 3.0 +
+
+from abc import ABCMeta, abstractmethod
+from mantid.simpleapi import HeliumAnalyserEfficiency
+from SANSPolarizationCorrectionsBase import SANSPolarizationCorrectionsBase
+
+
+class HeliumAnalyserEfficiencyTestBase(SANSPolarizationCorrectionsBase, metaclass=ABCMeta):
+    def __init__(self):
+        SANSPolarizationCorrectionsBase.__init__(self)
+
+    @property
+    @abstractmethod
+    def reference_basename(self):
+        """
+        The algorithm outputs 3 workspaces. This value is the string that precedes the specific workspace's reference
+        file.
+        :return: The prefix all the reference files are preceded by for the given test.
+        """
+        pass
+
+    @property
+    @abstractmethod
+    def input_filename(self):
+        """
+        The filename to use as the input to the algorithm in this test.
+        :return: The input workspace's filename.
+        """
+        pass
+
+    def _run_test(self):
+        pre_processed = self._prepare_workspace(self.input_filename)
+
+        HeliumAnalyserEfficiency(
+            pre_processed, "00,10,11,01", OutputWorkspace="efficiency", OutputFitCurves="curves", OutputFitParameters="params"
+        )
+
+    def _validate(self):
+        result_eff = "efficiency"
+        reference_eff = f"{self.reference_basename}EfficiencyReference.nxs"
+        result_curves = "curves"
+        reference_curves = f"{self.reference_basename}CurvesReference.nxs"
+        result_params = "params"
+        reference_params = f"{self.reference_basename}ParamsReference.nxs"
+
+        return result_eff, reference_eff, result_curves, reference_curves, result_params, reference_params
+
+
+class HeliumAnalyserEfficiencyPolarisedTest(HeliumAnalyserEfficiencyTestBase):
+    reference_basename = "HeliumAnalyser"
+    input_filename = "ZOOM00038249.nxs"
+
+    def __init__(self):
+        HeliumAnalyserEfficiencyTestBase.__init__(self)
+
+
+class HeliumAnalyserEfficiencyUnpolarisedTest(HeliumAnalyserEfficiencyTestBase):
+    reference_basename = "UnpolHeliumAnalyser"
+    input_filename = "ZOOM00038253.nxs"
+
+    def __init__(self):
+        HeliumAnalyserEfficiencyTestBase.__init__(self)

Testing/SystemTests/tests/framework/PolarizationCorrections/SANSPolarizationCorrectionsBase.py

@@ -0,0 +1,45 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2024 ISIS Rutherford Appleton Laboratory UKRI,
+#   NScD Oak Ridge National Laboratory, European Spallation Source,
+#   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
+# SPDX - License - Identifier: GPL - 3.0 +
+
+from abc import ABCMeta, abstractmethod
+from systemtesting import MantidSystemTest
+from mantid.api import AnalysisDataService
+from mantid.simpleapi import Load, ConvertUnits, CropWorkspace
+
+
+class SANSPolarizationCorrectionsBase(MantidSystemTest, metaclass=ABCMeta):
+    _tolerance = 1e-7
+
+    def runTest(self):
+        self._run_test()
+
+    @abstractmethod
+    def _run_test(self):
+        raise NotImplementedError("_run_test() method must be implemented.")
+
+    @staticmethod
+    def _prepare_workspace(input_filename):
+        run = Load(input_filename)
+        converted = ConvertUnits(run, "Wavelength", AlignBins=True, StoreInADS=False)
+        monitor_3 = CropWorkspace(converted, StartWorkspaceIndex=2, EndWorkspaceIndex=2, StoreInADS=False)
+        monitor_4 = CropWorkspace(converted, StartWorkspaceIndex=3, EndWorkspaceIndex=3, StoreInADS=False)
+        return monitor_4 / monitor_3
+
+    @staticmethod
+    def _average_workspaces_in_group(ws_list):
+        return sum(ws_list) / len(ws_list)
+
+    def validate(self):
+        return self._validate()
+
+    @abstractmethod
+    def _validate(self):
+        raise NotImplementedError("validate() method must be implemented.")
+
+    @staticmethod
+    def cleanup():
+        AnalysisDataService.clear()

Testing/SystemTests/tests/framework/PolarizationCorrections/__init__.py

@@ -0,0 +1 @@
+e4e8f8a34da3503ca94abdd7f2d4a43c

Testing/SystemTests/tests/framework/reference/HeliumAnalyserCurvesReference.nxs.md5

@@ -0,0 +1 @@
+53250098034066a9058e27bcb445958b

Testing/SystemTests/tests/framework/reference/HeliumAnalyserEfficiencyReference.nxs.md5

@@ -0,0 +1 @@
+a3f1b65884315dd469152a2bbadf6062

Testing/SystemTests/tests/framework/reference/HeliumAnalyserParamsReference.nxs.md5

@@ -0,0 +1 @@
+b861a0b89e71014098b482336c0c5018