SpectrumAlgorithm.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 "MantidAlgorithms/SpectrumAlgorithm.h"
 
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidKernel/ArrayProperty.h"
#include "MantidKernel/BoundedValidator.h"
 
using namespace Mantid;
using namespace Algorithms;
 
void SpectrumAlgorithm::declareWorkspaceIndexSetProperties(const std::string &indexMinPropertyName,
                                                           const std::string &indexMaxPropertyName,
                                                           const std::string &indexRangePropertyName) {
  m_indexMinPropertyName = indexMinPropertyName;
  m_indexMaxPropertyName = indexMaxPropertyName;
  m_indexRangePropertyName = indexRangePropertyName;
  auto mustBePositive = std::make_shared<Kernel::BoundedValidator<int>>();
  mustBePositive->setLower(0);
  // TODO: The names and descriptions of these properties are temporary and for
  // now follow the old naming from the algorithm ChangeBinOffset, to not break
  // its interface. This will be changed once a decision on a generic and
  // uniform interface has been made. We keep it for now, to avoid breaking that
  // algorithms interface twice.
  declareProperty(m_indexMinPropertyName, 0, mustBePositive, "The first Workspace index to be included in the summing");
  declareProperty(m_indexMaxPropertyName, EMPTY_INT(), mustBePositive,
                  "The last Workspace index to be included in the summing");
 
  declareProperty(std::make_unique<Kernel::ArrayProperty<size_t>>(m_indexRangePropertyName),
                  "A list of workspace indices as a string with ranges, for "
                  "example: 5-10,15,20-23. \n"
                  "Optional: if not specified, then the "
                  "Start/EndWorkspaceIndex fields are used alone. "
                  "If specified, the range and the list are combined (without "
                  "duplicating indices). For example, a range of 10 to 20 and "
                  "a list '12,15,26,28' gives '10-20,26,28'.");
}
 
Kernel::IndexSet SpectrumAlgorithm::getWorkspaceIndexSet(const API::MatrixWorkspace &workspace) const {
  auto numberOfSpectra = workspace.getNumberHistograms();
 
  if (!existsProperty(m_indexMinPropertyName))
    return {numberOfSpectra};
 
  int min = getProperty(m_indexMinPropertyName);
  int max = getProperty(m_indexMaxPropertyName);
  std::vector<size_t> indices_list = getProperty(m_indexRangePropertyName);
 
  if (indices_list.empty()) {
    if (isEmpty(max))
      return {numberOfSpectra};
    else
      return {min, max, numberOfSpectra};
  }
 
  // Add range to index list if given.
  if (!isEmpty(max)) {
    for (int i = min; i <= max; i++)
      indices_list.emplace_back(i);
  }
  return {indices_list, numberOfSpectra};
}
 
template <> void SpectrumAlgorithm::ifEventWorkspaceClearMRU(const DataObjects::EventWorkspace &workspace) {
  workspace.clearMRU();
}