#include <HcalTBDigiProducer.h>

Inheritance diagram for HcalTBDigiProducer:

Public Member Functions
void	accumulate (edm::Event const &e, edm::EventSetup const &c) override

void	accumulate (PileUpEventPrincipal const &e, edm::EventSetup const &c, edm::StreamID const &) override

void	finalizeEvent (edm::Event &e, edm::EventSetup const &c) override

	HcalTBDigiProducer (const edm::ParameterSet &ps, edm::ProducesCollector, edm::ConsumesCollector &iC)

void	initializeEvent (edm::Event const &e, edm::EventSetup const &c) override

	~HcalTBDigiProducer () override

Public Member Functions inherited from DigiAccumulatorMixMod
virtual void	beginLuminosityBlock (edm::LuminosityBlock const &lumi, edm::EventSetup const &setup)

virtual void	beginRun (edm::Run const &run, edm::EventSetup const &setup)

	DigiAccumulatorMixMod ()

	DigiAccumulatorMixMod (DigiAccumulatorMixMod const &)=delete

virtual void	endLuminosityBlock (edm::LuminosityBlock const &lumi, edm::EventSetup const &setup)

virtual void	endRun (edm::Run const &run, edm::EventSetup const &setup)

virtual void	finalizeBunchCrossing (edm::Event &event, edm::EventSetup const &setup, int bunchCrossing)

virtual PileupMixingContent *	getEventPileupInfo ()

virtual void	initializeBunchCrossing (edm::Event const &event, edm::EventSetup const &setup, int bunchCrossing)

DigiAccumulatorMixMod const &	operator= (DigiAccumulatorMixMod const &)=delete

virtual void	StorePileupInformation (std::vector< int > &numInteractionList, std::vector< int > &bunchCrossingList, std::vector< float > &TrueInteractionList, std::vector< edm::EventID > &eventList, int bunchSpace)

virtual	~DigiAccumulatorMixMod ()

Private Types
typedef CaloTDigitizer< HBHEDigitizerTraits >	HBHEDigitizer

typedef CaloTDigitizer< HODigitizerTraits >	HODigitizer

Private Member Functions
void	accumulateCaloHits (edm::Handle< std::vector< PCaloHit >> const &hits, int bunchCrossing)

void	checkGeometry (const edm::EventSetup &eventSetup)

void	setPhaseShift (const DetId &detId)

void	sortHits (const edm::PCaloHitContainer &hits)
	fills the vectors for each subdetector More...

void	updateGeometry ()

Private Attributes
const edm::ESGetToken< HcalDbService, HcalDbRecord >	conditionsToken_

bool	doPhaseShift

const std::string	ecalTBInfoLabel

const edm::ESGetToken< CaloGeometry, CaloGeometryRecord >	geometryToken_

edm::ESWatcher< CaloGeometryRecord >	geometryWatcher_

std::vector< DetId >	hbheCells

const HcalTimeSlew *	hcalTimeSlew_delay_

const edm::ESGetToken< HcalTimeSlew, HcalTimeSlewRecord >	hcalTimeSlew_delay_token_

const edm::EDGetTokenT< std::vector< PCaloHit > >	hcalToken_

std::vector< DetId >	hoCells

HcalSimParameterMap *	paraMap

CLHEP::HepRandomEngine *	randomEngine_ = nullptr

HcalAmplifier *	theAmplifier

HcalCoderFactory *	theCoderFactory

edm::EDGetTokenT< PEcalTBInfo >	theEcalTBToken_

HcalElectronicsSim *	theElectronicsSim

const CaloGeometry *	theGeometry

std::unique_ptr< HBHEDigitizer >	theHBHEDigitizer

HBHEHitFilter	theHBHEHitFilter

std::vector< PCaloHit >	theHBHEHits

CaloHitResponse *	theHBHEResponse

CaloVShape *	theHcalIntegratedShape

CaloVShape *	theHcalShape

std::unique_ptr< HODigitizer >	theHODigitizer

HOHitFilter	theHOHitFilter

std::vector< PCaloHit >	theHOHits

CaloHitResponse *	theHOResponse

HcalTBSimParameterMap *	theParameterMap

HcalTimeSlewSim *	theTimeSlewSim

double	thisPhaseShift

const double	tunePhaseShift

Detailed Description

Definition at line 36 of file HcalTBDigiProducer.h.

Member Typedef Documentation

◆ HBHEDigitizer

typedef CaloTDigitizer<HBHEDigitizerTraits> HcalTBDigiProducer::HBHEDigitizer

private

Reconstruction algorithm

Definition at line 62 of file HcalTBDigiProducer.h.

◆ HODigitizer

typedef CaloTDigitizer<HODigitizerTraits> HcalTBDigiProducer::HODigitizer

private

Definition at line 63 of file HcalTBDigiProducer.h.

Constructor & Destructor Documentation

◆ HcalTBDigiProducer()

HcalTBDigiProducer::HcalTBDigiProducer	(	const edm::ParameterSet &	ps,
		edm::ProducesCollector	producesCollector,
		edm::ConsumesCollector &	iC
	)

explicit

Definition at line 21 of file HcalTBDigiProducer.cc.

References edm::ConsumesCollector::consumes(), HcalCoderFactory::DB, DigiDM_cff::doNoise, doPhaseShift, hcalUnsuppressedDigis_cfi::doTimeSlew, ecalTBInfoLabel, edm::ParameterSet::getParameter(), DetId::Hcal, hcalTimeSlew_delay_, HLT_2022v15_cff::InputTag, instance, hcalUnsuppressedDigis_cfi::minFCToDelay, paraMap, edm::ProducesCollector::produces(), CaloHitResponse::setHitFilter(), HcalAmplifier::setTimeSlewSim(), HcalTBSimParameterMap::simParameters(), AlCaHLTBitMon_QueryRunRegistry::string, ecalSimParameterMap_cff::syncPhase, theAmplifier, theCoderFactory, theEcalTBToken_, theElectronicsSim, theHBHEDigitizer, theHBHEHitFilter, theHBHEResponse, theHODigitizer, theHOHitFilter, theHOResponse, theParameterMap, theTimeSlewSim, and tunePhaseShift.

     : tunePhaseShift(ps.getUntrackedParameter<double>("tunePhaseShiftTB", 1.)),
       ecalTBInfoLabel(ps.getUntrackedParameter<std::string>("EcalTBInfoLabel", "SimEcalTBG4Object")),
       theParameterMap(new HcalTBSimParameterMap(ps)),
       paraMap(new HcalSimParameterMap(ps)),
       theHcalShape(new HcalShape()),
       theHcalIntegratedShape(new CaloShapeIntegrator(theHcalShape)),
       theHBHEResponse(new CaloHitResponse(theParameterMap, theHcalIntegratedShape)),
       theHOResponse(new CaloHitResponse(theParameterMap, theHcalIntegratedShape)),
       theAmplifier(nullptr),
       theCoderFactory(nullptr),
       theElectronicsSim(nullptr),
       theTimeSlewSim(nullptr),
       geometryToken_(iC.esConsumes()),
       conditionsToken_(iC.esConsumes()),
       hcalTimeSlew_delay_token_(iC.esConsumes(edm::ESInputTag("", "HBHE"))),
       hcalToken_(iC.consumes<std::vector<PCaloHit>>(edm::InputTag("g4SimHits", "HcalHits"))),
       theHBHEHits(),
       theHOHits(),
       thisPhaseShift(0) {
   std::string const instance("simHcalDigis");
   producesCollector.produces<HBHEDigiCollection>(instance);
   producesCollector.produces<HODigiCollection>(instance);
 
   DetId detId(DetId::Hcal, 1);
   bool syncPhase = (theParameterMap->simParameters(detId)).syncPhase();
   doPhaseShift = !syncPhase;
 
   theHBHEResponse->setHitFilter(&theHBHEHitFilter);
   theHOResponse->setHitFilter(&theHOHitFilter);
 
   bool doNoise = ps.getParameter<bool>("doNoise");
   bool dummy1 = false;
   bool dummy2 = false;  // extra arguments for premixing
   theAmplifier = new HcalAmplifier(theParameterMap, doNoise, dummy1, dummy2);
   theCoderFactory = new HcalCoderFactory(HcalCoderFactory::DB);
   theElectronicsSim = new HcalElectronicsSim(paraMap, theAmplifier, theCoderFactory, dummy1);
 
   double minFCToDelay = ps.getParameter<double>("minFCToDelay");
   bool doTimeSlew = ps.getParameter<bool>("doTimeSlew");
 
   hcalTimeSlew_delay_ = nullptr;
   if (doTimeSlew) {
     // no time slewing for HF
     theTimeSlewSim = new HcalTimeSlewSim(theParameterMap, minFCToDelay);
     theAmplifier->setTimeSlewSim(theTimeSlewSim);
   }
 
   theHBHEDigitizer = std::make_unique<HBHEDigitizer>(theHBHEResponse, theElectronicsSim, doNoise);
   theHODigitizer = std::make_unique<HODigitizer>(theHOResponse, theElectronicsSim, doNoise);
 
   edm::LogVerbatim("HcalSim") << "HcalTBDigiProducer initialized with doNoise = " << doNoise
                               << ", doTimeSlew = " << doTimeSlew << " and doPhaseShift = " << doPhaseShift
                               << " tunePhasShift = " << tunePhaseShift;
 
   if (doPhaseShift)
     theEcalTBToken_ = iC.consumes<PEcalTBInfo>(edm::InputTag(ecalTBInfoLabel, ""));
 }

◆ ~HcalTBDigiProducer()

HcalTBDigiProducer::~HcalTBDigiProducer ( )

override

Definition at line 82 of file HcalTBDigiProducer.cc.

References paraMap, theAmplifier, theCoderFactory, theElectronicsSim, theHBHEResponse, theHcalIntegratedShape, theHcalShape, theHOResponse, theParameterMap, and theTimeSlewSim.

                                         {
   if (theParameterMap)
     delete theParameterMap;
   if (paraMap)
     delete paraMap;
   if (theHcalShape)
     delete theHcalShape;
   if (theHcalIntegratedShape)
     delete theHcalIntegratedShape;
   if (theHBHEResponse)
     delete theHBHEResponse;
   if (theHOResponse)
     delete theHOResponse;
   if (theElectronicsSim)
     delete theElectronicsSim;
   if (theAmplifier)
     delete theAmplifier;
   if (theCoderFactory)
     delete theCoderFactory;
   if (theTimeSlewSim)
     delete theTimeSlewSim;
 }

Member Function Documentation

◆ accumulate() [1/2]

void HcalTBDigiProducer::accumulate	(	edm::Event const &	e,
		edm::EventSetup const &	c
	)

overridevirtual

Implements DigiAccumulatorMixMod.

Definition at line 149 of file HcalTBDigiProducer.cc.

References accumulateCaloHits(), MillePedeFileConverter_cfg::e, and hcalToken_.

                                                                             {
   // Step A: Get Inputs, and accumulate digis
 
   edm::InputTag hcalTag("g4SimHits", "HcalHits");
   const edm::Handle<std::vector<PCaloHit>> &hcalHandle = e.getHandle(hcalToken_);
 
   accumulateCaloHits(hcalHandle, 0);
 }

◆ accumulate() [2/2]

void HcalTBDigiProducer::accumulate	(	PileUpEventPrincipal const &	e,
		edm::EventSetup const &	c,
		edm::StreamID const &	streamID
	)

overridevirtual

Implements DigiAccumulatorMixMod.

Definition at line 158 of file HcalTBDigiProducer.cc.

References accumulateCaloHits(), and MillePedeFileConverter_cfg::e.

                                                                  {
   // Step A: Get Inputs, and accumulate digis
 
   edm::InputTag hcalTag("g4SimHits", "HcalHits");
   edm::Handle<std::vector<PCaloHit>> hcalHandle;
   e.getByLabel(hcalTag, hcalHandle);
 
   accumulateCaloHits(hcalHandle, e.bunchCrossing());
 }

◆ accumulateCaloHits()

void HcalTBDigiProducer::accumulateCaloHits	(	edm::Handle< std::vector< PCaloHit >> const &	hits,
		int	bunchCrossing
	)

private

Definition at line 138 of file HcalTBDigiProducer.cc.

References hfClusterShapes_cfi::hits, LogDebug, randomEngine_, theHBHEDigitizer, and theHODigitizer.

Referenced by accumulate().

                                                                                                                {
   LogDebug("HcalSim") << "HcalTBDigiProducer::accumulate trying to get SimHit";
 
   if (hcalHandle.isValid()) {
     std::vector<PCaloHit> hits = *hcalHandle.product();
     LogDebug("HcalSim") << "HcalTBDigiProducer::accumulate Hits corrected";
     theHBHEDigitizer->add(hits, bunchCrossing, randomEngine_);
     theHODigitizer->add(hits, bunchCrossing, randomEngine_);
   }
 }

◆ checkGeometry()

void HcalTBDigiProducer::checkGeometry ( const edm::EventSetup & eventSetup )

private

make sure the digitizer has the correct list of all cells that exist in the geometry

Definition at line 202 of file HcalTBDigiProducer.cc.

References edm::ESWatcher< T >::check(), options_cfi::eventSetup, geometryToken_, geometryWatcher_, theGeometry, and updateGeometry().

Referenced by initializeEvent().

                                                                       {
   // see if we need to update
   if (geometryWatcher_.check(eventSetup)) {
     theGeometry = &eventSetup.getData(geometryToken_);
     updateGeometry();
   }
 }

◆ finalizeEvent()

void HcalTBDigiProducer::finalizeEvent	(	edm::Event &	e,
		edm::EventSetup const &	c
	)

overridevirtual

Implements DigiAccumulatorMixMod.

Definition at line 170 of file HcalTBDigiProducer.cc.

References MillePedeFileConverter_cfg::e, instance, LogDebug, eostools::move(), randomEngine_, AlCaHLTBitMon_QueryRunRegistry::string, theHBHEDigitizer, and theHODigitizer.

                                                                                    {
   // Step B: Create empty output
   std::unique_ptr<HBHEDigiCollection> hbheResult(new HBHEDigiCollection());
   std::unique_ptr<HODigiCollection> hoResult(new HODigiCollection());
   LogDebug("HcalSim") << "HcalTBDigiProducer::produce Empty collection created";
   // Step C: Invoke the algorithm, getting back outputs.
   theHBHEDigitizer->run(*hbheResult, randomEngine_);
   edm::LogVerbatim("HcalSim") << "HcalTBDigiProducer: HBHE digis : " << hbheResult->size();
   theHODigitizer->run(*hoResult, randomEngine_);
   edm::LogVerbatim("HcalSim") << "HcalTBDigiProducer: HO digis   : " << hoResult->size();
 
   // Step D: Put outputs into event
   std::string const instance("simHcalDigis");
   e.put(std::move(hbheResult), instance);
   e.put(std::move(hoResult), instance);
 
   randomEngine_ = nullptr;  // to prevent access outside event
 }

◆ initializeEvent()

void HcalTBDigiProducer::initializeEvent	(	edm::Event const &	e,
		edm::EventSetup const &	c
	)

overridevirtual

Implements DigiAccumulatorMixMod.

Definition at line 105 of file HcalTBDigiProducer.cc.

References checkGeometry(), submitPVValidationJobs::conditions, conditionsToken_, doPhaseShift, MillePedeFileConverter_cfg::e, options_cfi::eventSetup, edm::RandomNumberGenerator::getEngine(), DetId::Hcal, hcalTimeSlew_delay_, hcalTimeSlew_delay_token_, PEcalTBInfo::phaseShift(), randomEngine_, HcalCoderFactory::setDbService(), HcalAmplifier::setDbService(), setPhaseShift(), HcalAmplifier::setTimeSlew(), theAmplifier, theCoderFactory, theEcalTBToken_, theHBHEDigitizer, theHBHEHits, theHODigitizer, theHOHits, and thisPhaseShift.

                                                                                            {
   // get the appropriate gains, noises, & widths for this event
   const HcalDbService *conditions = &eventSetup.getData(conditionsToken_);
   theAmplifier->setDbService(conditions);
   theCoderFactory->setDbService(conditions);
 
   // get the correct geometry
   checkGeometry(eventSetup);
 
   // Cache random number engine
   edm::Service<edm::RandomNumberGenerator> rng;
   randomEngine_ = &rng->getEngine(e.streamID());
 
   theHBHEHits.clear();
   theHOHits.clear();
   if (doPhaseShift) {
     const edm::Handle<PEcalTBInfo> &theEcalTBInfo = e.getHandle(theEcalTBToken_);
     thisPhaseShift = theEcalTBInfo->phaseShift();
 
     DetId detIdHB(DetId::Hcal, 1);
     setPhaseShift(detIdHB);
     DetId detIdHO(DetId::Hcal, 3);
     setPhaseShift(detIdHO);
   }
 
   hcalTimeSlew_delay_ = &eventSetup.getData(hcalTimeSlew_delay_token_);
 
   theAmplifier->setTimeSlew(hcalTimeSlew_delay_);
 
   theHBHEDigitizer->initializeHits();
   theHODigitizer->initializeHits();
 }

◆ setPhaseShift()

void HcalTBDigiProducer::setPhaseShift ( const DetId & detId )

private

Definition at line 234 of file HcalTBDigiProducer.cc.

References CaloHitResponse::setPhaseShift(), HcalTBSimParameterMap::simParameters(), DetId::subdetId(), theHBHEResponse, theHOResponse, theParameterMap, thisPhaseShift, and tunePhaseShift.

Referenced by initializeEvent().

                                                          {
   const CaloSimParameters &parameters = theParameterMap->simParameters(detId);
   if (!parameters.syncPhase()) {
     int myDet = detId.subdetId();
     double passPhaseShift = thisPhaseShift + tunePhaseShift;
     if (myDet <= 2) {
       theHBHEResponse->setPhaseShift(passPhaseShift);
     } else {
       theHOResponse->setPhaseShift(passPhaseShift);
     }
   }
 }

◆ sortHits()

void HcalTBDigiProducer::sortHits ( const edm::PCaloHitContainer & hits )

private

fills the vectors for each subdetector

Definition at line 189 of file HcalTBDigiProducer.cc.

References HcalBarrel, HcalEndcap, HcalOuter, hfClusterShapes_cfi::hits, theHBHEHits, and theHOHits.

                                                                   {
   for (edm::PCaloHitContainer::const_iterator hitItr = hits.begin(); hitItr != hits.end(); ++hitItr) {
     HcalSubdetector subdet = HcalDetId(hitItr->id()).subdet();
     if (subdet == HcalBarrel || subdet == HcalEndcap) {
       theHBHEHits.push_back(*hitItr);
     } else if (subdet == HcalOuter) {
       theHOHits.push_back(*hitItr);
     } else {
       edm::LogError("HcalSim") << "Bad HcalHit subdetector " << subdet;
     }
   }
 }

◆ updateGeometry()

void HcalTBDigiProducer::updateGeometry ( )

private

Definition at line 210 of file HcalTBDigiProducer.cc.

References CaloGeometry::getValidDetIds(), hbheCells, DetId::Hcal, HcalBarrel, HcalEndcap, HcalOuter, hoCells, LogDebug, CaloHitResponse::setGeometry(), theGeometry, theHBHEDigitizer, theHBHEResponse, theHODigitizer, and theHOResponse.

Referenced by checkGeometry().

                                         {
   theHBHEResponse->setGeometry(theGeometry);
   theHOResponse->setGeometry(theGeometry);
 
   // Get cells for HB and HE
   hbheCells.clear();
   hbheCells = theGeometry->getValidDetIds(DetId::Hcal, HcalBarrel);
   std::vector<DetId> heCells = theGeometry->getValidDetIds(DetId::Hcal, HcalEndcap);
   // combine HB & HE
   hbheCells.insert(hbheCells.end(), heCells.begin(), heCells.end());
 
   // Get cells for HO
   hoCells.clear();
   hoCells = theGeometry->getValidDetIds(DetId::Hcal, HcalOuter);
 
   edm::LogVerbatim("HcalSim") << "HcalTBDigiProducer update Geometry with " << hbheCells.size()
                               << " cells in HB/HE and " << hoCells.size() << " cells in HO";
 
   theHBHEDigitizer->setDetIds(hbheCells);
   LogDebug("HcalSim") << "HcalTBDigiProducer: Set DetID's for HB/HE";
   theHODigitizer->setDetIds(hoCells);
   LogDebug("HcalSim") << "HcalTBDigiProducer: Set DetID's for HO";
 }