/
SumEventsByLogValue.h
91 lines (74 loc) · 3.58 KB
/
SumEventsByLogValue.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
83
84
85
86
87
88
89
90
91
#ifndef MANTID_ALGORITHMS_SUMEVENTSBYLOGVALUE_H_
#define MANTID_ALGORITHMS_SUMEVENTSBYLOGVALUE_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidKernel/TimeSeriesProperty.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidAPI/ITableWorkspace_fwd.h"
namespace Mantid {
namespace Algorithms {
/**
Produces a table or single spectrum workspace containing the total summed
events in the workspace
as a function of a specified log.
Copyright © 2012-3 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 SumEventsByLogValue : public API::Algorithm {
public:
SumEventsByLogValue();
~SumEventsByLogValue() override;
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "SumEventsByLogValue"; }
/// 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 "Events"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Produces a single spectrum workspace containing the "
"total summed events in the workspace as a function of a specified "
"log.";
}
std::map<std::string, std::string> validateInputs() override;
private:
void init() override;
void exec() override;
void createTableOutput(const Kernel::TimeSeriesProperty<int> *log);
template <typename T>
void createBinnedOutput(const Kernel::TimeSeriesProperty<T> *log);
void filterEventList(const API::IEventList &eventList, const int minVal,
const int maxVal,
const Kernel::TimeSeriesProperty<int> *log,
std::vector<int> &Y);
void addMonitorCounts(API::ITableWorkspace_sptr outputWorkspace,
const Kernel::TimeSeriesProperty<int> *log,
const int minVal, const int maxVal);
std::vector<std::pair<std::string, const Kernel::ITimeSeriesProperty *>>
getNumberSeriesLogs();
double
sumProtonCharge(const Kernel::TimeSeriesProperty<double> *protonChargeLog,
const Kernel::TimeSplitterType &filter);
DataObjects::EventWorkspace_const_sptr
m_inputWorkspace; ///< The input workspace
std::string m_logName; ///< The name of the log to sum against
std::vector<double> m_binningParams; ///< The optional binning parameters
};
} // namespace Algorithms
} // namespace Mantid
#endif /* MANTID_ALGORITHMS_SUMEVENTSBYLOGVALUE_H_ */