#include <CSCBaseElectronicsSim.h>

Inheritance diagram for CSCBaseElectronicsSim:

Public Types
typedef std::map< int, CSCAnalogSignal, std::less < int > >	CSCSignalMap

typedef edm::DetSet < StripDigiSimLink >	DigiSimLinks

Public Member Functions
const DigiSimLinks &	digiSimLinks () const

void	setLayerId (const CSCDetId &id)
	for standalone apps who don't calculate it from the geometry More...

void	simulate (const CSCLayer layer, const std::vector< CSCDetectorHit > &inputHits, CLHEP::HepRandomEngine )

virtual	~CSCBaseElectronicsSim ()

Protected Types
enum	{ NONE, CONSERVATIVE, RADICAL }

typedef std::multimap< int, CSCDetectorHit, std::less< int > >	DetectorHitMap

Protected Member Functions
CSCAnalogSignal &	add (const CSCAnalogSignal &, CLHEP::HepRandomEngine *)

virtual void	addLinks (int channelIndex)

void	addNoise (CLHEP::HepRandomEngine *)

CSCAnalogSignal	amplifySignal (const CSCDetectorHit &)

double	averageTimeOfFlight (const DetId &detId) const
	the average time-of-flight from the interaction point to the given detector More...

virtual float	calculateAmpResponse (float t) const =0

virtual int	channelIndex (int channel) const
	lets users map channels to different indices for links More...

void	combineAnalogSignals (const std::vector< CSCAnalogSignal > &)

	CSCBaseElectronicsSim (const edm::ParameterSet &p)

void	fillAmpResponse ()

CSCAnalogSignal &	find (int element, CLHEP::HepRandomEngine *)

virtual void	initParameters ()=0

CSCDetId	layerId () const
	the CSCDetId corresponding to the current layer More...

virtual CSCAnalogSignal	makeNoiseSignal (int element, CLHEP::HepRandomEngine *)

virtual int	readoutElement (int element) const =0

void	setLayer (const CSCLayer *layer)

void	setNoise (float rmsNoise, float noiseSigmaThreshold)

void	setSignalTimeRange (double startTime, double stopTime)

virtual float	signalDelay (int element, float pos) const

Protected Attributes
bool	doNoise_

int	nElements

CSCAnalogSignal	theAmpResponse

float	theBunchSpacing

std::vector< double >	theBunchTimingOffsets

DetectorHitMap	theDetectorHitMap

DigiSimLinks	theDigiSimLinks

const CSCLayer *	theLayer

const CSCLayerGeometry *	theLayerGeometry

CSCDetId	theLayerId

bool	theNoiseWasAdded

int	theNumberOfSamples

int	theOffsetOfBxZero

float	thePeakTimeSigma

float	theSamplingTime

int	theShapingTime

CSCSignalMap	theSignalMap

std::vector< double >	theSignalPropagationSpeed

float	theSignalStartTime

float	theSignalStopTime

const CSCChamberSpecs *	theSpecs

std::vector< double >	theTimingCalibrationError

Detailed Description

Commonalities between CSCStripElectronicsSim and CSCWireElectronicsSim.

Author: Rick Wilkinson

It has three non-virtual functions, so that's enough to deserve a new class. And since it has virtual functions it needs a virtual dtor.

Definition at line 37 of file CSCBaseElectronicsSim.h.

Member Typedef Documentation

typedef std::map<int, CSCAnalogSignal, std::less<int> > CSCBaseElectronicsSim::CSCSignalMap

Definition at line 41 of file CSCBaseElectronicsSim.h.

typedef std::multimap<int, CSCDetectorHit, std::less<int> > CSCBaseElectronicsSim::DetectorHitMap

protected

Definition at line 161 of file CSCBaseElectronicsSim.h.

typedef edm::DetSet<StripDigiSimLink> CSCBaseElectronicsSim::DigiSimLinks

Definition at line 42 of file CSCBaseElectronicsSim.h.

Member Enumeration Documentation

anonymous enum

protected

Enumerator
NONE
CONSERVATIVE
RADICAL

Definition at line 114 of file CSCBaseElectronicsSim.h.

114 {NONE, CONSERVATIVE, RADICAL};

CSCBaseElectronicsSim::NONE

Definition: CSCBaseElectronicsSim.h:114

CSCBaseElectronicsSim::CONSERVATIVE

Definition: CSCBaseElectronicsSim.h:114

CSCBaseElectronicsSim::RADICAL

Definition: CSCBaseElectronicsSim.h:114

Constructor & Destructor Documentation

CSCBaseElectronicsSim::~CSCBaseElectronicsSim ( )

virtual

Definition at line 41 of file CSCBaseElectronicsSim.cc.

42 {

43 }

CSCBaseElectronicsSim::CSCBaseElectronicsSim ( const edm::ParameterSet & p )

protected

Definition at line 15 of file CSCBaseElectronicsSim.cc.

References assert(), and theBunchTimingOffsets.

 : 
   theSpecs(0),
   theLayerGeometry(0),
   theLayer(0),
   theSignalMap(),
   theAmpResponse(),
   theBunchSpacing(25.),
   theNoiseWasAdded(false),
   nElements(0),
   theShapingTime(p.getParameter<int>("shapingTime")),
   thePeakTimeSigma(p.getParameter<double>("peakTimeSigma")),
   theBunchTimingOffsets(p.getParameter<std::vector<double> >("bunchTimingOffsets")),
   theSignalStartTime(p.getParameter<double>("signalStartTime")),
   theSignalStopTime(p.getParameter<double>("signalStopTime")),
   theSamplingTime(p.getParameter<double>("samplingTime")),
   theNumberOfSamples(static_cast<int>((theSignalStopTime-theSignalStartTime)/theSamplingTime)),
   theOffsetOfBxZero(p.getParameter<int>("timeBitForBxZero")),
   theSignalPropagationSpeed(p.getParameter<std::vector<double> >("signalSpeed")),
   theTimingCalibrationError(p.getParameter<std::vector<double> >("timingCalibrationError")),
   doNoise_(p.getParameter<bool>("doNoise"))
 {
   assert(theBunchTimingOffsets.size() == 11);
 }

Member Function Documentation

CSCAnalogSignal & CSCBaseElectronicsSim::add	(	const CSCAnalogSignal &	signal,
		CLHEP::HepRandomEngine *	engine
	)

protected

Definition at line 170 of file CSCBaseElectronicsSim.cc.

References find(), CSCAnalogSignal::getElement(), and CSCAnalogSignal::superimpose().

Referenced by counter.Counter::register(), and simulate().

                                                                                                          {
   int element = signal.getElement();
   CSCAnalogSignal & newSignal = find(element, engine);
   newSignal.superimpose(signal);
   return newSignal;
 }

void CSCBaseElectronicsSim::addLinks ( int channelIndex )

protectedvirtual

creates links from Digi to SimTrack disabled for now

Definition at line 188 of file CSCBaseElectronicsSim.cc.

References RecoTauCleanerPlugins::charge, PSimHit::eventId(), edm::DetSet< T >::push_back(), theDetectorHitMap, and theDigiSimLinks.

Referenced by CSCStripElectronicsSim::createDigi(), and CSCWireElectronicsSim::fillDigis().

                                                      {
   std::pair<DetectorHitMap::iterator, DetectorHitMap::iterator> channelHitItr 
     = theDetectorHitMap.equal_range(channelIndex);
 
   // find the fraction contribution for each SimTrack
   std::map<int,float> simTrackChargeMap;
   std::map<int, EncodedEventId> eventIdMap;
   float totalCharge = 0;
   for( DetectorHitMap::iterator hitItr = channelHitItr.first; 
                                 hitItr != channelHitItr.second; ++hitItr){
     const PSimHit * hit = hitItr->second.getSimHit();
     // might be zero for unit tests and such
     if(hit != 0) {
       int simTrackId = hitItr->second.getSimHit()->trackId();
       float charge = hitItr->second.getCharge();
       std::map<int,float>::iterator chargeItr = simTrackChargeMap.find(simTrackId);
       if( chargeItr == simTrackChargeMap.end() ) {
         simTrackChargeMap[simTrackId] = charge;
         eventIdMap[simTrackId] = hit->eventId();
       } else {
         chargeItr->second += charge;
       }
       totalCharge += charge;
     }
   }
 
   for(std::map<int,float>::iterator chargeItr = simTrackChargeMap.begin(); 
                           chargeItr != simTrackChargeMap.end(); ++chargeItr) {
     int simTrackId = chargeItr->first;
     theDigiSimLinks.push_back( StripDigiSimLink(channelIndex, simTrackId,  
                                   eventIdMap[simTrackId], chargeItr->second/totalCharge ) );
     
   }
 }

void CSCBaseElectronicsSim::addNoise ( CLHEP::HepRandomEngine * engine )

protected

Definition at line 135 of file CSCBaseElectronicsSim.cc.

References makeNoiseSignal(), theNoiseWasAdded, thePeakTimeSigma, and theSignalMap.

Referenced by simulate().

                                                                  {
   for(CSCSignalMap::iterator mapI = theSignalMap.begin(); 
       mapI!=  theSignalMap.end(); ++mapI) {
     // superimpose electronics noise
     (*mapI).second.superimpose(makeNoiseSignal((*mapI).first, engine));
     // DON'T do amp gain variations.  Handled in strips by calibration code
     // and variations in the shaper peaking time.
     double timeOffset = CLHEP::RandGaussQ::shoot(engine, (*mapI).second.getTimeOffset(), thePeakTimeSigma);
     (*mapI).second.setTimeOffset(timeOffset);
   }
   theNoiseWasAdded = true;
 }

CSCAnalogSignal CSCBaseElectronicsSim::amplifySignal ( const CSCDetectorHit & detectorHit )

protected

Definition at line 111 of file CSCBaseElectronicsSim.cc.

References channelIndex(), CSCDetectorHit::getCharge(), CSCDetectorHit::getElement(), CSCDetectorHit::getPosition(), CSCDetectorHit::getTime(), readoutElement(), signalDelay(), theAmpResponse, and theDetectorHitMap.

Referenced by simulate().

                                                                         {
   int element = readoutElement(detectorHit.getElement());
 
   float readoutTime = detectorHit.getTime() 
                     + signalDelay(element, detectorHit.getPosition());
 
   // start from the amp response, and modify it.
   CSCAnalogSignal thisSignal(theAmpResponse);
   thisSignal *= detectorHit.getCharge();
   thisSignal.setTimeOffset(readoutTime);
   thisSignal.setElement(element);
   // keep track of links between digis and hits
   theDetectorHitMap.insert( DetectorHitMap::value_type(channelIndex(element), detectorHit) );
   return thisSignal;
 } 

double CSCBaseElectronicsSim::averageTimeOfFlight ( const DetId & detId ) const

protected

the average time-of-flight from the interaction point to the given detector

virtual float CSCBaseElectronicsSim::calculateAmpResponse ( float t ) const

protectedpure virtual

Implemented in CSCStripElectronicsSim, and CSCWireElectronicsSim.

Referenced by fillAmpResponse().

virtual int CSCBaseElectronicsSim::channelIndex ( int channel ) const

inlineprotectedvirtual

lets users map channels to different indices for links

Reimplemented in CSCWireElectronicsSim.

Definition at line 105 of file CSCBaseElectronicsSim.h.

Referenced by amplifySignal(), and CSCStripElectronicsSim::createDigi().

105 {return channel;}

void CSCBaseElectronicsSim::combineAnalogSignals ( const std::vector< CSCAnalogSignal > & )

protected

const DigiSimLinks& CSCBaseElectronicsSim::digiSimLinks ( ) const

inline

Definition at line 50 of file CSCBaseElectronicsSim.h.

References theDigiSimLinks.

Referenced by CSCDigitizer::doAction().

50 {return theDigiSimLinks;}

CSCBaseElectronicsSim::theDigiSimLinks

DigiSimLinks theDigiSimLinks

Definition: CSCBaseElectronicsSim.h:163

void CSCBaseElectronicsSim::fillAmpResponse ( )

protected

Definition at line 92 of file CSCBaseElectronicsSim.cc.

References calculateAmpResponse(), i, LogTrace, theAmpResponse, theNumberOfSamples, and theSamplingTime.

Referenced by CSCStripElectronicsSim::CSCStripElectronicsSim(), and CSCWireElectronicsSim::CSCWireElectronicsSim().

                                             {
   std::vector<float> ampBinValues(theNumberOfSamples);
   int i = 0;
   for( ; i < theNumberOfSamples; ++i) {
     ampBinValues[i] = calculateAmpResponse(i*theSamplingTime);
     // truncate any entries that are trivially small
     if(i>5 && ampBinValues[i] < 0.000001) break;
   }
   ampBinValues.resize(i);
   theAmpResponse = CSCAnalogSignal(0, theSamplingTime, ampBinValues, 1., 0.);
 
   LogTrace("CSCBaseElectronicsSim") << 
     "CSCBaseElectronicsSim: dump of theAmpResponse follows...\n"
      << theAmpResponse;
 }

CSCAnalogSignal & CSCBaseElectronicsSim::find	(	int	element,
		CLHEP::HepRandomEngine *	engine
	)

protected

Definition at line 149 of file CSCBaseElectronicsSim.cc.

References LogTrace, makeNoiseSignal(), nElements, theNoiseWasAdded, theNumberOfSamples, theSamplingTime, theSignalMap, and theSignalStartTime.

Referenced by add(), CSCStripElectronicsSim::addCrosstalk(), CSCStripElectronicsSim::fillStripDigis(), and CSCStripElectronicsSim::runComparator().

                                                                                        {
   if(element <= 0 || element > nElements) {
     LogTrace("CSCBaseElectronicsSim") << "CSCBaseElectronicsSim: bad element = " << element << 
          ". There are " << nElements  << " elements.";
     edm::LogError("Error in CSCBaseElectronicsSim:  element out of bounds");
   }
   CSCSignalMap::iterator signalMapItr = theSignalMap.find(element);
   if(signalMapItr == theSignalMap.end()) {
     CSCAnalogSignal newSignal;
     if(theNoiseWasAdded) {
       newSignal = makeNoiseSignal(element, engine);
     } else {
       std::vector<float> emptyV(theNumberOfSamples);
       newSignal = CSCAnalogSignal(element, theSamplingTime, emptyV, 0., theSignalStartTime);
     }
     signalMapItr = theSignalMap.insert( std::pair<int, CSCAnalogSignal>(element, newSignal) ).first;
   }
   return (*signalMapItr).second;
 }

virtual void CSCBaseElectronicsSim::initParameters ( )

protectedpure virtual

Implemented in CSCStripElectronicsSim, and CSCWireElectronicsSim.

Referenced by setLayer().

CSCDetId CSCBaseElectronicsSim::layerId ( ) const

inlineprotected

the CSCDetId corresponding to the current layer

Definition at line 108 of file CSCBaseElectronicsSim.h.

References theLayerId.

Referenced by CSCStripElectronicsSim::addCrosstalk(), CSCStripElectronicsSim::createDigi(), CSCWireElectronicsSim::fillDigis(), CSCStripElectronicsSim::fillDigis(), CSCStripElectronicsSim::fillStripDigis(), CSCStripElectronicsSim::makeNoiseSignal(), and simulate().

108 {return theLayerId;}

CSCBaseElectronicsSim::theLayerId

CSCDetId theLayerId

Definition: CSCBaseElectronicsSim.h:119

CSCAnalogSignal CSCBaseElectronicsSim::makeNoiseSignal	(	int	element,
		CLHEP::HepRandomEngine *
	)

protectedvirtual

Reimplemented in CSCStripElectronicsSim.

Definition at line 128 of file CSCBaseElectronicsSim.cc.

References theNumberOfSamples, theSamplingTime, and theSignalStartTime.

Referenced by addNoise(), and find().

                                                                                          {
   std::vector<float> binValues(theNumberOfSamples);
   // default is empty
   return CSCAnalogSignal(element, theSamplingTime, binValues, 0., theSignalStartTime);
 } 

virtual int CSCBaseElectronicsSim::readoutElement ( int element ) const

protectedpure virtual

Implemented in CSCStripElectronicsSim, and CSCWireElectronicsSim.

Referenced by amplifySignal(), and simulate().

void CSCBaseElectronicsSim::setLayer ( const CSCLayer * layer )

protected

Definition at line 80 of file CSCBaseElectronicsSim.cc.

References CSCLayer::chamber(), CSCDetId, GeomDet::geographicalId(), CSCLayer::geometry(), initParameters(), DetId::rawId(), CSCChamber::specs(), theLayer, theLayerGeometry, theLayerId, and theSpecs.

Referenced by CSCStripElectronicsSim::fillMissingLayer(), and simulate().

 {
   // fill the specs member data
   theSpecs = layer->chamber()->specs();
   theLayerGeometry = layer->geometry();
 
   theLayer = layer;
   theLayerId = CSCDetId(theLayer->geographicalId().rawId());
   initParameters();
 }

void CSCBaseElectronicsSim::setLayerId ( const CSCDetId & id )

inline

for standalone apps who don't calculate it from the geometry

Definition at line 55 of file CSCBaseElectronicsSim.h.

References theLayerId.

55 {theLayerId = id;}

CSCBaseElectronicsSim::theLayerId

CSCDetId theLayerId

Definition: CSCBaseElectronicsSim.h:119

void CSCBaseElectronicsSim::setNoise	(	float	rmsNoise,
		float	noiseSigmaThreshold
	)

protected

void CSCBaseElectronicsSim::setSignalTimeRange	(	double	startTime,
		double	stopTime
	)

inlineprotected

How long before & after the bunch crossing to simulate shortening the time can save CPU

Definition at line 81 of file CSCBaseElectronicsSim.h.

References theSignalStartTime, and theSignalStopTime.

                                                              {
     theSignalStartTime = startTime;
     theSignalStopTime = stopTime;
   }

float CSCBaseElectronicsSim::signalDelay	(	int	element,
		float	pos
	)		const

protectedvirtual

how long, in ns, it takes a signal at pos to propagate to the readout edge. This may be negative, since the timing may be calibrated to the center of the detector

Definition at line 178 of file CSCBaseElectronicsSim.cc.

References CSCChamberSpecs::chamberType(), HLT_25ns10e33_v2_cff::distance, HLT_25ns10e33_v2_cff::speed, theSignalPropagationSpeed, and theSpecs.

Referenced by amplifySignal().

                                                                      {
   // readout is on top edge of chamber for strips, right edge
   // for wires.
   // zero calibrated to chamber center
   float distance = -1. * pos;
   float speed = theSignalPropagationSpeed[theSpecs->chamberType()];
   return distance / speed;
 }

void CSCBaseElectronicsSim::simulate	(	const CSCLayer *	layer,
		const std::vector< CSCDetectorHit > &	inputHits,
		CLHEP::HepRandomEngine *	engine
	)

Definition at line 46 of file CSCBaseElectronicsSim.cc.

References add(), addNoise(), amplifySignal(), doNoise_, AlCaHLTBitMon_QueryRunRegistry::getElement(), i, layerId(), readoutElement(), setLayer(), theDetectorHitMap, theDigiSimLinks, theNoiseWasAdded, and theSignalMap.

Referenced by CSCDigitizer::doAction().

 {
   theNoiseWasAdded = false;
 
   {
     theSignalMap.clear();
     theDetectorHitMap.clear();
     setLayer(layer);
     // can we swap for efficiency?
     theDigiSimLinks = DigiSimLinks(layerId().rawId());
   }
   
   {
     size_t nHits = detectorHits.size();
       // turn each detector hit into an analog signal
     for( size_t i = 0; i < nHits; ++i) {
       int element = readoutElement( detectorHits[i].getElement() );
 
       // skip if  hit element is not part of a readout element
       // e.g. wire in non-readout group
       if ( element != 0 ) add( amplifySignal(detectorHits[i]), engine );
     }
   }
   
   {
     if(doNoise_) {
       addNoise(engine);
     }
   }
 } 