Mantid
Loading...
Searching...
No Matches
Scale.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2010 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
10#include "MantidAlgorithms/DllConfig.h"
11
12namespace Mantid {
13namespace Algorithms {
31class MANTID_ALGORITHMS_DLL Scale : public API::Algorithm {
32public:
34 const std::string name() const override { return "Scale"; }
36 const std::string summary() const override {
37 return "Scales an input workspace by the given factor, which can be either "
38 "multiplicative or additive.";
39 }
40 std::map<std::string, std::string> validateInputs() override;
41
43 int version() const override { return (1); }
44 const std::vector<std::string> seeAlso() const override { return {"ScaleX"}; }
46 const std::string category() const override { return "Arithmetic;CorrectionFunctions"; }
47
48private:
50 void init() override;
52 void exec() override;
53};
54
55} // namespace Algorithms
56} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition Algorithm.h:76
Scales an input workspace by the given factor, which can be either multiplicative or additive.
Definition Scale.h:31
int version() const override
Algorithm's version.
Definition Scale.h:43
const std::string name() const override
Algorithm's name.
Definition Scale.h:34
const std::string category() const override
Algorithm's category for identification.
Definition Scale.h:46
const std::string summary() const override
Summary of algorithms purpose.
Definition Scale.h:36
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Definition Scale.h:44
Helper class which provides the Collimation Length for SANS instruments.