/
SolidAngle.h
78 lines (64 loc) · 2.85 KB
/
SolidAngle.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
71
72
73
74
75
76
77
78
#ifndef MANTID_ALGORITHMS_SOLIDANDGLE_H_
#define MANTID_ALGORITHMS_SOLIDANDGLE_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace Algorithms {
/** Calculates and outputs the solid angles for each detector in the instrument.
The sample position is taken as a point source for the solid angle
calculations.
Required 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>
</UL>
@author Nick Draper, Tessella Support Services plc
@date 26/01/2009
Copyright © 2009-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 SolidAngle : public API::Algorithm {
public:
/// Default constructor
SolidAngle();
/// Virtual destructor
~SolidAngle() override;
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "SolidAngle"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "The SolidAngle algorithm calculates the solid angle in steradians "
"for each of the detectors in an instrument and outputs the data in "
"a workspace. This can then be used to normalize a data workspace "
"using the divide algorithm should you wish.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; }
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override {
return "CorrectionFunctions\\InstrumentCorrections";
}
private:
// Overridden Algorithm methods
void init() override;
void exec() override;
};
} // namespace Algorithm
} // namespace Mantid
#endif /*MANTID_ALGORITHMS_SOLIDANDGLE_H_*/