#include <HcalAmplifier.h>

Public Member Functions
virtual void	amplify (CaloSamples &linearFrame) const

	HcalAmplifier (const CaloVSimParameterMap *parameters, bool addNoise)

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	setRandomEngine (CLHEP::HepRandomEngine &engine)

void	setStartingCapId (int capId)

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) 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

const HcalDbService *	theDbService

HPDIonFeedbackSim *	theIonFeedbackSim

const CaloVNoiseSignalGenerator *	theNoiseSignalGenerator

const CaloVSimParameterMap *	theParameterMap

CLHEP::RandFlat *	theRandFlat

CLHEP::RandGaussQ *	theRandGaussQ

unsigned	theStartingCapId

bool	useOldHB

bool	useOldHE

bool	useOldHF

bool	useOldHO

Detailed Description

Definition at line 20 of file HcalAmplifier.h.

Constructor & Destructor Documentation

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

Definition at line 21 of file HcalAmplifier.cc.

                                                                                    :
   theDbService(0), 
   theRandGaussQ(0),
   theRandFlat(0),
   theParameterMap(parameters),
   theNoiseSignalGenerator(0),
   theIonFeedbackSim(0),
   theStartingCapId(0), 
   addNoise_(addNoise),
   useOldHB(false),
   useOldHE(false),
   useOldHF(false),
   useOldHO(false)
 {
 }

virtual HcalAmplifier::~HcalAmplifier ( )

inlinevirtual

Definition at line 23 of file HcalAmplifier.h.

References theRandGaussQ.

23 { delete theRandGaussQ; }

HcalAmplifier::theRandGaussQ

CLHEP::RandGaussQ * theRandGaussQ

Definition: HcalAmplifier.h:58

Member Function Documentation

void HcalAmplifier::addPedestals ( CaloSamples & frame ) const

private

Definition at line 81 of file HcalAmplifier.cc.

References addNoise_, 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, HcalCalibrations::pedestal(), CaloSamples::size(), theDbService, theRandFlat, theRandGaussQ, 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] = theRandGaussQ->fire(0., 1.);
        makeNoiseOld(hcalSubDet, calibWidths, frame.size(), gauss, noise);
      }
    
      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(hcalGenDetId.isHcalCastorDetId()) return;
   if(hcalGenDetId.isHcalZDCDetId()) return;
 
   const HcalCholeskyMatrix * thisChanCholesky = myCholeskys->getValues(hcalGenDetId);
   const HcalPedestal * thisChanADCPeds = myADCPeds->getValues(hcalGenDetId);
   int theStartingCapId_2 = (int)floor(theRandFlat->fire(0.,4.));
 
   double noise [32] = {0.}; //big enough
   if(addNoise_)
   {
     double gauss [32]; //big enough
     for (int i = 0; i < frame.size(); i++) gauss[i] = theRandGaussQ->fire(0., 1.);
     makeNoise(*thisChanCholesky, frame.size(), gauss, noise, (int)theStartingCapId_2);
   }
 
   const HcalQIECoder* coder = theDbService->getHcalCoder(hcalGenDetId);
   const HcalQIEShape* shape = theDbService->getHcalShape();
 
   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;
   }
 }

void HcalAmplifier::amplify ( CaloSamples & linearFrame ) const

virtual

Definition at line 52 of file HcalAmplifier.cc.

References addPedestals(), HPDIonFeedbackSim::addThermalNoise(), CaloVNoiseSignalGenerator::contains(), CaloSamples::id(), LogDebug, pe2fC(), theIonFeedbackSim, and theNoiseSignalGenerator.

Referenced by HcalElectronicsSim::convert().

                                                      {
   if(theIonFeedbackSim)
   {
     theIonFeedbackSim->addThermalNoise(frame);
   }
   pe2fC(frame);
   if(theNoiseSignalGenerator==0 || !theNoiseSignalGenerator->contains(frame.id()))
   {
     addPedestals(frame);
   }
   LogDebug("HcalAmplifier") << frame;
 }

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

private

Definition at line 150 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 160 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 66 of file HcalAmplifier.cc.

References CaloSamples::id(), Parameters::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 48 of file HcalAmplifier.h.

References myADCPeds.

Referenced by HcalDigitizer::produce().

48 { myADCPeds = ADCPeds; }

HcalAmplifier::myADCPeds

const HcalPedestals * myADCPeds

Definition: HcalAmplifier.h:75

void HcalAmplifier::setCholesky ( const HcalCholeskyMatrices * Cholesky )

inline

Definition at line 47 of file HcalAmplifier.h.

References myCholeskys.

Referenced by HcalDigitizer::produce().

47 { myCholeskys = Cholesky; }

HcalAmplifier::myCholeskys

const HcalCholeskyMatrices * myCholeskys

Definition: HcalAmplifier.h:74

void HcalAmplifier::setDbService ( const HcalDbService * service )

the Producer will probably update this every event

Definition at line 38 of file HcalAmplifier.cc.

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

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

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

void HcalAmplifier::setHBtuningParameter ( double tp )

Definition at line 72 of file HcalAmplifier.cc.

References HB_ff.

72 { HB_ff = tp; }

HcalAmplifier::HB_ff

double HB_ff

Definition: HcalAmplifier.h:70

void HcalAmplifier::setHEtuningParameter ( double tp )

Definition at line 73 of file HcalAmplifier.cc.

References HE_ff.

73 { HE_ff = tp; }

HcalAmplifier::HE_ff

double HE_ff

Definition: HcalAmplifier.h:71

void HcalAmplifier::setHFtuningParameter ( double tp )

Definition at line 74 of file HcalAmplifier.cc.

References HF_ff.

Referenced by HcalDigitizer::HcalDigitizer().

74 { HF_ff = tp; }

HcalAmplifier::HF_ff

double HF_ff

Definition: HcalAmplifier.h:72

void HcalAmplifier::setHOtuningParameter ( double tp )

Definition at line 75 of file HcalAmplifier.cc.

References HO_ff.

Referenced by HcalDigitizer::HcalDigitizer().

75 { HO_ff = tp; }

HcalAmplifier::HO_ff

double HO_ff

Definition: HcalAmplifier.h:73

void HcalAmplifier::setIonFeedbackSim ( HPDIonFeedbackSim * feedbackSim )

inline

Definition at line 28 of file HcalAmplifier.h.

References theIonFeedbackSim.

28 {theIonFeedbackSim = feedbackSim;}

HcalAmplifier::theIonFeedbackSim

HPDIonFeedbackSim * theIonFeedbackSim

Definition: HcalAmplifier.h:62

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 32 of file HcalAmplifier.h.

References theNoiseSignalGenerator.

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

                                                                                        {
     theNoiseSignalGenerator = noiseSignalGenerator;
   }

void HcalAmplifier::setRandomEngine ( CLHEP::HepRandomEngine & engine )

Definition at line 44 of file HcalAmplifier.cc.

References HPDIonFeedbackSim::setRandomEngine(), theIonFeedbackSim, theRandFlat, and theRandGaussQ.

Referenced by HcalElectronicsSim::setRandomEngine().

 {
   theRandGaussQ = new CLHEP::RandGaussQ(engine);
   theRandFlat = new CLHEP::RandFlat(engine);
   if(theIonFeedbackSim) theIonFeedbackSim->setRandomEngine(engine);
 }