Refs #9349 - Utility to extract masked detector IDs.

Code/Mantid/scripts/SANS/SANSUtility.py

@@ -530,6 +530,25 @@ def extract_single_spectrum(ws, ws_index):
 
     return mtd[output_ws_name]
 
+def get_masked_det_ids(ws):
+    """
+    Given a workspace, will return a list of all the IDs that correspond to
+    detectors that have been masked.
+
+    @param ws :: the workspace to extract the det IDs from
+
+    @returns a list of IDs for masked detectors.
+    """
+    for ws_index in range(ws.getNumberHistograms()):
+        try:
+            det = ws.getDetector(ws_index)
+        except RuntimeError:
+            # Skip the rest after finding the first spectra with no detectors,
+            # which is a big speed increase for SANS2D.
+            break
+        if det.isMasked():
+            yield det.getID()
+
 ###############################################################################
 ######################### Start of Deprecated Code ############################
 ###############################################################################

Code/Mantid/scripts/test/SANSUtilityTest.py

@@ -2,7 +2,7 @@
 from mantid.simpleapi import *
 import SANSUtility as su
 
-class TestSliceStringParser(unittest.TestCase):
+class SANSUtilityTest(unittest.TestCase):
 
     def checkValues(self, list1, list2):
 
@@ -68,5 +68,17 @@ def test_extract_spectra(self):
         self.assertEquals(result.getDetector(1).getID(), 102)
         self.assertEquals(result.getDetector(2).getID(), 104)
 
+    def test_get_masked_det_ids(self):
+        ws = CreateSampleWorkspace("Histogram", "Multiple Peaks")
+
+        MaskDetectors(Workspace=ws, DetectorList=[100, 102, 104])
+
+        masked_det_ids = list(su.get_masked_det_ids(ws))
+
+        self.assertTrue(100 in masked_det_ids)
+        self.assertTrue(102 in masked_det_ids)
+        self.assertTrue(104 in masked_det_ids)
+        self.assertEquals(len(masked_det_ids), 3)
+
 if __name__ == "__main__":
     unittest.main()