HGCFEElectronics.h

Go to the documentation of this file.

#ifndef _hgcfeelectronics_h_
#define _hgcfeelectronics_h_

#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"

#include "CLHEP/Random/RandGauss.h"
#include "CLHEP/Random/RandGaussQ.h"
#include "CLHEP/Random/RandFlat.h"
#include "SimCalorimetry/HGCalSimProducers/interface/HGCDigitizerTypes.h"

namespace hgc = hgc_digi;

namespace hgc_digi {
  typedef std::array<float, 6> FEADCPulseShape;
}

template <class DFr>
class HGCFEElectronics {
public:
  enum HGCFEElectronicsFirmwareVersion { TRIVIAL, SIMPLE, WITHTOT };
  enum HGCFEElectronicsTOTMode { WEIGHTEDBYE, SIMPLETHRESHOLD };

  HGCFEElectronics(const edm::ParameterSet& ps);

  inline void runShaper(DFr& dataFrame,
                        hgc::HGCSimHitData& chargeColl,
                        hgc::HGCSimHitData& toa,
                        const hgc_digi::FEADCPulseShape& adcPulse,
                        CLHEP::HepRandomEngine* engine,
                        uint32_t thrADC = 0,
                        float lsbADC = -1,
                        uint32_t gainIdx = 0,
                        float maxADC = -1,
                        int thickness = 1,
                        float tdcOnsetAuto = -1,
                        float noiseWidth = -1) {
    switch (fwVersion_) {
      case SIMPLE: {
        runSimpleShaper(dataFrame, chargeColl, thrADC, lsbADC, gainIdx, maxADC, adcPulse);
        break;
      }
      case WITHTOT: {
        runShaperWithToT(dataFrame,
                         chargeColl,
                         toa,
                         engine,
                         thrADC,
                         lsbADC,
                         gainIdx,
                         maxADC,
                         thickness,
                         tdcOnsetAuto,
                         noiseWidth,
                         adcPulse);
        break;
      }
      default: {
        runTrivialShaper(dataFrame, chargeColl, thrADC, lsbADC, gainIdx, maxADC);
        break;
      }
    }
  }
  inline void runShaper(DFr& dataFrame,
                        hgc::HGCSimHitData& chargeColl,
                        hgc::HGCSimHitData& toa,
                        CLHEP::HepRandomEngine* engine,
                        uint32_t thrADC = 0,
                        float lsbADC = -1,
                        uint32_t gainIdx = 0,
                        float maxADC = -1,
                        int thickness = 1) {
    runShaper(dataFrame, chargeColl, toa, adcPulse_, engine, thrADC, lsbADC, gainIdx, maxADC, thickness);
  }

  void SetNoiseValues(const std::vector<float>& noise_fC) {
    noise_fC_.insert(noise_fC_.end(), noise_fC.begin(), noise_fC.end());
  };

  void generateTimeOffset(CLHEP::HepRandomEngine* engine) {
    for (int i = 0; i < 3; i++)
      eventTimeOffset_ns_[i] = CLHEP::RandGaussQ::shoot(engine, 0, jitterConstant_ns_[i]);
  };

  float getADClsb() { return adcLSB_fC_; }
  float getTDClsb() { return tdcLSB_fC_; }
  int getTargetMipValue() { return targetMIPvalue_ADC_; }
  float getADCThreshold() { return adcThreshold_fC_; }
  float getMaxADC() { return adcSaturation_fC_; }
  float getMaxTDC() { return tdcSaturation_fC_; }
  float getTDCOnset() { return tdcOnset_fC_; }
  std::array<float, 3> getTDCForToAOnset() { return tdcForToAOnset_fC_; }
  void setADClsb(float newLSB) { adcLSB_fC_ = newLSB; }
  void setTDCfsc(float newTDCfsc) {
    tdcSaturation_fC_ = newTDCfsc;
    tdcLSB_fC_ = tdcSaturation_fC_ / pow(2., tdcNbits_);
    // lower tdcSaturation_fC_ by one part in a million
    // to ensure largest charge converted in bits is 0xfff and not 0x000
    tdcSaturation_fC_ *= (1. - 1e-6);
  }

  void runTrivialShaper(
      DFr& dataFrame, hgc::HGCSimHitData& chargeColl, uint32_t thrADC, float lsbADC, uint32_t gainIdx, float maxADC);

  void runSimpleShaper(DFr& dataFrame,
                       hgc::HGCSimHitData& chargeColl,
                       uint32_t thrADC,
                       float lsbADC,
                       uint32_t gainIdx,
                       float maxADC,
                       const hgc_digi::FEADCPulseShape& adcPulse);
  void runSimpleShaper(
      DFr& dataFrame, hgc::HGCSimHitData& chargeColl, uint32_t thrADC, float lsbADC, uint32_t gainIdx, float maxADC) {
    runSimpleShaper(dataFrame, chargeColl, thrADC, lsbADC, gainIdx, maxADC, adcPulse_);
  }

  void runShaperWithToT(DFr& dataFrame,
                        hgc::HGCSimHitData& chargeColl,
                        hgc::HGCSimHitData& toa,
                        CLHEP::HepRandomEngine* engine,
                        uint32_t thrADC,
                        float lsbADC,
                        uint32_t gainIdx,
                        float maxADC,
                        int thickness,
                        float tdcOnsetAuto,
                        float noiseWidth,
                        const hgc_digi::FEADCPulseShape& adcPulse);
  void runShaperWithToT(DFr& dataFrame,
                        hgc::HGCSimHitData& chargeColl,
                        hgc::HGCSimHitData& toa,
                        CLHEP::HepRandomEngine* engine,
                        uint32_t thrADC,
                        float lsbADC,
                        uint32_t gainIdx,
                        float maxADC,
                        int thickness,
                        float tdcOnsetAuto,
                        float noiseWidth) {
    runShaperWithToT(dataFrame,
                     chargeColl,
                     toa,
                     engine,
                     thrADC,
                     lsbADC,
                     gainIdx,
                     maxADC,
                     thickness,
                     tdcOnsetAuto,
                     noiseWidth,
                     adcPulse_);
  }

  uint32_t toaMode() const { return toaMode_; }

  hgc_digi::FEADCPulseShape& getDefaultADCPulse() { return adcPulse_; }

  ~HGCFEElectronics() {}

private:
  //private members
  uint32_t fwVersion_;
  hgc_digi::FEADCPulseShape adcPulse_, pulseAvgT_;
  std::array<float, 3> tdcForToAOnset_fC_;
  std::vector<float> tdcChargeDrainParameterisation_;
  float adcSaturation_fC_, adcLSB_fC_, tdcLSB_fC_, tdcSaturation_fC_, adcThreshold_fC_, tdcOnset_fC_, toaLSB_ns_,
      tdcResolutionInNs_;
  uint32_t targetMIPvalue_ADC_;
  std::array<float, 3> jitterNoise_ns_, jitterConstant_ns_, eventTimeOffset_ns_;
  std::vector<float> noise_fC_;
  uint32_t toaMode_;
  uint32_t tdcNbits_;
  bool thresholdFollowsMIP_;
  //caches
  std::array<bool, hgc::nSamples> busyFlags, totFlags, toaFlags;
  hgc::HGCSimHitData newCharge, toaFromToT;
};

#endif