EcalLiteDTUCoder Class Reference

#include <EcalLiteDTUCoder.h>

Public Types
typedef CaloTSamples< float, ecalPh2::sampleSize >	EcalSamples
typedef CorrelatedNoisifier< EcalCorrMatrix_Ph2 >	Noisifier

Public Member Functions
virtual void	analogToDigital (CLHEP::HepRandomEngine *, const EcalSamples &clf, EcalDataFrame_Ph2 &df) const
	from EcalSamples to EcalDataFrame_Ph2 More...
	EcalLiteDTUCoder (bool addNoise, bool PreMix1, Noisifier *ebCorrNoise0, Noisifier *ebCorrNoise1=nullptr)
	ctor More...
void	setFullScaleEnergy (double EBscale)
void	setGainRatios (float gainRatios)
void	setIntercalibConstants (const EcalIntercalibConstantsMC *ical)
void	setPedestals (const EcalLiteDTUPedestalsMap *pedestals)
	can be fetched every event from the EventSetup More...
virtual	~EcalLiteDTUCoder ()
	dtor More...

Private Member Functions
void	encode (const EcalSamples &ecalSamples, EcalDataFrame_Ph2 &df, CLHEP::HepRandomEngine *) const
	produce the pulse-shape More...
void	findGains (const DetId &detId, float theGains[]) const
void	findIntercalibConstant (const DetId &detId, double &icalconst) const
void	findPedestal (const DetId &detId, int gainId, double &pedestal, double &width) const
double	fullScaleEnergy (const DetId &did) const
	limit on the energy scale due to the electronics range More...

Private Attributes
bool	m_addNoise
const Noisifier *	m_ebCorrNoise [ecalPh2::NGAINS]
float	m_gainRatios
const EcalIntercalibConstantsMC *	m_intercals
double	m_maxEneEB
const EcalLiteDTUPedestalsMap *	m_peds
bool	m_PreMix1

Detailed Description

Definition at line 24 of file EcalLiteDTUCoder.h.

Member Typedef Documentation

EcalSamples

typedef CaloTSamples<float, ecalPh2::sampleSize> EcalLiteDTUCoder::EcalSamples

Definition at line 26 of file EcalLiteDTUCoder.h.

Noisifier

typedef CorrelatedNoisifier<EcalCorrMatrix_Ph2> EcalLiteDTUCoder::Noisifier

Definition at line 28 of file EcalLiteDTUCoder.h.

Constructor & Destructor Documentation

EcalLiteDTUCoder()

EcalLiteDTUCoder::EcalLiteDTUCoder	(	bool	addNoise,
		bool	PreMix1,
		EcalLiteDTUCoder::Noisifier *	ebCorrNoise0,
		EcalLiteDTUCoder::Noisifier *	ebCorrNoise1 = nullptr
	)

ctor

Definition at line 9 of file EcalLiteDTUCoder.cc.

    : m_peds(nullptr),
      m_gainRatios(0),
      m_intercals(nullptr),
      m_maxEneEB(ecalPh2::maxEneEB),  // Maximum for CATIA: LSB gain 10: 0.048 MeV
      m_addNoise(addNoise),
      m_PreMix1(PreMix1),
      m_ebCorrNoise{ebCorrNoise0, ebCorrNoise1}
 
{}

~EcalLiteDTUCoder()

EcalLiteDTUCoder::~EcalLiteDTUCoder ( )

virtual

dtor

Definition at line 23 of file EcalLiteDTUCoder.cc.

{}

Member Function Documentation

analogToDigital()

void EcalLiteDTUCoder::analogToDigital ( CLHEP::HepRandomEngine *  engine, const EcalSamples &  clf, EcalDataFrame_Ph2 &  df  ) const

virtual

from EcalSamples to EcalDataFrame_Ph2

Definition at line 35 of file EcalLiteDTUCoder.cc.

                                                                    {
  df.setSize(clf.size());
  encode(clf, df, engine);
}

References hgcalPerformanceValidation::df, encode(), and CaloTSamplesBase< Ttype >::size().

encode()

void EcalLiteDTUCoder::encode ( const EcalSamples &  ecalSamples, EcalDataFrame_Ph2 &  df, CLHEP::HepRandomEngine *  engine  ) const

private

produce the pulse-shape

Definition at line 42 of file EcalLiteDTUCoder.cc.

                                                                  {
  const int nSamples(ecalSamples.size());
 
  DetId detId = ecalSamples.id();
  double Emax = fullScaleEnergy(detId);
 
  //N Gains set to 2 in the .h
  double pedestals[ecalPh2::NGAINS];
  double widths[ecalPh2::NGAINS];
  double LSB[ecalPh2::NGAINS];
  double trueRMS[ecalPh2::NGAINS];
  int nSaturatedSamples = 0;
  double icalconst = 1.;
  findIntercalibConstant(detId, icalconst);
 
  for (unsigned int igain(0); igain < ecalPh2::NGAINS; ++igain) {
    // fill in the pedestal and width
    findPedestal(detId, igain, pedestals[igain], widths[igain]);
    // insert an absolute value in the trueRMS
    trueRMS[igain] = std::sqrt(std::abs(widths[igain] * widths[igain] - 1. / 12.));
 
    LSB[igain] = Emax / (ecalPh2::MAXADC * ecalPh2::gains[igain]);
  }
 
  CaloSamples noiseframe[ecalPh2::NGAINS] = {
      CaloSamples(detId, nSamples),
      CaloSamples(detId, nSamples),
  };
 
  const Noisifier* noisy[ecalPh2::NGAINS] = {m_ebCorrNoise[0], m_ebCorrNoise[1]};
 
  if (m_addNoise) {
    for (unsigned int ig = 0; ig < ecalPh2::NGAINS; ++ig) {
      noisy[ig]->noisify(noiseframe[ig], engine);
    }
  }
 
  std::vector<std::vector<int>> adctrace(nSamples);
  int firstSaturatedSample[ecalPh2::NGAINS] = {0, 0};
 
  for (int i(0); i != nSamples; ++i)
    adctrace[i].resize(ecalPh2::NGAINS);
 
  for (unsigned int igain = 0; igain < ecalPh2::NGAINS; ++igain) {
    for (int i(0); i != nSamples; ++i) {
      adctrace[i][igain] = -1;
    }
  }
 
  // fill ADC trace in gain 0 (x10) and gain 1 (x1)
  for (unsigned int igain = 0; igain < ecalPh2::NGAINS; ++igain) {
    for (int i(0); i != nSamples; ++i) {
      double asignal = 0;
      if (!m_PreMix1) {
        asignal = pedestals[igain] + ecalSamples[i] / (LSB[igain] * icalconst) + trueRMS[igain] * noiseframe[igain][i];
        //Analog signal value for each sample in ADC.
        //It is corrected by the intercalibration constants
 
      } else {
        //  no noise nor pedestal when premixing
        asignal = ecalSamples[i] / (LSB[igain] * icalconst);
      }
      int isignal = asignal;
 
      unsigned int adc = asignal - (double)isignal < 0.5 ? isignal : isignal + 1;
      // gain 0 (x10) channel is saturated, readout will use gain 1 (x10), but I count the number of saturated samples
      if (adc > ecalPh2::MAXADC) {
        adc = ecalPh2::MAXADC;
        if (nSaturatedSamples == 0)
          firstSaturatedSample[igain] = i;
        nSaturatedSamples++;
      }
      adctrace[i][igain] = adc;
    }
    if (nSaturatedSamples == 0) {
      break;  //  gain 0 (x10) is not saturated, so don't bother with gain 1
    }
  }  // for igain
 
  int igain = 0;
 
  //Limits of gain 1:
  //The Lite DTU sends 5 samples before the saturating one, and 10 after with gain 1.
  //we put the maximum in bin 5, but could happen that the system saturates before.
 
  int previousSaturatedSamples = 5;
  int nextSaturatedSamples = 10;
  int startingLowerGainSample = 0;
  int endingLowerGainSample = (firstSaturatedSample[0] + nextSaturatedSamples + (nSaturatedSamples));
 
  if (nSaturatedSamples != 0 and (firstSaturatedSample[0] - previousSaturatedSamples) < 0) {
    startingLowerGainSample = 0;
  } else {
    startingLowerGainSample = (firstSaturatedSample[0] - previousSaturatedSamples);
  }
 
  //Setting values to the samples:
  for (int j = 0; j < nSamples; ++j) {
    if (nSaturatedSamples != 0 and j >= startingLowerGainSample and j < endingLowerGainSample) {
      igain = 1;
    } else {
      igain = 0;
    }
    df.setSample(j, EcalLiteDTUSample(adctrace[j][igain], igain));
  }
}

References funct::abs(), ecalLiteDTU::adc(), hgcalPerformanceValidation::df, findIntercalibConstant(), findPedestal(), fullScaleEnergy(), ecalPh2::gains, mps_fire::i, CaloTSamplesBase< Ttype >::id(), dqmiolumiharvest::j, m_addNoise, m_ebCorrNoise, m_PreMix1, ecalPh2::MAXADC, ecalPh2::NGAINS, CorrelatedNoisifier< M >::noisify(), PresampleTask_cfi::nSamples, CaloTSamplesBase< Ttype >::size(), and mathSSE::sqrt().

Referenced by analogToDigital().

findGains()

void EcalLiteDTUCoder::findGains ( const DetId &  detId, float  theGains[]  ) const

private

findIntercalibConstant()

void EcalLiteDTUCoder::findIntercalibConstant ( const DetId &  detId, double &  icalconst  ) const

private

Definition at line 165 of file EcalLiteDTUCoder.cc.

                                                                                         {
  EcalIntercalibConstantMC thisconst = 1.;
  // find intercalib constant for this xtal
  const EcalIntercalibConstantMCMap& icalMap = m_intercals->getMap();
  EcalIntercalibConstantMCMap::const_iterator icalit = icalMap.find(detId);
  if (icalit != icalMap.end()) {
    thisconst = (*icalit);
  } else {
    LogDebug("EcalLiteDTUCoder") << "Intercalib Constant not found, put default value \n";
    thisconst = 1.;
  }
 
  if (icalconst == 0.)
    thisconst = 1.;
 
  icalconst = thisconst;
}

References EcalCondObjectContainer< T >::end(), EcalCondObjectContainer< T >::find(), EcalCondObjectContainer< T >::getMap(), LogDebug, and m_intercals.

Referenced by encode().

findPedestal()

void EcalLiteDTUCoder::findPedestal ( const DetId &  detId, int  gainId, double &  pedestal, double &  width  ) const

private

Definition at line 151 of file EcalLiteDTUCoder.cc.

                                                                                                    {
  EcalLiteDTUPedestalsMap::const_iterator itped = m_peds->getMap().find(detId);
  if (itped != m_peds->getMap().end()) {
    ped = (*itped).mean(gainId);
    width = (*itped).rms(gainId);
    LogDebug("EcalLiteDTUCoder") << "Pedestals for " << detId.rawId() << " gain range " << gainId << " : \n"
                                 << "Mean = " << ped << " rms = " << width;
  } else {
    LogDebug("EcalLiteDTUCoder") << "Pedestals not found, put default values (ped: 12; width: 2.5) \n";
    ped = 12.;
    width = 2.5;
  }
}

References EcalCondObjectContainer< T >::end(), EcalCondObjectContainer< T >::find(), ecalLiteDTU::gainId(), EcalCondObjectContainer< T >::getMap(), LogDebug, m_peds, DetId::rawId(), and ApeEstimator_cff::width.

Referenced by encode().

fullScaleEnergy()

double EcalLiteDTUCoder::fullScaleEnergy ( const DetId &  did ) const

private

limit on the energy scale due to the electronics range

Definition at line 33 of file EcalLiteDTUCoder.cc.

{ return m_maxEneEB; }

References m_maxEneEB.

Referenced by encode().

setFullScaleEnergy()

void EcalLiteDTUCoder::setFullScaleEnergy

(

double

EBscale

)

Definition at line 25 of file EcalLiteDTUCoder.cc.

{ m_maxEneEB = ecalPh2::maxEneEB; }

References m_maxEneEB, and ecalPh2::maxEneEB.

setGainRatios()

void EcalLiteDTUCoder::setGainRatios

(

float

gainRatios

)

Definition at line 29 of file EcalLiteDTUCoder.cc.

{ m_gainRatios = gainRatios; }

References m_gainRatios.

setIntercalibConstants()

void EcalLiteDTUCoder::setIntercalibConstants

(

const EcalIntercalibConstantsMC *

ical

)

Definition at line 31 of file EcalLiteDTUCoder.cc.

{ m_intercals = ical; }

References m_intercals.

setPedestals()

void EcalLiteDTUCoder::setPedestals

(

const EcalLiteDTUPedestalsMap *

pedestals

)

can be fetched every event from the EventSetup

Definition at line 27 of file EcalLiteDTUCoder.cc.

{ m_peds = pedestals; }

References m_peds.

Member Data Documentation

m_addNoise

bool EcalLiteDTUCoder::m_addNoise

private

Definition at line 69 of file EcalLiteDTUCoder.h.

Referenced by encode().

m_ebCorrNoise

const Noisifier* EcalLiteDTUCoder::m_ebCorrNoise[ecalPh2::NGAINS]

private

Definition at line 72 of file EcalLiteDTUCoder.h.

Referenced by encode().

m_gainRatios

float EcalLiteDTUCoder::m_gainRatios

private

Definition at line 63 of file EcalLiteDTUCoder.h.

Referenced by setGainRatios().

m_intercals

const EcalIntercalibConstantsMC* EcalLiteDTUCoder::m_intercals

private

Definition at line 65 of file EcalLiteDTUCoder.h.

Referenced by findIntercalibConstant(), and setIntercalibConstants().

m_maxEneEB

double EcalLiteDTUCoder::m_maxEneEB

private

Definition at line 67 of file EcalLiteDTUCoder.h.

Referenced by fullScaleEnergy(), and setFullScaleEnergy().

m_peds

const EcalLiteDTUPedestalsMap* EcalLiteDTUCoder::m_peds

private

Definition at line 61 of file EcalLiteDTUCoder.h.

Referenced by findPedestal(), and setPedestals().

m_PreMix1

bool EcalLiteDTUCoder::m_PreMix1

private

Definition at line 70 of file EcalLiteDTUCoder.h.

Referenced by encode().