SumSpectra.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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/Algorithm.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidGeometry/IDTypes.h"
#include <set>
 
namespace Mantid {
 
namespace API { // forward declare
class ISpectrum;
class SpectrumInfo;
} // namespace API
 
namespace DataObjects { // forward declare
class RebinnedOutput;
using RebinnedOutput_sptr = std::shared_ptr<RebinnedOutput>;
using RebinnedOutput_const_sptr = std::shared_ptr<const RebinnedOutput>;
} // namespace DataObjects
 
namespace Algorithms {
 
using DataObjects::RebinnedOutput_const_sptr;
using DataObjects::RebinnedOutput_sptr;
 
class MANTID_ALGORITHMS_DLL SumSpectra : public API::Algorithm {
public:
  const std::string name() const override { return "SumSpectra"; }
  const std::string summary() const override {
    return "The SumSpectra algorithm adds the data values in each time bin "
           "across a range of spectra; the output workspace has a single "
           "spectrum. If the input is an EventWorkspace, the output is also an "
           "EventWorkspace; otherwise it will be a Workspace2D.";
  }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"SumNeighbours"}; }
  const std::string category() const override { return "Transforms\\Grouping"; }
  std::map<std::string, std::string> validateInputs() override;
 
private:
  void doFractionalSum(RebinnedOutput_const_sptr const &, RebinnedOutput_sptr const &, API::Progress &, size_t &);
  void doFractionalWeightedSum(RebinnedOutput_const_sptr const &, RebinnedOutput_sptr const &, API::Progress &,
                               size_t &);
  void doSimpleSum(API::MatrixWorkspace_const_sptr const &, API::ISpectrum &, API::Progress &, size_t &);
  void doSimpleWeightedSum(API::MatrixWorkspace_const_sptr const &, API::ISpectrum &, API::Progress &, size_t &);
 
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
  void execEvent(const API::MatrixWorkspace_sptr &outputWorkspace, API::Progress &progress, size_t &numZeros);
  specnum_t getOutputSpecNo(const API::MatrixWorkspace_const_sptr &localworkspace);
 
  API::MatrixWorkspace_sptr replaceSpecialValues();
  size_t determineIndices(API::SpectrumInfo const &, const size_t numberOfSpectra);
 
  specnum_t m_outSpecNum{0};
  bool m_keepMonitors{false};
  size_t m_numberOfSpectra{0};
  size_t m_yLength{0};
  std::set<size_t> m_indices;
 
  // if calculating additional workspace with specially weighted averages is
  // necessary
  bool m_calculateWeightedSum{false};
  bool m_multiplyByNumSpec{true};
};
 
} // namespace Algorithms
} // namespace Mantid