/
ElasticWindow.h
70 lines (57 loc) · 2.46 KB
/
ElasticWindow.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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
#ifndef MANTID_ALGORITHMS_ELASTIC_WINDOW_H_
#define MANTID_ALGORITHMS_ELASTIC_WINDOW_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace Algorithms {
/** @author Michael Whitty, STFC ISIS
@date 25/10/2010
This algorithm uses the Integration, ConvertSpectrumAxis and Transpose
algorithms
to provide an integrated value over q and q^2..
Copyright © 2010 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
National Laboratory & European Spallation Source
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://github.com/mantidproject/mantid>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport ElasticWindow : public API::Algorithm {
public:
/// (Empty) Constructor
ElasticWindow() : API::Algorithm() {}
/// Virtual destructor
~ElasticWindow() override {}
/// Algorithm's name
const std::string name() const override { return "ElasticWindow"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "This algorithm performs an integration over an energy range, with "
"the option to subtract a background over a second range, then "
"transposes the result into a single-spectrum workspace with units "
"in Q and Q^2.";
}
/// Algorithm's version
int version() const override { return (1); }
/// Algorithm's category for identification
const std::string category() const override { return "Inelastic\\Indirect"; }
private:
/// Initialisation code
void init() override;
/// Execution code
void exec() override;
};
} // namespace Algorithms
} // namespace Mantid
#endif /*MANTID_ALGORITHMS_ELASTIC_WINDOW_H_*/