HcalAmplifier Class Reference

#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	setDbService (const HcalDbService *service)
	the Producer will probably update this every event More...
void	setIonFeedbackSim (HPDIonFeedbackSim *feedbackSim)
void	setNoiseSignalGenerator (const CaloVNoiseSignalGenerator *noiseSignalGenerator)
void	setStartingCapId (int capId)
void	setTimeSlew (const HcalTimeSlew *timeSlew)
void	setTimeSlewSim (HcalTimeSlewSim *timeSlewSim)
virtual	~HcalAmplifier ()

Public Attributes
const HcalTimeSlew *	theTimeSlew = nullptr

Private Member Functions
void	addPedestals (CaloSamples &frame, CLHEP::HepRandomEngine *) const
void	makeNoise (HcalGenericDetId::HcalGenericSubdetector hcalSubDet, const HcalCalibrationWidths &width, int fFrames, double *fGauss, double *fNoise) const
void	pe2fC (CaloSamples &frame) const

Private Attributes
bool	addNoise_
bool	preMixAdd_
bool	preMixDigi_
const HcalDbService *	theDbService
HPDIonFeedbackSim *	theIonFeedbackSim
const CaloVNoiseSignalGenerator *	theNoiseSignalGenerator
const CaloVSimParameterMap *	theParameterMap
unsigned	theStartingCapId
HcalTimeSlewSim *	theTimeSlewSim

Detailed Description

Definition at line 20 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),
  theIonFeedbackSim(nullptr),
  theTimeSlewSim(nullptr),
  theStartingCapId(0),
  addNoise_(addNoise),
  preMixDigi_(PreMix1),
  preMixAdd_(PreMix2)
{ }

virtual HcalAmplifier::~HcalAmplifier ( )

inlinevirtual

Definition at line 24 of file HcalAmplifier.h.

{}

Member Function Documentation

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

private

Definition at line 70 of file HcalAmplifier.cc.

References addNoise_, HcalGenericDetId::genericSubdet(), HcalDbService::getHcalCalibrations(), HcalDbService::getHcalCalibrationWidths(), HcalGenericDetId::HcalGenBarrel, HcalGenericDetId::HcalGenEndcap, HcalGenericDetId::HcalGenForward, HcalGenericDetId::HcalGenOuter, mps_fire::i, CaloSamples::id(), makeNoise(), muonCSCDigis_cfi::pedestal, HcalCalibrations::pedestal(), preMixDigi_, CaloSamples::size(), DetId::subdetId(), theDbService, and theStartingCapId.

Referenced by amplify().

{
  assert(theDbService != nullptr);
  HcalGenericDetId hcalGenDetId(frame.id());
  HcalGenericDetId::HcalGenericSubdetector hcalSubDet = hcalGenDetId.genericSubdet();

  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;

  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.);
    makeNoise(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;
    }
  }
}

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

virtual

Definition at line 43 of file HcalAmplifier.cc.

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

Referenced by HcalElectronicsSim::convert().

                                                                                   {
  if(theIonFeedbackSim)
  {
    theIonFeedbackSim->addThermalNoise(frame, engine);
  }
  pe2fC(frame);
  // don't bother for blank signals
  if(theTimeSlewSim && frame.size()>4 && frame[4] > 1.e-6)
  {
    theTimeSlewSim->delay(frame, engine, theTimeSlew);
  }

  // if we are combining pre-mixed digis, we need noise and peds
  if(theNoiseSignalGenerator==nullptr || preMixAdd_ || !theNoiseSignalGenerator->contains(frame.id()) )
  {
    addPedestals(frame, engine);
  }
  LogDebug("HcalAmplifier") << frame;
}

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

private

Definition at line 104 of file HcalAmplifier.cc.

References corr, HcalGenericDetId::HcalGenForward, mps_fire::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 64 of file HcalAmplifier.cc.

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

Referenced by amplify().

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

void HcalAmplifier::setDbService

(

const HcalDbService *

service

)

the Producer will probably update this every event

Definition at line 37 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::setIonFeedbackSim ( HPDIonFeedbackSim *  feedbackSim )

inline

Definition at line 28 of file HcalAmplifier.h.

Referenced by HcalDigitizer::HcalDigitizer().

{theIonFeedbackSim = feedbackSim;}

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.

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

                                                                                       {
    theNoiseSignalGenerator = noiseSignalGenerator;
  }

void HcalAmplifier::setStartingCapId ( int  capId )

inline

Definition at line 46 of file HcalAmplifier.h.

References ApeEstimator_cff::width.

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

{theStartingCapId = capId;}

void HcalAmplifier::setTimeSlew ( const HcalTimeSlew *  timeSlew )

inline

Definition at line 40 of file HcalAmplifier.h.

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

                                                 {
    theTimeSlew = timeSlew;
  }

void HcalAmplifier::setTimeSlewSim ( HcalTimeSlewSim *  timeSlewSim )

inline

Definition at line 35 of file HcalAmplifier.h.

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

                                                     {
    theTimeSlewSim = timeSlewSim;
  }

Member Data Documentation

bool HcalAmplifier::addNoise_

private

Definition at line 60 of file HcalAmplifier.h.

Referenced by addPedestals().

bool HcalAmplifier::preMixAdd_

private

Definition at line 62 of file HcalAmplifier.h.

Referenced by amplify().

bool HcalAmplifier::preMixDigi_

private

Definition at line 61 of file HcalAmplifier.h.

Referenced by addPedestals().

const HcalDbService* HcalAmplifier::theDbService

private

Definition at line 54 of file HcalAmplifier.h.

Referenced by addPedestals(), and setDbService().

HPDIonFeedbackSim* HcalAmplifier::theIonFeedbackSim

private

Definition at line 57 of file HcalAmplifier.h.

Referenced by amplify(), and setDbService().

const CaloVNoiseSignalGenerator* HcalAmplifier::theNoiseSignalGenerator

private

Definition at line 56 of file HcalAmplifier.h.

Referenced by amplify().

const CaloVSimParameterMap* HcalAmplifier::theParameterMap

private

Definition at line 55 of file HcalAmplifier.h.

Referenced by pe2fC().

unsigned HcalAmplifier::theStartingCapId

private

Definition at line 59 of file HcalAmplifier.h.

Referenced by addPedestals().

const HcalTimeSlew* HcalAmplifier::theTimeSlew = nullptr

Definition at line 39 of file HcalAmplifier.h.

Referenced by amplify().

HcalTimeSlewSim* HcalAmplifier::theTimeSlewSim

private

Definition at line 58 of file HcalAmplifier.h.

Referenced by amplify().