#include <HcalAmplifier.h>

Public Member Functions
virtual void	amplify (CaloSamples &linearFrame, CLHEP::HepRandomEngine *) const

	HcalAmplifier (const CaloVSimParameterMap *parameters, bool addNoise, bool PreMix1, bool PreMix2)

void	setADCPeds (const HcalPedestals *ADCPeds)

void	setCholesky (const HcalCholeskyMatrices *Cholesky)

void	setDbService (const HcalDbService *service)
	the Producer will probably update this every event More...

void	setHBtuningParameter (double tp)

void	setHEtuningParameter (double tp)

void	setHFtuningParameter (double tp)

void	setHOtuningParameter (double tp)

void	setIonFeedbackSim (HPDIonFeedbackSim *feedbackSim)

void	setNoiseSignalGenerator (const CaloVNoiseSignalGenerator *noiseSignalGenerator)

void	setStartingCapId (int capId)

void	setTimeSlewSim (HcalTimeSlewSim *timeSlewSim)

void	setUseOldHB (bool useOld)

void	setUseOldHE (bool useOld)

void	setUseOldHF (bool useOld)

void	setUseOldHO (bool useOld)

virtual	~HcalAmplifier ()

Private Member Functions
void	addPedestals (CaloSamples &frame, CLHEP::HepRandomEngine *) const

void	makeNoise (const HcalCholeskyMatrix &thisChanCholesky, int fFrames, double fGauss, double fNoise, int m) const

void	makeNoiseOld (HcalGenericDetId::HcalGenericSubdetector hcalSubDet, const HcalCalibrationWidths &width, int fFrames, double fGauss, double fNoise) const

void	pe2fC (CaloSamples &frame) const

Private Attributes
bool	addNoise_

double	HB_ff

double	HE_ff

double	HF_ff

double	HO_ff

const HcalPedestals *	myADCPeds

const HcalCholeskyMatrices *	myCholeskys

bool	preMixAdd_

bool	preMixDigi_

const HcalDbService *	theDbService

HPDIonFeedbackSim *	theIonFeedbackSim

const CaloVNoiseSignalGenerator *	theNoiseSignalGenerator

const CaloVSimParameterMap *	theParameterMap

unsigned	theStartingCapId

HcalTimeSlewSim *	theTimeSlewSim

bool	useOldHB

bool	useOldHE

bool	useOldHF

bool	useOldHO

Detailed Description

Definition at line 23 of file HcalAmplifier.h.

Constructor & Destructor Documentation

HcalAmplifier::HcalAmplifier	(	const CaloVSimParameterMap *	parameters,
		bool	addNoise,
		bool	PreMix1,
		bool	PreMix2
	)

Definition at line 24 of file HcalAmplifier.cc.

                                                                                                                :
   theDbService(nullptr),
   theParameterMap(parameters),
   theNoiseSignalGenerator(nullptr),
   myCholeskys(nullptr),
   myADCPeds(nullptr),
   theIonFeedbackSim(nullptr),
   theTimeSlewSim(nullptr),
   theStartingCapId(0),
   addNoise_(addNoise),
   preMixDigi_(PreMix1),
   preMixAdd_(PreMix2),
   useOldHB(false),
   useOldHE(false),
   useOldHF(false),
   useOldHO(false)
 { }

virtual HcalAmplifier::~HcalAmplifier ( )

inlinevirtual

Definition at line 27 of file HcalAmplifier.h.

27 {}

Member Function Documentation

void HcalAmplifier::addPedestals	(	CaloSamples &	frame,
		CLHEP::HepRandomEngine *	engine
	)		const

private

Definition at line 85 of file HcalAmplifier.cc.

References addNoise_, assert(), HcalQIECoder::charge(), HcalGenericDetId::genericSubdet(), HcalDbService::getHcalCalibrations(), HcalDbService::getHcalCalibrationWidths(), HcalDbService::getHcalCoder(), HcalDbService::getHcalShape(), HcalPedestal::getValue(), HcalCholeskyMatrices::getValues(), HcalCondObjectContainer< Item >::getValues(), HB_ff, HcalGenericDetId::HcalGenBarrel, HcalGenericDetId::HcalGenEndcap, HcalGenericDetId::HcalGenForward, HcalGenericDetId::HcalGenOuter, HE_ff, HF_ff, HO_ff, i, CaloSamples::id(), makeNoise(), makeNoiseOld(), myADCPeds, myCholeskys, HLT_FULL_cff::noise, HcalCalibrations::pedestal(), EcalCondDBWriter_cfi::pedestal, preMixDigi_, CaloSamples::size(), DetId::subdetId(), theDbService, theStartingCapId, useOldHB, useOldHE, useOldHF, useOldHO, and x.

Referenced by amplify().

 {
    assert(theDbService != 0);
    HcalGenericDetId hcalGenDetId(frame.id());
    HcalGenericDetId::HcalGenericSubdetector hcalSubDet = hcalGenDetId.genericSubdet();
 
    bool useOld=false;
    if(hcalSubDet==HcalGenericDetId::HcalGenBarrel) useOld = useOldHB;
    if(hcalSubDet==HcalGenericDetId::HcalGenEndcap) useOld = useOldHE;
    if(hcalSubDet==HcalGenericDetId::HcalGenForward) useOld = useOldHF;
    if(hcalSubDet==HcalGenericDetId::HcalGenOuter) useOld = useOldHO;
    
    if(useOld)
    {
      const HcalCalibrationWidths & calibWidths =
        theDbService->getHcalCalibrationWidths(hcalGenDetId);
      const HcalCalibrations& calibs = theDbService->getHcalCalibrations(hcalGenDetId);
    
      double noise [32] = {0.}; //big enough
      if(addNoise_)
      {
        double gauss [32]; //big enough
        for (int i = 0; i < frame.size(); i++) gauss[i] = CLHEP::RandGaussQ::shoot(engine, 0., 1.);
        makeNoiseOld(hcalSubDet, calibWidths, frame.size(), gauss, noise);
      }
    
      if(!preMixDigi_){  // if we are doing initial premix, no pedestals
        for (int tbin = 0; tbin < frame.size(); ++tbin) {
      int capId = (theStartingCapId + tbin)%4;
      double pedestal = calibs.pedestal(capId) + noise[tbin];
 
      frame[tbin] += pedestal;
        }
      }
      return;
    }
 
 
   double fudgefactor = 1;
   if(hcalSubDet==HcalGenericDetId::HcalGenBarrel) fudgefactor = HB_ff;
   if(hcalSubDet==HcalGenericDetId::HcalGenEndcap) fudgefactor = HE_ff;
   if(hcalSubDet==HcalGenericDetId::HcalGenForward) fudgefactor = HF_ff;
   if(hcalSubDet==HcalGenericDetId::HcalGenOuter) fudgefactor = HO_ff;
 
   if ( !( (frame.id().subdetId()==HcalGenericDetId::HcalGenBarrel) ||
       (frame.id().subdetId()==HcalGenericDetId::HcalGenEndcap) ||
       (frame.id().subdetId()==HcalGenericDetId::HcalGenForward) ||
       (frame.id().subdetId()==HcalGenericDetId::HcalGenOuter) ) ) return;
 
   if(hcalGenDetId.isHcalCastorDetId()) return;
   if(hcalGenDetId.isHcalZDCDetId()) return;
 
   int theStartingCapId_2 = (int)floor(CLHEP::RandFlat::shoot(engine, 0., 4.));
   double noise [32] = {0.}; //big enough
 
   if( myCholeskys ) {
     const HcalCholeskyMatrix * thisChanCholesky = myCholeskys->getValues(hcalGenDetId,false);
     if ( !thisChanCholesky ) {
       edm::LogWarning("HcalAmplifier") << "no Cholesky " << hcalSubDet << " "
                        << hcalGenDetId.rawId() << " " 
                        << frame.id().subdetId();
       return;
     }
 
     if(addNoise_)
     {
       double gauss [32]; //big enough
       for (int i = 0; i < frame.size(); i++) gauss[i] = CLHEP::RandGaussQ::shoot(engine, 0., 1.);
       makeNoise(*thisChanCholesky, frame.size(), gauss, noise, (int)theStartingCapId_2);
     }
   } else if(addNoise_) {
     /* TODO: Re-add the Cholesky matrix when computing the noise.
      * The payloads currently stored in Condition DB suffer a bug in ROOT5 streamer.
      * The workaround here is to fall back to the old noise computation when the matrix is not provided.
      * When a permanent fix is found, this condition should be removed:
      * when Cholesky matrix is not set from the digitizer, issue a warning.
      * -Salvatore Di Guida
      */
     const HcalCalibrationWidths & calibWidths = theDbService->getHcalCalibrationWidths(hcalGenDetId);
     double gauss [32]; //big enough
     for (int i = 0; i < frame.size(); i++) gauss[i] = CLHEP::RandGaussQ::shoot(engine, 0., 1.);
     makeNoiseOld(hcalSubDet, calibWidths, frame.size(), gauss, noise);
   } else {
     edm::LogWarning("HcalAmplifier") << "No Cholesky Matrices provided for new HCAL noise simulation.";
   }
   
   if( myADCPeds ) {
     const HcalPedestal* thisChanADCPeds = myADCPeds->getValues(hcalGenDetId);
     const HcalQIECoder* coder = theDbService->getHcalCoder(hcalGenDetId);
     const HcalQIEShape* shape = theDbService->getHcalShape(coder);
 
     for (int tbin = 0; tbin < frame.size(); ++tbin) {
       int capId = (theStartingCapId_2 + tbin)%4;
       double x = noise[tbin] * fudgefactor + thisChanADCPeds->getValue(capId);//*(values+capId); //*.70 goes here!
       int x1=(int)std::floor(x);
       int x2=(int)std::floor(x+1);
       float y2=coder->charge(*shape,x2,capId);
       float y1=coder->charge(*shape,x1,capId);
       frame[tbin] = (y2-y1)*(x-x1)+y1;
     }
   } else {
     edm::LogWarning("HcalAmplifier") << "No ADC pedestals provided for new HCAL simulation.";
   }
 }

void HcalAmplifier::amplify	(	CaloSamples &	linearFrame,
		CLHEP::HepRandomEngine *	engine
	)		const

virtual

Definition at line 49 of file HcalAmplifier.cc.

References addPedestals(), HPDIonFeedbackSim::addThermalNoise(), CaloVNoiseSignalGenerator::contains(), HcalTimeSlewSim::delay(), alignCSCRings::e, CaloSamples::id(), LogDebug, pe2fC(), preMixAdd_, theIonFeedbackSim, theNoiseSignalGenerator, and theTimeSlewSim.

Referenced by HcalElectronicsSim::convert().

                                                                                    {
   if(theIonFeedbackSim)
   {
     theIonFeedbackSim->addThermalNoise(frame, engine);
   }
   pe2fC(frame);
   // don't bother for blank signals
   if(theTimeSlewSim && frame[4] > 1.e-6)
   {
     theTimeSlewSim->delay(frame, engine);
   }
 
   // if we are combining pre-mixed digis, we need noise and peds
   if(theNoiseSignalGenerator==0 || preMixAdd_ || !theNoiseSignalGenerator->contains(frame.id()) )
   {
     addPedestals(frame, engine);
   }
   LogDebug("HcalAmplifier") << frame;
 }

void HcalAmplifier::makeNoise	(	const HcalCholeskyMatrix &	thisChanCholesky,
		int	fFrames,
		double *	fGauss,
		double *	fNoise,
		int	m
	)		const

private

Definition at line 190 of file HcalAmplifier.cc.

References HcalCholeskyMatrix::getValue(), i, and j.

Referenced by addPedestals().

                                                                                                                                     {
    if(fFrames > 10) return;
 
    for(int i = 0; i != 10; i++){
       for(int j = 0; j != 10; j++){ //fNoise is initialized to zero in function above! Must be zero before this step
          fNoise[i] += thisChanCholesky.getValue(m,i,j) * fGauss[j];
       }
    }
 }

void HcalAmplifier::makeNoiseOld	(	HcalGenericDetId::HcalGenericSubdetector	hcalSubDet,
		const HcalCalibrationWidths &	width,
		int	fFrames,
		double *	fGauss,
		double *	fNoise
	)		const

private

Definition at line 200 of file HcalAmplifier.cc.

References corr, HcalGenericDetId::HcalGenForward, i, HcalCalibrationWidths::pedestal(), and mathSSE::sqrt().

Referenced by addPedestals().

 {
   // This is a simplified noise generation scheme using only the diagonal elements
   // (proposed by Salavat Abduline).
   // This is direct adaptation of the code in HcalPedestalWidth.cc
   
   // average over capId's
   double s_xx_mean =  0.25 * (width.pedestal(0)*width.pedestal(0) + 
                   width.pedestal(1)*width.pedestal(1) + 
                   width.pedestal(2)*width.pedestal(2) + 
                   width.pedestal(3)*width.pedestal(3));
 
 
   // Off-diagonal element approximation
   // In principle should come from averaging the values of elements (0.1), (1,2), (2,3), (3,0)
   // For now use the definition below (but keep structure of the code structure for development) 
   double s_xy_mean = -0.5 * s_xx_mean;
   // Use different parameter for HF to reproduce the noise rate after zero suppression.
   // Steven Won/Jim Hirschauer/Radek Ofierzynski 18.03.2010
   if (hcalSubDet == HcalGenericDetId::HcalGenForward) s_xy_mean = 0.08 * s_xx_mean;
 
   double term  = s_xx_mean*s_xx_mean - 2.*s_xy_mean*s_xy_mean;
 
   if (term < 0.) term = 1.e-50 ;
   double sigma = sqrt (0.5 * (s_xx_mean + sqrt(term)));
   double corr = sigma == 0. ? 0. : 0.5*s_xy_mean / sigma;
 
   for (int i = 0; i < fFrames; i++) {
     fNoise [i] = fGauss[i]*sigma;
     if (i > 0) fNoise [i] += fGauss[i-1]*corr;
     if (i < fFrames-1) fNoise [i] += fGauss[i+1]*corr;
   }
 }

void HcalAmplifier::pe2fC ( CaloSamples & frame ) const

private

Definition at line 70 of file HcalAmplifier.cc.

References CaloSamples::id(), HLT_FULL_cff::parameters, CaloSimParameters::photoelectronsToAnalog(), CaloVSimParameterMap::simParameters(), and theParameterMap.

Referenced by amplify().

 {
   const CaloSimParameters & parameters = theParameterMap->simParameters(frame.id());
   frame *= parameters.photoelectronsToAnalog(frame.id());
 }

void HcalAmplifier::setADCPeds ( const HcalPedestals * ADCPeds )

inline

Definition at line 54 of file HcalAmplifier.h.

References myADCPeds.

Referenced by HcalDigitizer::initializeEvent().

54 { myADCPeds = ADCPeds; }

HcalAmplifier::myADCPeds

const HcalPedestals * myADCPeds

Definition: HcalAmplifier.h:67

void HcalAmplifier::setCholesky ( const HcalCholeskyMatrices * Cholesky )

inline

Definition at line 53 of file HcalAmplifier.h.

References myCholeskys.

Referenced by HcalDigitizer::initializeEvent().

53 { myCholeskys = Cholesky; }

HcalAmplifier::myCholeskys

const HcalCholeskyMatrices * myCholeskys

Definition: HcalAmplifier.h:66

void HcalAmplifier::setDbService ( const HcalDbService * service )

the Producer will probably update this every event

Definition at line 43 of file HcalAmplifier.cc.

References HPDIonFeedbackSim::setDbService(), theDbService, and theIonFeedbackSim.

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

                                                               {
   theDbService = service;
   if(theIonFeedbackSim) theIonFeedbackSim->setDbService(service);
 }

void HcalAmplifier::setHBtuningParameter ( double tp )

Definition at line 76 of file HcalAmplifier.cc.

References HB_ff.

Referenced by HcalDigitizer::HcalDigitizer().

76 { HB_ff = tp; }

HcalAmplifier::HB_ff

double HB_ff

Definition: HcalAmplifier.h:79

void HcalAmplifier::setHEtuningParameter ( double tp )

Definition at line 77 of file HcalAmplifier.cc.

References HE_ff.

Referenced by HcalDigitizer::HcalDigitizer().

77 { HE_ff = tp; }

HcalAmplifier::HE_ff

double HE_ff

Definition: HcalAmplifier.h:80

void HcalAmplifier::setHFtuningParameter ( double tp )

Definition at line 78 of file HcalAmplifier.cc.

References HF_ff.

Referenced by HcalDigitizer::HcalDigitizer().

78 { HF_ff = tp; }

HcalAmplifier::HF_ff

double HF_ff

Definition: HcalAmplifier.h:81

void HcalAmplifier::setHOtuningParameter ( double tp )

Definition at line 79 of file HcalAmplifier.cc.

References HO_ff.

Referenced by HcalDigitizer::HcalDigitizer().

79 { HO_ff = tp; }

HcalAmplifier::HO_ff

double HO_ff

Definition: HcalAmplifier.h:82

void HcalAmplifier::setIonFeedbackSim ( HPDIonFeedbackSim * feedbackSim )

inline

Definition at line 31 of file HcalAmplifier.h.

References theIonFeedbackSim.

Referenced by HcalDigitizer::HcalDigitizer().

31 {theIonFeedbackSim = feedbackSim;}

HcalAmplifier::theIonFeedbackSim

HPDIonFeedbackSim * theIonFeedbackSim

Definition: HcalAmplifier.h:68

void HcalAmplifier::setNoiseSignalGenerator ( const CaloVNoiseSignalGenerator * noiseSignalGenerator )

inline

if it's set, the amplifier will only use it to check if it has already added noise

Definition at line 35 of file HcalAmplifier.h.

References theNoiseSignalGenerator.

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

                                                                                        {
     theNoiseSignalGenerator = noiseSignalGenerator;
   }

void HcalAmplifier::setStartingCapId ( int capId )

inline

Definition at line 44 of file HcalAmplifier.h.

References theStartingCapId.

Referenced by HcalElectronicsSim::newEvent(), and HcalElectronicsSim::setStartingCapId().

44 {theStartingCapId = capId;}

HcalAmplifier::theStartingCapId

unsigned theStartingCapId

Definition: HcalAmplifier.h:70

void HcalAmplifier::setTimeSlewSim ( HcalTimeSlewSim * timeSlewSim )

inline

Definition at line 38 of file HcalAmplifier.h.

References theTimeSlewSim.

Referenced by HcalDigitizer::HcalDigitizer().

                                                      {
     theTimeSlewSim = timeSlewSim;
   }

void HcalAmplifier::setUseOldHB ( bool useOld )

Definition at line 80 of file HcalAmplifier.cc.

References useOldHB.

Referenced by HcalDigitizer::HcalDigitizer().

80 { useOldHB = useOld; }

HcalAmplifier::useOldHB

bool useOldHB

Definition: HcalAmplifier.h:74

void HcalAmplifier::setUseOldHE ( bool useOld )

Definition at line 81 of file HcalAmplifier.cc.

References useOldHE.

Referenced by HcalDigitizer::HcalDigitizer().

81 { useOldHE = useOld; }

HcalAmplifier::useOldHE

bool useOldHE

Definition: HcalAmplifier.h:75

void HcalAmplifier::setUseOldHF ( bool useOld )

Definition at line 82 of file HcalAmplifier.cc.

References useOldHF.

Referenced by HcalDigitizer::HcalDigitizer().

82 { useOldHF = useOld; }

HcalAmplifier::useOldHF

bool useOldHF

Definition: HcalAmplifier.h:76

void HcalAmplifier::setUseOldHO ( bool useOld )

Definition at line 83 of file HcalAmplifier.cc.

References useOldHO.

Referenced by HcalDigitizer::HcalDigitizer().

83 { useOldHO = useOld; }

HcalAmplifier::useOldHO

bool useOldHO

Definition: HcalAmplifier.h:77

Member Data Documentation

bool HcalAmplifier::addNoise_

private

Definition at line 71 of file HcalAmplifier.h.

Referenced by addPedestals().

double HcalAmplifier::HB_ff

private

Definition at line 79 of file HcalAmplifier.h.

Referenced by addPedestals(), and setHBtuningParameter().

double HcalAmplifier::HE_ff

private

Definition at line 80 of file HcalAmplifier.h.

Referenced by addPedestals(), and setHEtuningParameter().

double HcalAmplifier::HF_ff

private

Definition at line 81 of file HcalAmplifier.h.

Referenced by addPedestals(), and setHFtuningParameter().

double HcalAmplifier::HO_ff

private

Definition at line 82 of file HcalAmplifier.h.

Referenced by addPedestals(), and setHOtuningParameter().

const HcalPedestals* HcalAmplifier::myADCPeds

private

Definition at line 67 of file HcalAmplifier.h.

Referenced by addPedestals(), and setADCPeds().

const HcalCholeskyMatrices* HcalAmplifier::myCholeskys

private

Definition at line 66 of file HcalAmplifier.h.

Referenced by addPedestals(), and setCholesky().

bool HcalAmplifier::preMixAdd_

private

Definition at line 73 of file HcalAmplifier.h.

Referenced by amplify().

bool HcalAmplifier::preMixDigi_

private

Definition at line 72 of file HcalAmplifier.h.

Referenced by addPedestals().

const HcalDbService* HcalAmplifier::theDbService

private

Definition at line 63 of file HcalAmplifier.h.

Referenced by addPedestals(), and setDbService().

HPDIonFeedbackSim* HcalAmplifier::theIonFeedbackSim

private

Definition at line 68 of file HcalAmplifier.h.

Referenced by amplify(), setDbService(), and setIonFeedbackSim().

const CaloVNoiseSignalGenerator* HcalAmplifier::theNoiseSignalGenerator

private

Definition at line 65 of file HcalAmplifier.h.

Referenced by amplify(), and setNoiseSignalGenerator().

const CaloVSimParameterMap* HcalAmplifier::theParameterMap

private

Definition at line 64 of file HcalAmplifier.h.

Referenced by pe2fC().

unsigned HcalAmplifier::theStartingCapId

private

Definition at line 70 of file HcalAmplifier.h.

Referenced by addPedestals(), and setStartingCapId().

HcalTimeSlewSim* HcalAmplifier::theTimeSlewSim

private

Definition at line 69 of file HcalAmplifier.h.

Referenced by amplify(), and setTimeSlewSim().

bool HcalAmplifier::useOldHB

private

Definition at line 74 of file HcalAmplifier.h.

Referenced by addPedestals(), and setUseOldHB().

bool HcalAmplifier::useOldHE

private

Definition at line 75 of file HcalAmplifier.h.

Referenced by addPedestals(), and setUseOldHE().

bool HcalAmplifier::useOldHF

private

Definition at line 76 of file HcalAmplifier.h.

Referenced by addPedestals(), and setUseOldHF().

bool HcalAmplifier::useOldHO

private

Definition at line 77 of file HcalAmplifier.h.

Referenced by addPedestals(), and setUseOldHO().

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation