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	applyQIEdelay (CaloSamples &frame, int delayQIE) 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::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) {}

~HcalAmplifier()

virtual HcalAmplifier::~HcalAmplifier ( )

inlinevirtual

Definition at line 24 of file HcalAmplifier.h.

{}

Member Function Documentation

addPedestals()

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

private

Definition at line 92 of file HcalAmplifier.cc.

                                                                                       {
  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;
    }
  }
}

References addNoise_, cms::cuda::assert(), amptDefault_cfi::frame, HcalGenericDetId::genericSubdet(), HcalDbService::getHcalCalibrations(), HcalDbService::getHcalCalibrationWidths(), HcalGenericDetId::HcalGenBarrel, HcalGenericDetId::HcalGenEndcap, HcalGenericDetId::HcalGenForward, HcalGenericDetId::HcalGenOuter, mps_fire::i, makeNoise(), hgcalDigitizer_cfi::noise, HcalCalibrations::pedestal(), EcalCondDBWriter_cfi::pedestal, preMixDigi_, theDbService, and theStartingCapId.

Referenced by amplify().

amplify()

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

virtual

Definition at line 41 of file HcalAmplifier.cc.

                                                                                  {
  if (theIonFeedbackSim) {
    theIonFeedbackSim->addThermalNoise(frame, engine);
  }
  pe2fC(frame);
 
  if (frame.id().det() == DetId::Hcal && ((frame.id().subdetId() == HcalGenericDetId::HcalGenBarrel) ||
                                          (frame.id().subdetId() == HcalGenericDetId::HcalGenEndcap))) {
    const HcalSimParameters& params = static_cast<const HcalSimParameters&>(theParameterMap->simParameters(frame.id()));
    if (params.delayQIE() > 0)
      applyQIEdelay(frame, params.delayQIE());
  }
 
  // 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;
}

References addPedestals(), HPDIonFeedbackSim::addThermalNoise(), applyQIEdelay(), CaloVNoiseSignalGenerator::contains(), HcalTimeSlewSim::delay(), amptDefault_cfi::frame, DetId::Hcal, HcalGenericDetId::HcalGenBarrel, HcalGenericDetId::HcalGenEndcap, LogDebug, CalibrationSummaryClient_cfi::params, pe2fC(), preMixAdd_, CaloVSimParameterMap::simParameters(), theIonFeedbackSim, theNoiseSignalGenerator, theParameterMap, theTimeSlew, and theTimeSlewSim.

Referenced by HcalElectronicsSim::convert().

applyQIEdelay()

void HcalAmplifier::applyQIEdelay ( CaloSamples &  frame, int  delayQIE  ) const

private

Definition at line 71 of file HcalAmplifier.cc.

                                                                     {
  DetId detId(cs.id());
  int maxbin = cs.size();
  int precisebin = cs.preciseSize();
  CaloSamples data(detId, maxbin, precisebin);  // make a temporary copy
  data = cs;
  data.setBlank();
  data.resetPrecise();
 
  for (int i = 0; i < precisebin; i++) {
    if (i < 2 * delayQIE)
      data.preciseAtMod(i) += 0.;
    else
      data.preciseAtMod(i) += cs.preciseAt(i - 2 * delayQIE);
    int samplebin = (int)i * maxbin / precisebin;
    data[samplebin] += data.preciseAt(i);
  }
 
  cs = data;  // update the sample
}

References fwrapper::cs, data, hcalSimParameters_cfi::delayQIE, mps_fire::i, and createfilelist::int.

Referenced by amplify().

makeNoise()

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

private

Definition at line 128 of file HcalAmplifier.cc.

                                                    {
  // 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;
  }
}

References alignCSCRings::corr, HcalGenericDetId::HcalGenForward, mps_fire::i, mathSSE::sqrt(), and ApeEstimator_cff::width.

Referenced by addPedestals().

pe2fC()

void HcalAmplifier::pe2fC ( CaloSamples &  frame ) const

private

Definition at line 66 of file HcalAmplifier.cc.

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

References amptDefault_cfi::frame, CaloVSimParameterMap::simParameters(), and theParameterMap.

Referenced by amplify().

setDbService()

void HcalAmplifier::setDbService

(

const HcalDbService *

service

)

the Producer will probably update this every event

Definition at line 35 of file HcalAmplifier.cc.

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

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

Referenced by HcalTBDigiProducer::initializeEvent().

setIonFeedbackSim()

void HcalAmplifier::setIonFeedbackSim ( HPDIonFeedbackSim *  feedbackSim )

inline

Definition at line 28 of file HcalAmplifier.h.

{ theIonFeedbackSim = feedbackSim; }

References theIonFeedbackSim.

setNoiseSignalGenerator()

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.

                                                                                      {
    theNoiseSignalGenerator = noiseSignalGenerator;
  }

References theNoiseSignalGenerator.

setStartingCapId()

void HcalAmplifier::setStartingCapId ( int  capId )

inline

Definition at line 42 of file HcalAmplifier.h.

{ theStartingCapId = capId; }

References theStartingCapId.

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

setTimeSlew()

void HcalAmplifier::setTimeSlew ( const HcalTimeSlew *  timeSlew )

inline

Definition at line 38 of file HcalAmplifier.h.

{ theTimeSlew = timeSlew; }

References theTimeSlew.

Referenced by HcalTBDigiProducer::initializeEvent().

setTimeSlewSim()

void HcalAmplifier::setTimeSlewSim ( HcalTimeSlewSim *  timeSlewSim )

inline

Definition at line 35 of file HcalAmplifier.h.

{ theTimeSlewSim = timeSlewSim; }

References theTimeSlewSim.

Referenced by HcalTBDigiProducer::HcalTBDigiProducer().

Member Data Documentation

addNoise_

bool HcalAmplifier::addNoise_

private

Definition at line 60 of file HcalAmplifier.h.

Referenced by addPedestals().

preMixAdd_

bool HcalAmplifier::preMixAdd_

private

Definition at line 62 of file HcalAmplifier.h.

Referenced by amplify().

preMixDigi_

bool HcalAmplifier::preMixDigi_

private

Definition at line 61 of file HcalAmplifier.h.

Referenced by addPedestals().

theDbService

const HcalDbService* HcalAmplifier::theDbService

private

Definition at line 54 of file HcalAmplifier.h.

Referenced by addPedestals(), and setDbService().

theIonFeedbackSim

HPDIonFeedbackSim* HcalAmplifier::theIonFeedbackSim

private

Definition at line 57 of file HcalAmplifier.h.

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

theNoiseSignalGenerator

const CaloVNoiseSignalGenerator* HcalAmplifier::theNoiseSignalGenerator

private

Definition at line 56 of file HcalAmplifier.h.

Referenced by amplify(), and setNoiseSignalGenerator().

theParameterMap

const CaloVSimParameterMap* HcalAmplifier::theParameterMap

private

Definition at line 55 of file HcalAmplifier.h.

Referenced by amplify(), and pe2fC().

theStartingCapId

unsigned HcalAmplifier::theStartingCapId

private

Definition at line 59 of file HcalAmplifier.h.

Referenced by addPedestals(), and setStartingCapId().

theTimeSlew

const HcalTimeSlew* HcalAmplifier::theTimeSlew = nullptr

Definition at line 37 of file HcalAmplifier.h.

Referenced by amplify(), and setTimeSlew().

theTimeSlewSim

HcalTimeSlewSim* HcalAmplifier::theTimeSlewSim

private

Definition at line 58 of file HcalAmplifier.h.

Referenced by amplify(), and setTimeSlewSim().