HGCDigitizer Class Reference

#include <HGCDigitizer.h>

Public Types
typedef std::tuple< int, uint32_t, float >	HGCCaloHitTuple_t

Public Member Functions
void	accumulate (edm::Event const &e, edm::EventSetup const &c, CLHEP::HepRandomEngine *hre)
	handle SimHit accumulation More...
void	accumulate (PileUpEventPrincipal const &e, edm::EventSetup const &c, CLHEP::HepRandomEngine *hre)
void	accumulate (edm::Handle< edm::PCaloHitContainer > const &hits, int bxCrossing, const edm::ESHandle< HGCalGeometry > &geom, CLHEP::HepRandomEngine *hre)
void	beginRun (const edm::EventSetup &es)
	actions at the start/end of run More...
std::string	digiCollection ()
void	endRun ()
void	finalizeEvent (edm::Event &e, edm::EventSetup const &c, CLHEP::HepRandomEngine *hre)
	HGCDigitizer (const edm::ParameterSet &ps, edm::ConsumesCollector &iC)
void	initializeEvent (edm::Event const &e, edm::EventSetup const &c)
	actions at the start/end of event More...
bool	producesEEDigis ()
bool	producesHEbackDigis ()
bool	producesHEfrontDigis ()
	~HGCDigitizer ()

Static Public Member Functions
static bool	orderByDetIdThenTime (const HGCCaloHitTuple_t &a, const HGCCaloHitTuple_t &b)

Private Member Functions
void	resetSimHitDataAccumulator ()

Private Attributes
double	bxTime_
bool	checkValidDetIds_
std::string	digiCollection_
int	digitizationType_
std::string	hitCollection_
int	maxSimHitsAccTime_
ForwardSubdetector	mySubDet_
float	refSpeed_
std::unique_ptr < hgc::HGCSimHitDataAccumulator >	simHitAccumulator_
std::unique_ptr< HGCEEDigitizer >	theHGCEEDigitizer_
std::unique_ptr < HGCHEbackDigitizer >	theHGCHEbackDigitizer_
std::unique_ptr < HGCHEfrontDigitizer >	theHGCHEfrontDigitizer_
float	tofDelay_
bool	useAllChannels_
uint32_t	verbosity_

Detailed Description

Definition at line 26 of file HGCDigitizer.h.

Member Typedef Documentation

typedef std::tuple<int,uint32_t,float> HGCDigitizer::HGCCaloHitTuple_t

Definition at line 33 of file HGCDigitizer.h.

Constructor & Destructor Documentation

HGCDigitizer::HGCDigitizer	(	const edm::ParameterSet &	ps,
		edm::ConsumesCollector &	iC
	)

Definition at line 24 of file HGCDigitizer.cc.

References bxTime_, edm::ConsumesCollector::consumes(), digiCollection_, digitizationType_, edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), HGCEE, HGCHEB, HGCHEF, hitCollection_, HLT_FULL_cff::InputTag, maxSimHitsAccTime_, mySubDet_, AlCaHLTBitMon_QueryRunRegistry::string, theHGCEEDigitizer_, theHGCHEbackDigitizer_, theHGCHEfrontDigitizer_, tofDelay_, useAllChannels_, and verbosity_.

                                                     :
  checkValidDetIds_(true),
  simHitAccumulator_( new HGCSimHitDataAccumulator ),
  mySubDet_(ForwardSubdetector::ForwardEmpty),
  refSpeed_(0.1*CLHEP::c_light) //[CLHEP::c_light]=mm/ns convert to cm/ns
{
  //configure from cfg
  hitCollection_     = ps.getParameter< std::string >("hitCollection");
  digiCollection_    = ps.getParameter< std::string >("digiCollection");
  maxSimHitsAccTime_ = ps.getParameter< uint32_t >("maxSimHitsAccTime");
  bxTime_            = ps.getParameter< double >("bxTime");
  digitizationType_  = ps.getParameter< uint32_t >("digitizationType");
  useAllChannels_    = ps.getParameter< bool >("useAllChannels");
  verbosity_         = ps.getUntrackedParameter< uint32_t >("verbosity",0);
  tofDelay_          = ps.getParameter< double >("tofDelay");  

  iC.consumes<std::vector<PCaloHit> >(edm::InputTag("g4SimHits",hitCollection_));
  
  if(hitCollection_.find("HitsEE")!=std::string::npos) { 
    mySubDet_=ForwardSubdetector::HGCEE;  
    theHGCEEDigitizer_=std::unique_ptr<HGCEEDigitizer>(new HGCEEDigitizer(ps) ); 
  }
  if(hitCollection_.find("HitsHEfront")!=std::string::npos)  
    { 
      mySubDet_=ForwardSubdetector::HGCHEF;
      theHGCHEfrontDigitizer_=std::unique_ptr<HGCHEfrontDigitizer>(new HGCHEfrontDigitizer(ps) );
    }
  if(hitCollection_.find("HitsHEback")!=std::string::npos)
    { 
      mySubDet_=ForwardSubdetector::HGCHEB;
      theHGCHEbackDigitizer_=std::unique_ptr<HGCHEbackDigitizer>(new HGCHEbackDigitizer(ps) );
    }
}

HGCDigitizer::~HGCDigitizer ( )

inline

Definition at line 31 of file HGCDigitizer.h.

{ }

Member Function Documentation

void HGCDigitizer::accumulate	(	edm::Event const &	e,
		edm::EventSetup const &	c,
		CLHEP::HepRandomEngine *	hre
	)

handle SimHit accumulation

Definition at line 92 of file HGCDigitizer.cc.

References relativeConstraints::geom, edm::EventSetup::get(), edm::Event::getByLabel(), hitCollection_, edm::HandleBase::isValid(), producesEEDigis(), producesHEbackDigis(), and producesHEfrontDigis().

Referenced by accumulate().

                                                                                                           {

  //get inputs
  edm::Handle<edm::PCaloHitContainer> hits;
  e.getByLabel(edm::InputTag("g4SimHits",hitCollection_),hits); 
  if( !hits.isValid() ){
    edm::LogError("HGCDigitizer") << " @ accumulate : can't find " << hitCollection_ << " collection of g4SimHits";
    return;
  }

  //get geometry
  edm::ESHandle<HGCalGeometry> geom;
  if( producesEEDigis() )      eventSetup.get<IdealGeometryRecord>().get("HGCalEESensitive"            , geom);
  if( producesHEfrontDigis() ) eventSetup.get<IdealGeometryRecord>().get("HGCalHESiliconSensitive"     , geom);
  if( producesHEbackDigis() )  eventSetup.get<IdealGeometryRecord>().get("HGCalHEScintillatorSensitive", geom);

  //accumulate in-time the main event
  accumulate(hits, 0, geom, hre);
}

void HGCDigitizer::accumulate	(	PileUpEventPrincipal const &	e,
		edm::EventSetup const &	c,
		CLHEP::HepRandomEngine *	hre
	)

Definition at line 113 of file HGCDigitizer.cc.

References accumulate(), PileUpEventPrincipal::bunchCrossing(), relativeConstraints::geom, edm::EventSetup::get(), PileUpEventPrincipal::getByLabel(), hitCollection_, edm::HandleBase::isValid(), producesEEDigis(), producesHEbackDigis(), and producesHEfrontDigis().

                                                                                                                       {

  //get inputs
  edm::Handle<edm::PCaloHitContainer> hits;
  e.getByLabel(edm::InputTag("g4SimHits",hitCollection_),hits); 
  if( !hits.isValid() ){
    edm::LogError("HGCDigitizer") << " @ accumulate : can't find " << hitCollection_ << " collection of g4SimHits";
    return;
  }

  //get geometry
  edm::ESHandle<HGCalGeometry> geom;
  if( producesEEDigis() )      eventSetup.get<IdealGeometryRecord>().get("HGCalEESensitive"            , geom);
  if( producesHEfrontDigis() ) eventSetup.get<IdealGeometryRecord>().get("HGCalHESiliconSensitive"     , geom);
  if( producesHEbackDigis() )  eventSetup.get<IdealGeometryRecord>().get("HGCalHEScintillatorSensitive", geom);

  //accumulate for the simulated bunch crossing  
  accumulate(hits, e.bunchCrossing(), geom, hre);
}

void HGCDigitizer::accumulate	(	edm::Handle< edm::PCaloHitContainer > const &	hits,
		int	bxCrossing,
		const edm::ESHandle< HGCalGeometry > &	geom,
		CLHEP::HepRandomEngine *	hre
	)

Definition at line 134 of file HGCDigitizer.cc.

References bxTime_, RecoTauCleanerPlugins::charge, checkValidDetIds_, HGCalTopology::dddConstants(), TauDecayModes::dec, HGCalTopology::detectorType(), HGCalDDDConstants::geomMode(), HGCEE, HGCHEB, HGCHEF, hitCollection_, i, edm::HandleBase::id(), edm::ESHandleBase::isValid(), bookConverter::max, mySubDet_, orderByDetIdThenTime(), producesEEDigis(), refSpeed_, simHitAccumulator_, HGCalDDDConstants::simToReco(), Square, theHGCEEDigitizer_, theHGCHEbackDigitizer_, theHGCHEfrontDigitizer_, tofDelay_, HGCalTestNumbering::unpackHexagonIndex(), HGCalTestNumbering::unpackSquareIndex(), useAllChannels_, and verbosity_.

{
  if(!geom.isValid()) return;
  const HGCalTopology &topo=geom->topology();
  const HGCalDDDConstants &dddConst=topo.dddConstants();

  //base time samples for each DetId, initialized to 0
  std::array<HGCSimHitData,2> baseData;
  baseData[0].fill(0.); //accumulated energy
  baseData[1].fill(0.); //time-of-flight
  
  //configuration to apply for the computation of time-of-flight
  bool weightToAbyEnergy(false);
  float tdcOnset(0),keV2fC(0.0);
  switch( mySubDet_ ) {
  case ForwardSubdetector::HGCEE:
    weightToAbyEnergy = theHGCEEDigitizer_->toaModeByEnergy();
    tdcOnset          = theHGCEEDigitizer_->tdcOnset();
    keV2fC            = theHGCEEDigitizer_->keV2fC();
    break;
  case ForwardSubdetector::HGCHEF:
    weightToAbyEnergy = theHGCHEfrontDigitizer_->toaModeByEnergy();
    tdcOnset          = theHGCHEfrontDigitizer_->tdcOnset();
    keV2fC            = theHGCHEfrontDigitizer_->keV2fC();
    break;
  case ForwardSubdetector::HGCHEB:
    weightToAbyEnergy = theHGCHEbackDigitizer_->toaModeByEnergy();
    tdcOnset          = std::numeric_limits<float>::max();//theHGCHEbackDigitizer_->tdcOnset();
    keV2fC            = theHGCHEbackDigitizer_->keV2fC();     
    break;
  default:
    break;
  }

  //create list of tuples (pos in container, RECO DetId, time) to be sorted first
  int nchits=(int)hits->size();  
  std::vector< HGCCaloHitTuple_t > hitRefs(nchits);
  for(int i=0; i<nchits; i++) {
    int layer, cell, sec, subsec, zp;
    uint32_t simId = hits->at(i).id();
    if (dddConst.geomMode() == HGCalGeometryMode::Square) {
      HGCalTestNumbering::unpackSquareIndex(simId, zp, layer, sec, subsec, cell);
    } else {
      int subdet;
      HGCalTestNumbering::unpackHexagonIndex(simId, subdet, zp, layer, sec, subsec, cell); 
      mySubDet_ = (ForwardSubdetector)(subdet);
      //sec is wafer and subsec is celltyp
    }
    //skip this hit if after ganging it is not valid
    std::pair<int,int> recoLayerCell=dddConst.simToReco(cell,layer,sec,topo.detectorType());
    cell  = recoLayerCell.first;
    layer = recoLayerCell.second;
    if (layer<0 || cell<0) {
      hitRefs[i]=std::make_tuple( i, 0, 0.);
      continue;
    }

    //assign the RECO DetId
    DetId id;
    if (dddConst.geomMode() == HGCalGeometryMode::Square) {
      id = (producesEEDigis() ? 
        (uint32_t)HGCEEDetId(mySubDet_,zp,layer,sec,subsec,cell):
        (uint32_t)HGCHEDetId(mySubDet_,zp,layer,sec,subsec,cell) );
    } else {
      id = HGCalDetId(mySubDet_,zp,layer,subsec,sec,cell);
    }

    if (verbosity_>0) {
      if (producesEEDigis())
      edm::LogInfo("HGCDigitizer") <<" i/p " << std::hex << simId << std::dec << " o/p " << HGCEEDetId(id) << std::endl;
      else
      edm::LogInfo("HGCDigitizer") << " i/p " << std::hex << simId << std::dec << " o/p " << HGCHEDetId(id) << std::endl;
    }

    hitRefs[i]=std::make_tuple( i, 
                id.rawId(), 
                (float)hits->at(i).time() );
  }
  std::sort(hitRefs.begin(),hitRefs.end(),this->orderByDetIdThenTime);
  
  //loop over sorted hits
  for(int i=0; i<nchits; ++i) {
    const int hitidx   = std::get<0>(hitRefs[i]);
    const uint32_t id  = std::get<1>(hitRefs[i]);
    if(id==0) continue; // to be ignored at RECO level

    const float toa    = std::get<2>(hitRefs[i]);
    const PCaloHit &hit=hits->at( hitidx );     
    const float charge = hit.energy()*1e6*keV2fC;
      
    //distance to the center of the detector
    const float dist2center( geom->getPosition(id).mag() );
      
    //hit time: [time()]=ns  [centerDist]=cm [refSpeed_]=cm/ns + delay by 1ns
    //accumulate in 15 buckets of 25ns (9 pre-samples, 1 in-time, 5 post-samples)
    const float tof = toa-dist2center/refSpeed_+tofDelay_ ;
    const int itime= std::floor( tof/bxTime_ ) + 9;
      
    //no need to add bx crossing - tof comes already corrected from the mixing module
    //itime += bxCrossing;
    //itime += 9;
      
    if(itime<0 || itime>14) continue; 
    
    //check if already existing (perhaps could remove this in the future - 2nd event should have all defined)
    HGCSimHitDataAccumulator::iterator simHitIt=simHitAccumulator_->find(id);
    if(simHitIt == simHitAccumulator_->end()) {
      simHitIt = simHitAccumulator_->insert( std::make_pair(id,baseData) ).first;
    }
      
    //check if time index is ok and store energy
    if(itime >= (int)simHitIt->second[0].size() ) continue;

    (simHitIt->second)[0][itime] += charge;
    float accCharge=(simHitIt->second)[0][itime];
      
    //time-of-arrival (check how to be used)
      if(weightToAbyEnergy) (simHitIt->second)[1][itime] += charge*tof;
      else if((simHitIt->second)[1][itime]==0)
    {   
      if( accCharge>tdcOnset)
        {
          //extrapolate linear using previous simhit if it concerns to the same DetId
          float fireTDC=tof;
          if(i>0)
        {
          uint32_t prev_id  = std::get<1>(hitRefs[i-1]);
          if(prev_id==id)
            {
              float prev_toa    = std::get<2>(hitRefs[i-1]);
              float prev_tof(prev_toa-dist2center/refSpeed_+tofDelay_);
              //float prev_charge = std::get<3>(hitRefs[i-1]);
              float deltaQ2TDCOnset = tdcOnset-((simHitIt->second)[0][itime]-charge);
              float deltaQ          = charge;
              float deltaT          = (tof-prev_tof);
              fireTDC               = deltaT*(deltaQ2TDCOnset/deltaQ)+prev_tof;
            }         
        }
          
          (simHitIt->second)[1][itime]=fireTDC;
        }
    }
    }
  hitRefs.clear();
  
  //add base data for noise simulation
  if(!checkValidDetIds_) return;
  if(!geom.isValid()) return;
  const std::vector<DetId> &validIds=geom->getValidDetIds();   
  int nadded(0);
  if (useAllChannels_) {
    for(std::vector<DetId>::const_iterator it=validIds.begin(); it!=validIds.end(); it++) {
      uint32_t id(it->rawId());
      simHitAccumulator_->emplace(id, baseData);
      nadded++;
    }
  }
  
  if (verbosity_ > 0) 
    edm::LogInfo("HGCDigitizer") 
      << "Added " << nadded << ":" << validIds.size() 
      << " detIds without " << hitCollection_ 
      << " in first event processed" << std::endl;
  checkValidDetIds_=false;
}

void HGCDigitizer::beginRun

(

const edm::EventSetup &

es

)

actions at the start/end of run

Definition at line 304 of file HGCDigitizer.cc.

{
}

std::string HGCDigitizer::digiCollection ( )

inline

Definition at line 66 of file HGCDigitizer.h.

References digiCollection_.

Referenced by finalizeEvent().

{ return digiCollection_; }

void HGCDigitizer::endRun

(

void

)

Definition at line 309 of file HGCDigitizer.cc.

{
}

void HGCDigitizer::finalizeEvent	(	edm::Event &	e,
		edm::EventSetup const &	c,
		CLHEP::HepRandomEngine *	hre
	)

Definition at line 66 of file HGCDigitizer.cc.

References digiCollection(), digitizationType_, producesEEDigis(), producesHEbackDigis(), producesHEfrontDigis(), edm::Event::put(), simHitAccumulator_, theHGCEEDigitizer_, theHGCHEbackDigitizer_, and theHGCHEfrontDigitizer_.

{
  if( producesEEDigis() ) 
    {
      std::auto_ptr<HGCEEDigiCollection> digiResult(new HGCEEDigiCollection() );
      theHGCEEDigitizer_->run(digiResult,*simHitAccumulator_,digitizationType_, hre);
      edm::LogInfo("HGCDigitizer") << " @ finalize event - produced " << digiResult->size() <<  " EE hits";
      e.put(digiResult,digiCollection());
    }
  if( producesHEfrontDigis())
    {
      std::auto_ptr<HGCHEDigiCollection> digiResult(new HGCHEDigiCollection() );
      theHGCHEfrontDigitizer_->run(digiResult,*simHitAccumulator_,digitizationType_, hre);
      edm::LogInfo("HGCDigitizer") << " @ finalize event - produced " << digiResult->size() <<  " HE front hits";
      e.put(digiResult,digiCollection());
    }
  if( producesHEbackDigis() )
    {
      std::auto_ptr<HGCHEDigiCollection> digiResult(new HGCHEDigiCollection() );
      theHGCHEbackDigitizer_->run(digiResult,*simHitAccumulator_,digitizationType_, hre);
      edm::LogInfo("HGCDigitizer") << " @ finalize event - produced " << digiResult->size() <<  " HE back hits";
      e.put(digiResult,digiCollection());
    }
}

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

actions at the start/end of event

Definition at line 60 of file HGCDigitizer.cc.

References resetSimHitDataAccumulator().

{
  resetSimHitDataAccumulator(); 
}

static bool HGCDigitizer::orderByDetIdThenTime ( const HGCCaloHitTuple_t &  a, const HGCCaloHitTuple_t &  b  )

inlinestatic

Definition at line 34 of file HGCDigitizer.h.

Referenced by accumulate().

  {
    unsigned int detId_a(std::get<1>(a)), detId_b(std::get<1>(b));

    if(detId_a<detId_b) return true;
    if(detId_a>detId_b) return false;

    double time_a(std::get<2>(a)), time_b(std::get<2>(b));
    if(time_a<time_b) return true;

    return false;
  }

bool HGCDigitizer::producesEEDigis ( )

inline

Definition at line 63 of file HGCDigitizer.h.

References HGCEE, and mySubDet_.

Referenced by accumulate(), and finalizeEvent().

{ return (mySubDet_==ForwardSubdetector::HGCEE);  }

bool HGCDigitizer::producesHEbackDigis ( )

inline

Definition at line 65 of file HGCDigitizer.h.

References HGCHEB, and mySubDet_.

Referenced by accumulate(), and finalizeEvent().

{ return (mySubDet_==ForwardSubdetector::HGCHEB); }

bool HGCDigitizer::producesHEfrontDigis ( )

inline

Definition at line 64 of file HGCDigitizer.h.

References HGCHEF, and mySubDet_.

Referenced by accumulate(), and finalizeEvent().

{ return (mySubDet_==ForwardSubdetector::HGCHEF); }

void HGCDigitizer::resetSimHitDataAccumulator ( )

private

Definition at line 314 of file HGCDigitizer.cc.

References simHitAccumulator_.

Referenced by initializeEvent().

{
  for( HGCSimHitDataAccumulator::iterator it = simHitAccumulator_->begin(); it!=simHitAccumulator_->end(); it++)
    {
      it->second[0].fill(0.);
      it->second[1].fill(0.);
    }
}

Member Data Documentation

double HGCDigitizer::bxTime_

private

Definition at line 87 of file HGCDigitizer.h.

Referenced by accumulate(), and HGCDigitizer().

bool HGCDigitizer::checkValidDetIds_

private

Definition at line 77 of file HGCDigitizer.h.

Referenced by accumulate().

std::string HGCDigitizer::digiCollection_

private

Definition at line 80 of file HGCDigitizer.h.

Referenced by digiCollection(), and HGCDigitizer().

int HGCDigitizer::digitizationType_

private

Definition at line 83 of file HGCDigitizer.h.

Referenced by finalizeEvent(), and HGCDigitizer().

std::string HGCDigitizer::hitCollection_

private

Definition at line 80 of file HGCDigitizer.h.

Referenced by accumulate(), and HGCDigitizer().

int HGCDigitizer::maxSimHitsAccTime_

private

Definition at line 86 of file HGCDigitizer.h.

Referenced by HGCDigitizer().

ForwardSubdetector HGCDigitizer::mySubDet_

private

Definition at line 97 of file HGCDigitizer.h.

Referenced by accumulate(), HGCDigitizer(), producesEEDigis(), producesHEbackDigis(), and producesHEfrontDigis().

float HGCDigitizer::refSpeed_

private

Definition at line 104 of file HGCDigitizer.h.

Referenced by accumulate().

std::unique_ptr<hgc::HGCSimHitDataAccumulator> HGCDigitizer::simHitAccumulator_

private

Definition at line 88 of file HGCDigitizer.h.

Referenced by accumulate(), finalizeEvent(), and resetSimHitDataAccumulator().

std::unique_ptr<HGCEEDigitizer> HGCDigitizer::theHGCEEDigitizer_

private

Definition at line 92 of file HGCDigitizer.h.

Referenced by accumulate(), finalizeEvent(), and HGCDigitizer().

std::unique_ptr<HGCHEbackDigitizer> HGCDigitizer::theHGCHEbackDigitizer_

private

Definition at line 93 of file HGCDigitizer.h.

Referenced by accumulate(), finalizeEvent(), and HGCDigitizer().

std::unique_ptr<HGCHEfrontDigitizer> HGCDigitizer::theHGCHEfrontDigitizer_

private

Definition at line 94 of file HGCDigitizer.h.

Referenced by accumulate(), finalizeEvent(), and HGCDigitizer().

float HGCDigitizer::tofDelay_

private

Definition at line 107 of file HGCDigitizer.h.

Referenced by accumulate(), and HGCDigitizer().

bool HGCDigitizer::useAllChannels_

private

Definition at line 100 of file HGCDigitizer.h.

Referenced by accumulate(), and HGCDigitizer().

uint32_t HGCDigitizer::verbosity_

private

Definition at line 101 of file HGCDigitizer.h.

Referenced by accumulate(), and HGCDigitizer().