/
MultiplyRange.h
53 lines (46 loc) · 1.83 KB
/
MultiplyRange.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
// 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
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAlgorithms/DllConfig.h"
namespace Mantid {
namespace Algorithms {
/** An algorithm to multiply a range of bins in a workspace by the factor given.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the input workspace</LI>
<LI> OutputWorkspace - The name of the output workspace</LI>
<LI> StartBin - The bin index at the start of the range</LI>
<LI> EndBin - The bin index at the end of the range</LI>
<LI> Factor - The value by which to multiply the input data
range</LI>
</UL>
@author Robert Dalgliesh, ISIS, RAL
@date 12/1/2010
*/
class MANTID_ALGORITHMS_DLL MultiplyRange : public API::Algorithm {
public:
const std::string name() const override { return "MultiplyRange"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "An algorithm to multiply a range of bins in a workspace by the "
"factor given.";
}
int version() const override { return (1); }
const std::vector<std::string> seeAlso() const override { return {"Multiply"}; }
const std::string category() const override { return "Arithmetic;CorrectionFunctions"; }
private:
/// Initialisation code
void init() override;
/// Execution code
void exec() override;
};
} // namespace Algorithms
} // namespace Mantid