-
Notifications
You must be signed in to change notification settings - Fork 122
/
PoldiAnalyseResiduals.h
82 lines (63 loc) · 3.05 KB
/
PoldiAnalyseResiduals.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
82
#ifndef MANTID_SINQ_POLDIANALYSERESIDUALS_H_
#define MANTID_SINQ_POLDIANALYSERESIDUALS_H_
#include "MantidSINQ/DllConfig.h"
#include "MantidAPI/Algorithm.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidSINQ/PoldiUtilities/PoldiInstrumentAdapter.h"
namespace Mantid {
namespace Poldi {
/** PoldiAnalyseResiduals
An algorithm that performs residual analysis for
POLDI data. It uses a modified version of the correlation
method implemented in PoldiAutoCorrelation.
@author Michael Wedel, Paul Scherrer Institut - SINQ
@date 21/11/2014
Copyright © 2014 PSI-MSS
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 MANTID_SINQ_DLL PoldiAnalyseResiduals : public API::Algorithm {
public:
const std::string name() const override;
int version() const override;
const std::string category() const override;
const std::string summary() const override;
protected:
double sumCounts(const DataObjects::Workspace2D_sptr &workspace,
const std::vector<int> &workspaceIndices) const;
size_t numberOfPoints(const DataObjects::Workspace2D_sptr &workspace,
const std::vector<int> &workspaceIndices) const;
void addValue(DataObjects::Workspace2D_sptr &workspace, double value,
const std::vector<int> &workspaceIndices) const;
DataObjects::Workspace2D_sptr
calculateResidualWorkspace(const DataObjects::Workspace2D_sptr &measured,
const DataObjects::Workspace2D_sptr &calculated);
void normalizeResiduals(DataObjects::Workspace2D_sptr &residuals,
const std::vector<int> &validWorkspaceIndices);
double relativeCountChange(const DataObjects::Workspace2D_sptr &sum,
double totalMeasuredCounts);
DataObjects::Workspace2D_sptr
addWorkspaces(const DataObjects::Workspace2D_sptr &lhs,
const DataObjects::Workspace2D_sptr &rhs);
void logIteration(int iteration, double relativeChange);
bool nextIterationAllowed(int iterations, double relativeChange);
bool relativeChangeIsLargerThanLimit(double relativeChange);
bool iterationLimitReached(int iterations);
private:
void init() override;
void exec() override;
};
} // namespace Poldi
} // namespace Mantid
#endif /* MANTID_SINQ_POLDIANALYSERESIDUALS_H_ */