GroupingWorkspace.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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 +
#pragma once
 
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidDataObjects/DllConfig.h"
#include "MantidDataObjects/SpecialWorkspace2D.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidGeometry/IDTypes.h"
#include "MantidKernel/PropertyWithValue.h"
#include <vector>
 
namespace Mantid {
namespace DataObjects {
 
class MANTID_DATAOBJECTS_DLL GroupingWorkspace : public SpecialWorkspace2D {
public:
  GroupingWorkspace(const Geometry::Instrument_const_sptr &inst);
  GroupingWorkspace() = default;
  GroupingWorkspace(size_t numvectors);
  inline GroupingWorkspace(const std::vector<detid_t> &detids) : SpecialWorkspace2D(detids) {}
 
  GroupingWorkspace &operator=(const GroupingWorkspace &) = delete;
 
  std::unique_ptr<GroupingWorkspace> clone() const { return std::unique_ptr<GroupingWorkspace>(doClone()); }
 
  std::unique_ptr<GroupingWorkspace> cloneEmpty() const { return std::unique_ptr<GroupingWorkspace>(doCloneEmpty()); }
 
  const std::string id() const override { return "GroupingWorkspace"; }
 
  void makeDetectorIDToGroupMap(std::map<detid_t, int> &detIDToGroup, int64_t &ngroups) const;
  void makeDetectorIDToGroupVector(std::vector<int> &detIDToGroup, int64_t &ngroups) const;
  int getTotalGroups() const;
  std::vector<int> getGroupIDs(const bool includeUnsetGroup = true) const;
  std::vector<detid_t> getDetectorIDsOfGroup(const int groupID) const;
 
protected:
  GroupingWorkspace(const GroupingWorkspace &) = default;
 
private:
  int translateToGroupID(const int n) const;
  GroupingWorkspace *doClone() const override { return new GroupingWorkspace(*this); }
  GroupingWorkspace *doCloneEmpty() const override { return new GroupingWorkspace(); }
};
 
using GroupingWorkspace_sptr = std::shared_ptr<GroupingWorkspace>;
 
using GroupingWorkspace_const_sptr = std::shared_ptr<const GroupingWorkspace>;
 
} // namespace DataObjects
} // namespace Mantid
 
// Instantiated and exported by DataObjects/src/PropertyWithValue.cpp
MANTID_DATAOBJECTS_EXTERN_TEMPLATE(
    Mantid::Kernel::PropertyWithValue<std::shared_ptr<Mantid::DataObjects::GroupingWorkspace>>);
 
#ifndef DataObjects_EXPORTS
#include "MantidAPI/WorkspaceProperty.h"
namespace Mantid::API {
extern template class MANTID_DATAOBJECTS_DLL WorkspaceProperty<DataObjects::GroupingWorkspace>;
} // namespace Mantid::API
#endif