HGCalSiNoiseMap Class Reference

derives from HGCalRadiation map to parse fluence parameters, provides Si-specific functions; see DN-19-045 More...

#include <HGCalSiNoiseMap.h>

Inheritance diagram for HGCalSiNoiseMap:

Classes
struct	SiCellOpCharacteristics

Public Types
enum	GainRange_t { q80fC, q160fC, q320fC, AUTO }
enum	NoiseMapAlgoBits_t { FLUENCE, CCE, NOISE }
Public Types inherited from HGCalRadiationMap
typedef std::map< std::pair< int, int >, DoseParameters >	doseParametersMap

Public Member Functions
std::vector< std::vector< double > > &	getCCEParam ()
std::array< double, 3 > &	getCellCapacitance ()
std::array< double, 3 > &	getCellVolume ()
std::vector< std::vector< double > > &	getENCsParam ()
std::vector< double > &	getIleakParam ()
std::vector< double > &	getLSBPerGain ()
std::vector< double > &	getMaxADCPerGain ()
std::array< double, 3 > &	getMipEqfC ()
SiCellOpCharacteristics	getSiCellOpCharacteristics (const HGCSiliconDetId &did, GainRange_t gain=GainRange_t::AUTO, int aimMIPtoADC=10)
	returns the charge collection efficiency and noise if gain range is set to auto, it will find the most appropriate gain to put the mip peak close to 10 ADC counts More...
	HGCalSiNoiseMap ()
void	setCceParam (const std::vector< double > &parsFine, const std::vector< double > &parsThin, const std::vector< double > &parsThick)
	set the cce parameters to use More...
void	setDoseMap (const std::string &, const unsigned int &)
	overrides base class method with specifics for the configuration of the algo More...
void	setIleakParam (const std::vector< double > &pars)
	set the ileak parameters to use More...
	~HGCalSiNoiseMap ()
Public Member Functions inherited from HGCalRadiationMap
const unsigned int &	algo ()
const HGCalDDDConstants *	ddd ()
const HGCalGeometry *	geom ()
const doseParametersMap &	getDoseMap ()
double	getDoseValue (const int, const int, const radiiVec &, bool logVal=false)
double	getFluenceValue (const int, const int, const radiiVec &, bool logVal=false)
	HGCalRadiationMap ()
void	setDoseMap (const std::string &, const unsigned int)
void	setGeometry (const CaloSubdetectorGeometry *)
const HGCalTopology *	topo ()
	~HGCalRadiationMap ()

Private Attributes
std::vector< std::vector< double > >	cceParam_
std::array< double, 3 >	cellCapacitance_
std::array< double, 3 >	cellVolume_
std::vector< double >	chargeAtFullScaleADCPerGain_
const double	encCommonNoiseSub_
const double	encpScale_
std::vector< std::vector< double > >	encsParam_
bool	ignoreCCE_
bool	ignoreFluence_
bool	ignoreNoise_
std::vector< double >	ileakParam_
std::vector< double >	lsbPerGain_
std::array< double, 3 >	mipEqfC_
const double	qe2fc_
const double	unitToMicro_ = 1.e6

Detailed Description

derives from HGCalRadiation map to parse fluence parameters, provides Si-specific functions; see DN-19-045

Definition at line 14 of file HGCalSiNoiseMap.h.

Member Enumeration Documentation

enum HGCalSiNoiseMap::GainRange_t

Enumerator
q80fC
q160fC
q320fC
AUTO

Definition at line 16 of file HGCalSiNoiseMap.h.

{ q80fC, q160fC, q320fC, AUTO };

enum HGCalSiNoiseMap::NoiseMapAlgoBits_t

Enumerator
FLUENCE
CCE
NOISE

Definition at line 17 of file HGCalSiNoiseMap.h.

{ FLUENCE, CCE, NOISE };

Constructor & Destructor Documentation

HGCalSiNoiseMap::HGCalSiNoiseMap

(

)

Definition at line 4 of file HGCalSiNoiseMap.cc.

References cellCapacitance_, cellVolume_, chargeAtFullScaleADCPerGain_, encsParam_, mps_fire::i, lsbPerGain_, mipEqfC_, and qe2fc_.

    : encpScale_(840.),
      encCommonNoiseSub_(sqrt(1.25)),
      qe2fc_(1.60217646E-4),
      ignoreFluence_(false),
      ignoreCCE_(false),
      ignoreNoise_(false) {
  encsParam_.push_back({636., 15.6, 0.0328});   // q80fC: II order polynomial coefficients
  chargeAtFullScaleADCPerGain_.push_back(80.);  //        the num of fC (charge) which corresponds to the max ADC value
  encsParam_.push_back({1045., 8.74, 0.0685});  // q160fC
  chargeAtFullScaleADCPerGain_.push_back(160.);
  encsParam_.push_back({1915., 2.79, 0.0878});  // q320fC
  chargeAtFullScaleADCPerGain_.push_back(320.);

  // adc has 10 bits -> 1024 counts at max ( >0 baseline to be handled)
  for (auto i : chargeAtFullScaleADCPerGain_)
    lsbPerGain_.push_back(i / 1024.);

  //fine sensors: 120 mum -  67: MPV of charge[number of e-]/mum for a mip in silicon; srouce PDG
  const double mipEqfC_120 = 120. * 67. * qe2fc_;
  mipEqfC_[0] = mipEqfC_120;
  const double cellCapacitance_120 = 50;
  cellCapacitance_[0] = cellCapacitance_120;
  const double cellVolume_120 = 0.52 * (120.e-4);
  cellVolume_[0] = cellVolume_120;

  //thin sensors: 200 mum
  const double mipEqfC_200 = 200. * 70. * qe2fc_;
  mipEqfC_[1] = mipEqfC_200;
  const double cellCapacitance_200 = 65;
  cellCapacitance_[1] = cellCapacitance_200;
  const double cellVolume_200 = 1.18 * (200.e-4);
  cellVolume_[1] = cellVolume_200;

  //thick sensors: 300 mum
  const double mipEqfC_300 = 300. * 73. * qe2fc_;
  mipEqfC_[2] = mipEqfC_300;
  const double cellCapacitance_300 = 45;
  cellCapacitance_[2] = cellCapacitance_300;
  const double cellVolume_300 = 1.18 * (300.e-4);
  cellVolume_[2] = cellVolume_300;
}

HGCalSiNoiseMap::~HGCalSiNoiseMap ( )

inline

Definition at line 27 of file HGCalSiNoiseMap.h.

{};

Member Function Documentation

std::vector<std::vector<double> >& HGCalSiNoiseMap::getCCEParam ( )

inline

Definition at line 61 of file HGCalSiNoiseMap.h.

References cceParam_.

{ return cceParam_; }

std::array<double, 3>& HGCalSiNoiseMap::getCellCapacitance ( )

inline

Definition at line 59 of file HGCalSiNoiseMap.h.

References cellCapacitance_.

{ return cellCapacitance_; }

std::array<double, 3>& HGCalSiNoiseMap::getCellVolume ( )

inline

Definition at line 60 of file HGCalSiNoiseMap.h.

References cellVolume_.

{ return cellVolume_; }

std::vector<std::vector<double> >& HGCalSiNoiseMap::getENCsParam ( )

inline

Definition at line 63 of file HGCalSiNoiseMap.h.

References encsParam_.

{ return encsParam_; }

std::vector<double>& HGCalSiNoiseMap::getIleakParam ( )

inline

Definition at line 62 of file HGCalSiNoiseMap.h.

References ileakParam_.

{ return ileakParam_; }

std::vector<double>& HGCalSiNoiseMap::getLSBPerGain ( )

inline

Definition at line 64 of file HGCalSiNoiseMap.h.

References lsbPerGain_.

Referenced by HGCDigitizerBase< DFr >::runSimple().

{ return lsbPerGain_; }

std::vector<double>& HGCalSiNoiseMap::getMaxADCPerGain ( )

inline

Definition at line 65 of file HGCalSiNoiseMap.h.

References chargeAtFullScaleADCPerGain_.

Referenced by HGCDigitizerBase< DFr >::runSimple().

{ return chargeAtFullScaleADCPerGain_; }

std::array<double, 3>& HGCalSiNoiseMap::getMipEqfC ( )

inline

Definition at line 58 of file HGCalSiNoiseMap.h.

References mipEqfC_.

{ return mipEqfC_; }

HGCalSiNoiseMap::SiCellOpCharacteristics HGCalSiNoiseMap::getSiCellOpCharacteristics	(	const HGCSiliconDetId &	did,
		GainRange_t	gain = GainRange_t::AUTO,
		int	aimMIPtoADC = 10
	)

returns the charge collection efficiency and noise if gain range is set to auto, it will find the most appropriate gain to put the mip peak close to 10 ADC counts

Definition at line 59 of file HGCalSiNoiseMap.cc.

References HGCalSiNoiseMap::SiCellOpCharacteristics::cce, cceParam_, cellCapacitance_, HGCSiliconDetId::cellU(), HGCSiliconDetId::cellV(), cellVolume_, HGCalRadiationMap::ddd(), relativeConstraints::empty, encCommonNoiseSub_, encpScale_, encsParam_, Exception, JetChargeProducer_cfi::exp, HGCalSiNoiseMap::SiCellOpCharacteristics::fluence, HGCalSiNoiseMap::SiCellOpCharacteristics::gain, PedestalClient_cfi::gain, HGCalRadiationMap::getDoseMap(), HGCalRadiationMap::getFluenceValue(), ignoreCCE_, ignoreFluence_, ignoreNoise_, HGCalSiNoiseMap::SiCellOpCharacteristics::ileak, ileakParam_, HGCSiliconDetId::layer(), HGCalSiNoiseMap::SiCellOpCharacteristics::lnfluence, dqm-mbProfile::log, lsbPerGain_, SiStripPI::max, HGCalSiNoiseMap::SiCellOpCharacteristics::mipADC, mipEqfC_, HGCalSiNoiseMap::SiCellOpCharacteristics::mipfC, HGCalSiNoiseMap::SiCellOpCharacteristics::noise, funct::pow(), q160fC, q320fC, q80fC, qe2fc_, BeamHaloGenFilter_cfi::radii, CosmicsPD_Skims::radius, S(), mathSSE::sqrt(), HGCSiliconDetId::subdet(), HGCalSiNoiseMap::SiCellOpCharacteristics::thrADC, HGCSiliconDetId::type(), unitToMicro_, HGCSiliconDetId::waferU(), HGCSiliconDetId::waferV(), and geometryCSVtoXML::xy.

Referenced by HGCDigitizerBase< DFr >::runSimple(), and setCceParam().

                                                                                                      {
  SiCellOpCharacteristics siop;

  //decode cell properties
  int layer(cellId.layer());
  unsigned int cellThick = cellId.type();
  double cellCap(cellCapacitance_[cellThick]);
  double cellVol(cellVolume_[cellThick]);

  //leakage current and CCE [muA]
  if (ignoreFluence_) {
    siop.fluence = 0;
    siop.lnfluence = -1;
    siop.ileak = exp(ileakParam_[1]) * cellVol * unitToMicro_;
    siop.cce = 1;
  } else {
    if (getDoseMap().empty()) {
      throw cms::Exception("BadConfiguration")
          << " Fluence is required but no DoseMap has been passed to HGCalSiNoiseMap";
      return siop;
    }

    //compute the radius here
    auto xy(ddd()->locateCell(
        cellId.layer(), cellId.waferU(), cellId.waferV(), cellId.cellU(), cellId.cellV(), true, true));
    double radius2 = std::pow(xy.first, 2) + std::pow(xy.second, 2);  //in cm

    double radius = sqrt(radius2);
    double radius3 = radius * radius2;
    double radius4 = pow(radius2, 2);
    radiiVec radii{{radius, radius2, radius3, radius4, 0., 0., 0., 0.}};
    siop.fluence = getFluenceValue(cellId.subdet(), layer, radii);
    siop.lnfluence = log(siop.fluence);
    siop.ileak = exp(ileakParam_[0] * siop.lnfluence + ileakParam_[1]) * cellVol * unitToMicro_;

    if (ignoreCCE_) {
      siop.cce = 1.0;
    } else {
      //lin+log parametrization
      //cceParam_ are parameters as defined in equation (2) of DN-19-045
      siop.cce = siop.fluence <= cceParam_[cellThick][0] ? 1. + cceParam_[cellThick][1] * siop.fluence
                                                         : (1. - cceParam_[cellThick][2] * siop.lnfluence) +
                                                               (cceParam_[cellThick][1] * cceParam_[cellThick][0] +
                                                                cceParam_[cellThick][2] * log(cceParam_[cellThick][0]));
      siop.cce = std::max(0., siop.cce);
    }
  }

  //determine the gain to apply accounting for cce
  //move computation to ROC level (one day)
  double S(siop.cce * mipEqfC_[cellThick]);
  if (gain == GainRange_t::AUTO) {
    double desiredLSB(S / aimMIPtoADC);
    std::vector<double> diffToPhysLSB = {fabs(desiredLSB - lsbPerGain_[GainRange_t::q80fC]),
                                         fabs(desiredLSB - lsbPerGain_[GainRange_t::q160fC]),
                                         fabs(desiredLSB - lsbPerGain_[GainRange_t::q320fC])};
    size_t gainIdx = std::min_element(diffToPhysLSB.begin(), diffToPhysLSB.end()) - diffToPhysLSB.begin();
    gain = HGCalSiNoiseMap::q80fC;
    if (gainIdx == 1)
      gain = HGCalSiNoiseMap::q160fC;
    if (gainIdx == 2)
      gain = HGCalSiNoiseMap::q320fC;
  }

  //fill in the parameters of the struct
  siop.gain = gain;
  siop.mipfC = S;
  siop.mipADC = std::floor(S / lsbPerGain_[gain]);
  siop.thrADC = std::floor(S / 2. / lsbPerGain_[gain]);

  //build noise estimate
  if (ignoreNoise_) {
    siop.noise = 0.0;
  } else {
    double enc_s(encsParam_[gain][0] + encsParam_[gain][1] * cellCap + encsParam_[gain][2] * pow(cellCap, 2));
    double enc_p(encpScale_ * sqrt(siop.ileak));
    siop.noise = hypot(enc_p, enc_s * encCommonNoiseSub_) * qe2fc_;
  }

  return siop;
}

void HGCalSiNoiseMap::setCceParam ( const std::vector< double > &  parsFine, const std::vector< double > &  parsThin, const std::vector< double > &  parsThick  )

inline

set the cce parameters to use

Definition at line 37 of file HGCalSiNoiseMap.h.

References cceParam_, HGCalSiNoiseMap::SiCellOpCharacteristics::gain, getSiCellOpCharacteristics(), setDoseMap(), and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by HGCDigitizerBase< DFr >::HGCDigitizerBase().

                                                       {
    cceParam_.push_back(parsFine);   //120
    cceParam_.push_back(parsThin);   //200
    cceParam_.push_back(parsThick);  //300
  }

void HGCalSiNoiseMap::setDoseMap	(	const std::string &	fullpath,
		const unsigned int &	algo
	)

overrides base class method with specifics for the configuration of the algo

Definition at line 48 of file HGCalSiNoiseMap.cc.

References CCE, FLUENCE, ignoreCCE_, ignoreFluence_, ignoreNoise_, NOISE, HGCalRadiationMap::setDoseMap(), and testProducerWithPsetDescEmpty_cfi::x1.

Referenced by HGCDigitizerBase< DFr >::HGCDigitizerBase(), and setCceParam().

                                                                                    {
  //decode bits in the algo word
  ignoreFluence_ = ((algo >> FLUENCE) & 0x1);
  ignoreCCE_ = ((algo >> CCE) & 0x1);
  ignoreNoise_ = ((algo >> NOISE) & 0x1);

  //call base class method
  HGCalRadiationMap::setDoseMap(fullpath, algo);
}

void HGCalSiNoiseMap::setIleakParam ( const std::vector< double > &  pars )

inline

set the ileak parameters to use

Definition at line 32 of file HGCalSiNoiseMap.h.

References ileakParam_.

Referenced by HGCDigitizerBase< DFr >::HGCDigitizerBase().

{ ileakParam_ = pars; }

Member Data Documentation

std::vector<std::vector<double> > HGCalSiNoiseMap::cceParam_

private

Definition at line 70 of file HGCalSiNoiseMap.h.

Referenced by getCCEParam(), getSiCellOpCharacteristics(), and setCceParam().

std::array<double, 3> HGCalSiNoiseMap::cellCapacitance_

private

Definition at line 69 of file HGCalSiNoiseMap.h.

Referenced by getCellCapacitance(), getSiCellOpCharacteristics(), and HGCalSiNoiseMap().

std::array<double, 3> HGCalSiNoiseMap::cellVolume_

private

Definition at line 69 of file HGCalSiNoiseMap.h.

Referenced by getCellVolume(), getSiCellOpCharacteristics(), and HGCalSiNoiseMap().

std::vector<double> HGCalSiNoiseMap::chargeAtFullScaleADCPerGain_

private

Definition at line 88 of file HGCalSiNoiseMap.h.

Referenced by getMaxADCPerGain(), and HGCalSiNoiseMap().

const double HGCalSiNoiseMap::encCommonNoiseSub_

private

Definition at line 79 of file HGCalSiNoiseMap.h.

Referenced by getSiCellOpCharacteristics().

const double HGCalSiNoiseMap::encpScale_

private

Definition at line 76 of file HGCalSiNoiseMap.h.

Referenced by getSiCellOpCharacteristics().

std::vector<std::vector<double> > HGCalSiNoiseMap::encsParam_

private

Definition at line 85 of file HGCalSiNoiseMap.h.

Referenced by getENCsParam(), getSiCellOpCharacteristics(), and HGCalSiNoiseMap().

bool HGCalSiNoiseMap::ignoreCCE_

private

Definition at line 94 of file HGCalSiNoiseMap.h.

Referenced by getSiCellOpCharacteristics(), and setDoseMap().

bool HGCalSiNoiseMap::ignoreFluence_

private

Definition at line 94 of file HGCalSiNoiseMap.h.

Referenced by getSiCellOpCharacteristics(), and setDoseMap().

bool HGCalSiNoiseMap::ignoreNoise_

private

Definition at line 94 of file HGCalSiNoiseMap.h.

Referenced by getSiCellOpCharacteristics(), and setDoseMap().

std::vector<double> HGCalSiNoiseMap::ileakParam_

private

Definition at line 73 of file HGCalSiNoiseMap.h.

Referenced by getIleakParam(), getSiCellOpCharacteristics(), and setIleakParam().

std::vector<double> HGCalSiNoiseMap::lsbPerGain_

private

Definition at line 88 of file HGCalSiNoiseMap.h.

Referenced by getLSBPerGain(), getSiCellOpCharacteristics(), and HGCalSiNoiseMap().

std::array<double, 3> HGCalSiNoiseMap::mipEqfC_

private

Definition at line 69 of file HGCalSiNoiseMap.h.

Referenced by getMipEqfC(), getSiCellOpCharacteristics(), and HGCalSiNoiseMap().

const double HGCalSiNoiseMap::qe2fc_

private

Definition at line 82 of file HGCalSiNoiseMap.h.

Referenced by getSiCellOpCharacteristics(), and HGCalSiNoiseMap().

const double HGCalSiNoiseMap::unitToMicro_ = 1.e6

private

Definition at line 91 of file HGCalSiNoiseMap.h.

Referenced by getSiCellOpCharacteristics().