CMS 3D CMS Logo

List of all members | Public Member Functions | Public Attributes | Private Member Functions | Private Attributes
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 HcalTimeSlewtheTimeSlew = 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 HcalDbServicetheDbService
 
HPDIonFeedbackSimtheIonFeedbackSim
 
const CaloVNoiseSignalGeneratortheNoiseSignalGenerator
 
const CaloVSimParameterMaptheParameterMap
 
unsigned theStartingCapId
 
HcalTimeSlewSimtheTimeSlewSim
 

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.

25  : theDbService(nullptr),
26  theParameterMap(parameters),
27  theNoiseSignalGenerator(nullptr),
28  theIonFeedbackSim(nullptr),
29  theTimeSlewSim(nullptr),
31  addNoise_(addNoise),
32  preMixDigi_(PreMix1),
33  preMixAdd_(PreMix2) {}
const CaloVNoiseSignalGenerator * theNoiseSignalGenerator
Definition: HcalAmplifier.h:55
const CaloVSimParameterMap * theParameterMap
Definition: HcalAmplifier.h:54
const HcalDbService * theDbService
Definition: HcalAmplifier.h:53
HcalTimeSlewSim * theTimeSlewSim
Definition: HcalAmplifier.h:57
unsigned theStartingCapId
Definition: HcalAmplifier.h:58
HPDIonFeedbackSim * theIonFeedbackSim
Definition: HcalAmplifier.h:56
virtual HcalAmplifier::~HcalAmplifier ( )
inlinevirtual

Definition at line 24 of file HcalAmplifier.h.

24 {}

Member Function Documentation

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

Definition at line 63 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(), hgcalDigitizer_cfi::noise, HcalCalibrations::pedestal(), EcalCondDBWriter_cfi::pedestal, preMixDigi_, CaloSamples::size(), DetId::subdetId(), theDbService, and theStartingCapId.

Referenced by amplify().

63  {
64  assert(theDbService != nullptr);
65  HcalGenericDetId hcalGenDetId(frame.id());
66  HcalGenericDetId::HcalGenericSubdetector hcalSubDet = hcalGenDetId.genericSubdet();
67 
68  if (!((frame.id().subdetId() == HcalGenericDetId::HcalGenBarrel) ||
72  return;
73 
74  if (hcalGenDetId.isHcalCastorDetId())
75  return;
76  if (hcalGenDetId.isHcalZDCDetId())
77  return;
78 
79  const HcalCalibrationWidths& calibWidths = theDbService->getHcalCalibrationWidths(hcalGenDetId);
80  const HcalCalibrations& calibs = theDbService->getHcalCalibrations(hcalGenDetId);
81 
82  double noise[32] = {0.}; //big enough
83  if (addNoise_) {
84  double gauss[32]; //big enough
85  for (int i = 0; i < frame.size(); i++)
86  gauss[i] = CLHEP::RandGaussQ::shoot(engine, 0., 1.);
87  makeNoise(hcalSubDet, calibWidths, frame.size(), gauss, noise);
88  }
89 
90  if (!preMixDigi_) { // if we are doing initial premix, no pedestals
91  for (int tbin = 0; tbin < frame.size(); ++tbin) {
92  int capId = (theStartingCapId + tbin) % 4;
93  double pedestal = calibs.pedestal(capId) + noise[tbin];
94  frame[tbin] += pedestal;
95  }
96  }
97 }
const HcalDbService * theDbService
Definition: HcalAmplifier.h:53
constexpr int subdetId() const
get the contents of the subdetector field (not cast into any detector&#39;s numbering enum) ...
Definition: DetId.h:48
const HcalCalibrationWidths & getHcalCalibrationWidths(const HcalGenericDetId &fId) const
constexpr double pedestal(int fCapId) const
get pedestal for capid=0..3
int size() const
get the size
Definition: CaloSamples.h:24
unsigned theStartingCapId
Definition: HcalAmplifier.h:58
void makeNoise(HcalGenericDetId::HcalGenericSubdetector hcalSubDet, const HcalCalibrationWidths &width, int fFrames, double *fGauss, double *fNoise) const
DetId id() const
get the (generic) id
Definition: CaloSamples.h:21
HcalGenericSubdetector genericSubdet() const
const HcalCalibrations & getHcalCalibrations(const HcalGenericDetId &fId) const
void HcalAmplifier::amplify ( CaloSamples linearFrame,
CLHEP::HepRandomEngine *  engine 
) const
virtual

Definition at line 41 of file HcalAmplifier.cc.

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

Referenced by HcalElectronicsSim::convert().

41  {
42  if (theIonFeedbackSim) {
44  }
45  pe2fC(frame);
46  // don't bother for blank signals
47  if (theTimeSlewSim && frame.size() > 4 && frame[4] > 1.e-6) {
49  }
50 
51  // if we are combining pre-mixed digis, we need noise and peds
53  addPedestals(frame, engine);
54  }
55  LogDebug("HcalAmplifier") << frame;
56 }
#define LogDebug(id)
const CaloVNoiseSignalGenerator * theNoiseSignalGenerator
Definition: HcalAmplifier.h:55
const HcalTimeSlew * theTimeSlew
Definition: HcalAmplifier.h:37
void addThermalNoise(CaloSamples &samples, CLHEP::HepRandomEngine *)
bool contains(const DetId &detId) const
void delay(CaloSamples &samples, CLHEP::HepRandomEngine *, const HcalTimeSlew *hcalTimeSlew_delay) const
HcalTimeSlewSim * theTimeSlewSim
Definition: HcalAmplifier.h:57
void addPedestals(CaloSamples &frame, CLHEP::HepRandomEngine *) const
void pe2fC(CaloSamples &frame) const
HPDIonFeedbackSim * theIonFeedbackSim
Definition: HcalAmplifier.h:56
void HcalAmplifier::makeNoise ( HcalGenericDetId::HcalGenericSubdetector  hcalSubDet,
const HcalCalibrationWidths width,
int  fFrames,
double *  fGauss,
double *  fNoise 
) const
private

Definition at line 99 of file HcalAmplifier.cc.

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

Referenced by addPedestals().

103  {
104  // This is a simplified noise generation scheme using only the diagonal elements
105  // (proposed by Salavat Abduline).
106  // This is direct adaptation of the code in HcalPedestalWidth.cc
107 
108  // average over capId's
109  double s_xx_mean = 0.25 * (width.pedestal(0) * width.pedestal(0) + width.pedestal(1) * width.pedestal(1) +
110  width.pedestal(2) * width.pedestal(2) + width.pedestal(3) * width.pedestal(3));
111 
112  // Off-diagonal element approximation
113  // In principle should come from averaging the values of elements (0.1), (1,2), (2,3), (3,0)
114  // For now use the definition below (but keep structure of the code structure for development)
115  double s_xy_mean = -0.5 * s_xx_mean;
116  // Use different parameter for HF to reproduce the noise rate after zero suppression.
117  // Steven Won/Jim Hirschauer/Radek Ofierzynski 18.03.2010
118  if (hcalSubDet == HcalGenericDetId::HcalGenForward)
119  s_xy_mean = 0.08 * s_xx_mean;
120 
121  double term = s_xx_mean * s_xx_mean - 2. * s_xy_mean * s_xy_mean;
122 
123  if (term < 0.)
124  term = 1.e-50;
125  double sigma = sqrt(0.5 * (s_xx_mean + sqrt(term)));
126  double corr = sigma == 0. ? 0. : 0.5 * s_xy_mean / sigma;
127 
128  for (int i = 0; i < fFrames; i++) {
129  fNoise[i] = fGauss[i] * sigma;
130  if (i > 0)
131  fNoise[i] += fGauss[i - 1] * corr;
132  if (i < fFrames - 1)
133  fNoise[i] += fGauss[i + 1] * corr;
134  }
135 }
double pedestal(int fCapId) const
get pedestal width for capid=0..3
T sqrt(T t)
Definition: SSEVec.h:19
JetCorrectorParameters corr
Definition: classes.h:5
void HcalAmplifier::pe2fC ( CaloSamples frame) const
private

Definition at line 58 of file HcalAmplifier.cc.

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

Referenced by amplify().

58  {
60  frame *= parameters.photoelectronsToAnalog(frame.id());
61 }
const CaloVSimParameterMap * theParameterMap
Definition: HcalAmplifier.h:54
Main class for Parameters in different subdetectors.
virtual const CaloSimParameters & simParameters(const DetId &id) const =0
DetId id() const
get the (generic) id
Definition: CaloSamples.h:21
double photoelectronsToAnalog() const
the factor which goes from photoelectrons to whatever gets read by ADCs
void HcalAmplifier::setDbService ( const HcalDbService service)

the Producer will probably update this every event

Definition at line 35 of file HcalAmplifier.cc.

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

Referenced by HcalTBDigiProducer::initializeEvent().

35  {
36  theDbService = service;
39 }
const HcalDbService * theDbService
Definition: HcalAmplifier.h:53
HPDIonFeedbackSim * theIonFeedbackSim
Definition: HcalAmplifier.h:56
void setDbService(const HcalDbService *service)
void HcalAmplifier::setIonFeedbackSim ( HPDIonFeedbackSim feedbackSim)
inline

Definition at line 28 of file HcalAmplifier.h.

28 { theIonFeedbackSim = feedbackSim; }
HPDIonFeedbackSim * theIonFeedbackSim
Definition: HcalAmplifier.h:56
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.

32  {
33  theNoiseSignalGenerator = noiseSignalGenerator;
34  }
const CaloVNoiseSignalGenerator * theNoiseSignalGenerator
Definition: HcalAmplifier.h:55
void HcalAmplifier::setStartingCapId ( int  capId)
inline
void HcalAmplifier::setTimeSlew ( const HcalTimeSlew timeSlew)
inline

Definition at line 38 of file HcalAmplifier.h.

Referenced by HcalTBDigiProducer::initializeEvent().

38 { theTimeSlew = timeSlew; }
const HcalTimeSlew * theTimeSlew
Definition: HcalAmplifier.h:37
void HcalAmplifier::setTimeSlewSim ( HcalTimeSlewSim timeSlewSim)
inline

Definition at line 35 of file HcalAmplifier.h.

Referenced by HcalTBDigiProducer::HcalTBDigiProducer().

35 { theTimeSlewSim = timeSlewSim; }
HcalTimeSlewSim * theTimeSlewSim
Definition: HcalAmplifier.h:57

Member Data Documentation

bool HcalAmplifier::addNoise_
private

Definition at line 59 of file HcalAmplifier.h.

Referenced by addPedestals().

bool HcalAmplifier::preMixAdd_
private

Definition at line 61 of file HcalAmplifier.h.

Referenced by amplify().

bool HcalAmplifier::preMixDigi_
private

Definition at line 60 of file HcalAmplifier.h.

Referenced by addPedestals().

const HcalDbService* HcalAmplifier::theDbService
private

Definition at line 53 of file HcalAmplifier.h.

Referenced by addPedestals(), and setDbService().

HPDIonFeedbackSim* HcalAmplifier::theIonFeedbackSim
private

Definition at line 56 of file HcalAmplifier.h.

Referenced by amplify(), and setDbService().

const CaloVNoiseSignalGenerator* HcalAmplifier::theNoiseSignalGenerator
private

Definition at line 55 of file HcalAmplifier.h.

Referenced by amplify().

const CaloVSimParameterMap* HcalAmplifier::theParameterMap
private

Definition at line 54 of file HcalAmplifier.h.

Referenced by pe2fC().

unsigned HcalAmplifier::theStartingCapId
private

Definition at line 58 of file HcalAmplifier.h.

Referenced by addPedestals().

const HcalTimeSlew* HcalAmplifier::theTimeSlew = nullptr

Definition at line 37 of file HcalAmplifier.h.

Referenced by amplify().

HcalTimeSlewSim* HcalAmplifier::theTimeSlewSim
private

Definition at line 57 of file HcalAmplifier.h.

Referenced by amplify().