LDMX Software
Public Member Functions | Private Attributes | List of all members
hcal::test::HcalFakeSimHits Class Reference

Public Member Functions

 HcalFakeSimHits (const std::string &name, framework::Process &p)
 
void beforeNewRun (ldmx::RunHeader &header) final override
 Handle allowing producers to modify run headers before the run begins.
 
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.
 
- Public Member Functions inherited from framework::EventProcessor
 EventProcessor (const std::string &name, Process &process)
 Class constructor.
 
virtual ~EventProcessor ()
 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 &runHeader)
 Callback for the EventProcessor to take any necessary action when the run being processed changes.
 
virtual void onFileOpen (EventFile &eventFile)
 Callback for the EventProcessor to take any necessary action when a new event input ROOT file is opened.
 
virtual void onFileClose (EventFile &eventFile)
 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 maxEnergy_ = 200 * PE_ENERGY
 Maximum energy to make a simulated hit for [MeV].
 
const double minEnergy_ = 4 * PE_ENERGY
 Minimum energy to make a sim hit for [MeV] Needs to be above readout threshold (after internal HcalDigi's calculation)
 
const double energyStep_ = (maxEnergy_ - minEnergy_) / 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 currEnergy_ = minEnergy_
 current energy of the sim hit we are on
 

Additional Inherited Members

- Static Public Member Functions inherited from framework::EventProcessor
static void declare (const std::string &classname, int classtype, EventProcessorMaker *)
 Internal function which is part of the PluginFactory machinery.
 
- Static Public Attributes inherited from framework::Producer
static const int CLASSTYPE {1}
 Constant used to track EventProcessor types by the PluginFactory.
 
- Protected Member Functions inherited from framework::EventProcessor
void abortEvent ()
 Abort the event immediately.
 
- Protected Attributes inherited from framework::EventProcessor
HistogramHelper histograms_
 Interface class for making and filling histograms.
 
NtupleManagerntuple_ {NtupleManager::getInstance()}
 Manager for any ntuples.
 
logging::logger theLog_
 The logger for this EventProcessor.
 

Detailed Description

Definition at line 121 of file HcalDigiPipelineTest.cxx.

Constructor & Destructor Documentation

◆ HcalFakeSimHits()

hcal::test::HcalFakeSimHits::HcalFakeSimHits ( const std::string &  name,
framework::Process p 
)
inline

Definition at line 145 of file HcalDigiPipelineTest.cxx.

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

◆ ~HcalFakeSimHits()

hcal::test::HcalFakeSimHits::~HcalFakeSimHits ( )
inline

Definition at line 147 of file HcalDigiPipelineTest.cxx.

147{}

Member Function Documentation

◆ beforeNewRun()

void hcal::test::HcalFakeSimHits::beforeNewRun ( ldmx::RunHeader header)
inlinefinaloverridevirtual

Handle allowing producers to modify run headers before the run begins.

Parameters
headerRunHeader for Producer to add parameters to

Reimplemented from framework::Producer.

Definition at line 149 of file HcalDigiPipelineTest.cxx.

149 {
150 header.setDetectorName("ldmx-det-v12");
151 }
void setDetectorName(const std::string &det)
Set the name of the detector that was used in this run.
Definition RunHeader.h:80

◆ produce()

void hcal::test::HcalFakeSimHits::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 153 of file HcalDigiPipelineTest.cxx.

153 {
154 // put in a single sim hit
155 std::vector<ldmx::SimCalorimeterHit> pretendSimHits(1);
156
157 // We hard-code the position of one hit: back hcal, layer 1, strip 31
158 // This real simHit position is obtained by looking at calorimeter
159 // SimHits of a 4 GeV muon shoot through the beamline
160 ldmx::HcalID id(0, 1, 31);
161 pretendSimHits[0].setPosition(-6.70265, 3.70265, 879); // mm
162 pretendSimHits[0].setID(id.raw());
163 pretendSimHits[0].addContrib(
164 -1, // incidentID
165 -1, // trackID
166 0, // pdg ID
167 currEnergy_, // edep
168 2.96628 // time - 299mm is about 1ns from target and in middle of HCal
169 );
170
171 // needs to be correct collection name
172 // REQUIRE_NOTHROW(event.add("HcalSimHits", pretendSimHits));
173 REQUIRE_NOTHROW(event.add("HcalFakeSimHits", pretendSimHits));
175
176 return;
177 }
void add(const std::string &collectionName, T &obj)
Adds an object to the event bus.
Definition Event.h:173
double currEnergy_
current energy of the sim hit we are on
const double energyStep_
The step between energies is calculated depending on the min, max energy and the total number of sim ...
Implements detector ids for HCal subdetector.
Definition HcalID.h:19

References currEnergy_, and energyStep_.

Member Data Documentation

◆ currEnergy_

double hcal::test::HcalFakeSimHits::currEnergy_ = minEnergy_
private

current energy of the sim hit we are on

Definition at line 142 of file HcalDigiPipelineTest.cxx.

Referenced by produce().

◆ energyStep_

const double hcal::test::HcalFakeSimHits::energyStep_ = (maxEnergy_ - minEnergy_) / 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 139 of file HcalDigiPipelineTest.cxx.

Referenced by produce().

◆ maxEnergy_

const double hcal::test::HcalFakeSimHits::maxEnergy_ = 200 * PE_ENERGY
private

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

Definition at line 127 of file HcalDigiPipelineTest.cxx.

◆ minEnergy_

const double hcal::test::HcalFakeSimHits::minEnergy_ = 4 * PE_ENERGY
private

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

Definition at line 133 of file HcalDigiPipelineTest.cxx.


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