EnergyScaleCorrection Class Reference

#include <EnergyScaleCorrection.h>

Classes
class	CorrectionCategory
class	ScaleCorrection
struct	SmearCorrection
class	Sorter

Public Types
enum	FileFormat { UNKNOWN =0, GLOBE, ECALELF_TOY, ECALELF }
enum	ParamSmear { kNone = 0, kRho, kPhi, kNParamSmear }
enum	ScaleNuisances {   kErrStatBitNr = 0, kErrSystBitNr = 1, kErrGainBitNr = 2, kErrNrBits =3,   kErrNone = 0, kErrStat = 1, kErrSyst = 2, kErrGain = 4,   kErrStatSyst = 3, kErrStatGain = 5, kErrSystGain = 6, kErrStatSystGain = 7 }

Public Member Functions
	EnergyScaleCorrection (const std::string &correctionFileName, unsigned int genSeed=0)
	EnergyScaleCorrection ()
const ScaleCorrection *	getScaleCorr (unsigned int runnr, double et, double eta, double r9, unsigned int gainSeed) const
const SmearCorrection *	getSmearCorr (unsigned int runnr, double et, double eta, double r9, unsigned int gainSeed) const
float	scaleCorr (unsigned int runnr, double et, double eta, double r9, unsigned int gainSeed=12, std::bitset< kErrNrBits > uncBitMask=kErrNone) const
float	scaleCorrUncert (unsigned int runnr, double et, double eta, double r9, unsigned int gainSeed, std::bitset< kErrNrBits > uncBitMask=kErrNone) const
void	setSmearingType (FileFormat value)
float	smearingSigma (int runnr, double et, double eta, double r9, unsigned int gainSeed, ParamSmear par, float nSigma=0.) const
float	smearingSigma (int runnr, double et, double eta, double r9, unsigned int gainSeed, float nSigmaRho, float nSigmaPhi) const
	~EnergyScaleCorrection ()

Private Member Functions
void	addScale (const std::string &category, int runMin, int runMax, double deltaP, double errDeltaP, double errSystDeltaP, double errDeltaPGain)
void	addSmearing (const std::string &category, int runMin, int runMax, double rho, double errRho, double phi, double errPhi, double eMean, double errEMean)
void	readScalesFromFile (const std::string &filename)
void	readSmearingsFromFile (const std::string &filename)

Private Attributes
std::vector< std::pair< CorrectionCategory, ScaleCorrection > >	scales_
std::vector< std::pair< CorrectionCategory, SmearCorrection > >	smearings_
FileFormat	smearingType_

Static Private Attributes
static constexpr float	kDefaultScaleVal_ = 1.0
static constexpr float	kDefaultSmearVal_ = 0.0

Detailed Description

Definition at line 19 of file EnergyScaleCorrection.h.

Member Enumeration Documentation

enum EnergyScaleCorrection::FileFormat

Enumerator
UNKNOWN
GLOBE
ECALELF_TOY
ECALELF

Definition at line 22 of file EnergyScaleCorrection.h.

                 {
    UNKNOWN=0,
    GLOBE,
    ECALELF_TOY,
    ECALELF
  };

enum EnergyScaleCorrection::ParamSmear

Enumerator
kNone
kRho
kPhi
kNParamSmear

Definition at line 29 of file EnergyScaleCorrection.h.

                 {
    kNone = 0,
    kRho,
    kPhi,
    kNParamSmear
  };

enum EnergyScaleCorrection::ScaleNuisances

Enumerator
kErrStatBitNr
kErrSystBitNr
kErrGainBitNr
kErrNrBits
kErrNone
kErrStat
kErrSyst
kErrGain
kErrStatSyst
kErrStatGain
kErrSystGain
kErrStatSystGain

Definition at line 36 of file EnergyScaleCorrection.h.

                     {
    kErrStatBitNr = 0,
    kErrSystBitNr = 1,
    kErrGainBitNr = 2,
    kErrNrBits=3,
    kErrNone = 0,
    kErrStat = 1,
    kErrSyst = 2,
    kErrGain = 4,
    kErrStatSyst = 3,
    kErrStatGain = 5,
    kErrSystGain = 6,
    kErrStatSystGain = 7
  };

Constructor & Destructor Documentation

EnergyScaleCorrection::EnergyScaleCorrection	(	const std::string &	correctionFileName,
		unsigned int	genSeed = 0
	)

Definition at line 11 of file EnergyScaleCorrection.cc.

References Exception, corrVsCorr::filename, readScalesFromFile(), readSmearingsFromFile(), scales_, smearings_, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                                                     :
  smearingType_(ECALELF)
{

  if(!correctionFileName.empty()) { 
    std::string filename = correctionFileName+"_scales.dat";
    readScalesFromFile(filename);
    if(scales_.empty()) {
      throw cms::Exception("EnergyScaleCorrection") << "scale correction map empty";
    }
  }
  
  if(!correctionFileName.empty()) { 
    std::string filename = correctionFileName+"_smearings.dat";
    readSmearingsFromFile(filename);
    if(smearings_.empty()) {
      throw cms::Exception("EnergyScaleCorrection") << "smearing correction map empty";
    }
  }

}

EnergyScaleCorrection::EnergyScaleCorrection ( )

inline

Definition at line 134 of file EnergyScaleCorrection.h.

{};

EnergyScaleCorrection::~EnergyScaleCorrection ( )

inline

Definition at line 135 of file EnergyScaleCorrection.h.

References addScale(), addSmearing(), python.rootplot.argparse::category, stringResolutionProvider_cfi::et, PVValHelper::eta, corrVsCorr::filename, getScaleCorr(), getSmearCorr(), kErrNone, gsfElectronCkfTrackCandidateMaker_cff::nSigma, nSigmaPhi, phi, electrons_cff::r9, readScalesFromFile(), readSmearingsFromFile(), rho, scaleCorr(), scaleCorrUncert(), setSmearingType(), smearingSigma(), and AlCaHLTBitMon_QueryRunRegistry::string.

{}

Member Function Documentation

void EnergyScaleCorrection::addScale ( const std::string &  category, int  runMin, int  runMax, double  deltaP, double  errDeltaP, double  errSystDeltaP, double  errDeltaPGain  )

private

Definition at line 127 of file EnergyScaleCorrection.cc.

References eostools::cat(), corr, Exception, mps_fire::result, and scales_.

Referenced by readScalesFromFile(), and ~EnergyScaleCorrection().

{
  
  CorrectionCategory cat(category,runMin,runMax); // build the category from the string
  auto result = std::equal_range(scales_.begin(),scales_.end(),cat,Sorter<CorrectionCategory,ScaleCorrection>());
  if(result.first!=result.second){
    throw cms::Exception("ConfigError") << "Category already defined! "<<cat;
  }
  
  ScaleCorrection corr(energyScale,energyScaleErrStat,energyScaleErrSyst,energyScaleErrGain);
  scales_.push_back({cat,corr});
  std::sort(scales_.begin(),scales_.end(),Sorter<CorrectionCategory,ScaleCorrection>()); 
  
}

void EnergyScaleCorrection::addSmearing ( const std::string &  category, int  runMin, int  runMax, double  rho, double  errRho, double  phi, double  errPhi, double  eMean, double  errEMean  )

private

Definition at line 144 of file EnergyScaleCorrection.cc.

References eostools::cat(), corr, Exception, and smearings_.

Referenced by readSmearingsFromFile(), and ~EnergyScaleCorrection().

{
  CorrectionCategory cat(category);
  
  auto res = std::equal_range(smearings_.begin(),smearings_.end(),cat,Sorter<CorrectionCategory,SmearCorrection>()); 

  if(res.first!=res.second) {
    throw cms::Exception("EnergyScaleCorrection") << "Smearing category already defined "<<cat;
  }
  
  SmearCorrection corr(rho,errRho,phi,errPhi,eMean,errEMean);
  smearings_.push_back({cat,corr});
  std::sort(smearings_.begin(),smearings_.end(),Sorter<CorrectionCategory,SmearCorrection>());
}

const EnergyScaleCorrection::ScaleCorrection * EnergyScaleCorrection::getScaleCorr	(	unsigned int	runnr,
		double	et,
		double	eta,
		double	r9,
		unsigned int	gainSeed
	)		const

Definition at line 75 of file EnergyScaleCorrection.cc.

References python.rootplot.argparse::category, SoftLeptonByDistance_cfi::distance, Exception, mps_fire::result, and scales_.

Referenced by PhotonEnergyCalibrator::calibrate(), ElectronEnergyCalibrator::calibrate(), scaleCorr(), scaleCorrUncert(), and ~EnergyScaleCorrection().

{

  // buld the category based on the values of the object
  CorrectionCategory category(runnr, et, eta, r9, gainSeed);
  auto result = std::equal_range(scales_.begin(),scales_.end(),category,Sorter<CorrectionCategory,ScaleCorrection>()); 
  auto nrFound = std::distance(result.first,result.second);
  if(nrFound==0){
    edm::LogInfo("EnergyScaleCorrection") << "Scale category not found: " << category << " Returning uncorrected value.";
    return nullptr;
  }else if(nrFound>1){
    std::ostringstream foundCats;
    for(auto it = result.first;it!=result.second;++it){
      foundCats<<"    "<<it->first<<std::endl;
    }
    throw cms::Exception("ConfigError") <<" scale error category "<<category<<" has "<<nrFound<<" entries "<<std::endl<<foundCats.str();
  }  
  //validate the result, just to be sure
  if(!result.first->first.inCategory(runnr,et,eta,r9,gainSeed)){
    throw cms::Exception("LogicError") <<" error found scale category "<<result.first->first<<" that does not contain run "<<runnr<<" et "<<et<<" eta "<<eta<<" r9 "<<r9<<" gain seed "<<gainSeed;
  }
  return &result.first->second;
}

const EnergyScaleCorrection::SmearCorrection * EnergyScaleCorrection::getSmearCorr	(	unsigned int	runnr,
		double	et,
		double	eta,
		double	r9,
		unsigned int	gainSeed
	)		const

Definition at line 101 of file EnergyScaleCorrection.cc.

References python.rootplot.argparse::category, SoftLeptonByDistance_cfi::distance, Exception, mps_fire::result, and smearings_.

Referenced by PhotonEnergyCalibrator::calibrate(), ElectronEnergyCalibrator::calibrate(), smearingSigma(), and ~EnergyScaleCorrection().

{

  // buld the category based on the values of the object
  CorrectionCategory category(runnr, et, eta, r9, gainSeed);
  auto result = std::equal_range(smearings_.begin(),smearings_.end(),category,Sorter<CorrectionCategory,SmearCorrection>()); 
  auto nrFound = std::distance(result.first,result.second);
  if(nrFound==0){
    edm::LogInfo("EnergyScaleCorrection") << "Smear category not found: " << category << " Returning uncorrected value.";
    return nullptr;
  }else if(nrFound>1){
    std::ostringstream foundCats;
    for(auto it = result.first;it!=result.second;++it){
      foundCats<<"    "<<it->first<<std::endl;
    }
    throw cms::Exception("ConfigError") <<" error smear category "<<category<<" has "<<nrFound<<" entries "<<std::endl<<foundCats.str();
  }
  //validate the result, just to be sure
  if(!result.first->first.inCategory(runnr,et,eta,r9,gainSeed)){
    throw cms::Exception("LogicError") <<" error found smear category "<<result.first->first<<" that does not contain run "<<runnr<<" et "<<et<<" eta "<<eta<<" r9 "<<r9<<" gain seed "<<gainSeed;
  }
  return &result.first->second;
}

void EnergyScaleCorrection::readScalesFromFile ( const std::string &  filename )

private

Definition at line 172 of file EnergyScaleCorrection.cc.

References addScale(), python.rootplot.argparse::category, Exception, FrontierConditions_GlobalTag_cff::file, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by EnergyScaleCorrection(), and ~EnergyScaleCorrection().

{
  std::ifstream file(edm::FileInPath(filename).fullPath().c_str());
  
  if(!file.good()) {
    throw cms::Exception("EnergyScaleCorrection") << "file " << filename << " not readable.";
  }
  
  int runMin, runMax;
  std::string category, region2;
  double energyScale, energyScaleErr, energyScaleErrStat, energyScaleErrSyst, energyScaleErrGain;
  
  for(file >> category; file.good(); file >> category) {
    file >> region2
     >> runMin >> runMax
     >> energyScale >> energyScaleErr >> energyScaleErrStat >> energyScaleErrSyst >> energyScaleErrGain;
    addScale(category, runMin, runMax, energyScale, energyScaleErrStat, energyScaleErrSyst, energyScaleErrGain);
  }
  
  file.close();  
  return;
}

void EnergyScaleCorrection::readSmearingsFromFile ( const std::string &  filename )

private

Definition at line 197 of file EnergyScaleCorrection.cc.

References addSmearing(), python.rootplot.argparse::category, ECALELF, ALCARECOTkAlBeamHalo_cff::etaMax, ALCARECOTkAlBeamHalo_cff::etaMin, Exception, FrontierConditions_GlobalTag_cff::file, GLOBE, M_PI_2, phi, photonValidator_cfi::r9Max, photonValidator_cfi::r9Min, rho, smearingType_, AlCaHLTBitMon_QueryRunRegistry::string, and UNKNOWN.

Referenced by EnergyScaleCorrection(), and ~EnergyScaleCorrection().

{
  std::ifstream file(edm::FileInPath(filename).fullPath().c_str());
  if(!file.good()) {
    throw cms::Exception("EnergyScaleCorrection") << "file " << filename << " not readable";
  }
  
  int runMin = 0;
  int runMax = 900000;
  int unused = 0;
  std::string category, region2;
  double rho, phi, eMean, errRho, errPhi, errEMean;
  double etaMin, etaMax, r9Min, r9Max;
  std::string phiString, errPhiString;
  
  while(file.peek() != EOF && file.good()) {
    if(file.peek() == 10) { // 10 = \n
      file.get();
      continue;
    }
    
    if(file.peek() == 35) { // 35 = #
      file.ignore(1000, 10); // ignore the rest of the line until \n
      continue;
    }
    
    if(smearingType_ == UNKNOWN) { // trying to guess: not recommended
      throw cms::Exception("ConfigError") <<"unknown smearing type";
      
    }else if(smearingType_ == GLOBE) {
      file >> category >> unused >> etaMin >> etaMax >> r9Min >> r9Max >> runMin >> runMax >>
    eMean >> errEMean >>
    rho >> errRho >> phi >> errPhi;
      
      addSmearing(category, runMin, runMax, rho,  errRho, phi, errPhi, eMean, errEMean);
      
    } else if(smearingType_ == ECALELF) {
      file >> category >> 
    eMean >> errEMean >>
    rho >> errRho >> phiString >> errPhiString;
      
      if(phiString=="M_PI_2") phi=M_PI_2;
      else phi = std::stod(phiString);
      
      if(errPhiString=="M_PI_2") errPhi=M_PI_2;
      else errPhi = std::stod(errPhiString);
      
      addSmearing(category, runMin, runMax, rho,  errRho, phi, errPhi, eMean, errEMean);
      
    } else {
      file >> category >> rho >> phi;
      errRho = errPhi = eMean = errEMean = 0;
      addSmearing(category, runMin, runMax, rho,  errRho, phi, errPhi, eMean, errEMean);
    }

  }
  
  file.close();
  return;
}

float EnergyScaleCorrection::scaleCorr	(	unsigned int	runnr,
		double	et,
		double	eta,
		double	r9,
		unsigned int	gainSeed = 12,
		std::bitset< kErrNrBits >	uncBitMask = kErrNone
	)		const

Definition at line 33 of file EnergyScaleCorrection.cc.

References getScaleCorr(), kDefaultScaleVal_, and EnergyScaleCorrection::ScaleCorrection::scale().

Referenced by scaleCorrUncert(), and ~EnergyScaleCorrection().

{
  const ScaleCorrection* scaleCorr =  getScaleCorr(runNumber, et, eta, r9, gainSeed);
  if(scaleCorr!=nullptr) return scaleCorr->scale();
  else return kDefaultScaleVal_;
}

float EnergyScaleCorrection::scaleCorrUncert	(	unsigned int	runnr,
		double	et,
		double	eta,
		double	r9,
		unsigned int	gainSeed,
		std::bitset< kErrNrBits >	uncBitMask = kErrNone
	)		const

Definition at line 43 of file EnergyScaleCorrection.cc.

References getScaleCorr(), scaleCorr(), and EnergyScaleCorrection::ScaleCorrection::scaleErr().

Referenced by ~EnergyScaleCorrection().

{
  
  const ScaleCorrection* scaleCorr = getScaleCorr(runNumber, et, eta, r9, gainSeed);
  if(scaleCorr!=nullptr) return scaleCorr->scaleErr(uncBitMask);
  else return 0.;
}

void EnergyScaleCorrection::setSmearingType

(

FileFormat

value

)

Definition at line 163 of file EnergyScaleCorrection.cc.

References smearingType_, UNKNOWN, and relativeConstraints::value.

Referenced by ~EnergyScaleCorrection().

{
  if(value >= 0 && value <= 1) {
    smearingType_ = value;
  } else {
    smearingType_ = UNKNOWN;
  }
}

float EnergyScaleCorrection::smearingSigma	(	int	runnr,
		double	et,
		double	eta,
		double	r9,
		unsigned int	gainSeed,
		ParamSmear	par,
		float	nSigma = 0.
	)		const

Definition at line 53 of file EnergyScaleCorrection.cc.

References kPhi, and kRho.

Referenced by ~EnergyScaleCorrection().

{
  if (par == kRho) return smearingSigma(runnr, et, eta, r9, gainSeed, nSigma, 0.);
  if (par == kPhi) return smearingSigma(runnr, et, eta, r9, gainSeed, 0., nSigma);
  return smearingSigma(runnr, et, eta, r9, gainSeed, 0., 0.);
}

float EnergyScaleCorrection::smearingSigma	(	int	runnr,
		double	et,
		double	eta,
		double	r9,
		unsigned int	gainSeed,
		float	nSigmaRho,
		float	nSigmaPhi
	)		const

Definition at line 63 of file EnergyScaleCorrection.cc.

References getSmearCorr(), kDefaultSmearVal_, and EnergyScaleCorrection::SmearCorrection::sigma().

{
  const SmearCorrection* smearCorr = getSmearCorr(runnr,et,eta,r9,gainSeed);
                          
  if(smearCorr!=nullptr) return smearCorr->sigma(nrSigmaRho,nrSigmaPhi);
  else return kDefaultSmearVal_;
}

Member Data Documentation

constexpr float EnergyScaleCorrection::kDefaultScaleVal_ = 1.0

staticprivate

Definition at line 164 of file EnergyScaleCorrection.h.

Referenced by scaleCorr().

constexpr float EnergyScaleCorrection::kDefaultSmearVal_ = 0.0

staticprivate

Definition at line 165 of file EnergyScaleCorrection.h.

Referenced by smearingSigma().

std::vector<std::pair<CorrectionCategory,ScaleCorrection> > EnergyScaleCorrection::scales_

private

Definition at line 169 of file EnergyScaleCorrection.h.

Referenced by addScale(), EnergyScaleCorrection(), and getScaleCorr().

std::vector<std::pair<CorrectionCategory,SmearCorrection> > EnergyScaleCorrection::smearings_

private

Definition at line 170 of file EnergyScaleCorrection.h.

Referenced by addSmearing(), EnergyScaleCorrection(), and getSmearCorr().

FileFormat EnergyScaleCorrection::smearingType_

private

Definition at line 168 of file EnergyScaleCorrection.h.

Referenced by readSmearingsFromFile(), and setSmearingType().