ATLAS Offline Software
Loading...
Searching...
No Matches
ColumnReaderImp.cxx
Go to the documentation of this file.
1/*
2 Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
3*/
4
6
7//
8// includes
9//
10
12
16#include <xAODBase/ObjectType.h>
18
19//
20// method implementations
21//
22
23namespace columnar
24{
25 namespace TestUtils
26 {
28 {
29 std::array<ColumnarOffsetType, 2> data = {0, 0};
30
32 {
33 outputColumns.push_back ({.name = eventRangeColumnName, .isOffset = true});
34 }
35
36 virtual bool connect(Backend /*source*/, std::unordered_map<std::string,const std::vector<ColumnarOffsetType>*>& /*offsetColumns*/,std::unordered_map<std::string, ColumnInfo>& requestedColumns) override
37 {
38 if (requestedColumns.contains(outputColumns.at(0).name))
39 {
40 requestedColumns.erase(outputColumns.at(0).name);
41 outputColumns.at(0).enabled = true;
42 return true;
43 }
44 return false;
45 }
46 virtual void clearColumns () override
47 {
48 data[0] = 0;
49 data[1] = 0;
50 }
51
52 virtual void getEntry (Long64_t /*entry*/) override
53 {
54 data[1] += 1;
55 }
56
57 virtual void setData (ColumnVectorData& columnData) override
58 {
59 if (outputColumns.at(0).columnIndex != ColumnVectorHeader::nullIndex)
60 columnData.setColumn (outputColumns.at(0).columnIndex, data.size(), data.data());
61 }
62
63 [[nodiscard]] virtual BranchPerfData getPerfData (float /*emptyTime*/) override
64 {
65 BranchPerfData result;
66 result.name = "EventCount(auto)";
67 return result;
68 }
69
70 virtual void collectColumnData () override
71 {}
72 };
73
74 template <typename T>
76 {
78 const std::vector<ColumnarOffsetType>* offsetColumn = nullptr;
79 std::vector<T> outData;
80 unsigned entries = 0;
81
82 ColumnReaderOutVector (const std::string& val_columnName, const T& val_defaultValue)
83 : defaultValue (val_defaultValue)
84 {
85 outputColumns.push_back ({.name = val_columnName});
86 }
87
88 virtual bool connect(Backend /*source*/, std::unordered_map<std::string, const std::vector<ColumnarOffsetType>*>& offsetColumns, std::unordered_map<std::string, ColumnInfo>& requestedColumns) override
89 {
90 auto iter = requestedColumns.find (outputColumns.at(0).name);
91 if (iter == requestedColumns.end())
92 return false;
93 outputColumns.at(0).enabled = true;
94
95 const auto & offsetName = iter->second.offsetName;
96 if (offsetName.empty())
97 throw std::runtime_error ("missing offset column for: " + outputColumns.at(0).name);
98
99 if (auto offsetIter = offsetColumns.find (offsetName); offsetIter != offsetColumns.end())
100 offsetColumn = offsetIter->second;
101 else
102 throw std::runtime_error ("missing offset column for: " + outputColumns.at(0).name + " (offset column: " + offsetName + ")");
103
104 // IMPORTANT: This has to be erased at the end of the function,
105 // since erasing it earlier would invalidate the offsetName
106 // reference.
107 requestedColumns.erase (iter);
108 return true;
109 }
110
111 virtual void clearColumns () override
112 {
113 outData.clear ();
114 }
115
116 virtual void getEntry (Long64_t /*entry*/) override
117 {
118 outData.resize (offsetColumn->back(), defaultValue);
119 }
120
121 virtual void setData (ColumnVectorData& columnData) override
122 {
123 if (outputColumns.at(0).columnIndex != ColumnVectorHeader::nullIndex)
124 columnData.setColumn (outputColumns.at(0).columnIndex, outData.size(), outData.data());
125 }
126
127 [[nodiscard]] virtual BranchPerfData getPerfData (float /*emptyTime*/) override
128 {
129 BranchPerfData result;
130 result.name = outputColumns.at(0).name + "(out)";
131 result.entries = entries;
132 return result;
133 }
134
135 virtual void collectColumnData () override
136 {
137 entries += outData.size();
138 }
139 };
140
143 template <typename T>
145 {
147 std::vector<T> outData;
148 unsigned entries = 0;
149
150 ColumnReaderOutScalar (const std::string& val_columnName, const T& val_defaultValue)
151 : defaultValue (val_defaultValue)
152 {
153 outputColumns.push_back ({.name = val_columnName});
154 }
155
156 virtual bool connect(Backend /*source*/, std::unordered_map<std::string, const std::vector<ColumnarOffsetType>*>& /*offsetColumns*/, std::unordered_map<std::string, ColumnInfo>& requestedColumns) override
157 {
158 auto iter = requestedColumns.find (outputColumns.at(0).name);
159 if (iter == requestedColumns.end())
160 return false;
161 outputColumns.at(0).enabled = true;
162 requestedColumns.erase (iter);
163 return true;
164 }
165
166 virtual void clearColumns () override
167 {
168 outData.clear ();
169 }
170
171 virtual void getEntry (Long64_t /*entry*/) override
172 {
173 outData.push_back (defaultValue);
174 }
175
176 virtual void setData (ColumnVectorData& columnData) override
177 {
178 if (outputColumns.at(0).columnIndex != ColumnVectorHeader::nullIndex)
179 columnData.setColumn (outputColumns.at(0).columnIndex, outData.size(), outData.data());
180 }
181
182 [[nodiscard]] virtual BranchPerfData getPerfData (float /*emptyTime*/) override
183 {
184 BranchPerfData result;
185 result.name = outputColumns.at(0).name + "(out)";
186 result.entries = entries;
187 return result;
188 }
189
190 virtual void collectColumnData () override
191 {
192 entries += outData.size();
193 }
194 };
195
197 {
198 std::vector<std::string> termNames;
199 const std::vector<ColumnarOffsetType>* offsetColumns = nullptr;
200 std::vector<ColumnarOffsetType> offsets = {0};
201 std::vector<ColumnarOffsetType> namesOffsets = {0};
202 std::vector<char> namesData;
203 std::vector<std::size_t> namesHash;
204
205 ColumnReaderOutputMet (const std::string& val_columnName, std::vector<std::string> val_termNames)
206 : termNames (std::move (val_termNames))
207 {
208 outputColumns.push_back ({.name = val_columnName, .isOffset = true});
209 outputColumns.push_back ({.name = val_columnName + ".name.data"});
210 outputColumns.push_back ({.name = val_columnName + ".name.offset", .isOffset = true});
211 outputColumns.push_back ({.name = val_columnName + ".nameHash"});
212 }
213
214 virtual bool connect([[maybe_unused]]Backend source, std::unordered_map<std::string, const std::vector<ColumnarOffsetType>*>& offsetColumns, std::unordered_map<std::string, ColumnInfo>& requestedColumns) override
215 {
216 if (auto iter = requestedColumns.find (outputColumns.at(0).name);
217 iter != requestedColumns.end())
218 requestedColumns.erase (iter);
219 else
220 return false;
221 outputColumns.at(0).enabled = true;
222
223 if (auto iter = requestedColumns.find (outputColumns.at(1).name);
224 iter != requestedColumns.end())
225 {
226 outputColumns.at(1).enabled = true;
227 requestedColumns.erase (iter);
228 }
229
230 if (auto iter = requestedColumns.find (outputColumns.at(2).name);
231 iter != requestedColumns.end())
232 {
233 outputColumns.at(2).enabled = true;
234 requestedColumns.erase (iter);
235 }
236
237 if (auto iter = requestedColumns.find (outputColumns.at(3).name);
238 iter != requestedColumns.end())
239 {
240 outputColumns.at(3).enabled = true;
241 requestedColumns.erase (iter);
242 }
243
244 // For multi-tool support, skip if offset column already registered
245 if (auto offsetIter = offsetColumns.find (outputColumns.at(0).name); offsetIter == offsetColumns.end())
246 offsetColumns.emplace (outputColumns.at(0).name, &offsets);
247
248 return true;
249 }
250
251 virtual void clearColumns () override
252 {
253 offsets.clear ();
254 offsets.push_back (0);
255 namesData.clear ();
256 namesOffsets.clear ();
257 namesOffsets.push_back (0);
258 namesHash.clear ();
259 }
260
261 virtual void getEntry (Long64_t /*entry*/) override
262 {
263 for (const auto& termName : termNames)
264 {
265 namesData.insert (namesData.end(), termName.begin(), termName.end());
266 namesOffsets.push_back (namesData.size());
267 namesHash.push_back (std::hash<std::string> () (termName));
268 }
269 offsets.push_back (namesHash.size());
270 }
271
272 virtual void setData (ColumnVectorData& colData) override
273 {
274 if (outputColumns.at(0).columnIndex != ColumnVectorHeader::nullIndex)
275 colData.setColumn (outputColumns.at(0).columnIndex, offsets.size(), offsets.data());
276 if (outputColumns.at(1).columnIndex != ColumnVectorHeader::nullIndex)
277 colData.setColumn (outputColumns.at(1).columnIndex, namesData.size(), namesData.data());
278 if (outputColumns.at(2).columnIndex != ColumnVectorHeader::nullIndex)
279 colData.setColumn (outputColumns.at(2).columnIndex, namesOffsets.size(), namesOffsets.data());
280 if (outputColumns.at(3).columnIndex != ColumnVectorHeader::nullIndex)
281 colData.setColumn (outputColumns.at(3).columnIndex, namesHash.size(), namesHash.data());
282 }
283
284 [[nodiscard]] virtual BranchPerfData getPerfData (float /*emptyTime*/) override
285 {
286 BranchPerfData result;
287 result.name = outputColumns.at(0).name + "(met-out)";
288 return result;
289 }
290
291 virtual void collectColumnData () override
292 {}
293 };
294
295
296
303 {
304 const std::vector<ColumnarOffsetType>* offsetColumn = nullptr;
305 std::vector<ColumnarOffsetType> data;
307 unsigned entries = 0;
308
309 explicit ColumnReaderEventIndex (const std::string& val_columnName)
310 {
311 outputColumns.push_back ({.name = val_columnName});
312 }
313
314 virtual bool connect(Backend /*source*/, std::unordered_map<std::string, const std::vector<ColumnarOffsetType>*>& offsetColumns, std::unordered_map<std::string, ColumnInfo>& requestedColumns) override
315 {
316 auto iter = requestedColumns.find (outputColumns.at(0).name);
317 if (iter == requestedColumns.end())
318 return false;
319
320 const auto& offsetName = iter->second.offsetName;
321 if (auto offsetIter = offsetColumns.find (offsetName); offsetIter != offsetColumns.end())
322 offsetColumn = offsetIter->second;
323 else if (iter->second.isOptional)
324 return false;
325 else
326 throw std::runtime_error ("missing offset column for: " + outputColumns.at(0).name + " (offset column: " + offsetName + ")");
327 outputColumns.at(0).enabled = true;
328
329 // IMPORTANT: This has to be erased at the end of the function,
330 // since erasing it earlier would invalidate the offsetName
331 // reference.
332 requestedColumns.erase (iter);
333 return true;
334 }
335
336 virtual void clearColumns () override
337 {
338 data.clear ();
339 currentEvent = 0;
340 }
341
342 virtual void getEntry (Long64_t /*entry*/) override
343 {
344 // all entries added to the offset column for this event belong
345 // to the current event
346 data.resize (offsetColumn->back(), currentEvent);
347 ++ currentEvent;
348 }
349
350 virtual void setData (ColumnVectorData& columnData) override
351 {
352 if (outputColumns.at(0).columnIndex != ColumnVectorHeader::nullIndex)
353 columnData.setColumn (outputColumns.at(0).columnIndex, data.size(), data.data());
354 }
355
356 [[nodiscard]] virtual BranchPerfData getPerfData (float /*emptyTime*/) override
357 {
358 BranchPerfData result;
359 result.name = outputColumns.at(0).name + "(event-index)";
360 result.entries = entries;
361 return result;
362 }
363
364 virtual void collectColumnData () override
365 {
366 entries += data.size();
367 }
368 };
369
370
371
372 void makeCommonColumnReaders (std::vector<std::shared_ptr<TestUtils::ColumnReader>>& knownColumns)
373 {
374 knownColumns.push_back (std::make_shared<ColumnReaderEventCount> ());
375 }
376
377 void makeCommonLateColumnReaders (std::vector<std::shared_ptr<TestUtils::ColumnReader>>& knownColumns, const std::vector<std::string>& allMetTermNames)
378 {
379 if (!allMetTermNames.empty())
380 knownColumns.push_back(std::make_shared<ColumnReaderOutputMet>("OutputMET",allMetTermNames));
381
382 // For METMaker we need various extra columns to run. This may need
383 // some work to avoid, but would likey be worth it.
384 knownColumns.push_back(std::make_shared<ColumnReaderOutVector<std::uint16_t>>("AnalysisMuons.objectType", xAOD::Type::Muon));
385 knownColumns.push_back(std::make_shared<ColumnReaderOutVector<float>>("AnalysisMuons.m", ParticleConstants::muonMassInMeV));
386 knownColumns.push_back(std::make_shared<ColumnReaderOutVector<std::uint16_t>>("AnalysisJets.objectType", xAOD::Type::Jet));
387
388 // These are columns that represent variables that are normally held
389 // by METAssociationHelper, or alternatively are decorated on the
390 // MET terms (even though they are per object).
391 knownColumns.push_back(std::make_shared<ColumnReaderOutVector<float>>("AnalysisMuons.MetObjectWeight", 0));
392 knownColumns.push_back(std::make_shared<ColumnReaderOutVector<float>>("AnalysisJets.MetObjectWeight", 0));
393 knownColumns.push_back(std::make_shared<ColumnReaderOutVector<float>>("AnalysisJets.MetObjectWeightSoft", 0));
394 knownColumns.push_back(std::make_shared<ColumnReaderOutVector<MissingETBase::Types::bitmask_t>>("METAssoc_AnalysisMET.useObjectFlags", 0));
395 }
396
397 void makeEventIndexColumnReaders (std::vector<std::shared_ptr<TestUtils::ColumnReader>>& knownColumns, const ColumnVectorHeader& columnHeader)
398 {
399 for (auto& [name, info] : columnHeader.getAllColumnInfo())
400 {
401 if (info.isEventIndex)
402 knownColumns.push_back (std::make_shared<ColumnReaderEventIndex> (name));
403 }
404 }
405
408 template <template <typename> class ReaderTemplate>
409 std::shared_ptr<TestUtils::ColumnReader> makeOutputColumnReader (const ColumnInfo& info)
410 {
411 if (*info.type == typeid(float))
412 return std::make_shared<ReaderTemplate<float>>(info.name, 0);
413 if (*info.type == typeid(char))
414 return std::make_shared<ReaderTemplate<char>>(info.name, 0);
415 if (*info.type == typeid(std::uint16_t))
416 return std::make_shared<ReaderTemplate<std::uint16_t>>(info.name, 0);
417 if (*info.type == typeid(std::uint32_t))
418 return std::make_shared<ReaderTemplate<std::uint32_t>>(info.name, 0);
419 if (*info.type == typeid(std::uint64_t))
420 return std::make_shared<ReaderTemplate<std::uint64_t>>(info.name, 0);
421 return nullptr;
422 }
423
424 void makeOutputColumnReaders (std::vector<std::shared_ptr<TestUtils::ColumnReader>>& knownColumns, const ColumnVectorHeader& columnHeader)
425 {
426 using namespace asg::msgUserCode;
427
428 // Get all column info directly from the header (all tools have already
429 // registered their columns via ToolColumnVectorMap)
430 auto requestedColumns = columnHeader.getAllColumnInfo();
431
432 for (auto& [name, info] : requestedColumns)
433 {
434 if (info.accessMode != ColumnAccessMode::output || !info.fixedDimensions.empty())
435 continue;
436 std::shared_ptr<TestUtils::ColumnReader> myColumn;
437 if (info.offsetName == eventRangeColumnName)
438 {
439 // a per-event scalar output (e.g. an EventInfo decoration)
441 } else
442 {
443 auto offsetIter = requestedColumns.find(info.offsetName);
444 if (offsetIter == requestedColumns.end() || offsetIter->second.offsetName != eventRangeColumnName)
445 {
446 ANA_MSG_WARNING ("skipping column {} as it is neither a scalar per-event output nor a scalar decoration on a global container", name);
447 continue;
448 }
450 }
451 if (!myColumn)
452 {
453 ANA_MSG_WARNING("unhandled column type: " << info.name << " "<< info.type->name());
454 continue;
455 }
456 knownColumns.push_back(myColumn);
457 }
458 }
459 }
460}
macros for messaging and checking status codes
#define ANA_MSG_WARNING(xmsg,...)
Macro printing warning messages.
A number of constexpr particle constants to avoid hardcoding them directly in various places.
a class that holds the columnar data for a single call
void setColumn(std::size_t columnIndex, std::size_t size, CT *dataPtr)
set the data for the given column
the header information for the entire columnar data vector
static constexpr std::size_t nullIndex
the index used for an invalid index (always has to be 0)
std::unordered_map< std::string, ColumnInfo > getAllColumnInfo() const
get all columns as a map of ColumnInfo for use with IColumnData::connect
std::vector< OutputColumnInfo > outputColumns
constexpr double muonMassInMeV
the mass of the muon (in MeV)
std::variant< TTree *, RNTupleBackend * > Backend
std::shared_ptr< TestUtils::ColumnReader > makeOutputColumnReader(const ColumnInfo &info)
create an output column reader of the given template for the type of the column, or nullptr if the ty...
void makeCommonColumnReaders(std::vector< std::shared_ptr< TestUtils::ColumnReader > > &knownColumns)
void makeCommonLateColumnReaders(std::vector< std::shared_ptr< TestUtils::ColumnReader > > &knownColumns, const std::vector< std::string > &allMetTermNames)
void makeEventIndexColumnReaders(std::vector< std::shared_ptr< TestUtils::ColumnReader > > &knownColumns, const ColumnVectorHeader &columnHeader)
void makeOutputColumnReaders(std::vector< std::shared_ptr< TestUtils::ColumnReader > > &knownColumns, const ColumnVectorHeader &columnHeader)
@ output
an output column
Definition ColumnInfo.h:25
const std::string eventRangeColumnName
the default name for the column containing the event range
std::size_t ColumnarOffsetType
the type used for the size and offsets in the columnar data
STL namespace.
@ Jet
The object is a jet.
Definition ObjectType.h:40
@ Muon
The object is a muon.
Definition ObjectType.h:48
a struct that contains meta-information about each column that's needed to interface the column with ...
Definition ColumnInfo.h:73
the performance data for reading a single branch/column
std::array< ColumnarOffsetType, 2 > data
virtual void setData(ColumnVectorData &columnData) override
virtual void getEntry(Long64_t) override
virtual bool connect(Backend, std::unordered_map< std::string, const std::vector< ColumnarOffsetType > * > &, std::unordered_map< std::string, ColumnInfo > &requestedColumns) override
virtual BranchPerfData getPerfData(float) override
virtual bool connect(Backend, std::unordered_map< std::string, const std::vector< ColumnarOffsetType > * > &offsetColumns, std::unordered_map< std::string, ColumnInfo > &requestedColumns) override
ColumnReaderEventIndex(const std::string &val_columnName)
virtual void getEntry(Long64_t) override
virtual BranchPerfData getPerfData(float) override
const std::vector< ColumnarOffsetType > * offsetColumn
std::vector< ColumnarOffsetType > data
virtual void setData(ColumnVectorData &columnData) override
ColumnReaderOutScalar(const std::string &val_columnName, const T &val_defaultValue)
virtual BranchPerfData getPerfData(float) override
virtual bool connect(Backend, std::unordered_map< std::string, const std::vector< ColumnarOffsetType > * > &, std::unordered_map< std::string, ColumnInfo > &requestedColumns) override
virtual void getEntry(Long64_t) override
virtual void setData(ColumnVectorData &columnData) override
virtual BranchPerfData getPerfData(float) override
virtual bool connect(Backend, std::unordered_map< std::string, const std::vector< ColumnarOffsetType > * > &offsetColumns, std::unordered_map< std::string, ColumnInfo > &requestedColumns) override
virtual void getEntry(Long64_t) override
virtual void setData(ColumnVectorData &columnData) override
ColumnReaderOutVector(const std::string &val_columnName, const T &val_defaultValue)
const std::vector< ColumnarOffsetType > * offsetColumn
const std::vector< ColumnarOffsetType > * offsetColumns
virtual void getEntry(Long64_t) override
virtual bool connect(Backend source, std::unordered_map< std::string, const std::vector< ColumnarOffsetType > * > &offsetColumns, std::unordered_map< std::string, ColumnInfo > &requestedColumns) override
std::vector< ColumnarOffsetType > namesOffsets
std::vector< ColumnarOffsetType > offsets
virtual BranchPerfData getPerfData(float) override
ColumnReaderOutputMet(const std::string &val_columnName, std::vector< std::string > val_termNames)
virtual void setData(ColumnVectorData &colData) override