GroupingWorkspace.cpp

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 +
#include <utility>
 
#include "MantidAPI/SpectraAxis.h"
#include "MantidAPI/WorkspaceFactory.h"
#include "MantidDataObjects/GroupingWorkspace.h"
 
#include "MantidKernel/IPropertyManager.h"
 
using std::size_t;
using namespace Mantid::API;
 
namespace Mantid::DataObjects {
namespace {
const int UNSET_GROUP{-1};
}
// Register the workspace
DECLARE_WORKSPACE(GroupingWorkspace)
 
 
GroupingWorkspace::GroupingWorkspace(size_t numvectors) { this->init(numvectors, 1, 1); }
 
//----------------------------------------------------------------------------------------------
GroupingWorkspace::GroupingWorkspace(const Geometry::Instrument_const_sptr &inst) : SpecialWorkspace2D(inst) {}
 
//----------------------------------------------------------------------------------------------
 
int GroupingWorkspace::translateToGroupID(const int n) const {
  if (n == 0)
    return UNSET_GROUP;
  else
    return n;
}
 
void GroupingWorkspace::makeDetectorIDToGroupMap(std::map<detid_t, int> &detIDToGroup, int64_t &ngroups) const {
  ngroups = 0;
  for (size_t wi = 0; wi < getNumberHistograms(); ++wi) {
    // Convert the Y value to a group number
    auto group = this->translateToGroupID(static_cast<int>(this->readY(wi)[0]));
    auto detIDs = this->getDetectorIDs(wi);
    for (auto detID : detIDs) {
      detIDToGroup[detID] = group;
      if (group > ngroups)
        ngroups = group;
    }
  }
}
 
void GroupingWorkspace::makeDetectorIDToGroupVector(std::vector<int> &detIDToGroup, int64_t &ngroups) const {
  ngroups = 0;
  for (size_t wi = 0; wi < getNumberHistograms(); ++wi) {
    // Convert the Y value to a group number
    auto group = this->translateToGroupID(static_cast<int>(this->y(wi).front()));
    auto detIDs = this->getDetectorIDs(wi);
    for (auto detID : detIDs) {
      // if you need negative detector ids, use the other function
      if (detID < 0)
        continue;
      if (detIDToGroup.size() < static_cast<size_t>(detID + 1))
        detIDToGroup.resize(detID + 1);
      detIDToGroup[detID] = group;
      if (group > ngroups)
        ngroups = group;
    }
  }
}
 
std::vector<int> GroupingWorkspace::getGroupIDs(const bool includeUnsetGroup) const {
  // collect all the group numbers
  std::set<int> groupIDs;
  for (size_t wi = 0; wi < getNumberHistograms(); ++wi) {
    // Convert the Y value to a group number
    auto group = this->translateToGroupID(static_cast<int>(this->y(wi).front()));
    if (!includeUnsetGroup && group == UNSET_GROUP)
      continue;
    groupIDs.insert(group);
  }
  std::vector<int> output(groupIDs.begin(), groupIDs.end());
  return output;
}
 
int GroupingWorkspace::getTotalGroups() const {
  // count distinct group numbers
  std::vector<int> groups = this->getGroupIDs();
  return static_cast<int>(groups.size());
}
 
std::vector<detid_t> GroupingWorkspace::getDetectorIDsOfGroup(const int groupID) const {
  std::vector<detid_t> detectorIDs;
  for (size_t wi = 0; wi < getNumberHistograms(); ++wi) {
    // Convert the Y value to a group number
    const auto group = this->translateToGroupID(static_cast<int>(this->y(wi).front()));
    if (group == groupID) {
      // if the instrument isn't set no detector ids exist
      const auto detIDs = this->getDetectorIDs(wi);
      std::transform(detIDs.cbegin(), detIDs.cend(), std::back_inserter(detectorIDs),
                     [](const auto &detID) { return static_cast<int>(detID); });
    }
  }
  return detectorIDs;
}
 
} // namespace Mantid::DataObjects
 
 
namespace Mantid::Kernel {
 
template <>
DLLExport Mantid::DataObjects::GroupingWorkspace_sptr
IPropertyManager::getValue<Mantid::DataObjects::GroupingWorkspace_sptr>(const std::string &name) const {
  auto *prop =
      dynamic_cast<PropertyWithValue<Mantid::DataObjects::GroupingWorkspace_sptr> *>(getPointerToProperty(name));
  if (prop) {
    return *prop;
  } else {
    std::string message =
        "Attempt to assign property " + name + " to incorrect type. Expected shared_ptr<GroupingWorkspace>.";
    throw std::runtime_error(message);
  }
}
 
template <>
DLLExport Mantid::DataObjects::GroupingWorkspace_const_sptr
IPropertyManager::getValue<Mantid::DataObjects::GroupingWorkspace_const_sptr>(const std::string &name) const {
  auto const *prop =
      dynamic_cast<PropertyWithValue<Mantid::DataObjects::GroupingWorkspace_sptr> *>(getPointerToProperty(name));
  if (prop) {
    return prop->operator()();
  } else {
    std::string message =
        "Attempt to assign property " + name + " to incorrect type. Expected const shared_ptr<GroupingWorkspace>.";
    throw std::runtime_error(message);
  }
}
 
} // namespace Mantid::Kernel