-
Notifications
You must be signed in to change notification settings - Fork 121
/
NormaliseByCurrent.h
81 lines (68 loc) · 2.97 KB
/
NormaliseByCurrent.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
79
80
81
#ifndef MANTID_ALGORITHMS_NORMALISEBYCURRENT_H_
#define MANTID_ALGORITHMS_NORMALISEBYCURRENT_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include <boost/shared_ptr.hpp>
namespace Mantid {
namespace API {
// Forward declare
class MatrixWorkspace;
}
namespace Algorithms {
/** Normalises a workspace according to the good proton charge figure taken from
the
raw file (and stored in the Sample object). Every data point is divided by
that number.
Note that units are not fully dealt with at the moment - the output will
have identical
units to the input workspace (i.e. will not show "/ uA.hour").
Required Properties:
<UL>
<LI> InputWorkspace - The names of the input workspace. </LI>
<LI> OutputWorkspace - The name of the output workspace. </LI>
</UL>
@author Russell Taylor, Tessella Support Services plc
@date 25/08/2008
Copyright © 2008 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 NormaliseByCurrent : public API::Algorithm {
public:
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "NormaliseByCurrent"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Normalises a workspace by the proton charge.";
}
/// 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\\NormalisationCorrections";
}
private:
// Overridden Algorithm methods
void init() override;
void exec() override;
// Extract the charge value from the logs.
double extractCharge(boost::shared_ptr<Mantid::API::MatrixWorkspace> inputWS,
const bool integratePCharge) const;
};
} // namespace Algorithm
} // namespace Mantid
#endif /* MANTID_ALGORITHMS_NORMALISEBYCURRENT_H_ */