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	addNoiseHits (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...
void	initializeHits ()
void	run (MixCollection< PCaloHit > &, DigiCollection &)
	turns hits into digis More...
void	run (DigiCollection &output, CLHEP::HepRandomEngine *engine)
	Collects the digis. More...
void	setDetIds (const std::vector< DetId > &detIds)
void	setNoiseHitGenerator (CaloVNoiseHitGenerator *generator)
void	setNoiseSignalGenerator (CaloVNoiseSignalGenerator *generator)
	~CaloTDigitizer ()
	doesn't delete the pointers passed in More...

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

Detailed Description

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

Definition at line 38 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 45 of file CaloTDigitizer.h.

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

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

Definition at line 46 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 44 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 48 of file CaloTDigitizer.h.

  :  theHitResponse(hitResponse),
     theNoiseHitGenerator(0),
     theNoiseSignalGenerator(0),
     theElectronicsSim(electronicsSim),
     theDetIds(0),
     addNoise_(addNoise)
  {
  }

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

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

inline

doesn't delete the pointers passed in

Definition at line 60 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 76 of file CaloTDigitizer.h.

References CaloHitResponse::add(), CaloTDigitizer< Traits, runHelper >::theHitResponse, and CaloHitResponse::withinBunchRange().

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 >::addNoiseHits ( CLHEP::HepRandomEngine *  engine )

inline

Definition at line 133 of file CaloTDigitizer.h.

References CaloHitResponse::add(), CaloVNoiseHitGenerator::getNoiseHits(), CaloTDigitizer< Traits, runHelper >::theHitResponse, and CaloTDigitizer< Traits, runHelper >::theNoiseHitGenerator.

Referenced by CaloTDigitizer< Traits, runHelper >::run().

  {
    std::vector<PCaloHit> noiseHits;
    theNoiseHitGenerator->getNoiseHits(noiseHits);
    for(std::vector<PCaloHit>::const_iterator hitItr = noiseHits.begin(),
        hitEnd = noiseHits.end(); hitItr != hitEnd; ++hitItr)
    {
      theHitResponse->add(*hitItr, engine);
    }
  }

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

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

inline

Definition at line 144 of file CaloTDigitizer.h.

References CaloHitResponse::add(), CaloVNoiseSignalGenerator::fillEvent(), CaloVNoiseSignalGenerator::getNoiseSignals(), CaloTDigitizer< Traits, runHelper >::theHitResponse, and CaloTDigitizer< Traits, runHelper >::theNoiseSignalGenerator.

Referenced by CaloTDigitizer< Traits, runHelper >::run().

  {
    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 63 of file CaloTDigitizer.h.

References assert(), and CaloTDigitizer< Traits, runHelper >::theDetIds.

Referenced by CaloTDigitizer< Traits, runHelper >::setDetIds().

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

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

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

inline

Definition at line 84 of file CaloTDigitizer.h.

References CaloHitResponse::initializeHits(), and CaloTDigitizer< Traits, runHelper >::theHitResponse.

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 89 of file CaloTDigitizer.h.

References assert().

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 95 of file CaloTDigitizer.h.

References CaloTDigitizer< Traits, runHelper >::addNoise_, CaloTDigitizer< Traits, runHelper >::addNoiseHits(), CaloTDigitizer< Traits, runHelper >::addNoiseSignals(), assert(), CaloHitResponse::clear(), CaloHitResponse::finalizeHits(), CaloHitResponse::findSignal(), CaloHitResponse::makeBlankSignal(), CaloHitResponse::nSignals(), CaloTDigitizer< Traits, runHelper >::runAnalogToDigital, CaloTDigitizer< Traits, runHelper >::theDetIds, CaloTDigitizer< Traits, runHelper >::theElectronicsSim, CaloTDigitizer< Traits, runHelper >::theHitResponse, CaloTDigitizer< Traits, runHelper >::theNoiseHitGenerator, and CaloTDigitizer< Traits, runHelper >::theNoiseSignalGenerator.

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

    assert(theDetIds->size() != 0);

    if(theNoiseHitGenerator != 0) addNoiseHits(engine);
    if(theNoiseSignalGenerator != 0) addNoiseSignals(engine);

    theElectronicsSim->newEvent(engine);

    // reserve space for how many digis we expect
    int nDigisExpected = addNoise_ ? theDetIds->size() : theHitResponse->nSignals();
    output.reserve(nDigisExpected);

    // 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);
       bool needToDeleteSignal = false;
       // don't bother digitizing if no signal and no noise
       if(analogSignal == 0 && 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 != 0) { 
         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 >::setDetIds ( const std::vector< DetId > &  detIds )

inline

Definition at line 64 of file CaloTDigitizer.h.

References CaloTDigitizer< Traits, runHelper >::detIds(), and CaloTDigitizer< Traits, runHelper >::theDetIds.

Referenced by 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 >::setNoiseHitGenerator ( CaloVNoiseHitGenerator *  generator )

inline

Definition at line 66 of file CaloTDigitizer.h.

References reco_application_tbsim_DetSim-Digi_cfg::generator, and CaloTDigitizer< Traits, runHelper >::theNoiseHitGenerator.

Referenced by HcalDigitizer::HcalDigitizer().

  {
    theNoiseHitGenerator = generator;
  }

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

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

inline

Definition at line 71 of file CaloTDigitizer.h.

References reco_application_tbsim_DetSim-Digi_cfg::generator, and CaloTDigitizer< Traits, runHelper >::theNoiseSignalGenerator.

Referenced by HcalDigitizer::HcalDigitizer(), HcalDigitizer::setHBHENoiseSignalGenerator(), HcalDigitizer::setHFNoiseSignalGenerator(), HcalDigitizer::setHONoiseSignalGenerator(), 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 164 of file CaloTDigitizer.h.

Referenced by CaloTDigitizer< Traits, runHelper >::run().

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

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

private

Definition at line 158 of file CaloTDigitizer.h.

Referenced by CaloTDigitizer< Traits, runHelper >::run().

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

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

private

Definition at line 163 of file CaloTDigitizer.h.

Referenced by CaloTDigitizer< Traits, runHelper >::detIds(), CaloTDigitizer< Traits, runHelper >::run(), and CaloTDigitizer< Traits, runHelper >::setDetIds().

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

ElectronicsSim* CaloTDigitizer< Traits, runHelper >::theElectronicsSim

private

Definition at line 162 of file CaloTDigitizer.h.

Referenced by CaloTDigitizer< Traits, runHelper >::run().

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

CaloHitResponse* CaloTDigitizer< Traits, runHelper >::theHitResponse

private

Definition at line 159 of file CaloTDigitizer.h.

Referenced by CaloTDigitizer< Traits, runHelper >::add(), CaloTDigitizer< Traits, runHelper >::addNoiseHits(), CaloTDigitizer< Traits, runHelper >::addNoiseSignals(), CaloTDigitizer< Traits, runHelper >::initializeHits(), and CaloTDigitizer< Traits, runHelper >::run().

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

CaloVNoiseHitGenerator* CaloTDigitizer< Traits, runHelper >::theNoiseHitGenerator

private

Definition at line 160 of file CaloTDigitizer.h.

Referenced by CaloTDigitizer< Traits, runHelper >::addNoiseHits(), CaloTDigitizer< Traits, runHelper >::run(), and CaloTDigitizer< Traits, runHelper >::setNoiseHitGenerator().

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

CaloVNoiseSignalGenerator* CaloTDigitizer< Traits, runHelper >::theNoiseSignalGenerator

private

Definition at line 161 of file CaloTDigitizer.h.

Referenced by CaloTDigitizer< Traits, runHelper >::addNoiseSignals(), CaloTDigitizer< Traits, runHelper >::run(), and CaloTDigitizer< Traits, runHelper >::setNoiseSignalGenerator().