artdaq_demo  3.13.00
CheckIntegrity_module.cc
1 // Class: CheckIntegrity
3 // Module Type: analyzer
4 // File: CheckIntegrity_module.cc
5 // Description: Prints out information about each event.
7 
8 #include "art/Framework/Core/EDAnalyzer.h"
9 #include "art/Framework/Core/ModuleMacros.h"
10 #include "art/Framework/Principal/Event.h"
11 #include "art/Framework/Principal/Handle.h"
12 #include "canvas/Utilities/Exception.h"
13 
14 #include "artdaq-core-demo/Overlays/FragmentType.hh"
15 #include "artdaq-core-demo/Overlays/ToyFragment.hh"
16 #include "artdaq-core/Data/ContainerFragment.hh"
17 #include "artdaq-core/Data/Fragment.hh"
18 
19 #include "TRACE/tracemf.h" // TLOG
20 #define TRACE_NAME "CheckIntegrity"
21 
22 #include <algorithm>
23 #include <cassert>
24 #include <cmath>
25 #include <fstream>
26 #include <iomanip>
27 #include <iostream>
28 #include <vector>
29 
30 namespace demo {
31 class CheckIntegrity;
32 } // namespace demo
33 
37 class demo::CheckIntegrity : public art::EDAnalyzer
38 {
39 public:
49  explicit CheckIntegrity(fhicl::ParameterSet const& pset);
50 
54  ~CheckIntegrity() override = default;
55 
60  void analyze(art::Event const& evt) override;
61 
62 private:
63  CheckIntegrity(CheckIntegrity const&) = delete;
64  CheckIntegrity(CheckIntegrity&&) = delete;
65  CheckIntegrity& operator=(CheckIntegrity const&) = delete;
66  CheckIntegrity& operator=(CheckIntegrity&&) = delete;
67 
68  std::string raw_data_label_;
69  bool exception_on_integrity_failure_;
70 };
71 
72 demo::CheckIntegrity::CheckIntegrity(fhicl::ParameterSet const& pset)
73  : EDAnalyzer(pset)
74  , raw_data_label_(pset.get<std::string>("raw_data_label", "daq"))
75  , exception_on_integrity_failure_(pset.get<bool>("exception_on_integrity_failure", false))
76 {}
77 
78 void demo::CheckIntegrity::analyze(art::Event const& evt)
79 {
80  artdaq::Fragments fragments;
81  artdaq::FragmentPtrs containerFragments;
82 
83  std::vector<art::Handle<artdaq::Fragments>> fragmentHandles;
84  fragmentHandles = evt.getMany<std::vector<artdaq::Fragment>>();
85 
86  for (const auto& handle : fragmentHandles)
87  {
88  if (!handle.isValid() || handle->empty())
89  {
90  continue;
91  }
92 
93  if (handle->front().type() == artdaq::Fragment::ContainerFragmentType)
94  {
95  for (const auto& cont : *handle)
96  {
97  artdaq::ContainerFragment contf(cont);
98  if (contf.fragment_type() != demo::FragmentType::TOY1 && contf.fragment_type() != demo::FragmentType::TOY2)
99  {
100  break;
101  }
102 
103  for (size_t ii = 0; ii < contf.block_count(); ++ii)
104  {
105  containerFragments.push_back(contf[ii]);
106  fragments.push_back(*containerFragments.back());
107  }
108  }
109  }
110  else
111  {
112  if (handle->front().type() == demo::FragmentType::TOY1 || handle->front().type() == demo::FragmentType::TOY2)
113  {
114  for (auto frag : *handle)
115  {
116  fragments.emplace_back(frag);
117  }
118  }
119  }
120  }
121 
122  TLOG(TLVL_DEBUG) << "Run " << evt.run() << ", subrun " << evt.subRun() << ", event " << evt.event() << " has "
123  << fragments.size() << " fragment(s) of type TOY1 or TOY2";
124 
125  bool err = false;
126  for (const auto& frag : fragments)
127  {
128  // These methods take significantly more time when processing non-CurrentVersion Fragments, so cache them here
129  ToyFragment bb(frag);
130  auto dist_type = bb.hdr_distribution_type();
131 
132  auto evtSize = bb.hdr_event_size() * sizeof(ToyFragment::Header::data_t);
133  if (bb.hdr_event_size() % (sizeof(artdaq::RawDataType) / sizeof(ToyFragment::Header::data_t)) != 0) {
134  evtSize = ceil(evtSize / static_cast<double>(sizeof(artdaq::RawDataType))) * sizeof(artdaq::RawDataType);
135  }
136 
137  if (evtSize !=
138  frag.dataSize() * sizeof(artdaq::RawDataType))
139  {
140  TLOG(TLVL_ERROR) << "Error: in run " << evt.run() << ", subrun " << evt.subRun() << ", event "
141  << evt.event() << ", seqID " << frag.sequenceID() << ", fragID " << frag.fragmentID()
142  << ": Size mismatch!"
143  << " ToyFragment Header reports size of "
144  << bb.hdr_event_size() * sizeof(ToyFragment::Header::data_t)
145  << " bytes, but Fragment reports size of "
146  << frag.dataSize() * sizeof(artdaq::RawDataType) << " bytes.";
147 
148  if (exception_on_integrity_failure_)
149  {
150  throw cet::exception("CheckIntegrity")
151  << "Error: in run " << evt.run() << ", subrun " << evt.subRun() << ", event " << evt.event()
152  << ", seqID " << frag.sequenceID() << ", fragID " << frag.fragmentID() << ": Size mismatch!"
153  << " ToyFragment Header reports size of "
154  << bb.hdr_event_size() * sizeof(ToyFragment::Header::data_t)
155  << " bytes, but Fragment reports size of " << frag.dataSize() * sizeof(artdaq::RawDataType)
156  << " bytes.";
157  }
158  continue;
159  }
160 
161  if ((frag.size() - frag.headerSizeWords() - frag.dataSize()) * sizeof(artdaq::RawDataType) !=
162  sizeof(ToyFragment::Metadata))
163  {
164  TLOG(TLVL_ERROR) << "Error: in run " << evt.run() << ", subrun " << evt.subRun() << ", event "
165  << evt.event() << ", seqID " << frag.sequenceID() << ", fragID " << frag.fragmentID()
166  << ": Metadata error!"
167  << " ToyFragment metadata size should be " << sizeof(ToyFragment::Metadata)
168  << " bytes, but Fragment reports size of "
169  << (frag.size() - frag.headerSizeWords() - frag.dataSize()) *
170  sizeof(artdaq::RawDataType)
171  << " bytes.";
172  if (exception_on_integrity_failure_)
173  {
174  throw cet::exception("CheckIntegrity")
175  << "Error: in run " << evt.run() << ", subrun " << evt.subRun() << ", event " << evt.event()
176  << ", seqID " << frag.sequenceID() << ", fragID " << frag.fragmentID() << ": Metadata error!"
177  << " ToyFragment metadata size should be " << sizeof(ToyFragment::Metadata)
178  << " bytes, but Fragment reports size of "
179  << (frag.size() - frag.headerSizeWords() - frag.dataSize()) * sizeof(artdaq::RawDataType)
180  << " bytes.";
181  }
182  continue;
183  }
184 
185  {
186  auto adc_iter = bb.dataBeginADCs();
187  auto adc_end = bb.dataEndADCs();
188  ToyFragment::adc_t expected_adc = 1;
189 
190  for (; adc_iter != adc_end; adc_iter++, expected_adc++)
191  {
192  if (expected_adc > demo::ToyFragment::adc_range(frag.metadata<ToyFragment::Metadata>()->num_adc_bits))
193  {
194  expected_adc = 0;
195  }
196 
197  // ELF 7/10/18: Distribution type 2 is the monotonically-increasing one
198  if (dist_type == 2 && *adc_iter != expected_adc)
199  {
200  TLOG(TLVL_ERROR) << "Error: in run " << evt.run() << ", subrun " << evt.subRun() << ", event "
201  << evt.event() << ", seqID " << frag.sequenceID() << ", fragID "
202  << frag.fragmentID() << ": expected an ADC value of " << expected_adc << ", got "
203  << *adc_iter;
204  err = true;
205  if (exception_on_integrity_failure_)
206  {
207  throw cet::exception("CheckIntegrity")
208  << "Error: in run " << evt.run() << ", subrun " << evt.subRun() << ", event " << evt.event()
209  << ", seqID " << frag.sequenceID() << ", fragID " << frag.fragmentID()
210  << ": expected an ADC value of " << expected_adc << ", got " << *adc_iter;
211  }
212  break;
213  }
214 
215  // ELF 7/10/18: As of now, distribution types 3 and 4 are uninitialized, and can therefore produce
216  // out-of-range counts.
217  if (bb.hdr_distribution_type() < 3 &&
218  *adc_iter > demo::ToyFragment::adc_range(frag.metadata<ToyFragment::Metadata>()->num_adc_bits))
219  {
220  TLOG(TLVL_ERROR) << "Error: in run " << evt.run() << ", subrun " << evt.subRun() << ", event "
221  << evt.event() << ", seqID " << frag.sequenceID() << ", fragID "
222  << frag.fragmentID() << ": " << *adc_iter
223  << " is out-of-range for this Fragment type";
224  err = true;
225  if (exception_on_integrity_failure_)
226  {
227  throw cet::exception("CheckIntegrity")
228  << "Error: in run " << evt.run() << ", subrun " << evt.subRun() << ", event " << evt.event()
229  << ", seqID " << frag.sequenceID() << ", fragID " << frag.fragmentID() << ": " << *adc_iter
230  << " is out-of-range for this Fragment type";
231  }
232  break;
233  }
234  }
235  }
236  }
237  if (!err)
238  {
239  TLOG(TLVL_DEBUG) << "In run " << evt.run() << ", subrun " << evt.subRun() << ", event " << evt.event()
240  << ", everything is fine";
241  }
242 }
243 
244 DEFINE_ART_MODULE(demo::CheckIntegrity) // NOLINT(performance-unnecessary-value-param)
~CheckIntegrity() override=default
Default destructor.
void analyze(art::Event const &evt) override
Analyze an event. Called by art for each event in run (based on command line options) ...
Demonstration art::EDAnalyzer which checks that all ToyFragment ADC counts are in the defined range...
CheckIntegrity(fhicl::ParameterSet const &pset)
CheckIntegrity Constructor.