LDMX Software
dqm::ReSimVerifier Class Reference

Public Member Functions

 ReSimVerifier (const std::string &name, framework::Process &process)
 
void configure (framework::config::Parameters &parameters) override
 Callback for the EventProcessor to configure itself from the given set of parameters.
 
void analyze (const framework::Event &event) override
 Process the event and make histograms or summaries.
 
bool verifySimCalorimeterHits (const std::vector< ldmx::SimCalorimeterHit > &simHits, const std::vector< ldmx::SimCalorimeterHit > &reSimHits)
 
bool verifySimParticles (const framework::Event &event)
 
- Public Member Functions inherited from framework::Analyzer
 Analyzer (const std::string &name, Process &process)
 Class constructor.
 
virtual void process (Event &event) final
 Processing an event for an Analyzer is calling analyze.
 
virtual void beforeNewRun (ldmx::RunHeader &run_header) final
 Don't allow Analyzers to add parameters to the run header.
 
- Public Member Functions inherited from framework::EventProcessor
 DECLARE_FACTORY (EventProcessor, EventProcessor *, const std::string &, Process &)
 declare that we have a factory for this class
 
 EventProcessor (const std::string &name, Process &process)
 Class constructor.
 
virtual ~EventProcessor ()=default
 Class destructor.
 
virtual void onNewRun (const ldmx::RunHeader &run_header)
 Callback for the EventProcessor to take any necessary action when the run being processed changes.
 
virtual void onFileOpen (EventFile &event_file)
 Callback for the EventProcessor to take any necessary action when a new event input ROOT file is opened.
 
virtual void onFileClose (EventFile &event_file)
 Callback for the EventProcessor to take any necessary action when a event input ROOT file is closed.
 
virtual void onProcessStart ()
 Callback for the EventProcessor to take any necessary action when the processing of events starts, such as creating histograms.
 
virtual void onProcessEnd ()
 Callback for the EventProcessor to take any necessary action when the processing of events finishes, such as calculating job-summary quantities.
 
template<class T >
const T & getCondition (const std::string &condition_name)
 Access a conditions object for the current event.
 
TDirectory * getHistoDirectory ()
 Access/create a directory in the histogram file for this event processor to create histograms and analysis tuples.
 
void setStorageHint (framework::StorageControl::Hint hint)
 Mark the current event as having the given storage control hint from this module_.
 
void setStorageHint (framework::StorageControl::Hint hint, const std::string &purposeString)
 Mark the current event as having the given storage control hint from this module and the given purpose string.
 
int getLogFrequency () const
 Get the current logging frequency from the process.
 
int getRunNumber () const
 Get the run number from the process.
 
std::string getName () const
 Get the processor name.
 
void createHistograms (const std::vector< framework::config::Parameters > &histos)
 Internal function which is used to create histograms passed from the python configuration @parma histos vector of Parameters that configure histograms to create.
 

Private Attributes

std::vector< std::string > collections_
 
std::string sim_pass_name_ {""}
 
std::string re_sim_pass_name_ {""}
 
bool stop_on_error_ {}
 

Additional Inherited Members

- Protected Member Functions inherited from framework::EventProcessor
void abortEvent ()
 Abort the event immediately.
 
- Protected Attributes inherited from framework::EventProcessor
HistogramPool histograms_
 helper object for making and filling histograms
 
NtupleManagerntuple_ {NtupleManager::getInstance()}
 Manager for any ntuples.
 
logging::logger the_log_
 The logger for this EventProcessor.
 

Detailed Description

Definition at line 14 of file ReSimVerifier.h.

Constructor & Destructor Documentation

◆ ReSimVerifier()

dqm::ReSimVerifier::ReSimVerifier ( const std::string & name,
framework::Process & process )
inline

Definition at line 16 of file ReSimVerifier.h.

Base class for a module which does not produce a data product.
virtual void process(Event &event) final
Processing an event for an Analyzer is calling analyze.

Member Function Documentation

◆ analyze()

void dqm::ReSimVerifier::analyze ( const framework::Event & event)
overridevirtual

Process the event and make histograms or summaries.

Parameters
eventThe Event to analyze

Implements framework::Analyzer.

Definition at line 60 of file ReSimVerifier.cxx.

60 {
61 std::stringstream ss;
62 bool passing{true};
63 bool skipped{false};
64 auto event_number{event.getEventNumber()};
65 for (auto collection : collections_) {
66 const auto sim_hits = event.getCollection<ldmx::SimCalorimeterHit>(
67 collection, sim_pass_name_);
68 const auto re_sim_hits = event.getCollection<ldmx::SimCalorimeterHit>(
69 collection, re_sim_pass_name_);
70 if (re_sim_hits.size() == 0) {
71 skipped = true;
72 continue;
73 } else {
74 skipped = false;
75 }
76
77 if (!verifySimCalorimeterHits(sim_hits, re_sim_hits)) {
78 passing = false;
79 ss << "Event " << event_number << " has different simhits for "
80 << collection << std::endl;
81 }
82 }
83 if (skipped) {
84 ldmx_log(info) << "Skipping event " << event_number
85 << "since it was not resimulated";
86 }
87 if (!verifySimParticles(event)) {
88 passing = false;
89 ss << "Event " << event_number
90 << " has different SimParticles between the two passes" << std::endl;
91 }
92 if (!passing) {
93 if (stop_on_error_) {
94 EXCEPTION_RAISE("ReSimVerify", ss.str());
95 } else {
96 ldmx_log(info) << ss.str();
97 }
98 }
99
100} // Analyze
Stores simulated calorimeter hit information.

◆ configure()

void dqm::ReSimVerifier::configure ( framework::config::Parameters & parameters)
overridevirtual

Callback for the EventProcessor to configure itself from the given set of parameters.

The parameters a processor has access to are the member variables of the python class in the sequence that has className equal to the EventProcessor class name.

For an example, look at MyProcessor.

Parameters
parametersParameters for configuration.

Reimplemented from framework::EventProcessor.

Definition at line 4 of file ReSimVerifier.cxx.

4 {
5 sim_pass_name_ = parameters.get<std::string>("sim_pass_name");
6 re_sim_pass_name_ = parameters.get<std::string>("resim_pass_name");
7 stop_on_error_ = parameters.get<bool>("stop_on_error");
8 collections_ = parameters.get<std::vector<std::string>>("collections");
9}
const T & get(const std::string &name) const
Retrieve the parameter of the given name.
Definition Parameters.h:78

References framework::config::Parameters::get().

◆ verifySimCalorimeterHits()

bool dqm::ReSimVerifier::verifySimCalorimeterHits ( const std::vector< ldmx::SimCalorimeterHit > & simHits,
const std::vector< ldmx::SimCalorimeterHit > & reSimHits )

Definition at line 10 of file ReSimVerifier.cxx.

12 {
13 for (auto i{0}; i < simHits.size(); ++i) {
14 auto hit{simHits[i]};
15 auto rehit{reSimHits[i]};
16
17 if (hit.getEdep() != rehit.getEdep()) {
18 return false;
19 }
20 if (hit.getID() != rehit.getID()) {
21 return false;
22 }
23 if (hit.getTime() != rehit.getTime()) {
24 return false;
25 }
26 if (hit.getNumberOfContribs() != rehit.getNumberOfContribs()) {
27 return false;
28 }
29 auto pos{hit.getPosition()};
30 auto repos{rehit.getPosition()};
31 if (pos[0] != repos[0] || pos[1] != repos[1] || pos[2] != repos[2]) {
32 return false;
33 }
34 }
35 return true;
36}

◆ verifySimParticles()

bool dqm::ReSimVerifier::verifySimParticles ( const framework::Event & event)

Definition at line 38 of file ReSimVerifier.cxx.

38 {
39 const auto& sim_particles{
40 event.getMap<int, ldmx::SimParticle>("SimParticles", sim_pass_name_)};
41 const auto& re_sim_particles{
42 event.getMap<int, ldmx::SimParticle>("SimParticles", re_sim_pass_name_)};
43 for (auto [id, simParticle] : sim_particles) {
44 if (!re_sim_particles.count(id)) {
45 return false;
46 }
47 auto re_sim_particle{re_sim_particles.at(id)};
48 if (simParticle.getEnergy() != re_sim_particle.getEnergy()) {
49 return false;
50 }
51 if (simParticle.getPdgID() != re_sim_particle.getPdgID()) {
52 return false;
53 }
54 if (simParticle.getTime() != re_sim_particle.getTime()) {
55 return false;
56 }
57 }
58 return true;
59}
Class representing a simulated particle.
Definition SimParticle.h:23

Member Data Documentation

◆ collections_

std::vector<std::string> dqm::ReSimVerifier::collections_
private

Definition at line 41 of file ReSimVerifier.h.

◆ re_sim_pass_name_

std::string dqm::ReSimVerifier::re_sim_pass_name_ {""}
private

Definition at line 43 of file ReSimVerifier.h.

43{""};

◆ sim_pass_name_

std::string dqm::ReSimVerifier::sim_pass_name_ {""}
private

Definition at line 42 of file ReSimVerifier.h.

42{""};

◆ stop_on_error_

bool dqm::ReSimVerifier::stop_on_error_ {}
private

Definition at line 48 of file ReSimVerifier.h.

48{};

The documentation for this class was generated from the following files: