-
Notifications
You must be signed in to change notification settings - Fork 122
/
ChangeBinOffset.h
52 lines (45 loc) · 1.83 KB
/
ChangeBinOffset.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
// 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 "MantidAlgorithms/SpectrumAlgorithm.h"
namespace Mantid {
namespace Algorithms {
/**Takes a workspace and adjusts all the time bin values by the same amount.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the Workspace to take as input </LI>
<LI> OutputWorkspace - The name of the workspace in which to store the result
</LI>
<LI> Offset - The amount to adjust the time bins. Usually in microseconds</LI>
</UL>
@author
@date 11/07/2008
*/
class MANTID_ALGORITHMS_DLL ChangeBinOffset : public SpectrumAlgorithm {
public:
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "ChangeBinOffset"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Adjusts all the time bin values in a workspace by a specified "
"amount.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; }
const std::vector<std::string> seeAlso() const override { return {"ScaleX"}; }
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "Transforms\\Axes"; }
/// Algorithm's Alternate Name
const std::string alias() const override { return "OffsetX"; }
private:
/// Initialisation method. Declares properties to be used in algorithm.
void init() override;
/// Executes the algorithm
void exec() override;
};
} // namespace Algorithms
} // namespace Mantid