LDMX Software
ecal::test::EcalFakeSimHits Class Reference

Public Member Functions

 EcalFakeSimHits (const std::string &name, framework::Process &p)
 
void configure (framework::config::Parameters &ps) final override
 Callback for the EventProcessor to configure itself from the given set of parameters.
 
void beforeNewRun (ldmx::RunHeader &header) final override
 Callback for Producers to add parameters to the run header before conditions are initialized.
 
void produce (framework::Event &event) final override
 Process the event and put new data products into it.
 
- Public Member Functions inherited from framework::Producer
 Producer (const std::string &name, Process &process)
 Class constructor.
 
virtual void process (Event &event) final
 Processing an event for a Producer is calling produce.
 
- 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

double max_energy_
 Maximum energy to make a simulated hit for [MeV].
 
double min_energy_
 Minimum energy to make a sim hit for [MeV] Needs to be above readout threshold (after internal EcalDigi's calculation)
 
double max_time_
 last arrival time of the sim hit to make [ns]
 
double min_time_
 first arrival time of the sim hit to make [ns]
 
double energy_step_
 The step between energies (times) is calculated depending on the min, max energy (time) and the number of steps to take to get there.
 
double time_step_
 
double curr_energy_
 current energy of the sim hit we are on
 
double curr_time_
 current arrival time of the sim hit we are on
 

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 150 of file EcalDigiPipelineTest.cxx.

Constructor & Destructor Documentation

◆ EcalFakeSimHits()

ecal::test::EcalFakeSimHits::EcalFakeSimHits ( const std::string & name,
framework::Process & p )
inline

Definition at line 187 of file EcalDigiPipelineTest.cxx.

188 : framework::Producer(name, p) {}
Base class for a module which produces a data product.

◆ ~EcalFakeSimHits()

ecal::test::EcalFakeSimHits::~EcalFakeSimHits ( )
inline

Definition at line 189 of file EcalDigiPipelineTest.cxx.

189{}

Member Function Documentation

◆ beforeNewRun()

void ecal::test::EcalFakeSimHits::beforeNewRun ( ldmx::RunHeader & run_header)
inlinefinaloverridevirtual

Callback for Producers to add parameters to the run header before conditions are initialized.

Reimplemented from framework::EventProcessor.

Definition at line 208 of file EcalDigiPipelineTest.cxx.

208 {
209 header.setDetectorName("ldmx-det-v15-8gev");
210 }

◆ configure()

void ecal::test::EcalFakeSimHits::configure ( framework::config::Parameters & parameters)
inlinefinaloverridevirtual

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 class_name equal to the EventProcessor class name.

For an example, look at MyProcessor.

Parameters
parametersParameters for configuration.

Reimplemented from framework::EventProcessor.

Definition at line 191 of file EcalDigiPipelineTest.cxx.

191 {
192 min_energy_ = ps.get<double>("min_energy", MIP_SI_ENERGY);
193 max_energy_ = ps.get<double>("max_energy", 10000. * MEV_PER_FC);
194 // 299mm is about 1ns from target and in middle of ECal,
195 // so the default arrival time of 1ns is an in-time hit
196 min_time_ = ps.get<double>("min_time", 1.);
197 max_time_ = ps.get<double>("max_time", 1.);
198 // should match the number of events the process runs
199 int n_steps = ps.get<int>("n_steps", NUM_TEST_SIM_HITS);
200
201 energy_step_ = (max_energy_ - min_energy_) / n_steps;
202 time_step_ = (max_time_ - min_time_) / n_steps;
203
206 }
double curr_time_
current arrival time of the sim hit we are on
double max_time_
last arrival time of the sim hit to make [ns]
double curr_energy_
current energy of the sim hit we are on
double max_energy_
Maximum energy to make a simulated hit for [MeV].
double min_time_
first arrival time of the sim hit to make [ns]
double min_energy_
Minimum energy to make a sim hit for [MeV] Needs to be above readout threshold (after internal EcalDi...
double energy_step_
The step between energies (times) is calculated depending on the min, max energy (time) and the numbe...

References curr_energy_, curr_time_, energy_step_, max_energy_, max_time_, min_energy_, and min_time_.

◆ produce()

void ecal::test::EcalFakeSimHits::produce ( framework::Event & event)
inlinefinaloverridevirtual

Process the event and put new data products into it.

Parameters
eventThe Event to process.

Implements framework::Producer.

Definition at line 212 of file EcalDigiPipelineTest.cxx.

212 {
213 // put in a single sim hit
214 std::vector<ldmx::SimCalorimeterHit> pretend_sim_hits(1);
215
216 ldmx::EcalID id(0, 0, 0);
217 pretend_sim_hits[0].setID(id.raw());
218 // incidentID, trackID, pdg ID, edep, time
219 pretend_sim_hits[0].addContrib(-1, -1, 0, curr_energy_, curr_time_);
220 // sim position in middle of ECal
221 pretend_sim_hits[0].setPosition(0., 0., 299.);
222
223 // needs to be correct collection name
224 REQUIRE_NOTHROW(event.add("EcalSimHits", pretend_sim_hits));
225
227 curr_time_ += time_step_;
228
229 return;
230 }
void add(const std::string &collectionName, T &obj)
Adds an object to the event bus.
Definition Event.h:195
Extension of DetectorID providing access to ECal layers and cell numbers in a hex grid.
Definition EcalID.h:20

References curr_energy_, curr_time_, and energy_step_.

Member Data Documentation

◆ curr_energy_

double ecal::test::EcalFakeSimHits::curr_energy_
private

current energy of the sim hit we are on

Definition at line 181 of file EcalDigiPipelineTest.cxx.

Referenced by configure(), and produce().

◆ curr_time_

double ecal::test::EcalFakeSimHits::curr_time_
private

current arrival time of the sim hit we are on

Definition at line 184 of file EcalDigiPipelineTest.cxx.

Referenced by configure(), and produce().

◆ energy_step_

double ecal::test::EcalFakeSimHits::energy_step_
private

The step between energies (times) is calculated depending on the min, max energy (time) and the number of steps to take to get there.

Definition at line 177 of file EcalDigiPipelineTest.cxx.

Referenced by configure(), and produce().

◆ max_energy_

double ecal::test::EcalFakeSimHits::max_energy_
private

Maximum energy to make a simulated hit for [MeV].

The maximum value to be readout is 4096 TDC which is equivalent to ~10000fC deposited charge.

Definition at line 157 of file EcalDigiPipelineTest.cxx.

Referenced by configure().

◆ max_time_

double ecal::test::EcalFakeSimHits::max_time_
private

last arrival time of the sim hit to make [ns]

Definition at line 168 of file EcalDigiPipelineTest.cxx.

Referenced by configure().

◆ min_energy_

double ecal::test::EcalFakeSimHits::min_energy_
private

Minimum energy to make a sim hit for [MeV] Needs to be above readout threshold (after internal EcalDigi's calculation)

One MIP is ~0.13 MeV, so we choose that.

Definition at line 165 of file EcalDigiPipelineTest.cxx.

Referenced by configure().

◆ min_time_

double ecal::test::EcalFakeSimHits::min_time_
private

first arrival time of the sim hit to make [ns]

Definition at line 171 of file EcalDigiPipelineTest.cxx.

Referenced by configure().

◆ time_step_

double ecal::test::EcalFakeSimHits::time_step_
private

Definition at line 178 of file EcalDigiPipelineTest.cxx.


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