PowerLawCorrection.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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 "MantidAlgorithms/UnaryOperation.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL PowerLawCorrection : public UnaryOperation {
public:
  PowerLawCorrection();
  const std::string name() const override { return "PowerLawCorrection"; }
  const std::string summary() const override {
    return "Corrects the data and error values on a workspace by the value of "
           "an exponential function which is evaluated at the X value of each "
           "data point: c0*x^C1. The data and error values are multiplied by "
           "the value of this function.";
  }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override {
    return {"PolynomialCorrection", "OneMinusExponentialCor", "MagFormFactorCorrection", "ExponentialCorrection"};
  }
  const std::string category() const override { return "CorrectionFunctions"; }
 
private:
  // Overridden UnaryOperation methods
  void defineProperties() override;
  void retrieveProperties() override;
  void performUnaryOperation(const double XIn, const double YIn, const double EIn, double &YOut, double &EOut) override;
 
  double m_c0; 
  double m_c1; 
};
 
} // namespace Algorithms
} // namespace Mantid