CastorDigiProducer Class Reference

#include <CastorDigiProducer.h>

Inheritance diagram for CastorDigiProducer:

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
	CastorDigiProducer (const edm::ParameterSet &ps, edm::ProducesCollector, edm::ConsumesCollector &iC)
void	finalizeEvent (edm::Event &e, edm::EventSetup const &c) override
void	initializeEvent (edm::Event const &e, edm::EventSetup const &c) override
	~CastorDigiProducer () 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 ()
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)
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< CastorDigitizerTraits >	CastorDigitizer

Private Member Functions
void	accumulateCaloHits (std::vector< PCaloHit > const &, int bunchCrossing)
void	checkGeometry (const edm::EventSetup &eventSetup)
void	fillFakeHits ()
	some hits in each subdetector, just for testing purposes More...
void	sortHits (const edm::PCaloHitContainer &hits)
	fills the vectors for each subdetector More...

Private Attributes
CLHEP::HepRandomEngine *	randomEngine_ = nullptr
CastorAmplifier *	theAmplifier
CastorDigitizer *	theCastorDigitizer
CastorHitFilter	theCastorHitFilter
std::vector< PCaloHit >	theCastorHits
CaloVShape *	theCastorIntegratedShape
CaloHitResponse *	theCastorResponse
CaloVShape *	theCastorShape
CastorCoderFactory *	theCoderFactory
CastorElectronicsSim *	theElectronicsSim
CastorHitCorrection *	theHitCorrection
edm::InputTag	theHitsProducerTag
CastorSimParameterMap *	theParameterMap

Detailed Description

Definition at line 35 of file CastorDigiProducer.h.

Member Typedef Documentation

CastorDigitizer

typedef CaloTDigitizer<CastorDigitizerTraits> CastorDigiProducer::CastorDigitizer

private

Reconstruction algorithm

Definition at line 59 of file CastorDigiProducer.h.

Constructor & Destructor Documentation

CastorDigiProducer()

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

explicit

Definition at line 22 of file CastorDigiProducer.cc.

    : theParameterMap(new CastorSimParameterMap(ps)),
      theCastorShape(new CastorShape()),
      theCastorIntegratedShape(new CaloShapeIntegrator(theCastorShape)),
      theCastorResponse(new CaloHitResponse(theParameterMap, theCastorIntegratedShape)),
      theAmplifier(nullptr),
      theCoderFactory(nullptr),
      theElectronicsSim(nullptr),
      theHitCorrection(nullptr),
      theCastorDigitizer(nullptr),
      theCastorHits() {
  theHitsProducerTag = ps.getParameter<edm::InputTag>("hitsProducer");
  iC.consumes<std::vector<PCaloHit>>(theHitsProducerTag);
 
  producesCollector.produces<CastorDigiCollection>();
 
  theCastorResponse->setHitFilter(&theCastorHitFilter);
 
  bool doTimeSlew = ps.getParameter<bool>("doTimeSlew");
  if (doTimeSlew) {
    // no time slewing for HF
    theCastorResponse->setHitCorrection(theHitCorrection);
  }
 
  bool doNoise = ps.getParameter<bool>("doNoise");
  theAmplifier = new CastorAmplifier(theParameterMap, doNoise);
  theCoderFactory = new CastorCoderFactory(CastorCoderFactory::DB);
  theElectronicsSim = new CastorElectronicsSim(theAmplifier, theCoderFactory);
 
  theCastorDigitizer = new CastorDigitizer(theCastorResponse, theElectronicsSim, doNoise);
 
  edm::Service<edm::RandomNumberGenerator> rng;
  if (!rng.isAvailable()) {
    throw cms::Exception("Configuration") << "CastorDigiProducer requires the RandomNumberGeneratorService\n"
                                             "which is not present in the configuration file.  You must add the "
                                             "service\n"
                                             "in the configuration file or remove the modules that require it.";
  }
}

References edm::ConsumesCollector::consumes(), CastorCoderFactory::DB, DigiDM_cff::doNoise, hcalUnsuppressedDigis_cfi::doTimeSlew, Exception, edm::ParameterSet::getParameter(), edm::Service< T >::isAvailable(), edm::ProducesCollector::produces(), CaloHitResponse::setHitCorrection(), CaloHitResponse::setHitFilter(), theAmplifier, theCastorDigitizer, theCastorHitFilter, theCastorResponse, theCoderFactory, theElectronicsSim, theHitCorrection, theHitsProducerTag, and theParameterMap.

~CastorDigiProducer()

CastorDigiProducer::~CastorDigiProducer ( )

override

Definition at line 64 of file CastorDigiProducer.cc.

                                        {
  delete theCastorDigitizer;
  delete theParameterMap;
  delete theCastorShape;
  delete theCastorIntegratedShape;
  delete theCastorResponse;
  delete theElectronicsSim;
  delete theAmplifier;
  delete theCoderFactory;
  delete theHitCorrection;
}

References theAmplifier, theCastorDigitizer, theCastorIntegratedShape, theCastorResponse, theCastorShape, theCoderFactory, theElectronicsSim, theHitCorrection, and theParameterMap.

Member Function Documentation

accumulate() [1/2]

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

overridevirtual

Implements DigiAccumulatorMixMod.

Definition at line 107 of file CastorDigiProducer.cc.

                                                                            {
  // Step A: Get and accumulate digitized hits
  edm::Handle<std::vector<PCaloHit>> castorHandle;
  e.getByLabel(theHitsProducerTag, castorHandle);
 
  accumulateCaloHits(*castorHandle.product(), 0);
}

References accumulateCaloHits(), MillePedeFileConverter_cfg::e, edm::Handle< T >::product(), and theHitsProducerTag.

accumulate() [2/2]

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

overridevirtual

Implements DigiAccumulatorMixMod.

Definition at line 115 of file CastorDigiProducer.cc.

                                                                 {
  // Step A: Get and accumulate digitized hits
  edm::Handle<std::vector<PCaloHit>> castorHandle;
  e.getByLabel(theHitsProducerTag, castorHandle);
 
  accumulateCaloHits(*castorHandle.product(), e.bunchCrossing());
}

References accumulateCaloHits(), MillePedeFileConverter_cfg::e, edm::Handle< T >::product(), and theHitsProducerTag.

accumulateCaloHits()

void CastorDigiProducer::accumulateCaloHits ( std::vector< PCaloHit > const &  hcalHits, int  bunchCrossing  )

private

Definition at line 98 of file CastorDigiProducer.cc.

                                                                                                  {
  // fillFakeHits();
 
  if (theHitCorrection != nullptr) {
    theHitCorrection->fillChargeSums(hcalHits);
  }
  theCastorDigitizer->add(hcalHits, bunchCrossing, randomEngine_);
}

References CaloTDigitizer< Traits, runHelper >::add(), CastorHitCorrection::fillChargeSums(), randomEngine_, theCastorDigitizer, and theHitCorrection.

Referenced by accumulate().

checkGeometry()

void CastorDigiProducer::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 158 of file CastorDigiProducer.cc.

                                                                      {
  // TODO find a way to avoid doing this every event
  edm::ESHandle<CaloGeometry> geometry;
  eventSetup.get<CaloGeometryRecord>().get(geometry);
  theCastorResponse->setGeometry(&*geometry);
 
  const std::vector<DetId> &castorCells = geometry->getValidDetIds(DetId::Calo, HcalCastorDetId::SubdetectorId);
 
  // std::cout<<"CastorDigiProducer::CheckGeometry number of cells:
  // "<<castorCells.size()<<std::endl;
  theCastorDigitizer->setDetIds(castorCells);
}

References DetId::Calo, options_cfi::eventSetup, geometry, get, CaloTDigitizer< Traits, runHelper >::setDetIds(), CaloHitResponse::setGeometry(), HcalCastorDetId::SubdetectorId, theCastorDigitizer, and theCastorResponse.

Referenced by initializeEvent().

fillFakeHits()

void CastorDigiProducer::fillFakeHits ( )

private

some hits in each subdetector, just for testing purposes

Definition at line 152 of file CastorDigiProducer.cc.

                                      {
  HcalCastorDetId castorDetId(HcalCastorDetId::Section(2), true, 1, 1);
 
  theCastorHits.emplace_back(castorDetId.rawId(), 50.0, 0.);
}

References DetId::rawId(), and theCastorHits.

finalizeEvent()

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

overridevirtual

Implements DigiAccumulatorMixMod.

Definition at line 125 of file CastorDigiProducer.cc.

                                                                                   {
  // Step B: Create empty output
 
  std::unique_ptr<CastorDigiCollection> castorResult(new CastorDigiCollection());
 
  // Step C: Invoke the algorithm, getting back outputs.
  theCastorDigitizer->run(*castorResult, randomEngine_);
 
  edm::LogInfo("CastorDigiProducer") << "HCAL/Castor digis   : " << castorResult->size();
 
  // Step D: Put outputs into event
  e.put(std::move(castorResult));
 
  randomEngine_ = nullptr;  // to prevent access outside event
}

References MillePedeFileConverter_cfg::e, eostools::move(), randomEngine_, CaloTDigitizer< Traits, runHelper >::run(), and theCastorDigitizer.

initializeEvent()

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

overridevirtual

Implements DigiAccumulatorMixMod.

Definition at line 76 of file CastorDigiProducer.cc.

                                                                                               {
  // get the appropriate gains, noises, & widths for this event
  edm::ESHandle<CastorDbService> conditions;
  eventSetup.get<CastorDbRecord>().get(conditions);
  theAmplifier->setDbService(conditions.product());
  theCoderFactory->setDbService(conditions.product());
  theParameterMap->setDbService(conditions.product());
 
  // Cache random number engine
  edm::Service<edm::RandomNumberGenerator> rng;
  randomEngine_ = &rng->getEngine(event.streamID());
 
  edm::LogInfo("CastorDigiProducer") << "checking the geometry...";
 
  // get the correct geometry
  checkGeometry(eventSetup);
 
  theCastorHits.clear();
 
  theCastorDigitizer->initializeHits();
}

References checkGeometry(), options_cfi::eventSetup, get, edm::RandomNumberGenerator::getEngine(), CaloTDigitizer< Traits, runHelper >::initializeHits(), edm::ESHandle< T >::product(), randomEngine_, CastorCoderFactory::setDbService(), CastorAmplifier::setDbService(), CastorSimParameterMap::setDbService(), theAmplifier, theCastorDigitizer, theCastorHits, theCoderFactory, and theParameterMap.

sortHits()

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

private

fills the vectors for each subdetector

Definition at line 141 of file CastorDigiProducer.cc.

                                                                  {
  for (edm::PCaloHitContainer::const_iterator hitItr = hits.begin(); hitItr != hits.end(); ++hitItr) {
    DetId detId = hitItr->id();
    if (detId.det() == DetId::Calo && detId.subdetId() == HcalCastorDetId::SubdetectorId) {
      theCastorHits.push_back(*hitItr);
    } else {
      edm::LogError("CastorDigiProducer") << "Bad Hit subdetector " << detId.subdetId();
    }
  }
}

References DetId::Calo, DetId::det(), hfClusterShapes_cfi::hits, HcalCastorDetId::SubdetectorId, DetId::subdetId(), and theCastorHits.

Member Data Documentation

randomEngine_

CLHEP::HepRandomEngine* CastorDigiProducer::randomEngine_ = nullptr

private

Definition at line 79 of file CastorDigiProducer.h.

Referenced by accumulateCaloHits(), finalizeEvent(), and initializeEvent().

theAmplifier

CastorAmplifier* CastorDigiProducer::theAmplifier

private

Definition at line 67 of file CastorDigiProducer.h.

Referenced by CastorDigiProducer(), initializeEvent(), and ~CastorDigiProducer().

theCastorDigitizer

CastorDigitizer* CastorDigiProducer::theCastorDigitizer

private

Definition at line 75 of file CastorDigiProducer.h.

Referenced by accumulateCaloHits(), CastorDigiProducer(), checkGeometry(), finalizeEvent(), initializeEvent(), and ~CastorDigiProducer().

theCastorHitFilter

CastorHitFilter CastorDigiProducer::theCastorHitFilter

private

Definition at line 71 of file CastorDigiProducer.h.

Referenced by CastorDigiProducer().

theCastorHits

std::vector<PCaloHit> CastorDigiProducer::theCastorHits

private

Definition at line 77 of file CastorDigiProducer.h.

Referenced by fillFakeHits(), initializeEvent(), and sortHits().

theCastorIntegratedShape

CaloVShape* CastorDigiProducer::theCastorIntegratedShape

private

Definition at line 63 of file CastorDigiProducer.h.

Referenced by ~CastorDigiProducer().

theCastorResponse

CaloHitResponse* CastorDigiProducer::theCastorResponse

private

Definition at line 65 of file CastorDigiProducer.h.

Referenced by CastorDigiProducer(), checkGeometry(), and ~CastorDigiProducer().

theCastorShape

CaloVShape* CastorDigiProducer::theCastorShape

private

Definition at line 62 of file CastorDigiProducer.h.

Referenced by ~CastorDigiProducer().

theCoderFactory

CastorCoderFactory* CastorDigiProducer::theCoderFactory

private

Definition at line 68 of file CastorDigiProducer.h.

Referenced by CastorDigiProducer(), initializeEvent(), and ~CastorDigiProducer().

theElectronicsSim

CastorElectronicsSim* CastorDigiProducer::theElectronicsSim

private

Definition at line 69 of file CastorDigiProducer.h.

Referenced by CastorDigiProducer(), and ~CastorDigiProducer().

theHitCorrection

CastorHitCorrection* CastorDigiProducer::theHitCorrection

private

Definition at line 73 of file CastorDigiProducer.h.

Referenced by accumulateCaloHits(), CastorDigiProducer(), and ~CastorDigiProducer().

theHitsProducerTag

edm::InputTag CastorDigiProducer::theHitsProducerTag

private

Definition at line 56 of file CastorDigiProducer.h.

Referenced by accumulate(), and CastorDigiProducer().

theParameterMap

CastorSimParameterMap* CastorDigiProducer::theParameterMap

private

Definition at line 61 of file CastorDigiProducer.h.

Referenced by CastorDigiProducer(), initializeEvent(), and ~CastorDigiProducer().