HGCDigitizerBase< DFr > Class Template Reference

#include <HGCDigitizerBase.h>

Public Types
typedef edm::SortedCollection< DFr >	DColl
typedef DFr	DigiType

Public Member Functions
	HGCDigitizerBase (const edm::ParameterSet &ps)
	CTOR. More...
float	keV2fC () const
	getters More...
void	run (std::unique_ptr< DColl > &digiColl, hgc::HGCSimHitDataAccumulator &simData, const CaloSubdetectorGeometry *theGeom, const std::unordered_set< DetId > &validIds, uint32_t digitizationType, CLHEP::HepRandomEngine *engine)
	steer digitization mode More...
virtual void	runDigitizer (std::unique_ptr< DColl > &coll, hgc::HGCSimHitDataAccumulator &simData, const CaloSubdetectorGeometry *theGeom, const std::unordered_set< DetId > &validIds, uint32_t digitizerType, CLHEP::HepRandomEngine *engine)
	to be specialized by top class More...
void	runSimple (std::unique_ptr< DColl > &coll, hgc::HGCSimHitDataAccumulator &simData, const CaloSubdetectorGeometry *theGeom, const std::unordered_set< DetId > &validIds, CLHEP::HepRandomEngine *engine)
	a trivial digitization: sum energies and digitize without noise More...
std::array< float, 3 >	tdcForToAOnset () const
float	tdcOnset () const
bool	toaModeByEnergy () const
void	updateOutput (std::unique_ptr< DColl > &coll, const DFr &rawDataFrame)
	prepares the output according to the number of time samples to produce More...
virtual	~HGCDigitizerBase ()
	DTOR. More...

Protected Attributes
double	bxTime_
std::vector< double >	cce_
bool	doTimeSamples_
float	keV2fC_
edm::ParameterSet	myCfg_
std::unique_ptr< HGCFEElectronics< DFr > >	myFEelectronics_
std::vector< float >	noise_fC_

Detailed Description

template<class DFr>
class HGCDigitizerBase< DFr >

Definition at line 66 of file HGCDigitizerBase.h.

Member Typedef Documentation

template<class DFr>

typedef edm::SortedCollection<DFr> HGCDigitizerBase< DFr >::DColl

Definition at line 71 of file HGCDigitizerBase.h.

template<class DFr>

typedef DFr HGCDigitizerBase< DFr >::DigiType

Definition at line 69 of file HGCDigitizerBase.h.

Constructor & Destructor Documentation

template<class DFr >

HGCDigitizerBase< DFr >::HGCDigitizerBase

(

const edm::ParameterSet &

ps

)

CTOR.

Definition at line 9 of file HGCDigitizerBase.cc.

References hgcalDigitizer_cfi::feCfg, edm::ParameterSet::getParameter(), hgcalLayerClusters_cff::noises, and edm::swap().

                                                                 {
  bxTime_        = ps.getParameter<double>("bxTime");
  myCfg_         = ps.getParameter<edm::ParameterSet>("digiCfg");
  doTimeSamples_ = myCfg_.getParameter< bool >("doTimeSamples");
  if(myCfg_.exists("keV2fC"))   keV2fC_   = myCfg_.getParameter<double>("keV2fC");
  else                          keV2fC_   = 1.0;

  if( myCfg_.existsAs<edm::ParameterSet>( "chargeCollectionEfficiencies" ) ) {
    cce_ = myCfg_.getParameter<edm::ParameterSet>("chargeCollectionEfficiencies").template getParameter<std::vector<double>>("values");
  } else {
    std::vector<double>().swap(cce_);
  }

  if(myCfg_.existsAs<double>("noise_fC")) {
    noise_fC_.resize(1);
    noise_fC_[0] = myCfg_.getParameter<double>("noise_fC");
  } else if ( myCfg_.existsAs<std::vector<double> >("noise_fC") ) {
    const auto& noises = myCfg_.getParameter<std::vector<double> >("noise_fC");
    noise_fC_.resize(0);
    noise_fC_.reserve(noises.size());
    for( auto noise : noises ) { noise_fC_.push_back( noise ); }
  } else if(myCfg_.existsAs<edm::ParameterSet>("noise_fC")) {
    const auto& noises = myCfg_.getParameter<edm::ParameterSet>("noise_fC").template getParameter<std::vector<double> >("values");
    noise_fC_.resize(0);
    noise_fC_.reserve(noises.size());
    for( auto noise : noises ) { noise_fC_.push_back( noise ); }
  } else {
    noise_fC_.resize(1);
    noise_fC_[0] = 1.f;
  }
  edm::ParameterSet feCfg = myCfg_.getParameter<edm::ParameterSet>("feCfg");
  myFEelectronics_        = std::unique_ptr<HGCFEElectronics<DFr> >( new HGCFEElectronics<DFr>(feCfg) );
  myFEelectronics_->SetNoiseValues(noise_fC_);
}

template<class DFr>

virtual HGCDigitizerBase< DFr >::~HGCDigitizerBase ( )

inlinevirtual

DTOR.

Definition at line 117 of file HGCDigitizerBase.h.

    { };

Member Function Documentation

template<class DFr>

float HGCDigitizerBase< DFr >::keV2fC ( ) const

inline

getters

Definition at line 87 of file HGCDigitizerBase.h.

{ return keV2fC_; }

template<class DFr >

void HGCDigitizerBase< DFr >::run	(	std::unique_ptr< DColl > &	digiColl,
		hgc::HGCSimHitDataAccumulator &	simData,
		const CaloSubdetectorGeometry *	theGeom,
		const std::unordered_set< DetId > &	validIds,
		uint32_t	digitizationType,
		CLHEP::HepRandomEngine *	engine
	)

steer digitization mode

Definition at line 45 of file HGCDigitizerBase.cc.

                                               {
  if(digitizationType==0) runSimple(digiColl,simData,theGeom,validIds,engine);
  else                    runDigitizer(digiColl,simData,theGeom,validIds,digitizationType,engine);
}

template<class DFr>

virtual void HGCDigitizerBase< DFr >::runDigitizer ( std::unique_ptr< DColl > &  coll, hgc::HGCSimHitDataAccumulator &  simData, const CaloSubdetectorGeometry *  theGeom, const std::unordered_set< DetId > &  validIds, uint32_t  digitizerType, CLHEP::HepRandomEngine *  engine  )

inlinevirtual

to be specialized by top class

Reimplemented in HGCHEbackDigitizer, HGCEEDigitizer, and HGCHEfrontDigitizer.

Definition at line 107 of file HGCDigitizerBase.h.

  {
    throw cms::Exception("HGCDigitizerBaseException") << " Failed to find specialization of runDigitizer";
  }

template<class DFr >

void HGCDigitizerBase< DFr >::runSimple	(	std::unique_ptr< DColl > &	coll,
		hgc::HGCSimHitDataAccumulator &	simData,
		const CaloSubdetectorGeometry *	theGeom,
		const std::unordered_set< DetId > &	validIds,
		CLHEP::HepRandomEngine *	engine
	)

a trivial digitization: sum energies and digitize without noise

Definition at line 56 of file HGCDigitizerBase.cc.

References hgc_digi_utils::addCellMetadata(), f, hgc_digi::HGCCellInfo::hit_info, mps_fire::i, SiStripPI::max, hgc_digi::HGCCellInfo::size, and hgc_digi::HGCCellInfo::thickness.

                                                    {
  HGCSimHitData chargeColl,toa;

  // this represents a cell with no signal charge
  HGCCellInfo zeroData;
  zeroData.hit_info[0].fill(0.f); //accumulated energy
  zeroData.hit_info[1].fill(0.f); //time-of-flight

  for( const auto& id : validIds ) {
    chargeColl.fill(0.f);
    toa.fill(0.f);
    HGCSimHitDataAccumulator::iterator it = simData.find(id);
    HGCCellInfo& cell = ( simData.end() == it ? zeroData : it->second );
    addCellMetadata(cell,theGeom,id);

    for(size_t i=0; i<cell.hit_info[0].size(); i++) {
      double rawCharge(cell.hit_info[0][i]);

      //time of arrival
      toa[i]=cell.hit_info[1][i];
      if(myFEelectronics_->toaMode()==HGCFEElectronics<DFr>::WEIGHTEDBYE && rawCharge>0)
        toa[i]=cell.hit_info[1][i]/rawCharge;

      //convert total energy in GeV to charge (fC)
      //double totalEn=rawEn*1e6*keV2fC_;
      float totalCharge=rawCharge;

      //add noise (in fC)
      //we assume it's randomly distributed and won't impact ToA measurement
      //also assume that it is related to the charge path only and that noise fluctuation for ToA circuit be handled separately
      totalCharge += std::max( (float)CLHEP::RandGaussQ::shoot(engine,0.0,cell.size*noise_fC_[cell.thickness-1]) , 0.f );
      if(totalCharge<0.f) totalCharge=0.f;

      chargeColl[i]= totalCharge;
    }

    //run the shaper to create a new data frame
    DFr rawDataFrame( id );
    if( !cce_.empty() )
      myFEelectronics_->runShaper(rawDataFrame, chargeColl, toa, cell.thickness, engine, cce_[cell.thickness-1]);
    else
      myFEelectronics_->runShaper(rawDataFrame, chargeColl, toa, cell.thickness, engine);

    //update the output according to the final shape
    updateOutput(coll,rawDataFrame);
  }
}

template<class DFr>

std::array<float,3> HGCDigitizerBase< DFr >::tdcForToAOnset ( ) const

inline

Definition at line 90 of file HGCDigitizerBase.h.

{ return myFEelectronics_->getTDCForToAOnset(); }

template<class DFr>

float HGCDigitizerBase< DFr >::tdcOnset ( ) const

inline

Definition at line 89 of file HGCDigitizerBase.h.

{ return myFEelectronics_->getTDCOnset(); }

template<class DFr>

bool HGCDigitizerBase< DFr >::toaModeByEnergy ( ) const

inline

Definition at line 88 of file HGCDigitizerBase.h.

{ return (myFEelectronics_->toaMode()==HGCFEElectronics<DFr>::WEIGHTEDBYE); }

template<class DFr>

void HGCDigitizerBase< DFr >::updateOutput	(	std::unique_ptr< DColl > &	coll,
		const DFr &	rawDataFrame
	)

prepares the output according to the number of time samples to produce

Definition at line 109 of file HGCDigitizerBase.cc.

                                                                   {
  int itIdx(9);
  if(rawDataFrame.size()<=itIdx+2) return;

  DFr dataFrame( rawDataFrame.id() );
  dataFrame.resize(5);
  bool putInEvent(false);
  for(int it=0;it<5; it++) {
    dataFrame.setSample(it, rawDataFrame[itIdx-2+it]);
    if(it==2) putInEvent = rawDataFrame[itIdx-2+it].threshold();
  }

  if(putInEvent) {
    coll->push_back(dataFrame);
  }
}

Member Data Documentation

template<class DFr>

double HGCDigitizerBase< DFr >::bxTime_

protected

Definition at line 140 of file HGCDigitizerBase.h.

template<class DFr>

std::vector<double> HGCDigitizerBase< DFr >::cce_

protected

Definition at line 134 of file HGCDigitizerBase.h.

template<class DFr>

bool HGCDigitizerBase< DFr >::doTimeSamples_

protected

Definition at line 143 of file HGCDigitizerBase.h.

template<class DFr>

float HGCDigitizerBase< DFr >::keV2fC_

protected

Definition at line 128 of file HGCDigitizerBase.h.

template<class DFr>

edm::ParameterSet HGCDigitizerBase< DFr >::myCfg_

protected

Definition at line 118 of file HGCDigitizerBase.h.

template<class DFr>

std::unique_ptr<HGCFEElectronics<DFr> > HGCDigitizerBase< DFr >::myFEelectronics_

protected

Definition at line 137 of file HGCDigitizerBase.h.

template<class DFr>

std::vector<float> HGCDigitizerBase< DFr >::noise_fC_

protected

Definition at line 131 of file HGCDigitizerBase.h.