-
Notifications
You must be signed in to change notification settings - Fork 122
/
Scale.h
56 lines (49 loc) · 1.85 KB
/
Scale.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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"
namespace Mantid {
namespace Algorithms {
/** Scales an input workspace by the given factor, which can be either
multiplicative or additive.
Properties:
<UL>
<LI> InputWorkspace - The name of the input workspace. </LI>
<LI> OutputWorkspace - The name of the output workspace. Can be the same as
the input one. </LI>
<LI> Factor - The value by which to scale the input workspace.
</LI>
<LI> Operation - Whether to multiply (the default) or add by Factor.
</LI>
</UL>
@author Russell Taylor, Tessella plc
@date 19/03/2010
*/
class MANTID_ALGORITHMS_DLL Scale : public API::DistributedAlgorithm {
public:
/// Algorithm's name
const std::string name() const override { return "Scale"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Scales an input workspace by the given factor, which can be either "
"multiplicative or additive.";
}
std::map<std::string, std::string> validateInputs() override;
/// Algorithm's version
int version() const override { return (1); }
const std::vector<std::string> seeAlso() const override { return {"ScaleX"}; }
/// Algorithm's category for identification
const std::string category() const override { return "Arithmetic;CorrectionFunctions"; }
private:
/// Initialisation code
void init() override;
/// Execution code
void exec() override;
};
} // namespace Algorithms
} // namespace Mantid