HBHEDarkening Class Reference

#include <HBHEDarkening.h>

Classes
struct	LumiYear
struct	LumiYearComp

Public Member Functions
float	degradation (float intlumi, int ieta, int lay) const
int	get_ieta_shift () const
	HBHEDarkening (int ieta_shift, float drdA, float drdB, std::map< int, std::vector< std::vector< float >>> dosemaps, std::vector< LumiYear > years)
	~HBHEDarkening ()

Static Public Member Functions
static std::vector< std::vector< float > >	readDoseMap (const std::string &fullpath)

Private Member Functions
float	degradationYear (const LumiYear &year, float intlumi, int ieta, int lay) const
float	dose (int ieta, int lay, int energy) const
std::string	getYearForLumi (float intlumi) const

Private Attributes
std::map< int, std::vector< std::vector< float > > >	dosemaps_
float	drdA_
float	drdB_
int	ieta_shift_
std::vector< LumiYear >	years_

Detailed Description

Definition at line 17 of file HBHEDarkening.h.

Constructor & Destructor Documentation

HBHEDarkening()

HBHEDarkening::HBHEDarkening	(	int	ieta_shift,
		float	drdA,
		float	drdB,
		std::map< int, std::vector< std::vector< float >>>	dosemaps,
		std::vector< LumiYear >	years
	)

Definition at line 16 of file HBHEDarkening.cc.

References jetUpdater_cfi::sort, HLT_2023v12_cff::year, and years_.

    : ieta_shift_(ieta_shift), drdA_(drdA), drdB_(drdB), dosemaps_(std::move(dosemaps)), years_(std::move(years)) {
  //finish initializing years
  std::sort(years_.begin(), years_.end());
  //sum up int lumi
  float sumlumi = 0.0;
  for (auto& year : years_) {
    sumlumi += year.intlumi_;
    year.sumlumi_ = sumlumi;
  }
}

~HBHEDarkening()

HBHEDarkening::~HBHEDarkening ( )

inline

Definition at line 45 of file HBHEDarkening.h.

{}

Member Function Documentation

degradation()

float HBHEDarkening::degradation	(	float	intlumi,
		int	ieta,
		int	lay
	)		const

Definition at line 98 of file HBHEDarkening.cc.

References funct::abs(), cms::cuda::assert(), degradationYear(), getYearForLumi(), hcalRecHitTable_cff::ieta, ieta_shift_, submitPVValidationJobs::intlumi, AlCaHLTBitMon_QueryRunRegistry::string, HLT_2023v12_cff::year, and years_.

Referenced by HcalDigitizer::darkening(), HCalSD::getEnergyDeposit(), and HBHERecalibration::initialize().

                                                                       {
  ieta = abs(ieta);
  //shift ieta tower index to act as array index
  ieta -= ieta_shift_;
  //shift layer index by 1 to act as array index
  lay -= 1;

  //accumulate degradation over years
  float response = 1.0;
  std::string yearForLumi = getYearForLumi(intlumi);
  assert(!yearForLumi.empty());

  for (const auto& year : years_) {
    response *= degradationYear(year, intlumi, ieta, lay);
    if (year.year_ == yearForLumi)
      break;
  }

  return response;
}

degradationYear()

float HBHEDarkening::degradationYear ( const LumiYear &  year, float  intlumi, int  ieta, int  lay  ) const

private

Definition at line 80 of file HBHEDarkening.cc.

References dose(), drdA_, drdB_, JetChargeProducer_cfi::exp, hcalRecHitTable_cff::ieta, submitPVValidationJobs::intlumi, conifer::pow(), and HLT_2023v12_cff::year.

Referenced by degradation().

                                                                                                 {
  float doseToUse = dose(ieta, lay, year.energy_);
  if (doseToUse == 0.0)
    return 1.0;

  //apply dose rate dependence model to the provided year
  //get krad/hr from Mrad/fb-1 and fb-1/hr
  float decayConst = drdA_ * std::pow(1000 * doseToUse * year.lumirate_, drdB_);

  //determine if this is a partial year
  float intlumiToUse = year.intlumi_;
  if (intlumi < year.sumlumi_)
    intlumiToUse = intlumi - (year.sumlumi_ - year.intlumi_);

  //calculate degradation
  return std::exp(-(intlumiToUse * doseToUse) / decayConst);
}

dose()

float HBHEDarkening::dose ( int  ieta, int  lay, int  energy  ) const

private

Definition at line 51 of file HBHEDarkening.cc.

References dosemaps_, hcalRecHitTable_cff::energy, and hcalRecHitTable_cff::ieta.

Referenced by degradationYear().

                                                             {
  //existence check
  const auto dosemapIt = dosemaps_.find(energy);
  if (dosemapIt == dosemaps_.end())
    return 0.0;

  //bounds check
  const auto& dosemap = dosemapIt->second;
  if (ieta < 0 or ieta >= int(dosemap.size()))
    return 0.0;

  //bounds check
  const auto& doserow = dosemap[ieta];
  if (lay < 0 or lay >= int(doserow.size()))
    return 0.0;

  return doserow[lay];
}

get_ieta_shift()

int HBHEDarkening::get_ieta_shift ( ) const

inline

Definition at line 49 of file HBHEDarkening.h.

References ieta_shift_.

Referenced by HBHERecalibration::setup().

{ return ieta_shift_; }

getYearForLumi()

std::string HBHEDarkening::getYearForLumi ( float  intlumi ) const

private

Definition at line 70 of file HBHEDarkening.cc.

References Exception, submitPVValidationJobs::intlumi, pfDeepBoostedJetPreprocessParams_cfi::lower_bound, or, and years_.

Referenced by degradation().

                                                           {
  //compare based on sum lumi value
  auto lb = std::lower_bound(years_.begin(), years_.end(), intlumi, LumiYearComp());
  if (lb == years_.end() or lb->sumlumi_ < intlumi) {
    throw cms::Exception("ValueError") << "HBHEDarkening: insufficient LHC run information provided to simulate "
                                       << intlumi << "/fb - check the python config" << std::endl;
  }
  return lb->year_;
}

readDoseMap()

std::vector< std::vector< float > > HBHEDarkening::readDoseMap ( const std::string &  fullpath )

static

Definition at line 32 of file HBHEDarkening.cc.

References Exception, reco_skim_cfg_mod::fullpath, timingPdfMaker::infile, mps_splice::line, mps_fire::result, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by HBHEDarkeningEP::produce().

                                                                                {
  std::ifstream infile(fullpath.c_str());
  if (!infile.is_open()) {
    throw cms::Exception("FileNotFound") << "Unable to open '" << fullpath << "'" << std::endl;
  }
  std::string line;
  std::vector<std::vector<float>> result;
  while (getline(infile, line)) {
    //space-separated
    std::stringstream linestream(line);
    std::vector<float> lineresult;
    float doseval;
    while (linestream >> doseval)
      lineresult.push_back(doseval);
    result.push_back(lineresult);
  }
  return result;
}

Member Data Documentation

dosemaps_

std::map<int, std::vector<std::vector<float> > > HBHEDarkening::dosemaps_

private

Definition at line 63 of file HBHEDarkening.h.

Referenced by dose().

drdA_

float HBHEDarkening::drdA_

private

Definition at line 62 of file HBHEDarkening.h.

Referenced by degradationYear().

drdB_

float HBHEDarkening::drdB_

private

Definition at line 62 of file HBHEDarkening.h.

Referenced by degradationYear().

ieta_shift_

int HBHEDarkening::ieta_shift_

private

Definition at line 61 of file HBHEDarkening.h.

Referenced by degradation(), and get_ieta_shift().

years_

std::vector<LumiYear> HBHEDarkening::years_

private

Definition at line 64 of file HBHEDarkening.h.

Referenced by degradation(), getYearForLumi(), and HBHEDarkening().