LDMX Software
OverlayProducer.h
1#ifndef RECON_OVERLAYPRODUCER_H
2#define RECON_OVERLAYPRODUCER_H
3
4//---< C++ StdLib >---//
5#include <memory>
6#include <string>
7#include <vector>
8
9//---< ROOT >---//
10#include "TRandom2.h"
11
12//---< Framework >---//
13#include "Framework/Configure/Parameters.h"
14#include "Framework/EventFile.h"
16
17namespace recon {
18
23 public:
24 OverlayProducer(const std::string& name, framework::Process& process)
25 : framework::Producer(name, process), overlay_event_{"overlay"} {}
26
27 // Destructor
28 virtual ~OverlayProducer() = default;
29
33 void configure(framework::config::Parameters& parameters) override;
34
39 void onNewRun(const ldmx::RunHeader&) override; // ); //
40
58 void produce(framework::Event& event) override;
59
70 int encodeTrack(int track_id, const unsigned int encoding_version,
71 const unsigned int event_index = 0);
72
76 void onProcessStart() override;
77
78 private:
81
85 std::string overlay_filename_;
86
90 std::unique_ptr<framework::EventFile> overlay_file_;
91
96
101 std::vector<std::string> calo_collections_;
102
107 std::vector<std::string> tracker_collections_;
108
113 std::vector<std::string> particle_collections_;
114
118 std::vector<std::string> contrib_collections_;
119
123 std::string overlay_passname_;
124
128 std::string sim_passname_;
129
134 std::string out_coll_postfix_;
135
141
147
151 double poisson_mu_{0.};
152
158 std::unique_ptr<TRandom2> rndm_;
159
165 std::unique_ptr<TRandom2> rndm_time_;
166
171 double time_sigma_{0.};
172
178 double time_mean_{0.};
179
183 double bunch_spacing_{0.};
184
191
197 int n_later_{0};
198
204
210
222};
223} // namespace recon
224
225#endif /* RECON_OVERLAY_OVERLAYPRODUCER_H */
Base classes for all user event processing components to extend.
Implements an event buffer system for storing event data.
Definition Event.h:40
Class which represents the process under execution.
Definition Process.h:34
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:26
Run-specific configuration and data stored in its own output TTree alongside the event TTree in the o...
Definition RunHeader.h:68
Class to overlay in-time pile-up events from an overlay file.
int encodeTrack(int track_id, const unsigned int encoding_version, const unsigned int event_index=0)
Encode track ID with overlay event information.
int start_event_max_
Maximum event number to start overlaying from.
std::vector< std::string > particle_collections_
List of SimParticle collection(s) to loop over and add hits from, combining sim and pileup.
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.
unsigned track_id_encoding_
Track ID encoding scheme version.
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.
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.