CaloTDigitizer< Traits, runHelper > Class Template Reference

#include <CaloTDigitizer.h>

Public Types
typedef Traits::Digi	Digi
typedef Traits::DigiCollection	DigiCollection
typedef Traits::ElectronicsSim	ElectronicsSim

Public Member Functions
void	add (const std::vector< PCaloHit > &hits, int bunchCrossing, CLHEP::HepRandomEngine *engine)
void	addNoiseSignals (CLHEP::HepRandomEngine *engine)
	CaloTDigitizer (CaloHitResponse *hitResponse, ElectronicsSim *electronicsSim, bool addNoise)
const std::vector< DetId > &	detIds () const
	tell the digitizer which cells exist More...
const CaloSamplesCollection &	getCaloSamples () const
void	initializeHits ()
void	run (MixCollection< PCaloHit > &, DigiCollection &)
	turns hits into digis More...
void	run (DigiCollection &output, CLHEP::HepRandomEngine *engine)
	Collects the digis. More...
void	setDebugCaloSamples (bool debug)
void	setDetIds (const std::vector< DetId > &detIds)
void	setNoiseSignalGenerator (CaloVNoiseSignalGenerator *generator)
	~CaloTDigitizer ()
	doesn't delete the pointers passed in More...

Private Attributes
bool	addNoise_
CaloSamplesCollection	csColl_
bool	debugCS_
runHelper< Traits >	runAnalogToDigital
const std::vector< DetId > *	theDetIds
ElectronicsSim *	theElectronicsSim
CaloHitResponse *	theHitResponse
CaloVNoiseSignalGenerator *	theNoiseSignalGenerator

Detailed Description

template<class Traits, template< class > class runHelper = CaloTDigitizerDefaultRun>
class CaloTDigitizer< Traits, runHelper >

Definition at line 37 of file CaloTDigitizer.h.

Member Typedef Documentation

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

typedef Traits::Digi CaloTDigitizer< Traits, runHelper >::Digi

Definition at line 44 of file CaloTDigitizer.h.

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

typedef Traits::DigiCollection CaloTDigitizer< Traits, runHelper >::DigiCollection

Definition at line 45 of file CaloTDigitizer.h.

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

typedef Traits::ElectronicsSim CaloTDigitizer< Traits, runHelper >::ElectronicsSim

these are the types that need to be defined in the Traits class. The ElectronicsSim needs to have an interface that you'll see in the run() method

Definition at line 43 of file CaloTDigitizer.h.

Constructor & Destructor Documentation

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

CaloTDigitizer< Traits, runHelper >::CaloTDigitizer ( CaloHitResponse *  hitResponse, ElectronicsSim *  electronicsSim, bool  addNoise  )

inline

Definition at line 47 of file CaloTDigitizer.h.

  :  theHitResponse(hitResponse),
     theNoiseSignalGenerator(nullptr),
     theElectronicsSim(electronicsSim),
     theDetIds(nullptr),
     addNoise_(addNoise),
     debugCS_(false)
  {
  }

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

CaloTDigitizer< Traits, runHelper >::~CaloTDigitizer ( )

inline

doesn't delete the pointers passed in

Definition at line 59 of file CaloTDigitizer.h.

{}

Member Function Documentation

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

void CaloTDigitizer< Traits, runHelper >::add ( const std::vector< PCaloHit > &  hits, int  bunchCrossing, CLHEP::HepRandomEngine *  engine  )

inline

Definition at line 78 of file CaloTDigitizer.h.

Referenced by HcalTBDigiProducer::accumulateCaloHits(), CastorDigiProducer::accumulateCaloHits(), HcalDigitizer::accumulateCaloHits(), and counter.Counter::register().

                                                                                              {
    if(theHitResponse->withinBunchRange(bunchCrossing)) {
      for(std::vector<PCaloHit>::const_iterator it = hits.begin(), itEnd = hits.end(); it != itEnd; ++it) {
        theHitResponse->add(*it, engine);
      }
    }
  }

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

void CaloTDigitizer< Traits, runHelper >::addNoiseSignals ( CLHEP::HepRandomEngine *  engine )

inline

Definition at line 140 of file CaloTDigitizer.h.

  {
    std::vector<CaloSamples> noiseSignals;
    // noise signals need to be in units of photoelectrons.  Fractional is OK
    theNoiseSignalGenerator->fillEvent(engine);
    theNoiseSignalGenerator->getNoiseSignals(noiseSignals);
    for(std::vector<CaloSamples>::const_iterator signalItr = noiseSignals.begin(),
        signalEnd = noiseSignals.end(); signalItr != signalEnd; ++signalItr)
    {
      theHitResponse->add(*signalItr);
    }
  }

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

const std::vector<DetId>& CaloTDigitizer< Traits, runHelper >::detIds ( void  ) const

inline

tell the digitizer which cells exist

Definition at line 62 of file CaloTDigitizer.h.

{assert( 0 != theDetIds ) ; return *theDetIds;}

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

const CaloSamplesCollection& CaloTDigitizer< Traits, runHelper >::getCaloSamples ( ) const

inline

Definition at line 74 of file CaloTDigitizer.h.

Referenced by HcalDigitizer::finalizeEvent().

                                                      {
    return csColl_;
  }

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

void CaloTDigitizer< Traits, runHelper >::initializeHits ( )

inline

Definition at line 86 of file CaloTDigitizer.h.

Referenced by CastorDigiProducer::initializeEvent(), HcalTBDigiProducer::initializeEvent(), and HcalDigitizer::initializeEvent().

                        {
     theHitResponse->initializeHits();
  }

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

void CaloTDigitizer< Traits, runHelper >::run ( MixCollection< PCaloHit > &  , DigiCollection &    )

inline

turns hits into digis

Definition at line 91 of file CaloTDigitizer.h.

Referenced by CastorDigiProducer::finalizeEvent(), HcalTBDigiProducer::finalizeEvent(), and HcalDigitizer::finalizeEvent().

                                                        {
    assert(0);
  }

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

void CaloTDigitizer< Traits, runHelper >::run ( DigiCollection &  output, CLHEP::HepRandomEngine *  engine  )

inline

Collects the digis.

Definition at line 97 of file CaloTDigitizer.h.

                                                                  {
    assert(!theDetIds->empty());

    if(theNoiseSignalGenerator != nullptr) addNoiseSignals(engine);

    theHitResponse->finalizeHits(engine);
    //std::cout << " In CaloTDigitizer, after finalize hits " << std::endl;

    theElectronicsSim->newEvent(engine);

    // reserve space for how many digis we expect
    int nDigisExpected = addNoise_ ? theDetIds->size() : theHitResponse->nSignals();
    output.reserve(nDigisExpected);
    if(debugCS_) {
      csColl_.clear();
      csColl_.reserve(nDigisExpected);
      theHitResponse->setStorePrecise(true);
    }

    // make a raw digi for evey cell
    for(std::vector<DetId>::const_iterator idItr = theDetIds->begin();
        idItr != theDetIds->end(); ++idItr)
    {
       CaloSamples * analogSignal = theHitResponse->findSignal(*idItr);
       if(analogSignal && debugCS_) csColl_.push_back(*analogSignal);
       bool needToDeleteSignal = false;
       // don't bother digitizing if no signal and no noise
       if(analogSignal == nullptr && addNoise_) {
         // I guess we need to make a blank signal for this cell.
         // Don't bother storing it anywhere.
         analogSignal = new CaloSamples(theHitResponse->makeBlankSignal(*idItr));
         needToDeleteSignal = true;
       }
       if(analogSignal != nullptr) { 
         runAnalogToDigital(output,engine,analogSignal,idItr,theElectronicsSim);
         if(needToDeleteSignal) delete analogSignal;
      }
    }

    // free up some memory
    theHitResponse->clear();
  }

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

void CaloTDigitizer< Traits, runHelper >::setDebugCaloSamples ( bool  debug )

inline

Definition at line 70 of file CaloTDigitizer.h.

References debug.

Referenced by HcalDigitizer::HcalDigitizer().

                                      {
    debugCS_ = debug;
  }

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

void CaloTDigitizer< Traits, runHelper >::setDetIds ( const std::vector< DetId > &  detIds )

inline

Definition at line 63 of file CaloTDigitizer.h.

Referenced by HcalDigitizer::buildHBHEQIECells(), HcalDigitizer::buildHFQIECells(), HcalDigitizer::buildHOSiPMCells(), CastorDigiProducer::checkGeometry(), HcalTBDigiProducer::updateGeometry(), and HcalDigitizer::updateGeometry().

{theDetIds = &detIds;}

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

void CaloTDigitizer< Traits, runHelper >::setNoiseSignalGenerator ( CaloVNoiseSignalGenerator *  generator )

inline

Definition at line 65 of file CaloTDigitizer.h.

References cmsBatch::generator.

Referenced by HcalDigitizer::setHBHENoiseSignalGenerator(), HcalDigitizer::setHFNoiseSignalGenerator(), HcalDigitizer::setHONoiseSignalGenerator(), HcalDigitizer::setQIE10NoiseSignalGenerator(), HcalDigitizer::setQIE11NoiseSignalGenerator(), and HcalDigitizer::setZDCNoiseSignalGenerator().

  {
    theNoiseSignalGenerator = generator;
  }

Member Data Documentation

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

bool CaloTDigitizer< Traits, runHelper >::addNoise_

private

Definition at line 159 of file CaloTDigitizer.h.

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

CaloSamplesCollection CaloTDigitizer< Traits, runHelper >::csColl_

private

Definition at line 161 of file CaloTDigitizer.h.

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

bool CaloTDigitizer< Traits, runHelper >::debugCS_

private

Definition at line 160 of file CaloTDigitizer.h.

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

runHelper<Traits> CaloTDigitizer< Traits, runHelper >::runAnalogToDigital

private

Definition at line 154 of file CaloTDigitizer.h.

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

const std::vector<DetId>* CaloTDigitizer< Traits, runHelper >::theDetIds

private

Definition at line 158 of file CaloTDigitizer.h.

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

ElectronicsSim* CaloTDigitizer< Traits, runHelper >::theElectronicsSim

private

Definition at line 157 of file CaloTDigitizer.h.

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

CaloHitResponse* CaloTDigitizer< Traits, runHelper >::theHitResponse

private

Definition at line 155 of file CaloTDigitizer.h.

template<class Traits , template< class > class runHelper = CaloTDigitizerDefaultRun>

CaloVNoiseSignalGenerator* CaloTDigitizer< Traits, runHelper >::theNoiseSignalGenerator

private

Definition at line 156 of file CaloTDigitizer.h.