HcalSignalGenerator< HCALDIGITIZERTRAITS > Class Template Reference

#include <HcalSignalGenerator.h>

Inheritance diagram for HcalSignalGenerator< HCALDIGITIZERTRAITS >:

Public Types
typedef HCALDIGITIZERTRAITS::DigiCollection	COLLECTION
typedef HCALDIGITIZERTRAITS::Digi	DIGI

Public Member Functions
virtual void	fill (edm::ModuleCallingContext const *mcc)
	HcalSignalGenerator ()
	HcalSignalGenerator (const edm::InputTag &inputTag, const edm::EDGetTokenT< COLLECTION > &t)
void	initializeEvent (const edm::Event *event, const edm::EventSetup *eventSetup)
void	initializeEvent (const edm::EventPrincipal *eventPrincipal, const edm::EventSetup *eventSetup)
	some users use EventPrincipals, not Events. We support both More...
virtual	~HcalSignalGenerator ()
Public Member Functions inherited from HcalBaseSignalGenerator
	HcalBaseSignalGenerator ()
void	setElectronicsSim (HcalElectronicsSim *electronicsSim)
void	setParameterMap (HcalSimParameterMap *map)
virtual	~HcalBaseSignalGenerator ()
Public Member Functions inherited from CaloVNoiseSignalGenerator
	CaloVNoiseSignalGenerator ()
bool	contains (const DetId &detId) const
void	fillEvent (CLHEP::HepRandomEngine *)
	fill theNoiseSignals with one event's worth of noise, in units of pe More...
void	fillEvent ()
void	getNoiseSignals (std::vector< CaloSamples > &noiseSignals)
void	setNoiseSignals (const std::vector< CaloSamples > &noiseSignals)
virtual	~CaloVNoiseSignalGenerator ()

Private Member Functions
virtual void	fillNoiseSignals (CLHEP::HepRandomEngine *) override
virtual void	fillNoiseSignals () override
CaloSamples	samplesInPE (const DIGI &digi)
bool	validDigi (const DIGI &digi)

Private Attributes
edm::ESHandle< HcalDbService >	theConditions
const edm::Event *	theEvent
	these fields are set in initializeEvent() More...
const edm::EventPrincipal *	theEventPrincipal
edm::InputTag	theInputTag
	these come from the ParameterSet More...
edm::EDGetTokenT< COLLECTION >	tok_

Additional Inherited Members
Protected Member Functions inherited from HcalBaseSignalGenerator
void	fC2pe (CaloSamples &samples) const
Protected Attributes inherited from HcalBaseSignalGenerator
HcalElectronicsSim *	theElectronicsSim
HcalSimParameterMap *	theParameterMap
Protected Attributes inherited from CaloVNoiseSignalGenerator
std::vector< CaloSamples >	theNoiseSignals

Detailed Description

template<class HCALDIGITIZERTRAITS>
class HcalSignalGenerator< HCALDIGITIZERTRAITS >

Definition at line 29 of file HcalSignalGenerator.h.

Member Typedef Documentation

template<class HCALDIGITIZERTRAITS>

typedef HCALDIGITIZERTRAITS::DigiCollection HcalSignalGenerator< HCALDIGITIZERTRAITS >::COLLECTION

Definition at line 33 of file HcalSignalGenerator.h.

template<class HCALDIGITIZERTRAITS>

typedef HCALDIGITIZERTRAITS::Digi HcalSignalGenerator< HCALDIGITIZERTRAITS >::DIGI

Definition at line 32 of file HcalSignalGenerator.h.

Constructor & Destructor Documentation

template<class HCALDIGITIZERTRAITS>

HcalSignalGenerator< HCALDIGITIZERTRAITS >::HcalSignalGenerator ( )

inline

Definition at line 35 of file HcalSignalGenerator.h.

:HcalBaseSignalGenerator() { }

template<class HCALDIGITIZERTRAITS>

HcalSignalGenerator< HCALDIGITIZERTRAITS >::HcalSignalGenerator ( const edm::InputTag &  inputTag, const edm::EDGetTokenT< COLLECTION > &  t  )

inline

Definition at line 37 of file HcalSignalGenerator.h.

  : HcalBaseSignalGenerator(), theEvent(0), theEventPrincipal(0), theInputTag(inputTag), tok_(t) 
  { }

template<class HCALDIGITIZERTRAITS>

virtual HcalSignalGenerator< HCALDIGITIZERTRAITS >::~HcalSignalGenerator ( )

inlinevirtual

Definition at line 41 of file HcalSignalGenerator.h.

{}

Member Function Documentation

template<class HCALDIGITIZERTRAITS>

virtual void HcalSignalGenerator< HCALDIGITIZERTRAITS >::fill ( edm::ModuleCallingContext const *  mcc )

inlinevirtual

Definition at line 59 of file HcalSignalGenerator.h.

Referenced by edm::DataMixingHcalDigiWorkerProd::addHcalPileups().

  {

    theNoiseSignals.clear();
    edm::Handle<COLLECTION> pDigis;
    const COLLECTION *  digis = 0;
    // try accessing by whatever is set, Event or EventPrincipal
    if(theEvent) 
     {
      if( theEvent->getByToken(tok_, pDigis) ) {
        digis = pDigis.product(); // get a ptr to the product
        LogTrace("HcalSignalGenerator") << "total # digis  for "  << theInputTag << " " <<  digis->size();
      }
      else
      {
        throw cms::Exception("HcalSignalGenerator") << "Cannot find input data " << theInputTag;
      }
    }
    else if(theEventPrincipal)
    {
       std::shared_ptr<edm::Wrapper<COLLECTION>  const> digisPTR =
     edm::getProductByTag<COLLECTION>(*theEventPrincipal, theInputTag, mcc );
       if(digisPTR) {
          digis = digisPTR->product();
       }
    }
    else
    {
      throw cms::Exception("HcalSignalGenerator") << "No Event or EventPrincipal was set";
    }

    if (digis)
    {

      // loop over digis, adding these to the existing maps
      for(typename COLLECTION::const_iterator it  = digis->begin();
          it != digis->end(); ++it) 
      {
        // for the first signal, set the starting cap id
        if((it == digis->begin()) && theElectronicsSim)
        {
          int startingCapId = (*it)[0].capid();
          theElectronicsSim->setStartingCapId(startingCapId);
          // theParameterMap->setFrameSize(it->id(), it->size()); //don't need this
        }
    if(validDigi(*it)) {
      theNoiseSignals.push_back(samplesInPE(*it));
    }
      }
    }
  }

template<class HCALDIGITIZERTRAITS>

virtual void HcalSignalGenerator< HCALDIGITIZERTRAITS >::fillNoiseSignals ( CLHEP::HepRandomEngine *  )

inlineoverrideprivatevirtual

if you want to fill signals on demand, override this subclass is responsible for clearing theNoiseSignals before adding

Implements CaloVNoiseSignalGenerator.

Definition at line 114 of file HcalSignalGenerator.h.

{}

template<class HCALDIGITIZERTRAITS>

virtual void HcalSignalGenerator< HCALDIGITIZERTRAITS >::fillNoiseSignals ( )

inlineoverrideprivatevirtual

Implements CaloVNoiseSignalGenerator.

Definition at line 115 of file HcalSignalGenerator.h.

{}

template<class HCALDIGITIZERTRAITS>

void HcalSignalGenerator< HCALDIGITIZERTRAITS >::initializeEvent ( const edm::Event *  event, const edm::EventSetup *  eventSetup  )

inline

Definition at line 44 of file HcalSignalGenerator.h.

Referenced by edm::DataMixingHcalDigiWorkerProd::addHcalPileups().

  {
    theEvent = event;
    eventSetup->get<HcalDbRecord>().get(theConditions);
    theParameterMap->setDbService(theConditions.product());
  }

template<class HCALDIGITIZERTRAITS>

void HcalSignalGenerator< HCALDIGITIZERTRAITS >::initializeEvent ( const edm::EventPrincipal *  eventPrincipal, const edm::EventSetup *  eventSetup  )

inline

some users use EventPrincipals, not Events. We support both

Definition at line 52 of file HcalSignalGenerator.h.

  {
    theEventPrincipal = eventPrincipal;
    eventSetup->get<HcalDbRecord>().get(theConditions);
    theParameterMap->setDbService(theConditions.product());
  }

template<class HCALDIGITIZERTRAITS>

CaloSamples HcalSignalGenerator< HCALDIGITIZERTRAITS >::samplesInPE ( const DIGI &  digi )

inlineprivate

Definition at line 127 of file HcalSignalGenerator.h.

Referenced by HcalSignalGenerator< HBHEDigitizerTraits >::fill().

  {

    // For PreMixing, (Note that modifications will need to be made for DataMixing) the 
    // energy for each channel is kept as fC*10, but stored as an integer in ADC.  If this
    // results in an overflow, the "standard" ADC conversion is used and that channel is marked
    // with an error that allows the "standard" decoding to convert ADC back to fC.  So, most
    // channels get to fC by just dividing ADC/10; some require special treatment.

    // calibration, for future reference:  (same block for all Hcal types)
    HcalDetId cell = digi.id();
    //         const HcalCalibrations& calibrations=conditions->getHcalCalibrations(cell);
    //const HcalQIECoder* channelCoder = theConditions->getHcalCoder (cell);
    //const HcalQIEShape* channelShape = theConditions->getHcalShape (cell);
    //HcalCoderDb coder (*channelCoder, *channelShape);
    CaloSamples result = CaloSamples(cell,digi.size());;
    //coder.adc2fC(digi, result);

    // first, check if there was an overflow in this fake digi:
    bool overflow = false;
    // find and list them

    for(int isample=0; isample<digi.size(); ++isample) {
      if(digi[isample].er()) overflow = true; 
    }
 
    if(overflow) {  // do full conversion, go back and overwrite fake entries
 
      const HcalQIECoder* channelCoder = theConditions->getHcalCoder (cell);
      const HcalQIEShape* channelShape = theConditions->getHcalShape (cell);
      HcalCoderDb coder (*channelCoder, *channelShape);
      coder.adc2fC(digi, result);
 
      // overwrite with coded information
      for(int isample=0; isample<digi.size(); ++isample) {
    if(!digi[isample].er()) result[isample] = float(digi[isample].adc())/10.;
      }
    }
    else {  // saves creating the coder, etc., every time
      // use coded information
      for(int isample=0; isample<digi.size(); ++isample) {
    result[isample] = float(digi[isample].adc())/10.;
      }
      result.setPresamples(digi.presamples());
    }
 
    // std::cout << " HcalSignalGenerator: noise input ADC " << digi << std::endl;
    // std::cout << " HcalSignalGenerator: noise input in fC " << result << std::endl;
 
    // translation done in fC, convert to pe: 
    fC2pe(result);

    return result;
  }

template<class HCALDIGITIZERTRAITS>

bool HcalSignalGenerator< HCALDIGITIZERTRAITS >::validDigi ( const DIGI &  digi )

inlineprivate

Definition at line 117 of file HcalSignalGenerator.h.

Referenced by HcalSignalGenerator< HBHEDigitizerTraits >::fill().

  {
    int DigiSum = 0;
    for(int id = 0; id<digi.size(); id++) {
      if(digi[id].adc() > 0) ++DigiSum;
    }
    return(DigiSum>0);
  }

Member Data Documentation

template<class HCALDIGITIZERTRAITS>

edm::ESHandle<HcalDbService> HcalSignalGenerator< HCALDIGITIZERTRAITS >::theConditions

private

Definition at line 185 of file HcalSignalGenerator.h.

Referenced by HcalSignalGenerator< HBHEDigitizerTraits >::initializeEvent(), and HcalSignalGenerator< HBHEDigitizerTraits >::samplesInPE().

template<class HCALDIGITIZERTRAITS>

const edm::Event* HcalSignalGenerator< HCALDIGITIZERTRAITS >::theEvent

private

these fields are set in initializeEvent()

Definition at line 183 of file HcalSignalGenerator.h.

Referenced by HcalSignalGenerator< HBHEDigitizerTraits >::fill(), and HcalSignalGenerator< HBHEDigitizerTraits >::initializeEvent().

template<class HCALDIGITIZERTRAITS>

const edm::EventPrincipal* HcalSignalGenerator< HCALDIGITIZERTRAITS >::theEventPrincipal

private

Definition at line 184 of file HcalSignalGenerator.h.

Referenced by HcalSignalGenerator< HBHEDigitizerTraits >::fill(), and HcalSignalGenerator< HBHEDigitizerTraits >::initializeEvent().

template<class HCALDIGITIZERTRAITS>

edm::InputTag HcalSignalGenerator< HCALDIGITIZERTRAITS >::theInputTag

private

these come from the ParameterSet

Definition at line 187 of file HcalSignalGenerator.h.

Referenced by HcalSignalGenerator< HBHEDigitizerTraits >::fill().

template<class HCALDIGITIZERTRAITS>

edm::EDGetTokenT<COLLECTION> HcalSignalGenerator< HCALDIGITIZERTRAITS >::tok_

private

Definition at line 188 of file HcalSignalGenerator.h.

Referenced by HcalSignalGenerator< HBHEDigitizerTraits >::fill().