Integration.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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/ISpectrum.h"
#include "MantidAlgorithms/DllConfig.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL Integration final : public API::Algorithm {
public:
  const std::string name() const override { return "Integration"; }
  const std::string summary() const override {
    return "Integration takes a 2D workspace or an EventWorkspace as input and "
           "sums the data values. Optionally, the range summed can be "
           "restricted in either dimension.";
  }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"IntegrateByComponent", "Rebin"}; }
  const std::string category() const override { return "Arithmetic;Transforms\\Rebin"; }
 
private:
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
 
  API::MatrixWorkspace_sptr rangeFilterEventWorkspace(const API::MatrixWorkspace_sptr &workspace, double minRange,
                                                      double maxRange);
 
  API::MatrixWorkspace_sptr getInputWorkspace();
  API::MatrixWorkspace_sptr getOutputWorkspace(API::MatrixWorkspace_sptr inWS, const int minSpec, const int maxSpec);
  std::map<std::string, std::string> validateInputs() override;
  void integrateSpectrum(const API::ISpectrum &inSpec, API::ISpectrum &outSpec, const std::vector<double> *Fin,
                         std::vector<double> *Fout, double lowerLimit, double upperLimit, bool incPartBins);
};
 
} // namespace Algorithms
} // namespace Mantid