HcalElectronicsSim Class Reference

#include <HcalElectronicsSim.h>

Public Member Functions
void	analogToDigital (CLHEP::HepRandomEngine *, CaloSamples &linearFrame, HBHEDataFrame &result, double preMixFactor=10.0, unsigned preMixBits=126)
void	analogToDigital (CLHEP::HepRandomEngine *, CaloSamples &linearFrame, HFDataFrame &result, double preMixFactor=10.0, unsigned preMixBits=126)
void	analogToDigital (CLHEP::HepRandomEngine *, CaloSamples &linearFrame, HODataFrame &result, double preMixFactor=10.0, unsigned preMixBits=126)
void	analogToDigital (CLHEP::HepRandomEngine *, CaloSamples &linearFrame, QIE10DataFrame &result, double preMixFactor=10.0, unsigned preMixBits=126)
void	analogToDigital (CLHEP::HepRandomEngine *, CaloSamples &linearFrame, QIE11DataFrame &result, double preMixFactor=10.0, unsigned preMixBits=126)
void	analogToDigital (CLHEP::HepRandomEngine *, CaloSamples &linearFrame, ZDCDataFrame &result, double preMixFactor=10.0, unsigned preMixBits=126)
	HcalElectronicsSim (const HcalSimParameterMap *parameterMap, HcalAmplifier *amplifier, const HcalCoderFactory *coderFactory, bool PreMix)
void	newEvent (CLHEP::HepRandomEngine *)
void	setDbService (const HcalDbService *service)
void	setStartingCapId (int startingCapId)
	~HcalElectronicsSim ()

Private Member Functions
template<class Digi >
void	analogToDigitalImpl (CLHEP::HepRandomEngine *, CaloSamples &linearFrame, Digi &result, double preMixFactor, unsigned preMixBits)
template<class Digi >
void	convert (CaloSamples &frame, Digi &result, CLHEP::HepRandomEngine *)
template<>
void	convert (CaloSamples &frame, QIE10DataFrame &result, CLHEP::HepRandomEngine *engine)
template<>
void	convert (CaloSamples &frame, QIE11DataFrame &result, CLHEP::HepRandomEngine *engine)
template<class Digi >
void	premix (CaloSamples &frame, Digi &result, double preMixFactor, unsigned preMixBits)
template<>
void	premix (CaloSamples &frame, QIE10DataFrame &result, double preMixFactor, unsigned preMixBits)
template<>
void	premix (CaloSamples &frame, QIE11DataFrame &result, double preMixFactor, unsigned preMixBits)

Private Attributes
bool	PreMixDigis
HcalAmplifier *	theAmplifier
const HcalCoderFactory *	theCoderFactory
const HcalSimParameterMap *	theParameterMap
int	theStartingCapId
bool	theStartingCapIdIsRandom
HcalTDC	theTDC

Detailed Description

Definition at line 25 of file HcalElectronicsSim.h.

Constructor & Destructor Documentation

HcalElectronicsSim()

HcalElectronicsSim::HcalElectronicsSim	(	const HcalSimParameterMap *	parameterMap,
		HcalAmplifier *	amplifier,
		const HcalCoderFactory *	coderFactory,
		bool	PreMix
	)

Definition at line 13 of file HcalElectronicsSim.cc.

    : theParameterMap(parameterMap),
      theAmplifier(amplifier),
      theCoderFactory(coderFactory),
      theStartingCapId(0),
      theStartingCapIdIsRandom(true),
      PreMixDigis(PreMixing) {}

~HcalElectronicsSim()

HcalElectronicsSim::~HcalElectronicsSim

(

)

Definition at line 24 of file HcalElectronicsSim.cc.

{}

Member Function Documentation

analogToDigital() [1/6]

void HcalElectronicsSim::analogToDigital	(	CLHEP::HepRandomEngine *	engine,
		CaloSamples &	linearFrame,
		HBHEDataFrame &	result,
		double	preMixFactor = 10.0,
		unsigned	preMixBits = 126
	)

Definition at line 118 of file HcalElectronicsSim.cc.

                                                                                                                    {
  analogToDigitalImpl(engine, lf, result, preMixFactor, preMixBits);
}

References analogToDigitalImpl(), and mps_fire::result.

analogToDigital() [2/6]

void HcalElectronicsSim::analogToDigital	(	CLHEP::HepRandomEngine *	engine,
		CaloSamples &	linearFrame,
		HFDataFrame &	result,
		double	preMixFactor = 10.0,
		unsigned	preMixBits = 126
	)

Definition at line 128 of file HcalElectronicsSim.cc.

                                                                                                                  {
  analogToDigitalImpl(engine, lf, result, preMixFactor, preMixBits);
}

References analogToDigitalImpl(), and mps_fire::result.

analogToDigital() [3/6]

void HcalElectronicsSim::analogToDigital	(	CLHEP::HepRandomEngine *	engine,
		CaloSamples &	linearFrame,
		HODataFrame &	result,
		double	preMixFactor = 10.0,
		unsigned	preMixBits = 126
	)

Definition at line 123 of file HcalElectronicsSim.cc.

                                                                                                                  {
  analogToDigitalImpl(engine, lf, result, preMixFactor, preMixBits);
}

References analogToDigitalImpl(), and mps_fire::result.

analogToDigital() [4/6]

void HcalElectronicsSim::analogToDigital	(	CLHEP::HepRandomEngine *	engine,
		CaloSamples &	linearFrame,
		QIE10DataFrame &	result,
		double	preMixFactor = 10.0,
		unsigned	preMixBits = 126
	)

Definition at line 138 of file HcalElectronicsSim.cc.

                                                                                                                     {
  analogToDigitalImpl(engine, lf, result, preMixFactor, preMixBits);
}

References analogToDigitalImpl(), and mps_fire::result.

analogToDigital() [5/6]

void HcalElectronicsSim::analogToDigital	(	CLHEP::HepRandomEngine *	engine,
		CaloSamples &	linearFrame,
		QIE11DataFrame &	result,
		double	preMixFactor = 10.0,
		unsigned	preMixBits = 126
	)

Definition at line 143 of file HcalElectronicsSim.cc.

                                                                                                                     {
  analogToDigitalImpl(engine, lf, result, preMixFactor, preMixBits);
  if (!PreMixDigis) {
    const HcalSimParameters& pars = static_cast<const HcalSimParameters&>(theParameterMap->simParameters(lf.id()));
    if (pars.threshold_currentTDC() > 0.) {
      HcalTDC theTDC((pars.threshold_currentTDC()));
      theTDC.timing(lf, result);
    }
  }
}

References analogToDigitalImpl(), CaloSamples::id(), PreMixDigis, mps_fire::result, HcalSimParameterMap::simParameters(), theParameterMap, theTDC, HcalSimParameters::threshold_currentTDC(), and HcalTDC::timing().

analogToDigital() [6/6]

void HcalElectronicsSim::analogToDigital	(	CLHEP::HepRandomEngine *	engine,
		CaloSamples &	linearFrame,
		ZDCDataFrame &	result,
		double	preMixFactor = 10.0,
		unsigned	preMixBits = 126
	)

Definition at line 133 of file HcalElectronicsSim.cc.

                                                                                                                   {
  analogToDigitalImpl(engine, lf, result, preMixFactor, preMixBits);
}

References analogToDigitalImpl(), and mps_fire::result.

analogToDigitalImpl()

template<class Digi >

void HcalElectronicsSim::analogToDigitalImpl ( CLHEP::HepRandomEngine *  engine, CaloSamples &  linearFrame, Digi &  result, double  preMixFactor, unsigned  preMixBits  )

private

Definition at line 108 of file HcalElectronicsSim.cc.

                                                                                                           {
  convert<Digi>(lf, result, engine);
  if (PreMixDigis)
    premix(lf, result, preMixFactor, preMixBits);
}

References premix(), PreMixDigis, and mps_fire::result.

Referenced by analogToDigital().

convert() [1/3]

template<class Digi >

void HcalElectronicsSim::convert ( CaloSamples &  frame, Digi &  result, CLHEP::HepRandomEngine *  engine  )

private

Definition at line 32 of file HcalElectronicsSim.cc.

                                                                                               {
  result.setSize(frame.size());
  theAmplifier->amplify(frame, engine);
  theCoderFactory->coder(frame.id())->fC2adc(frame, result, theStartingCapId);
}

References HcalAmplifier::amplify(), HcalCoderFactory::coder(), amptDefault_cfi::frame, mps_fire::result, theAmplifier, theCoderFactory, and theStartingCapId.

convert() [2/3]

template<>

void HcalElectronicsSim::convert ( CaloSamples &  frame, QIE10DataFrame &  result, CLHEP::HepRandomEngine *  engine  )

private

Definition at line 39 of file HcalElectronicsSim.cc.

                                                                               {
  theAmplifier->amplify(frame, engine);
  theCoderFactory->coder(frame.id())->fC2adc(frame, result, theStartingCapId);
}

References HcalAmplifier::amplify(), HcalCoderFactory::coder(), amptDefault_cfi::frame, mps_fire::result, theAmplifier, theCoderFactory, and theStartingCapId.

convert() [3/3]

template<>

void HcalElectronicsSim::convert ( CaloSamples &  frame, QIE11DataFrame &  result, CLHEP::HepRandomEngine *  engine  )

private

Definition at line 47 of file HcalElectronicsSim.cc.

                                                                               {
  theAmplifier->amplify(frame, engine);
  theCoderFactory->coder(frame.id())->fC2adc(frame, result, theStartingCapId);
}

References HcalAmplifier::amplify(), HcalCoderFactory::coder(), amptDefault_cfi::frame, mps_fire::result, theAmplifier, theCoderFactory, and theStartingCapId.

newEvent()

void HcalElectronicsSim::newEvent

(

CLHEP::HepRandomEngine *

engine

)

Things that need to be initialized every event sets starting CapID randomly

Definition at line 155 of file HcalElectronicsSim.cc.

                                                              {
  // pick a new starting Capacitor ID
  if (theStartingCapIdIsRandom) {
    theStartingCapId = CLHEP::RandFlat::shootInt(engine, 4);
    theAmplifier->setStartingCapId(theStartingCapId);
  }
}

References HcalAmplifier::setStartingCapId(), theAmplifier, theStartingCapId, and theStartingCapIdIsRandom.

premix() [1/3]

template<class Digi >

void HcalElectronicsSim::premix ( CaloSamples &  frame, Digi &  result, double  preMixFactor, unsigned  preMixBits  )

private

Definition at line 55 of file HcalElectronicsSim.cc.

                                                                                                          {
  for (int isample = 0; isample != frame.size(); ++isample) {
    uint16_t theADC = round(preMixFactor * frame[isample]);
    unsigned capId = result[isample].capid();
 
    if (theADC > preMixBits) {
      uint16_t keepADC = result[isample].adc();
      result.setSample(isample, HcalQIESample(keepADC, capId, 0, 0, true, true));  // set error bit as a flag
    } else {
      result.setSample(isample, HcalQIESample(theADC, capId, 0, 0));  // preserve fC, no noise
    }
  }
}

References amptDefault_cfi::frame, and mps_fire::result.

Referenced by analogToDigitalImpl().

premix() [2/3]

template<>

void HcalElectronicsSim::premix ( CaloSamples &  frame, QIE10DataFrame &  result, double  preMixFactor, unsigned  preMixBits  )

private

Definition at line 70 of file HcalElectronicsSim.cc.

                                                                     {
  for (int isample = 0; isample != frame.size(); ++isample) {
    uint16_t theADC = round(preMixFactor * frame[isample]);
    unsigned capId = result[isample].capid();
    bool ok = true;
 
    if (theADC > preMixBits) {
      theADC = result[isample].adc();
      ok = false;  // set error bit as a flag
    }
 
    result.setSample(
        isample, theADC, result[isample].le_tdc(), result[isample].te_tdc(), capId, result[isample].soi(), ok);
  }
}

References amptDefault_cfi::frame, convertSQLiteXML::ok, and mps_fire::result.

premix() [3/3]

template<>

void HcalElectronicsSim::premix ( CaloSamples &  frame, QIE11DataFrame &  result, double  preMixFactor, unsigned  preMixBits  )

private

Definition at line 90 of file HcalElectronicsSim.cc.

                                                                     {
  for (int isample = 0; isample != frame.size(); ++isample) {
    uint16_t theADC = round(preMixFactor * frame[isample]);
    int tdcErrorBit = 0;
 
    if (theADC > preMixBits) {
      theADC = result[isample].adc();
      tdcErrorBit = 1;  //use TDC bits for error bit
    }
 
    result.setSample(isample, theADC, tdcErrorBit, result[isample].soi());
  }
}

References amptDefault_cfi::frame, and mps_fire::result.

setDbService()

void HcalElectronicsSim::setDbService

(

const HcalDbService *

service

)

Definition at line 26 of file HcalElectronicsSim.cc.

                                                                  {
  //  theAmplifier->setDbService(service);
  theTDC.setDbService(service);
}

References HcalTDC::setDbService(), and theTDC.

setStartingCapId()

void HcalElectronicsSim::setStartingCapId

(

int

startingCapId

)

Definition at line 163 of file HcalElectronicsSim.cc.

                                                           {
  theStartingCapId = startingCapId;
  theAmplifier->setStartingCapId(theStartingCapId);
  // turns off random capIDs forever for this instance
  theStartingCapIdIsRandom = false;
}

References HcalAmplifier::setStartingCapId(), theAmplifier, theStartingCapId, and theStartingCapIdIsRandom.

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

Member Data Documentation

PreMixDigis

bool HcalElectronicsSim::PreMixDigis

private

Definition at line 87 of file HcalElectronicsSim.h.

Referenced by analogToDigital(), and analogToDigitalImpl().

theAmplifier

HcalAmplifier* HcalElectronicsSim::theAmplifier

private

Definition at line 81 of file HcalElectronicsSim.h.

Referenced by convert(), newEvent(), and setStartingCapId().

theCoderFactory

const HcalCoderFactory* HcalElectronicsSim::theCoderFactory

private

Definition at line 82 of file HcalElectronicsSim.h.

Referenced by convert().

theParameterMap

const HcalSimParameterMap* HcalElectronicsSim::theParameterMap

private

Definition at line 80 of file HcalElectronicsSim.h.

Referenced by analogToDigital().

theStartingCapId

int HcalElectronicsSim::theStartingCapId

private

Definition at line 85 of file HcalElectronicsSim.h.

Referenced by convert(), newEvent(), and setStartingCapId().

theStartingCapIdIsRandom

bool HcalElectronicsSim::theStartingCapIdIsRandom

private

Definition at line 86 of file HcalElectronicsSim.h.

Referenced by newEvent(), and setStartingCapId().

theTDC

HcalTDC HcalElectronicsSim::theTDC

private

Definition at line 83 of file HcalElectronicsSim.h.

Referenced by analogToDigital(), and setDbService().