CaloTDigitizer< Traits > 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)
void	addNoiseHits ()
void	addNoiseSignals ()
	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)
	Collects the digis. More...
void	setDetIds (const std::vector< DetId > &detIds)
void	setNoiseHitGenerator (CaloVNoiseHitGenerator *generator)
void	setNoiseSignalGenerator (CaloVNoiseSignalGenerator *generator)
void	setRandomEngine (CLHEP::HepRandomEngine &engine)
	~CaloTDigitizer ()
	doesn't delete the pointers passed in More...

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

Detailed Description

template<class Traits>
class CaloTDigitizer< Traits >

Turns hits into digis. Assumes that there's an ElectroncsSim class with the interface analogToDigital(const CaloSamples &, Digi &);

Definition at line 18 of file CaloTDigitizer.h.

Member Typedef Documentation

template<class Traits >

typedef Traits::Digi CaloTDigitizer< Traits >::Digi

Definition at line 25 of file CaloTDigitizer.h.

template<class Traits >

typedef Traits::DigiCollection CaloTDigitizer< Traits >::DigiCollection

Definition at line 26 of file CaloTDigitizer.h.

template<class Traits >

typedef Traits::ElectronicsSim CaloTDigitizer< Traits >::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 24 of file CaloTDigitizer.h.

Constructor & Destructor Documentation

template<class Traits >

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

inline

Definition at line 28 of file CaloTDigitizer.h.

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

template<class Traits >

CaloTDigitizer< Traits >::~CaloTDigitizer ( )

inline

doesn't delete the pointers passed in

Definition at line 40 of file CaloTDigitizer.h.

{}

Member Function Documentation

template<class Traits >

void CaloTDigitizer< Traits >::add ( const std::vector< PCaloHit > &  hits, int  bunchCrossing  )

inline

Definition at line 62 of file CaloTDigitizer.h.

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

Referenced by CastorDigiProducer::accumulateCaloHits(), HcalTBDigiProducer::accumulateCaloHits(), HcalDigitizer::accumulateCaloHits(), and EcalDigiProducer::accumulateCaloHits().

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

template<class Traits >

void CaloTDigitizer< Traits >::addNoiseHits ( )

inline

Definition at line 120 of file CaloTDigitizer.h.

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

Referenced by CaloTDigitizer< Traits >::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);
    }
  }

template<class Traits >

void CaloTDigitizer< Traits >::addNoiseSignals ( )

inline

Definition at line 131 of file CaloTDigitizer.h.

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

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

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

template<class Traits >

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

inline

tell the digitizer which cells exist

Definition at line 43 of file CaloTDigitizer.h.

References CaloTDigitizer< Traits >::theDetIds.

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

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

template<class Traits >

void CaloTDigitizer< Traits >::initializeHits ( )

inline

Definition at line 70 of file CaloTDigitizer.h.

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

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

                        {
     theHitResponse->initializeHits();
  }

template<class Traits >

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

inline

turns hits into digis

Definition at line 75 of file CaloTDigitizer.h.

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

                                                        {
    assert(0);
  }

template<class Traits >

void CaloTDigitizer< Traits >::run ( DigiCollection &  output )

inline

Collects the digis.

Definition at line 80 of file CaloTDigitizer.h.

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

                                    {
    theHitResponse->finalizeHits();

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

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

    theElectronicsSim->newEvent();

    // 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)
    {
       Digi digi(*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) { 
         theElectronicsSim->analogToDigital(*analogSignal , digi);
         output.push_back(std::move(digi));
         if(needToDeleteSignal) delete analogSignal;
      }
    }

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

template<class Traits >

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

inline

Definition at line 44 of file CaloTDigitizer.h.

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

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

{theDetIds = &detIds;}

template<class Traits >

void CaloTDigitizer< Traits >::setNoiseHitGenerator ( CaloVNoiseHitGenerator *  generator )

inline

Definition at line 46 of file CaloTDigitizer.h.

References python.IdGenerator::generator, and CaloTDigitizer< Traits >::theNoiseHitGenerator.

Referenced by HcalDigitizer::HcalDigitizer().

  {
    theNoiseHitGenerator = generator;
  }

template<class Traits >

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

inline

Definition at line 51 of file CaloTDigitizer.h.

References python.IdGenerator::generator, and CaloTDigitizer< Traits >::theNoiseSignalGenerator.

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

  {
    theNoiseSignalGenerator = generator;
  }

template<class Traits >

void CaloTDigitizer< Traits >::setRandomEngine ( CLHEP::HepRandomEngine &  engine )

inline

Definition at line 56 of file CaloTDigitizer.h.

References CaloHitResponse::setRandomEngine(), CaloTDigitizer< Traits >::theElectronicsSim, and CaloTDigitizer< Traits >::theHitResponse.

Referenced by HcalDigitizer::HcalDigitizer().

  {
    theHitResponse->setRandomEngine(engine);
    theElectronicsSim->setRandomEngine(engine);
  }

Member Data Documentation

template<class Traits >

bool CaloTDigitizer< Traits >::addNoise_

private

Definition at line 150 of file CaloTDigitizer.h.

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

template<class Traits >

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

private

Definition at line 149 of file CaloTDigitizer.h.

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

template<class Traits >

ElectronicsSim* CaloTDigitizer< Traits >::theElectronicsSim

private

Definition at line 148 of file CaloTDigitizer.h.

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

template<class Traits >

CaloHitResponse* CaloTDigitizer< Traits >::theHitResponse

private

Definition at line 145 of file CaloTDigitizer.h.

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

template<class Traits >

CaloVNoiseHitGenerator* CaloTDigitizer< Traits >::theNoiseHitGenerator

private

Definition at line 146 of file CaloTDigitizer.h.

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

template<class Traits >

CaloVNoiseSignalGenerator* CaloTDigitizer< Traits >::theNoiseSignalGenerator

private

Definition at line 147 of file CaloTDigitizer.h.

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