LDMX Software
ecal::test::EcalFakeSimHits Class Reference

Public Member Functions

 EcalFakeSimHits (const std::string &name, framework::Process &p)
 
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 configure (framework::config::Parameters &parameters)
 Callback for the EventProcessor to configure itself from the given set of parameters.
 
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

const double MAX_ENERGY = 10000. * MEV_PER_FC
 Maximum energy to make a simulated hit for [MeV].
 
const double MIN_ENERGY = MIP_SI_ENERGY
 Minimum energy to make a sim hit for [MeV] Needs to be above readout threshold (after internal EcalDigi's calculation)
 
const double ENERGY_STEP = (MAX_ENERGY - MIN_ENERGY) / NUM_TEST_SIM_HITS
 The step between energies is calculated depending on the min, max energy and the total number of sim hits_ you desire.
 
double curr_energy_ = MIN_ENERGY
 current energy 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 178 of file EcalDigiPipelineTest.cxx.

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

◆ ~EcalFakeSimHits()

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

Definition at line 180 of file EcalDigiPipelineTest.cxx.

180{}

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

182 {
183 header.setDetectorName("ldmx-det-v14-8gev");
184 }

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

186 {
187 // put in a single sim hit
188 std::vector<ldmx::SimCalorimeterHit> pretend_sim_hits(1);
189
190 ldmx::EcalID id(0, 0, 0);
191 pretend_sim_hits[0].setID(id.raw());
192 // incidentID, trackID, pdg ID, edep, time - 299mm is about 1ns from target
193 // and in middle of ECal
194 pretend_sim_hits[0].addContrib(-1, -1, 0, curr_energy_, 1.);
195 // sim position in middle of ECal
196 pretend_sim_hits[0].setPosition(0., 0., 299.);
197
198 // needs to be correct collection name
199 REQUIRE_NOTHROW(event.add("EcalSimHits", pretend_sim_hits));
200
202
203 return;
204 }
const double ENERGY_STEP
The step between energies is calculated depending on the min, max energy and the total number of sim ...
double curr_energy_
current energy of the sim hit we are on
void add(const std::string &collectionName, T &obj)
Adds an object to the event bus.
Definition Event.h:184
Extension of DetectorID providing access to ECal layers and cell numbers in a hex grid.
Definition EcalID.h:20

References curr_energy_, and ENERGY_STEP.

Member Data Documentation

◆ curr_energy_

double ecal::test::EcalFakeSimHits::curr_energy_ = MIN_ENERGY
private

current energy of the sim hit we are on

Definition at line 175 of file EcalDigiPipelineTest.cxx.

Referenced by produce().

◆ ENERGY_STEP

const double ecal::test::EcalFakeSimHits::ENERGY_STEP = (MAX_ENERGY - MIN_ENERGY) / NUM_TEST_SIM_HITS
private

The step between energies is calculated depending on the min, max energy and the total number of sim hits_ you desire.

[MeV]

Definition at line 172 of file EcalDigiPipelineTest.cxx.

Referenced by produce().

◆ MAX_ENERGY

const double ecal::test::EcalFakeSimHits::MAX_ENERGY = 10000. * MEV_PER_FC
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.

◆ MIN_ENERGY

const double ecal::test::EcalFakeSimHits::MIN_ENERGY = MIP_SI_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.


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