LDMX Software
OverlayProducer.h
1#ifndef RECON_OVERLAYPRODUCER_H
2#define RECON_OVERLAYPRODUCER_H
3
4//---< C++ StdLib >---//
5#include <algorithm>
6#include <map>
7#include <memory>
8#include <string>
9#include <vector>
10
11//---< ROOT >---//
12#include "TFile.h"
13#include "TRandom2.h"
14
15//---< Framework >---//
16#include "Framework/Configure/Parameters.h"
17#include "Framework/EventFile.h"
19#include "Framework/Exception/Exception.h"
23
24namespace recon {
25
30 public:
31 OverlayProducer(const std::string &name, framework::Process &process)
32 : framework::Producer(name, process), overlay_event_{"overlay"} {}
33
34 // Destructor
35 virtual ~OverlayProducer() = default;
36
40 void configure(framework::config::Parameters &parameters) override;
41
46 void onNewRun(const ldmx::RunHeader &) override; // ); //
47
65 void produce(framework::Event &event) override;
66
70 void onProcessStart() override;
71
72 private:
75
79 std::string overlay_filename_;
80
84 std::unique_ptr<framework::EventFile> overlay_file_;
85
90
95 std::vector<std::string> calo_collections_;
96
101 std::vector<std::string> tracker_collections_;
102
106 std::vector<std::string> contrib_collections_;
107
111 std::string overlay_passname_;
112
116 std::string sim_passname_;
117
122 std::string out_coll_postfix_;
123
129
135
139 double poisson_mu_{0.};
140
146 std::unique_ptr<TRandom2> rndm_;
147
153 std::unique_ptr<TRandom2> rndm_time_;
154
159 double time_sigma_{0.};
160
166 double time_mean_{0.};
167
171 double bunch_spacing_{0.};
172
179
185 int n_later_{0};
186
192
198
206 int overlay_track_id_{-1000};
207 int overlay_pdg_code_{0};
208};
209} // namespace recon
210
211#endif /* RECON_OVERLAY_OVERLAYPRODUCER_H */
Base classes for all user event processing components to extend.
Conditions object for random number seeds.
Class which stores simulated calorimeter hit information.
Class which encapsulates information from a hit in a simulated tracking detector.
Implements an event buffer system for storing event data.
Definition Event.h:42
Class which represents the process under execution.
Definition Process.h:37
Base class for a module which produces a data product.
virtual void process(Event &event) final
Processing an event for a Producer is calling produce.
Class encapsulating parameters for configuring a processor.
Definition Parameters.h:29
Run-specific configuration and data stored in its own output TTree alongside the event TTree in the o...
Definition RunHeader.h:57
Class to overlay in-time pile-up events from an overlay file.
int start_event_max_
Maximum event number to start overlaying from.
std::string overlay_filename_
Pileup overlay events input file name.
std::unique_ptr< framework::EventFile > overlay_file_
Pileup overlay events input file.
bool do_poisson_in_time_
Let the total number of in-time events be poisson distributed, or fix at the chosen value,...
int n_later_
Number of bunches after the sim event to pull pileup events from.
std::string overlay_passname_
Pileup overlay events input pass name.
bool do_poisson_out_of_time_
Let the total number of out-of-time events be poisson distributed, or fix at the chosen value,...
void onNewRun(const ldmx::RunHeader &) override
At the start of the run, the pileup overlay file is set up, and the starting event number is chosen,...
std::vector< std::string > tracker_collections_
List of SimTrackerHit collection(s) to loop over and add hits from, combining sim and pileup.
framework::config::Parameters params_
The parameters used to configure this producer.
std::vector< std::string > contrib_collections_
List of SimCalorimeterHit collections which keep track of hit contribs.
double bunch_spacing_
Spacing in time (in [ns]) between electron bunches.
std::string sim_passname_
To use for finding the sim event bus passengers, mostly a disambiguation.
std::vector< std::string > calo_collections_
List of SimCalorimeterHit collection(s) to loop over and add hits from, combining sim and pileup.
std::unique_ptr< TRandom2 > rndm_time_
Random number generator for pileup event time offset.
std::unique_ptr< TRandom2 > rndm_
Random number generator for number of overlaid events.
void produce(framework::Event &event) override
Based on the list of collections to overlay, and the desired number of events, loop through all relev...
double poisson_mu_
(average) total number of events
void configure(framework::config::Parameters &parameters) override
Configure the processor with input parameters from the python cofig.
std::string out_coll_postfix_
Postfix to add to the collection name of the overlayed collections.
void onProcessStart() override
At the start of processing, the pileup overlay file is set up.
int overlay_incident_id_
For Ecal, overlay hits should be added as contribs.
double time_sigma_
Width of pileup bunch spread in time (in [ns]), specified as a sigma of a Gaussian distribution.
int start_event_min_
Minimum event number to start overlaying from.
framework::Event overlay_event_
The overlay ldmx event bus.
double time_mean_
Average position in time (in [ns]) of pileup bunches, relative to the sim event.
int n_earlier_
Number of bunches before the sim event to pull pileup events from.