Mantid
Loading...
Searching...
No Matches
ChangeBinOffset.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2008 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
11namespace Mantid {
12namespace Algorithms {
26class MANTID_ALGORITHMS_DLL ChangeBinOffset : public SpectrumAlgorithm {
27public:
29 const std::string name() const override { return "ChangeBinOffset"; }
31 const std::string summary() const override {
32 return "Adjusts all the time bin values in a workspace by a specified "
33 "amount.";
34 }
35
37 int version() const override { return 1; }
38 const std::vector<std::string> seeAlso() const override { return {"ScaleX"}; }
40 const std::string category() const override { return "Transforms\\Axes"; }
42 const std::string alias() const override { return "OffsetX"; }
43
44private:
46 void init() override;
48 void exec() override;
49};
50
51} // namespace Algorithms
52} // namespace Mantid
Takes a workspace and adjusts all the time bin values by the same amount.
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
int version() const override
Algorithm's version for identification overriding a virtual method.
const std::string alias() const override
Algorithm's Alternate Name.
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
const std::string summary() const override
Summary of algorithms purpose.
SpectrumAlgorithm is a base class for algorithms that work with MatrixWorkspace.
Helper class which provides the Collimation Length for SANS instruments.