CreateUserDefinedBackground.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2016 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 "MantidAPI/ITableWorkspace_fwd.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidHistogramData/Histogram.h"
namespace Mantid {
namespace Kernel {
class Interpolation;
}
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL CreateUserDefinedBackground final : public API::Algorithm {
public:
  const std::string name() const override;
  int version() const override;
  const std::vector<std::string> seeAlso() const override {
    return {"RemoveBackground", "CalculatePolynomialBackground"};
  }
  const std::string category() const override;
  const std::string summary() const override;
 
private:
  void init() override;
  void exec() override;
  std::map<std::string, std::string> validateInputs() override;
  void cleanUpTable(API::ITableWorkspace_sptr &table) const;
  void extendBackgroundToData(API::ITableWorkspace_sptr &background, const API::MatrixWorkspace_const_sptr &data) const;
  API::MatrixWorkspace_sptr createBackgroundWorkspace(const API::ITableWorkspace_const_sptr &background,
                                                      const API::MatrixWorkspace_const_sptr &data) const;
  Kernel::Interpolation getInterpolator(const API::ITableWorkspace_const_sptr &background,
                                        const API::MatrixWorkspace_const_sptr &workspace) const;
  HistogramData::Histogram::YMode getBackgroundYMode(const API::MatrixWorkspace_const_sptr &data,
                                                     std::vector<double> &yBackground) const;
  void multiplyByBinWidth(const API::MatrixWorkspace_const_sptr &data, std::vector<double> &yBackground) const;
  static const std::string AUTODISTRIBUTIONKEY;
};
 
} // namespace Algorithms
} // namespace Mantid