Add masking to sliceviewer

Framework/Algorithms/src/MaskBins.cpp

@@ -27,9 +27,10 @@ using DataObjects::EventWorkspace_const_sptr;
 using DataObjects::EventWorkspace_sptr;
 
 void MaskBins::init() {
-  declareWorkspaceInputProperties<MatrixWorkspace>("InputWorkspace",
-                                                   "The name of the input workspace. Must contain histogram data.",
-                                                   std::make_shared<HistogramValidator>());
+  declareWorkspaceInputProperties<MatrixWorkspace, static_cast<int>(IndexType::WorkspaceIndex) |
+                                                       static_cast<int>(IndexType::SpectrumNum)>(
+      "InputWorkspace", "The name of the input workspace. Must contain histogram data.",
+      std::make_shared<HistogramValidator>());
   declareProperty(std::make_unique<WorkspaceProperty<>>("OutputWorkspace", "", Direction::Output),
                   "The name of the Workspace containing the masked bins.");
 

Framework/Algorithms/src/MaskBinsFromTable.cpp

@@ -75,7 +75,7 @@ void MaskBinsFromTable::maskBins(const API::MatrixWorkspace_sptr &dataws) {
     maskbins->initialize();
 
     // Set properties
-    g_log.debug() << "Input to MaskBins: SpetraList = '" << m_spectraVec[ib] << "'; Xmin = " << m_xminVec[ib]
+    g_log.debug() << "Input to MaskBins: SpectraList = '" << m_spectraVec[ib] << "'; Xmin = " << m_xminVec[ib]
                   << ", Xmax = " << m_xmaxVec[ib] << ".\n";
 
     if (firstloop) {
@@ -87,7 +87,8 @@ void MaskBinsFromTable::maskBins(const API::MatrixWorkspace_sptr &dataws) {
       maskbins->setProperty("InputWorkspace", outputws);
     }
     maskbins->setProperty("OutputWorkspace", this->getPropertyValue("OutputWorkspace"));
-    maskbins->setPropertyValue("SpectraList", m_spectraVec[ib]);
+    maskbins->setPropertyValue("InputWorkspaceIndexType", "SpectrumNumber");
+    maskbins->setPropertyValue("InputWorkspaceIndexSet", m_spectraVec[ib]);
     maskbins->setProperty("XMin", m_xminVec[ib]);
     maskbins->setProperty("XMax", m_xmaxVec[ib]);
 

docs/source/release/v6.14.0/Workbench/SliceViewer/New_features/000000.rst

@@ -0,0 +1 @@
+- Added a masking feature to Sliceviewer for axis with a non-numerical y axis. This enables direct application of the mask to the underlying workspace, or the outputting of a table workspace that can be applied subsequently using ``MaskFromTableWorkspace``.

qt/python/mantidqt/mantidqt/widgets/regionselector/presenter.py

@@ -258,3 +258,21 @@ def get_extra_image_info_columns(self, xdata, ydata):
 
     def is_integer_frame(self):
         return False, False
+
+    def masking(self, active):
+        pass
+
+    def rect_masking_clicked(self, active):
+        pass
+
+    def elli_masking_clicked(self, active):
+        pass
+
+    def poly_masking_clicked(self, active):
+        pass
+
+    def export_masking_clicked(self):
+        pass
+
+    def apply_masking_clicked(self):
+        pass

qt/python/mantidqt/mantidqt/widgets/regionselector/test/test_regionselector_presenter.py

@@ -10,6 +10,7 @@
 
 from mantidqt.widgets.regionselector.presenter import RegionSelector
 from mantidqt.widgets.sliceviewer.models.workspaceinfo import WS_TYPE
+from mantid.api import MatrixWorkspace
 
 
 class RegionSelectorTest(unittest.TestCase):
@@ -24,10 +25,10 @@ def tearDown(self) -> None:
         self._ws_info_patcher.stop()
 
     def test_matrix_workspaces_allowed(self):
-        self.assertIsNotNone(RegionSelector(Mock(), view=Mock()))
+        self.assertIsNotNone(RegionSelector(ws=Mock(spec=MatrixWorkspace), view=Mock()))
 
     def test_show_all_data_not_called_on_creation(self):
-        region_selector = RegionSelector(ws=Mock(), view=Mock())
+        region_selector = RegionSelector(ws=Mock(spec=MatrixWorkspace), view=Mock())
         region_selector.show_all_data_clicked = Mock()
 
         region_selector.show_all_data_clicked.assert_not_called()
@@ -49,15 +50,15 @@ def test_creation_without_workspace(self):
     def test_update_workspace_updates_model(self):
         region_selector = RegionSelector(view=Mock())
         region_selector.show_all_data_clicked = Mock()
-        mock_ws = Mock()
+        mock_ws = Mock(spec=MatrixWorkspace)
 
         region_selector.update_workspace(mock_ws)
 
         self.assertEqual(mock_ws, region_selector.model.ws)
 
     def test_update_workspace_with_invalid_workspaces_fails(self):
         invalid_types = [WS_TYPE.MDH, WS_TYPE.MDE, None]
-        mock_ws = Mock()
+        mock_ws = Mock(spec=MatrixWorkspace)
         region_selector = RegionSelector(view=Mock())
 
         for ws_type in invalid_types:
@@ -69,15 +70,15 @@ def test_update_workspace_updates_view(self):
         mock_view = Mock()
         region_selector = RegionSelector(view=mock_view)
         region_selector.show_all_data_clicked = Mock()
-        mock_ws = Mock()
+        mock_ws = Mock(spec=MatrixWorkspace)
 
         region_selector.update_workspace(mock_ws)
 
         mock_view.set_workspace.assert_called_once_with(mock_ws)
         region_selector.show_all_data_clicked.assert_called_once()
 
     def test_add_rectangular_region_creates_selector(self):
-        region_selector = RegionSelector(ws=Mock(), view=self.mock_view)
+        region_selector = RegionSelector(ws=Mock(spec=MatrixWorkspace), view=self.mock_view)
 
         region_selector.add_rectangular_region("test", "black", "/")
 
@@ -86,7 +87,7 @@ def test_add_rectangular_region_creates_selector(self):
         self.assertEqual("test", region_selector._selectors[0].region_type())
 
     def test_add_second_rectangular_region_deactivates_first_selector(self):
-        region_selector = RegionSelector(ws=Mock(), view=self.mock_view)
+        region_selector = RegionSelector(ws=Mock(spec=MatrixWorkspace), view=self.mock_view)
 
         region_selector.add_rectangular_region("test", "black", "/")
         region_selector._drawing_region = False
@@ -100,7 +101,7 @@ def test_add_second_rectangular_region_deactivates_first_selector(self):
     def test_clear_workspace_will_clear_all_the_selectors_and_model_workspace(self):
         region_selector = RegionSelector(view=self.mock_view)
         region_selector.show_all_data_clicked = Mock()
-        mock_ws = Mock()
+        mock_ws = Mock(spec=MatrixWorkspace)
 
         region_selector.update_workspace(mock_ws)
         region_selector.add_rectangular_region("test", "black", "/")
@@ -176,7 +177,7 @@ def test_canvas_clicked_sets_only_one_selector_active_if_multiple_contain_point(
         selector_two.set_active.assert_called_once_with(False)
 
     def test_delete_key_pressed_will_do_nothing_if_no_selectors_exist(self):
-        region_selector = RegionSelector(ws=Mock(), view=Mock())
+        region_selector = RegionSelector(ws=Mock(spec=MatrixWorkspace), view=Mock())
 
         event = Mock()
         event.key = "delete"
@@ -228,7 +229,7 @@ def test_delete_key_pressed_will_notify_region_changed(self):
         mock_observer.notifyRegionChanged.assert_called_once()
 
     def test_mouse_moved_will_not_set_override_cursor_if_no_selectors_exist(self):
-        region_selector = RegionSelector(ws=Mock(), view=Mock())
+        region_selector = RegionSelector(ws=Mock(spec=MatrixWorkspace), view=Mock())
         region_selector.view.set_override_cursor = Mock()
 
         event = Mock()
@@ -275,7 +276,7 @@ def test_mouse_moved_will_set_override_cursor_if_hovering_over_active_selector(s
         region_selector.view.set_override_cursor.assert_called_once_with(True)
 
     def test_on_rectangle_selected_notifies_observer(self):
-        region_selector = RegionSelector(ws=Mock(), view=self.mock_view)
+        region_selector = RegionSelector(ws=Mock(spec=MatrixWorkspace), view=self.mock_view)
         mock_observer = Mock()
         region_selector.subscribe(mock_observer)
 
@@ -285,15 +286,15 @@ def test_on_rectangle_selected_notifies_observer(self):
         mock_observer.notifyRegionChanged.assert_called_once()
 
     def test_cancel_drawing_region_will_remove_last_selector(self):
-        region_selector = RegionSelector(ws=Mock(), view=self.mock_view)
+        region_selector = RegionSelector(ws=Mock(spec=MatrixWorkspace), view=self.mock_view)
         region_selector.add_rectangular_region("test", "black", "/")
         self.assertEqual(1, len(region_selector._selectors))
         region_selector.cancel_drawing_region()
         self.assertEqual(0, len(region_selector._selectors))
 
     def test_when_multiple_region_adds_are_requested_only_one_region_is_added(self):
         # Given
-        region_selector = RegionSelector(ws=Mock(), view=self.mock_view)
+        region_selector = RegionSelector(ws=Mock(spec=MatrixWorkspace), view=self.mock_view)
         region_selector.add_rectangular_region("test", "black", "/")
         self.assertEqual(1, len(region_selector._selectors))
 
@@ -305,11 +306,11 @@ def test_when_multiple_region_adds_are_requested_only_one_region_is_added(self):
         self.assertEqual(region_selector._selectors[0]._region_type, "test2")
 
     def test_cancel_drawing_region_with_no_selectors_does_not_crash(self):
-        region_selector = RegionSelector(ws=Mock(), view=Mock())
+        region_selector = RegionSelector(ws=Mock(spec=MatrixWorkspace), view=Mock())
         region_selector.cancel_drawing_region()
 
     def test_display_rectangular_region_creates_selector(self):
-        region_selector = RegionSelector(ws=Mock(), view=self._mock_view_with_axes_limits((2000, 10000), (0, 500)))
+        region_selector = RegionSelector(ws=Mock(spec=MatrixWorkspace), view=self._mock_view_with_axes_limits((2000, 10000), (0, 500)))
         # The expected extents should be within the axes x and y limits
         expected_extents = (4000, 6000, 100, 300)
         region_type = "test"
@@ -321,22 +322,22 @@ def test_display_rectangular_region_creates_selector(self):
 
     def test_display_rectangular_region_y1_out_of_bounds_does_not_add_selector(self):
         y_limits = (200, 500)
-        region_selector = RegionSelector(ws=Mock(), view=self._mock_view_with_axes_limits((2000, 10000), y_limits))
+        region_selector = RegionSelector(ws=Mock(spec=MatrixWorkspace), view=self._mock_view_with_axes_limits((2000, 10000), y_limits))
 
         region_selector.display_rectangular_region("test", "black", "/", y_limits[0] - 50, y_limits[1])
 
         self.assertEqual(0, len(region_selector._selectors))
 
     def test_display_rectangular_region_y2_out_of_bounds_does_not_add_selector(self):
         y_limits = (200, 500)
-        region_selector = RegionSelector(ws=Mock(), view=self._mock_view_with_axes_limits((2000, 10000), y_limits))
+        region_selector = RegionSelector(ws=Mock(spec=MatrixWorkspace), view=self._mock_view_with_axes_limits((2000, 10000), y_limits))
 
         region_selector.display_rectangular_region("test", "black", "/", y_limits[0], y_limits[1] + 50)
 
         self.assertEqual(0, len(region_selector._selectors))
 
     def test_display_rectangular_region_does_not_add_duplicate_selector(self):
-        region_selector = RegionSelector(ws=Mock(), view=self._mock_view_with_axes_limits((2000, 10000), (0, 500)))
+        region_selector = RegionSelector(ws=Mock(spec=MatrixWorkspace), view=self._mock_view_with_axes_limits((2000, 10000), (0, 500)))
         # The expected extents should be within the axes x and y limits
         expected_extents = (4000, 6000, 100, 300)
         region_type = "test"
@@ -351,7 +352,7 @@ def test_display_rectangular_region_does_not_add_duplicate_selector(self):
         self._check_rectangular_region(region_selector._selectors[0], region_type, expected_extents)
 
     def test_display_rectangular_region_adds_second_different_selector(self):
-        region_selector = RegionSelector(ws=Mock(), view=self._mock_view_with_axes_limits((2000, 10000), (0, 500)))
+        region_selector = RegionSelector(ws=Mock(spec=MatrixWorkspace), view=self._mock_view_with_axes_limits((2000, 10000), (0, 500)))
         # The expected extents should be within the axes x and y limits
         expected_x_values = (4000, 6000)
         first_y_values = (100, 200)
@@ -376,7 +377,7 @@ def _mock_selectors(selector_one_type="signal", selector_two_type="signal"):
         selector_one.extents = [1, 2, 3, 4]
         selector_two.extents = [5, 6, 7, 8]
 
-        region_selector = RegionSelector(ws=Mock(), view=Mock())
+        region_selector = RegionSelector(ws=Mock(spec=MatrixWorkspace), view=Mock())
         region_selector._selectors.append(selector_one)
         region_selector._selectors.append(selector_two)