NormaliseByCurrent.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
 
#include "MantidAPI/DistributedAlgorithm.h"
#include "MantidAlgorithms/DllConfig.h"
#include <memory>
namespace Mantid {
namespace API {
// Forward declare
class MatrixWorkspace;
} // namespace API
namespace Algorithms {
class MANTID_ALGORITHMS_DLL NormaliseByCurrent : public API::DistributedAlgorithm {
public:
  const std::string name() const override { return "NormaliseByCurrent"; }
  const std::string summary() const override { return "Normalises a workspace by the proton charge."; }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"Divide"}; }
  const std::string category() const override { return "CorrectionFunctions\\NormalisationCorrections"; }
 
private:
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
  // Extract the charge value from the logs.
  double extractCharge(const std::shared_ptr<Mantid::API::MatrixWorkspace> &inputWS, const bool integratePCharge) const;
};
 
} // namespace Algorithms
} // namespace Mantid