-
Notifications
You must be signed in to change notification settings - Fork 122
/
FilterEvents.h
236 lines (184 loc) · 7.82 KB
/
FilterEvents.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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 ISIS Rutherford Appleton Laboratory UKRI,
// NScD Oak Ridge National Laboratory, European Spallation Source,
// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/ISplittersWorkspace.h"
#include "MantidAPI/ITableWorkspace_fwd.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidDataObjects/SplittersWorkspace.h"
#include "MantidDataObjects/TableWorkspace.h"
#include "MantidKernel/TimeSeriesProperty.h"
#include "MantidKernel/TimeSplitter.h"
namespace Mantid {
namespace Algorithms {
class TimeAtSampleStrategy;
/** FilterEvents : Filter Events in EventWorkspace to multiple EventsWorkspace
by Splitters
@date 2012-04-04
*/
class MANTID_ALGORITHMS_DLL FilterEvents : public API::Algorithm {
enum TOFCorrectionType {
NoneCorrect,
CustomizedCorrect,
DirectCorrect,
ElasticCorrect,
IndirectCorrect
};
enum TOFCorrectionOp { MultiplyOp, ShiftOp };
enum EVENTFILTERSKIP { EventFilterSkipNoDet, EventFilterSkipNoDetTOFCorr };
public:
FilterEvents();
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "FilterEvents"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Filter events from an EventWorkspace to one or multiple "
"EventWorkspaces according to a series of splitters.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; }
const std::vector<std::string> seeAlso() const override {
return {"GenerateEventsFilter", "FilterByTime", "FilterByLogValue"};
}
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override {
return "Events\\EventFiltering";
}
std::map<std::string, std::string> validateInputs() override;
private:
// Implement abstract Algorithm methods
void init() override;
// Implement abstract Algorithm methods
void exec() override;
/// Process user input properties
void processAlgorithmProperties();
/// process splitters given by a SplittersWorkspace
void processSplittersWorkspace();
void processTableSplittersWorkspace();
/// process splitters given by a MatrixWorkspace
void processMatrixSplitterWorkspace();
/// create event workspace
std::shared_ptr<DataObjects::EventWorkspace> createEventWorkspaceNoLog();
/// create output workspaces if the splitters are given in SplittersWorkspace
void createOutputWorkspacesSplitters();
/// create output workspaces in the case of using TableWorlspace for splitters
void createOutputWorkspacesTableSplitterCase();
/// create output workspaces in the case of using MatrixWorkspace for
/// splitters
void createOutputWorkspacesMatrixCase();
/// Set up detector calibration parameters
void setupDetectorTOFCalibration();
/// Set up detector calibration parameters for elastic scattering instrument
TimeAtSampleStrategy *setupElasticTOFCorrection() const;
/// Set up detector calibration parmaeters for direct inelastic scattering
/// instrument
TimeAtSampleStrategy *setupDirectTOFCorrection() const;
/// Set up detector calibration parameters for indirect inelastic scattering
/// instrument
TimeAtSampleStrategy *setupIndirectTOFCorrection() const;
/// Set up detector calibration parameters from customized values
void setupCustomizedTOFCorrection();
/// Filter events by splitters in format of Splitter
void filterEventsBySplitters(double progressamount);
/// Filter events by splitters in format of vector
void filterEventsByVectorSplitters(double progressamount);
/// Examine workspace
void examineAndSortEventWS();
/// Convert SplittersWorkspace to vector of time and vector of target
/// (itarget)
void convertSplittersWorkspaceToVectors();
void splitTimeSeriesLogs(
const std::vector<Kernel::TimeSeriesProperty<int> *> &int_tsp_vector,
const std::vector<Kernel::TimeSeriesProperty<double> *> &dbl_tsp_vector,
const std::vector<Kernel::TimeSeriesProperty<bool> *> &bool_tsp_vector,
const std::vector<Kernel::TimeSeriesProperty<std::string> *>
&string_tsp_vector);
/// get the names of all the time series properties in the input workspace's
/// Run object
std::vector<std::string> getTimeSeriesLogNames();
void generateSplitterTSP(
std::vector<std::unique_ptr<Kernel::TimeSeriesProperty<int>>>
&split_tsp_vec);
void generateSplitterTSPalpha(
std::vector<std::unique_ptr<Kernel::TimeSeriesProperty<int>>>
&split_tsp_vec);
/// Add time series property 'Splitter' to each child workspace
void mapSplitterTSPtoWorkspaces(
std::vector<std::unique_ptr<Kernel::TimeSeriesProperty<int>>>
&split_tsp_vec);
void copyNoneSplitLogs(
std::vector<Kernel::TimeSeriesProperty<int> *> &int_tsp_name_vector,
std::vector<Kernel::TimeSeriesProperty<double> *> &dbl_tsp_name_vector,
std::vector<Kernel::TimeSeriesProperty<bool> *> &bool_tsp_name_vector,
std::vector<Kernel::TimeSeriesProperty<std::string> *>
&string_tsp_vector);
template <typename TYPE>
void splitTimeSeriesProperty(
Kernel::TimeSeriesProperty<TYPE> *tsp,
std::vector<Types::Core::DateAndTime> &split_datetime_vec,
const int max_target_index);
void groupOutputWorkspace();
/// calculate split-workspace's duration according to splitter time series
/// property
double calculate_duration(
std::unique_ptr<Kernel::TimeSeriesProperty<int>> &splitter_tsp);
DataObjects::EventWorkspace_sptr m_eventWS;
DataObjects::SplittersWorkspace_sptr m_splittersWorkspace;
DataObjects::TableWorkspace_sptr m_splitterTableWorkspace;
API::MatrixWorkspace_const_sptr m_matrixSplitterWS;
DataObjects::TableWorkspace_sptr m_detCorrectWorkspace;
/// Flag to use matrix splitters or table splitters
bool m_useSplittersWorkspace;
bool m_useArbTableSplitters;
std::set<int> m_targetWorkspaceIndexSet;
int m_maxTargetIndex;
Kernel::TimeSplitterType m_splitters;
std::map<int, DataObjects::EventWorkspace_sptr> m_outputWorkspacesMap;
std::vector<std::string> m_wsNames;
std::vector<double> m_detTofOffsets;
std::vector<double> m_detTofFactors;
bool m_filterByPulseTime;
DataObjects::TableWorkspace_sptr m_informationWS;
bool m_hasInfoWS;
double m_progress;
/// Base of output workspace's name
std::string m_outputWSNameBase;
/// TableWorkspace splitters: from target map to vector workspace group-index
/// These 2 maps are complimentary to each other
std::map<std::string, int> m_targetIndexMap;
std::map<int, std::string> m_wsGroupIndexTargetMap;
/// MatrixWorkspace splitters:
std::map<int, uint32_t> m_yIndexMap;
std::map<uint32_t, int> m_wsGroupdYMap;
/// Flag to group workspace
bool m_toGroupWS;
/// Vector for splitting time
/// FIXME - shall we convert this to DateAndTime???. Need to do speed test!
std::vector<int64_t> m_vecSplitterTime;
/// Vector for splitting group
std::vector<int> m_vecSplitterGroup;
/// Flag to split sample logs
bool m_splitSampleLogs;
/// Debug
bool m_useDBSpectrum;
int m_dbWSIndex;
/// TOF detector/sample correction type
TOFCorrectionType m_tofCorrType;
/// Spectrum skip type
EVENTFILTERSKIP m_specSkipType;
/// Vector for skip information
std::vector<bool> m_vecSkip;
// Flag to have relative time in splitters workspace
bool m_isSplittersRelativeTime;
// Starting time for starting time of event filters
Types::Core::DateAndTime m_filterStartTime;
// EventWorkspace (aka. run)'s starting time
Types::Core::DateAndTime m_runStartTime;
};
} // namespace Algorithms
} // namespace Mantid