ScaleX.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 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/Workspace_fwd.h"
#include "MantidAlgorithms/DllConfig.h"
 
#include <boost/function.hpp>
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL ScaleX final : public API::Algorithm {
public:
  ScaleX();
 
  const std::string name() const override { return "ScaleX"; }
  const std::string summary() const override {
    return "Scales the X-axis of an input workspace by the given factor, which "
           "can be either multiplicative or additive.";
  }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"ChangeBinOffset", "Scale"}; }
  const std::string category() const override { return "Arithmetic;CorrectionFunctions"; }
 
private:
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
  void execEvent();
 
  API::MatrixWorkspace_sptr createOutputWS(const API::MatrixWorkspace_sptr &input);
  double getScaleFactor(const API::MatrixWorkspace_const_sptr &inputWS, const size_t index);
 
  std::unique_ptr<API::Progress> m_progress;
 
  double m_algFactor;
  std::string m_parname;
  bool m_combine;
  boost::function<double(double, double)> m_binOp;
  int m_wi_min;
  int m_wi_max;
};
 
} // namespace Algorithms
} // namespace Mantid