SumSpectra.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/SumSpectra.h"
#include "MantidAPI/CommonBinsValidator.h"
#include "MantidAPI/Run.h"
#include "MantidAPI/SpectrumInfo.h"
#include "MantidAPI/WorkspaceFactory.h"
#include "MantidAPI/WorkspaceGroup.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidDataObjects/RebinnedOutput.h"
#include "MantidDataObjects/WorkspaceCreation.h"
#include "MantidGeometry/IDetector.h"
#include "MantidKernel/ArrayProperty.h"
#include "MantidKernel/BoundedValidator.h"
#include "MantidKernel/EnabledWhenProperty.h"
 
#include <functional>
 
namespace Mantid::Algorithms {
 
// Register the class into the algorithm factory
DECLARE_ALGORITHM(SumSpectra)
 
using namespace Kernel;
using namespace API;
using namespace DataObjects;
 
namespace {
bool validateSingleMatrixWorkspace(std::map<std::string, std::string> &validationOutput, const MatrixWorkspace &ws,
                                   const int minIndex, const int maxIndex, const std::vector<int> &indices) {
  bool success(true);
  const auto numSpectra = static_cast<int>(ws.getNumberHistograms());
  // check StartWorkSpaceIndex,  >=0 done by validator
  if (minIndex >= numSpectra) {
    validationOutput["StartWorkspaceIndex"] = "Selected minimum workspace index is greater than available "
                                              "spectra.";
    success = false;
  }
  // check EndWorkspaceIndex in range
  if (maxIndex != EMPTY_INT()) {
    // check EndWorkspaceIndex in range
    if (maxIndex >= numSpectra) {
      validationOutput["EndWorkspaceIndex"] = "Selected maximum workspace index is greater than available "
                                              "spectra.";
      success = false;
      // check StartWorkspaceIndex < EndWorkspaceIndex
    }
  }
  // check ListOfWorkspaceIndices in range
  if (std::any_of(indices.cbegin(), indices.cend(),
                  [numSpectra](const auto index) { return (index >= numSpectra) || (index < 0); })) {
    validationOutput["ListOfWorkspaceIndices"] = "One or more indices out of range of available spectra.";
    success = false;
  }
  return success;
}
 
void validateWorkspaceName(std::map<std::string, std::string> &validationOutput, const std::string &name,
                           const int minIndex, const int maxIndex, const std::vector<int> &indices) {
  const auto &ads = AnalysisDataService::Instance();
  if (!ads.doesExist(name))
    return;
  auto wsGroup = ads.retrieveWS<WorkspaceGroup>(name);
  if (!wsGroup)
    return;
  size_t index = 0;
  for (const auto &item : *wsGroup) {
    auto matrixWs = std::dynamic_pointer_cast<MatrixWorkspace>(item);
    if (!matrixWs) {
      validationOutput["InputWorkspace"] = "Input group contains an invalid workspace type at item " +
                                           std::to_string(index) + ". All members must be a  MatrixWorkspace";
      break;
    }
    if (!validateSingleMatrixWorkspace(validationOutput, *matrixWs, minIndex, maxIndex, indices)) {
      break;
    }
    ++index;
  }
}
} // namespace
 
void SumSpectra::init() {
  declareProperty(std::make_unique<WorkspaceProperty<>>("InputWorkspace", "", Direction::Input,
                                                        std::make_shared<CommonBinsValidator>()),
                  "The workspace containing the spectra to be summed.");
  declareProperty(std::make_unique<WorkspaceProperty<>>("OutputWorkspace", "", Direction::Output),
                  "The name of the workspace to be created as the output of the algorithm. "
                  " A workspace of this name will be created and stored in the Analysis "
                  "Data Service.");
 
  auto mustBePositive = std::make_shared<BoundedValidator<int>>();
  mustBePositive->setLower(0);
  declareProperty("StartWorkspaceIndex", 0, mustBePositive, "The first Workspace index to be included in the summing");
  declareProperty("EndWorkspaceIndex", EMPTY_INT(), mustBePositive,
                  "The last Workspace index to be included in the summing");
 
  declareProperty(std::make_unique<Kernel::ArrayProperty<int>>("ListOfWorkspaceIndices"),
                  "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'.");
 
  declareProperty("IncludeMonitors", true, "Whether to include monitor spectra in the summation.");
 
  declareProperty("WeightedSum", false,
                  "Instead of the usual spectra sum, calculate the weighted "
                  "sum. This has the form: \n"
                  ":math:`nSpectra "
                  "\\times\\Sigma(Signal_i/Error_i^2)/\\Sigma(1/Error_i^2)`\n "
                  "This property is ignored for event workspace.\n"
                  "The sums are defined for :math:`Error_i != 0` only, so the "
                  "values with zero error are dropped from the summation. To "
                  "estimate the number of dropped values see the "
                  "description. ");
 
  declareProperty("RemoveSpecialValues", false,
                  "If enabled floating point special values such as NaN or Inf"
                  " are removed before the spectra are summed.");
 
  declareProperty("MultiplyBySpectra", true,
                  "For unnormalized data one should multiply the weighted sum "
                  "by the number of spectra contributing to the bin.");
  setPropertySettings("MultiplyBySpectra", std::make_unique<EnabledWhenProperty>("WeightedSum", IS_EQUAL_TO, "1"));
 
  declareProperty("UseFractionalArea", true,
                  "Normalize the output workspace to the fractional area for "
                  "RebinnedOutput workspaces.");
}
 
/*
 * Validate the input parameters
 * @returns map with keys corresponding to properties with errors and values
 * containing the error messages.
 */
std::map<std::string, std::string> SumSpectra::validateInputs() {
  // create the map
  std::map<std::string, std::string> validationOutput;
 
  // Non-workspace checks
  const int minIndex = getProperty("StartWorkspaceIndex");
  const int maxIndex = getProperty("EndWorkspaceIndex");
  if (minIndex > maxIndex) {
    validationOutput["StartWorkspaceIndex"] = "Selected minimum workspace "
                                              "index is greater than selected "
                                              "maximum workspace index.";
    validationOutput["EndWorkspaceIndex"] = "Selected maximum workspace index "
                                            "is lower than selected minimum "
                                            "workspace index.";
  } else {
    const std::vector<int> indices = getProperty("ListOfWorkspaceIndices");
    if (MatrixWorkspace_const_sptr singleWs = getProperty("InputWorkspace")) {
      validateSingleMatrixWorkspace(validationOutput, *singleWs, minIndex, maxIndex, indices);
    } else {
      validateWorkspaceName(validationOutput, getPropertyValue("InputWorkspace"), minIndex, maxIndex, indices);
    }
  }
  return validationOutput;
}
 
namespace { // anonymous namespace
// various checks on the workspace index to see if it should be included in the
// sum if it is masked, the value of numMasked is incremented
bool useSpectrum(const SpectrumInfo &spectrumInfo, const size_t wsIndex, const bool keepMonitors, size_t &numMasked) {
  if (spectrumInfo.hasDetectors(wsIndex)) {
    // Skip monitors, if the property is set to do so
    if (!keepMonitors && spectrumInfo.isMonitor(wsIndex))
      return false;
    // Skip masked detectors
    if (spectrumInfo.isMasked(wsIndex)) {
      numMasked++;
      return false;
    }
  }
  return true;
}
} // anonymous namespace
 
void SumSpectra::exec() {
  // Try and retrieve the optional properties
  m_keepMonitors = getProperty("IncludeMonitors");
 
  // setup all of the outputs
  MatrixWorkspace_sptr outputWorkspace = nullptr;
  size_t numSpectra(0); // total number of processed spectra
  size_t numMasked(0);  // total number of the masked and skipped spectra
  size_t numZeros(0);   // number of spectra which have 0 value in the first column (used in special cases of evaluating
                        // how good Poissonian statistics is)
 
  // Get the input workspace -- ths may be a temporary workspace with the special values replaced
  MatrixWorkspace_const_sptr localworkspace = replaceSpecialValues();
  auto spectrumInfo = localworkspace->spectrumInfo();
  m_numberOfSpectra = static_cast<int>(localworkspace->getNumberHistograms());
  numMasked = determineIndices(spectrumInfo, m_numberOfSpectra);
  numSpectra = m_indices.size();
  m_yLength = localworkspace->y(*(m_indices.begin())).size();
 
  // determine the output spectrum number
  m_outSpecNum = getOutputSpecNo(localworkspace);
  g_log.information() << "Spectra remapping gives single spectra with spectra number: " << m_outSpecNum << "\n";
 
  m_calculateWeightedSum = getProperty("WeightedSum");
  m_multiplyByNumSpec = getProperty("MultiplyBySpectra");
 
  EventWorkspace_const_sptr eventW = std::dynamic_pointer_cast<const EventWorkspace>(localworkspace);
  if (eventW) {
    Progress progress(this, 0.0, 1.0, m_indices.size());
    if (m_calculateWeightedSum) {
      g_log.warning("Ignoring request for WeightedSum");
      m_calculateWeightedSum = false;
    }
    outputWorkspace = create<EventWorkspace>(*eventW, 1, eventW->binEdges(0));
 
    execEvent(outputWorkspace, progress, numZeros);
  } else {
    //-------Workspace 2D mode -----
 
    // Create the 2D workspace for the output
    outputWorkspace = API::WorkspaceFactory::Instance().create(
        localworkspace, 1, localworkspace->x(*(m_indices.begin())).size(), m_yLength);
 
    // This is the (only) output spectrum
    auto &outSpec = outputWorkspace->getSpectrum(0);
 
    // Copy over the bin boundaries
    outSpec.setSharedX(localworkspace->sharedX(0));
 
    // Build a new spectra map
    outSpec.setSpectrumNo(m_outSpecNum);
    outSpec.clearDetectorIDs();
 
    for (size_t const i : m_indices) {
      outSpec.addDetectorIDs(localworkspace->getSpectrum(i).getDetectorIDs());
    }
 
    Progress progress(this, 0.0, 1.0, m_yLength);
    if (localworkspace->id() == "RebinnedOutput") {
      // this version is for a special workspace that has fractional overlap information
      // Transform to real workspace types
      RebinnedOutput_const_sptr inWS = std::dynamic_pointer_cast<const RebinnedOutput>(localworkspace);
      RebinnedOutput_sptr outWS = std::dynamic_pointer_cast<RebinnedOutput>(outputWorkspace);
      if (m_calculateWeightedSum) {
        doFractionalWeightedSum(inWS, outWS, progress, numZeros);
      } else {
        doFractionalSum(inWS, outWS, progress, numZeros);
      }
    } else {
      // for things where all the bins are lined up
      if (m_calculateWeightedSum) {
        doSimpleWeightedSum(localworkspace, outSpec, progress, numZeros);
      } else {
        doSimpleSum(localworkspace, outSpec, progress, numZeros);
      }
    }
  }
 
  // set up the summing statistics
  outputWorkspace->mutableRun().addProperty("NumAllSpectra", int(numSpectra), "", true);
  outputWorkspace->mutableRun().addProperty("NumMaskSpectra", int(numMasked), "", true);
  outputWorkspace->mutableRun().addProperty("NumZeroSpectra", int(numZeros), "", true);
 
  // Assign it to the output workspace property
  setProperty("OutputWorkspace", outputWorkspace);
}
 
size_t SumSpectra::determineIndices(SpectrumInfo const &spectrumInfo, const size_t numberOfSpectra) {
  // assume that m_numberOfSpectra has been set
  m_indices.clear();
 
  // try the list form first
  const std::vector<int> indices_list = getProperty("ListOfWorkspaceIndices");
  m_indices.insert(indices_list.begin(), indices_list.end());
 
  // add the range specified by the user
  // this has been checked to be 0<= m_minWsInd <= maxIndex <=
  // m_numberOfSpectra where maxIndex can be an EMPTY_INT
  int minIndex = getProperty("StartWorkspaceIndex");
  int maxIndex = getProperty("EndWorkspaceIndex");
  if (isEmpty(maxIndex) && m_indices.empty()) {
    maxIndex = static_cast<int>(numberOfSpectra - 1);
  }
 
  // create the indices in the range
  size_t numMasked{0};
  if (!isEmpty(maxIndex)) {
    for (int i = minIndex; i <= maxIndex; i++) {
      // only include indices that are not masked and, if requested, are not monitors.
      // the number of masked spectra is counted in numMasked.
      if (useSpectrum(spectrumInfo, static_cast<size_t>(i), m_keepMonitors, numMasked)) {
        m_indices.insert(static_cast<size_t>(i));
      }
    }
  }
  return numMasked;
}
 
specnum_t SumSpectra::getOutputSpecNo(const MatrixWorkspace_const_sptr &localworkspace) {
  // initial value - any included spectrum will do
  specnum_t specId = localworkspace->getSpectrum(*m_indices.begin()).getSpectrumNo();
 
  // the total number of spectra
  size_t totalSpec = localworkspace->getNumberHistograms();
 
  specnum_t temp;
  for (const auto index : m_indices) {
    if (index < totalSpec) {
      temp = localworkspace->getSpectrum(index).getSpectrumNo();
      if (temp < specId)
        specId = temp;
    }
  }
 
  return specId;
}
 
API::MatrixWorkspace_sptr SumSpectra::replaceSpecialValues() {
  // Get a copy of the input workspace
  MatrixWorkspace_sptr wksp = getProperty("InputWorkspace");
  bool replaceSpecialValues = getProperty("RemoveSpecialValues");
  if (replaceSpecialValues) {
    auto alg = createChildAlgorithm("ReplaceSpecialValues");
    alg->setProperty<MatrixWorkspace_sptr>("InputWorkspace", wksp);
    std::string outName = "_" + wksp->getName() + "_clean";
    alg->setProperty("OutputWorkspace", outName);
    alg->setProperty("NaNValue", 0.0);
    alg->setProperty("NaNError", 0.0);
    alg->setProperty("InfinityValue", 0.0);
    alg->setProperty("InfinityError", 0.0);
    alg->executeAsChildAlg();
    return alg->getProperty("OutputWorkspace");
  } else {
    // Skip any additional processing
    return wksp;
  }
}
 
void SumSpectra::doSimpleSum(MatrixWorkspace_const_sptr const &inWS, ISpectrum &outSpec, Progress &progress,
                             size_t &numZeros) {
  // Get references to the output workspaces's data vectors
  auto &YSum = outSpec.mutableY();
  auto &YErrorSum = outSpec.mutableE();
 
  // Loop over bins
  for (size_t jbin = 0; jbin < m_yLength; jbin++) {
    YSum[jbin] = 0.;
    YErrorSum[jbin] = 0.;
    // add the values for this bin together using simple summation
    for (size_t iwksp : m_indices) {
      YSum[jbin] += inWS->y(iwksp)[jbin];
      YErrorSum[jbin] += inWS->e(iwksp)[jbin] * inWS->e(iwksp)[jbin];
    }
    YErrorSum[jbin] = sqrt(YErrorSum[jbin]);
    progress.report();
  }
  numZeros = 0;
}
 
void SumSpectra::doSimpleWeightedSum(MatrixWorkspace_const_sptr const &inWS, ISpectrum &outSpec, Progress &progress,
                                     size_t &numZeros) {
  // Get references to the output workspaces's data vectors
  auto &YSum = outSpec.mutableY();
  auto &YErrorSum = outSpec.mutableE();
 
  std::vector<size_t> nZeroes(YSum.size(), 0);
 
  // Loop over bins
  for (size_t jbin = 0; jbin < m_yLength; jbin++) {
    double normalization = 0.;
    YSum[jbin] = 0.;
    YErrorSum[jbin] = 0.;
    // loop over spectra
    for (size_t iwksp : m_indices) {
      double weight = 0.;
      double e = inWS->e(iwksp)[jbin];
      double y = inWS->y(iwksp)[jbin];
      if (std::isnormal(e)) {
        weight = 1. / (e * e);
      } else {
        weight = 0.;
        nZeroes[jbin]++;
      }
      normalization += weight;
      YSum[jbin] += weight * y;
    }
    // apply the normalization factor
    if (normalization != 0.) {
      normalization = 1. / normalization;
      YSum[jbin] *= normalization;
      // NOTE: the total error ends up being the root of the normalization factor
      YErrorSum[jbin] = sqrt(normalization);
    }
    if (m_multiplyByNumSpec) {
      // NOTE: do not include the zero-weighted values in the number of spectra
      YSum[jbin] *= double(m_indices.size() - nZeroes[jbin]);
      YErrorSum[jbin] *= double(m_indices.size() - nZeroes[jbin]);
    }
    progress.report();
  }
  // add up all zeros across the bins to get the total number of spectra that were dropped from the sum
  numZeros = std::accumulate(nZeroes.begin(), nZeroes.end(), size_t(0));
}
 
void SumSpectra::doFractionalSum(RebinnedOutput_const_sptr const &inWS, RebinnedOutput_sptr const &outWS,
                                 Progress &progress, size_t &numZeros) {
  // Check finalize state prior to the sum process, at the completion
  // the output is unfinalized
  auto isFinalized = inWS->isFinalized();
 
  // Get references to the output workspaces's data vectors
  auto &outSpec = outWS->getSpectrum(0);
  auto &YSum = outSpec.mutableY();
  auto &YErrorSum = outSpec.mutableE();
  auto &FracSum = outWS->dataF(0);
 
  // loop over bins
  for (size_t jbin = 0; jbin < m_yLength; jbin++) {
    YSum[jbin] = 0.;
    YErrorSum[jbin] = 0.;
    FracSum[jbin] = 0.;
    // loop over spectra
    for (size_t iwksp : m_indices) {
      // use the mappin y' --> y * fracVal and e' --> e * fracVal where fracVal is the fractional area for this bin
      double fracVal = (isFinalized ? inWS->readF(iwksp)[jbin] : 1.0);
      double y = inWS->y(iwksp)[jbin] * fracVal;
      double e = inWS->e(iwksp)[jbin] * fracVal;
      // no do simple sum of the mapped values
      YSum[jbin] += y;
      YErrorSum[jbin] += e * e;
      FracSum[jbin] += inWS->readF(iwksp)[jbin];
    }
    YErrorSum[jbin] = sqrt(YErrorSum[jbin]);
    progress.report();
  }
 
  numZeros = 0;
 
  // Create the correct representation if using fractional area
  auto useFractionalArea = getProperty("UseFractionalArea");
  if (useFractionalArea) {
    outWS->finalize(/*hasSqrdErrs =*/false);
  }
}
 
void SumSpectra::doFractionalWeightedSum(RebinnedOutput_const_sptr const &inWS, RebinnedOutput_sptr const &outWS,
                                         Progress &progress, size_t &numZeros) {
  // Check finalize state prior to the sum process, at the completion
  // the output is unfinalized
  auto isFinalized = inWS->isFinalized();
 
  // Get references to the output workspaces's data vectors
  auto &outSpec = outWS->getSpectrum(0);
  auto &YSum = outSpec.mutableY();
  auto &YErrorSum = outSpec.mutableE();
  auto &FracSum = outWS->dataF(0);
 
  std::vector<size_t> nZeroes(YSum.size(), 0);
 
  // Loop over bins
  for (size_t jbin = 0; jbin < m_yLength; jbin++) {
    YSum[jbin] = 0.;
    YErrorSum[jbin] = 0.;
    FracSum[jbin] = 0.;
    double normalization = 0.;
    // loop over spectra
    for (size_t iwksp : m_indices) {
      // use the mappin y' --> y * fracVal and e' --> e * fracVal where fracVal is the fractional area for this bin
      double fracVal = (isFinalized ? inWS->readF(iwksp)[jbin] : 1.0);
      double y = inWS->y(iwksp)[jbin] * fracVal;
      double e = inWS->e(iwksp)[jbin] * fracVal;
      // now perform weghted sum of the mapped values
      double weight = 0.;
      if (std::isnormal(e)) { // is non-zero, nan, or infinity
        weight = 1. / (e * e);
      } else {
        weight = 0.;
        nZeroes[jbin]++;
      }
      normalization += weight;
      YSum[jbin] += weight * y;
      FracSum[jbin] += inWS->readF(iwksp)[jbin];
    }
    // apply the normalization factor
    if (normalization != 0.) {
      normalization = 1. / normalization;
      YSum[jbin] *= normalization;
      // NOTE: the total error is the sqrt of the normalization factor
      YErrorSum[jbin] = sqrt(normalization);
    }
    if (m_multiplyByNumSpec) {
      // NOTE: do not include the zero-weighted values in the number of spectra
      YSum[jbin] *= double(m_indices.size() - nZeroes[jbin]);
      YErrorSum[jbin] *= double(m_indices.size() - nZeroes[jbin]);
    }
    progress.report();
  }
  numZeros = std::accumulate(nZeroes.begin(), nZeroes.end(), size_t(0));
 
  // Create the correct representation if using fractional area
  auto useFractionalArea = getProperty("UseFractionalArea");
  if (useFractionalArea) {
    outWS->finalize(/*hasSqrdErrs =*/false);
  }
}
 
void SumSpectra::execEvent(const MatrixWorkspace_sptr &outputWorkspace, Progress &progress, size_t &numZeros) {
  MatrixWorkspace_const_sptr localworkspace = getProperty("InputWorkspace");
  EventWorkspace_const_sptr inputWorkspace = std::dynamic_pointer_cast<const EventWorkspace>(localworkspace);
 
  // Get the pointer to the output event list
  EventWorkspace_sptr outputEventWorkspace = std::dynamic_pointer_cast<EventWorkspace>(outputWorkspace);
  EventList &outputEL = outputEventWorkspace->getSpectrum(0);
  outputEL.setSpectrumNo(m_outSpecNum);
  outputEL.clearDetectorIDs();
 
  // count number of events for the output
  std::size_t numOutputEvents{0};
  for (const auto i : m_indices) {
    numOutputEvents += inputWorkspace->getSpectrum(i).getNumberEvents();
  }
  outputEL.switchTo(inputWorkspace->getSpectrum(0).getEventType());
  outputEL.reserve(numOutputEvents);
 
  // Loop over spectra
  for (const auto i : m_indices) {
    // Add the event lists with the operator
    const EventList &inputEL = inputWorkspace->getSpectrum(i);
    if (inputEL.empty()) {
      ++numZeros;
    }
    outputEL += inputEL;
 
    progress.report();
  }
}
 
} // namespace Mantid::Algorithms