NormaliseToUnity.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 "MantidAlgorithms/DllConfig.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL NormaliseToUnity final : public API::Algorithm {
public:
  const std::string name() const override { return "NormaliseToUnity"; }
  const std::string summary() const override {
    return "NormaliseToUnity takes a 2D workspace or an EventWorkspace as "
           "input and normalises it to 1. 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 {"Divide"}; }
  const std::string category() const override { return "CorrectionFunctions\\NormalisationCorrections"; }
 
private:
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
};
 
} // namespace Algorithms
} // namespace Mantid