Add table view for group peak workspace (#37166)

* Add group peak workspaces model

* Add show data to group peak workspaces

* Add group presenter and table model

* Add support for sorting, deleting, plotting, stats, and batch loading

* Add group model unit tests

* Add group table model unit tests

* Add group presenter unit tests

* Add release note

Author: MohamedAlmaki

Framework/API/inc/MantidAPI/WorkspaceGroup.h

@@ -69,8 +69,10 @@ class MANTID_API_DLL WorkspaceGroup : public Workspace {
   /// This method returns true if the group is empty (no member workspace)
   bool isEmpty() const;
   bool areNamesSimilar() const;
-  /// Inidicates that the workspace group can be treated as multiperiod.
+  /// Indicates that the workspace group can be treated as multiperiod.
   bool isMultiperiod() const;
+  /// Check if the workspace group contains just peak workspaces
+  bool isGroupPeaksWorkspaces() const;
   /// Check if a workspace is included in this group or any nested groups.
   bool isInGroup(const Workspace &workspaceToCheck, size_t level = 0) const;
   /// Prints the group to the screen using the logger at debug

Framework/API/src/WorkspaceGroup.cpp

@@ -6,6 +6,7 @@
 // SPDX - License - Identifier: GPL - 3.0 +
 #include "MantidAPI/WorkspaceGroup.h"
 #include "MantidAPI/AnalysisDataService.h"
+#include "MantidAPI/IPeaksWorkspace.h"
 #include "MantidAPI/MatrixWorkspace.h"
 #include "MantidAPI/Run.h"
 #include "MantidKernel/IPropertyManager.h"
@@ -455,6 +456,14 @@ bool WorkspaceGroup::isMultiperiod() const {
   return true;
 }
 
+/**
+ * @return :: True if all of the workspaces in the group are peak workspaces
+ */
+bool WorkspaceGroup::isGroupPeaksWorkspaces() const {
+  return std::all_of(m_workspaces.begin(), m_workspaces.end(),
+                     [](auto ws) { return dynamic_cast<IPeaksWorkspace *>(ws.get()) != nullptr; });
+}
+
 /**
  * @param workspaceToCheck :: A workspace to check.
  * @param level :: The current nesting level. Intended for internal use only
@@ -471,7 +480,7 @@ bool WorkspaceGroup::isInGroup(const Workspace &workspaceToCheck, size_t level)
   for (const auto &workspace : m_workspaces) {
     if (workspace.get() == &workspaceToCheck)
       return true;
-    auto *group = dynamic_cast<WorkspaceGroup *>(workspace.get());
+    const auto *group = dynamic_cast<WorkspaceGroup *>(workspace.get());
     if (group) {
       if (group->isInGroup(workspaceToCheck, level + 1))
         return true;
@@ -503,7 +512,7 @@ namespace Mantid::Kernel {
 template <>
 MANTID_API_DLL Mantid::API::WorkspaceGroup_sptr
 IPropertyManager::getValue<Mantid::API::WorkspaceGroup_sptr>(const std::string &name) const {
-  auto *prop = dynamic_cast<PropertyWithValue<Mantid::API::WorkspaceGroup_sptr> *>(getPointerToProperty(name));
+  const auto *prop = dynamic_cast<PropertyWithValue<Mantid::API::WorkspaceGroup_sptr> *>(getPointerToProperty(name));
   if (prop) {
     return *prop;
   } else {
@@ -516,7 +525,7 @@ IPropertyManager::getValue<Mantid::API::WorkspaceGroup_sptr>(const std::string &
 template <>
 MANTID_API_DLL Mantid::API::WorkspaceGroup_const_sptr
 IPropertyManager::getValue<Mantid::API::WorkspaceGroup_const_sptr>(const std::string &name) const {
-  auto *prop = dynamic_cast<PropertyWithValue<Mantid::API::WorkspaceGroup_sptr> *>(getPointerToProperty(name));
+  const auto *prop = dynamic_cast<PropertyWithValue<Mantid::API::WorkspaceGroup_sptr> *>(getPointerToProperty(name));
   if (prop) {
     return prop->operator()();
   } else {

Framework/PythonInterface/mantid/api/src/Exports/AnalysisDataService.cpp

@@ -5,6 +5,8 @@
 //   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
 // SPDX - License - Identifier: GPL - 3.0 +
 #include "MantidAPI/AnalysisDataService.h"
+#include "MantidAPI/IPeaksWorkspace.h"
+#include "MantidAPI/WorkspaceGroup.h"
 #include "MantidKernel/WarningSuppressions.h"
 #include "MantidPythonInterface/core/Converters/PySequenceToVector.h"
 #include "MantidPythonInterface/core/Converters/ToPyList.h"
@@ -67,6 +69,28 @@ list retrieveWorkspaces(AnalysisDataServiceImpl const *const self, const list &n
   return Converters::ToPyList<WeakPtr>()(wsWeakPtrs);
 }
 
+list retrieveGroupPeaksWorkspaces(AnalysisDataServiceImpl const *const self, const list &names) {
+  using WeakPtr = std::weak_ptr<Workspace>;
+
+  auto wsSharedPtrs = self->retrieveWorkspaces(Converters::PySequenceToVector<std::string>(names)(), false);
+
+  auto isNotGroupPeakWorkspace = [](const Workspace_sptr &wksp) {
+    if (auto gws = dynamic_cast<WorkspaceGroup *>(wksp.get())) {
+      return !gws->isGroupPeaksWorkspaces();
+    }
+    return true;
+  };
+  auto end = std::remove_if(wsSharedPtrs.begin(), wsSharedPtrs.end(), isNotGroupPeakWorkspace);
+  wsSharedPtrs.erase(end, wsSharedPtrs.end());
+
+  std::vector<WeakPtr> wsWeakPtrs;
+  wsWeakPtrs.reserve(wsSharedPtrs.size());
+  std::transform(wsSharedPtrs.cbegin(), wsSharedPtrs.cend(), std::back_inserter(wsWeakPtrs),
+                 [](const Workspace_sptr &wksp) -> WeakPtr { return WeakPtr(wksp); });
+
+  return Converters::ToPyList<WeakPtr>()(wsWeakPtrs);
+}
+
 GNU_DIAG_OFF("unused-local-typedef")
 // Ignore -Wconversion warnings coming from boost::python
 // Seen with GCC 7.1.1 and Boost 1.63.0
@@ -86,6 +110,7 @@ void export_AnalysisDataService() {
       .def("retrieveWorkspaces", retrieveWorkspaces,
            AdsRetrieveWorkspacesOverloads("Retrieve a list of workspaces by name",
                                           (arg("self"), arg("names"), arg("unrollGroups") = false)))
+      .def("retrieveGroupPeaksWorkspaces", retrieveGroupPeaksWorkspaces, (arg("self"), arg("names")))
       .def("addToGroup", &AnalysisDataServiceImpl::addToGroup, (arg("groupName"), arg("wsName")),
            "Add a workspace in the ADS to a group in the ADS")
       .def("removeFromGroup", &AnalysisDataServiceImpl::removeFromGroup, (arg("groupName"), arg("wsName")),

buildconfig/CMake/CppCheck_Suppressions.txt.in

@@ -395,12 +395,10 @@ constVariablePointer:${CMAKE_SOURCE_DIR}/Framework/API/src/MultiPeriodGroupWorke
 constVariablePointer:${CMAKE_SOURCE_DIR}/Framework/API/src/MultiPeriodGroupWorker.cpp:261
 constVariablePointer:${CMAKE_SOURCE_DIR}/Framework/API/src/MultiPeriodGroupWorker.cpp:268
 constVariableReference:${CMAKE_SOURCE_DIR}/Framework/Crystal/src/CalculateUMatrix.cpp:65
-constVariablePointer:${CMAKE_SOURCE_DIR}/Framework/API/src/WorkspaceGroup.cpp:78
-constVariablePointer:${CMAKE_SOURCE_DIR}/Framework/API/src/WorkspaceGroup.cpp:437
-constVariablePointer:${CMAKE_SOURCE_DIR}/Framework/API/src/WorkspaceGroup.cpp:474
-constVariablePointer:${CMAKE_SOURCE_DIR}/Framework/API/src/WorkspaceGroup.cpp:519
-useStlAlgorithm:${CMAKE_SOURCE_DIR}/Framework/API/src/WorkspaceGroup.cpp:125
-useStlAlgorithm:${CMAKE_SOURCE_DIR}/Framework/API/src/WorkspaceGroup.cpp:406
+constVariablePointer:${CMAKE_SOURCE_DIR}/Framework/API/src/WorkspaceGroup.cpp:79
+constVariablePointer:${CMAKE_SOURCE_DIR}/Framework/API/src/WorkspaceGroup.cpp:438
+useStlAlgorithm:${CMAKE_SOURCE_DIR}/Framework/API/src/WorkspaceGroup.cpp:126
+useStlAlgorithm:${CMAKE_SOURCE_DIR}/Framework/API/src/WorkspaceGroup.cpp:407
 shadowFunction:${CMAKE_SOURCE_DIR}/Framework/API/src/IFunction.cpp:263
 shadowFunction:${CMAKE_SOURCE_DIR}/Framework/API/src/IFunction.cpp:313
 shadowFunction:${CMAKE_SOURCE_DIR}/Framework/API/src/IFunction.cpp:325

docs/source/release/v6.12.0/Diffraction/Single_Crystal/New_features/37166.rst

@@ -0,0 +1 @@
+- Added table view for group peaks workspaces, displaying group indices alongside standard peak data, with all the capabilities of a standard table view.

qt/applications/workbench/workbench/plugins/workspacewidget.py

@@ -295,6 +295,19 @@ def _do_show_data(self, names):
         import matplotlib.pyplot
 
         parent, flags = get_window_config()
+        # Process group peak workspaces first and remove them from the list
+        for ws in self._ads.retrieveGroupPeaksWorkspaces(names):
+            try:
+                TableWorkspaceDisplay.supports(ws)
+                presenter = TableWorkspaceDisplay(ws, plot=matplotlib.pyplot, parent=parent, window_flags=flags, group=True)
+                presenter.show_view()
+                names.remove(ws.name())
+            except ValueError as e:
+                logger.error(str(e))
+                logger.error(
+                    "Could not open workspace: {0} with neither " "MatrixWorkspaceDisplay nor TableWorkspaceDisplay." "".format(ws.name())
+                )
+
         for ws in self._ads.retrieveWorkspaces(names, unrollGroups=True):
             try:
                 MatrixWorkspaceDisplay.supports(ws)

qt/python/mantidqt/CMakeLists.txt

@@ -168,6 +168,9 @@ set(PYTHON_WIDGET_QT5_ONLY_TESTS
     mantidqt/widgets/workspacedisplay/matrix/test/test_matrixworkspacedisplay_view.py
     mantidqt/widgets/workspacedisplay/matrix/test/test_matrixworkspacedisplay_io.py
     mantidqt/widgets/workspacedisplay/table/test/test_tableworkspacedisplay_error_column.py
+    mantidqt/widgets/workspacedisplay/table/test/test_tableworkspacedisplay_group_model.py
+    mantidqt/widgets/workspacedisplay/table/test/test_tableworkspacedisplay_group_table_model.py
+    mantidqt/widgets/workspacedisplay/table/test/test_tableworkspacedisplay_group_presenter.py
     mantidqt/widgets/workspacedisplay/table/test/test_tableworkspacedisplay_marked_columns.py
     mantidqt/widgets/workspacedisplay/table/test/test_tableworkspacedisplay_tableworkspace_item.py
     mantidqt/widgets/workspacedisplay/table/test/test_tableworkspacedisplay_model.py

qt/python/mantidqt/mantidqt/utils/testing/mocks/mock_mantid.py

@@ -66,7 +66,7 @@ class MockWorkspace:
     def _return_MockSpectrumInfo():
         return MockSpectrumInfo()
 
-    def __init__(self, read_return=None, axes=2, isHistogramData=True):
+    def __init__(self, read_return=None, axes=2, isHistogramData=True, name=TEST_NAME):
         if read_return is None:
             read_return = [1, 2, 3, 4, 5]
         # This is assigned to a function, as the original implementation is a function that returns
@@ -96,7 +96,7 @@ def __init__(self, read_return=None, axes=2, isHistogramData=True):
 
         self.setCell = StrictMock()
 
-        self.name = StrictMock(return_value=self.TEST_NAME)
+        self.name = StrictMock(return_value=name)
 
         self._column_names = []
         for i in range(self.COLS):
@@ -119,3 +119,59 @@ def __init__(self, read_return=None, axes=2, isHistogramData=True):
         self.getLinkedYCol = StrictMock()
 
         self.hasDx = lambda x: x < len(read_return)
+
+    def __len__(self):
+        return self.row_count
+
+
+class MockWorkspaceGroup:
+    def __init__(self, name=None, workspaces=None):
+        super().__init__()
+        self._workspaces = workspaces if workspaces is not None else []
+        self._name = name
+
+        # Override id from parent
+        self.id = StrictMock(return_value="WorkspaceGroup")
+
+        # Group-specific methods
+        self.name = StrictMock(return_value=self._name)
+        self.toString = StrictMock(return_value="MockWorkspaceGroup")
+        self.getMemorySize = StrictMock(return_value=1000)
+        self.sortMembersByName = StrictMock()
+        self.addWorkspace = StrictMock()
+        self.getNumberOfEntries = StrictMock(return_value=len(self._workspaces))
+        self.getItem = StrictMock()
+        self.getAllItems = StrictMock(return_value=self._workspaces)
+        self.removeItem = StrictMock()
+        self.removeAll = StrictMock()
+        self.isEmpty = StrictMock(return_value=len(self._workspaces) == 0)
+        self.areNamesSimilar = StrictMock(return_value=True)
+        self.isMultiperiod = StrictMock(return_value=True)
+        self.isGroupPeaksWorkspaces = StrictMock(return_value=False)
+        self.isInGroup = StrictMock(return_value=False)
+        self.print = StrictMock()
+        self.throwIndexOutOfRangeError = StrictMock()
+
+        # ADS-related methods
+        self.sortByName = StrictMock()
+        self.add = StrictMock(self._workspaces.append)
+        self.remove = StrictMock(side_effect=lambda idx: self._workspaces.pop(idx))
+        self.contains = StrictMock(side_effect=self._contains)
+        self.getNames = StrictMock(return_value=[ws.name() for ws in self._workspaces])
+
+    def _contains(self, ws_or_name) -> bool:
+        if isinstance(ws_or_name, str):
+            return any(ws.name() == ws_or_name for ws in self._workspaces)
+        return ws_or_name in self._workspaces
+
+    def __iter__(self):
+        return iter(self._workspaces)
+
+    def __getitem__(self, index):
+        return self._workspaces[index]
+
+    def append(self, value):
+        self._workspaces.append(value)
+
+    def size(self):
+        return len(self._workspaces)

qt/python/mantidqt/mantidqt/widgets/observers/ads_observer.py

@@ -31,14 +31,15 @@ def wrapper(*args, **kwargs):
 
 
 class WorkspaceDisplayADSObserver(AnalysisDataServiceObserver):
-    def __init__(self, presenter, observe_replace=True):
+    def __init__(self, presenter, observe_replace=True, observe_group_update=False):
         super(WorkspaceDisplayADSObserver, self).__init__()
         self.presenter = presenter
 
         self.observeClear(True)
         self.observeDelete(True)
         self.observeReplace(observe_replace)
         self.observeRename(True)
+        self.observeGroupUpdate(observe_group_update)
 
     @_catch_exceptions
     def clearHandle(self):
@@ -72,3 +73,7 @@ def replaceHandle(self, name, workspace):
     @_catch_exceptions
     def renameHandle(self, old_name, new_name):
         self.presenter.rename_workspace(old_name, new_name)
+
+    @_catch_exceptions
+    def groupUpdateHandle(self, ws_name, workspace):
+        self.presenter.group_update(ws_name, workspace)

qt/python/mantidqt/mantidqt/widgets/observers/observing_presenter.py

@@ -56,3 +56,6 @@ def replace_workspace(self, workspace_name, workspace):
     def rename_workspace(self, old_name, new_name):
         if self.model.workspace_equals(old_name):
             self.container.emit_rename(new_name)
+
+    def group_update(self, ws_name, workspace):
+        return