Inheritance diagram for EGRegressionModifierV3:

Classes
struct	EleRegs

struct	PhoRegs

Public Member Functions
	EGRegressionModifierV3 (const edm::ParameterSet &conf, edm::ConsumesCollector &cc)

void	modifyObject (pat::Electron &) const final

void	modifyObject (pat::Photon &) const final

void	modifyObject (reco::GsfElectron &) const final

void	modifyObject (reco::Photon &) const final

void	setEvent (const edm::Event &) final

void	setEventContent (const edm::EventSetup &) final

	~EGRegressionModifierV3 () override

Public Member Functions inherited from ModifyObjectValueBase
virtual void	modifyObject (pat::Jet &) const

virtual void	modifyObject (pat::Muon &) const

virtual void	modifyObject (pat::Tau &) const

virtual void	modifyObject (reco::BaseTau &) const

virtual void	modifyObject (reco::Jet &) const

virtual void	modifyObject (reco::Muon &) const

	ModifyObjectValueBase (const edm::ParameterSet &conf)

const std::string &	name () const

virtual	~ModifyObjectValueBase ()

Private Member Functions
std::array< float, 32 >	getRegData (const reco::GsfElectron &ele) const

std::array< float, 32 >	getRegData (const reco::Photon &pho) const

void	getSeedCrysCoord (const reco::CaloCluster &clus, int &iEtaOrX, int &iPhiOrY) const

Private Attributes
edm::ESHandle< CaloGeometry >	caloGeomHandle_

std::unique_ptr< EleRegs >	eleRegs_

float	maxRawEnergyForLowPtEBSigma_

float	maxRawEnergyForLowPtEESigma_

std::unique_ptr< PhoRegs >	phoRegs_

edm::EDGetTokenT< double >	rhoToken_

float	rhoValue_

bool	useClosestToCentreSeedCrysDef_

Detailed Description

Definition at line 22 of file EGRegressionModifierV3.cc.

Constructor & Destructor Documentation

◆ EGRegressionModifierV3()

EGRegressionModifierV3::EGRegressionModifierV3	(	const edm::ParameterSet &	conf,
		edm::ConsumesCollector &	cc
	)

Definition at line 71 of file EGRegressionModifierV3.cc.

     : ModifyObjectValueBase(conf),
       rhoValue_(0.),
       rhoToken_(cc.consumes(conf.getParameter<edm::InputTag>("rhoTag"))),
       useClosestToCentreSeedCrysDef_(conf.getParameter<bool>("useClosestToCentreSeedCrysDef")),
       maxRawEnergyForLowPtEBSigma_(conf.getParameter<double>("maxRawEnergyForLowPtEBSigma")),
       maxRawEnergyForLowPtEESigma_(conf.getParameter<double>("maxRawEnergyForLowPtEESigma")) {
   if (conf.exists("eleRegs")) {
     eleRegs_ = std::make_unique<EleRegs>(conf.getParameterSet("eleRegs"), cc);
   }
   if (conf.exists("phoRegs")) {
     phoRegs_ = std::make_unique<PhoRegs>(conf.getParameterSet("phoRegs"), cc);
   }
 }

References eleRegs_, edm::ParameterSet::exists(), edm::ParameterSet::getParameterSet(), and phoRegs_.

◆ ~EGRegressionModifierV3()

EGRegressionModifierV3::~EGRegressionModifierV3 ( )

override

Definition at line 86 of file EGRegressionModifierV3.cc.

86 {}

Member Function Documentation

◆ getRegData() [1/2]

std::array< float, 32 > EGRegressionModifierV3::getRegData ( const reco::GsfElectron & ele ) const

private

Definition at line 199 of file EGRegressionModifierV3.cc.

                                                                                        {
   std::array<float, 32> data;
  
   const reco::SuperClusterRef& superClus = ele.superCluster();
   const edm::Ptr<reco::CaloCluster>& seedClus = superClus->seed();
  
   const bool isEB = ele.isEB();
   const double rawEnergy = superClus->rawEnergy();
   const double rawESEnergy = superClus->preshowerEnergy();
   const int numberOfClusters = superClus->clusters().size();
   const auto& ssFull5x5 = ele.full5x5_showerShape();
  
   float e5x5Inverse = ssFull5x5.e5x5 != 0. ? vdt::fast_inv(ssFull5x5.e5x5) : 0.;
  
   data[0] = rawEnergy;
   data[1] = superClus->etaWidth();
   data[2] = superClus->phiWidth();
   data[3] = superClus->seed()->energy() / rawEnergy;
   data[4] = ssFull5x5.e5x5 / rawEnergy;
   data[5] = ele.hcalOverEcalBc();
   data[6] = rhoValue_;
   data[7] = seedClus->eta() - superClus->position().Eta();
   data[8] = reco::deltaPhi(seedClus->phi(), superClus->position().Phi());
   data[9] = ssFull5x5.r9;
   data[10] = ssFull5x5.sigmaIetaIeta;
   data[11] = ssFull5x5.sigmaIetaIphi;
   data[12] = ssFull5x5.sigmaIphiIphi;
   data[13] = ssFull5x5.eMax * e5x5Inverse;
   data[14] = ssFull5x5.e2nd * e5x5Inverse;
   data[15] = ssFull5x5.eTop * e5x5Inverse;
   data[16] = ssFull5x5.eBottom * e5x5Inverse;
   data[17] = ssFull5x5.eLeft * e5x5Inverse;
   data[18] = ssFull5x5.eRight * e5x5Inverse;
   data[19] = ssFull5x5.e2x5Max * e5x5Inverse;
   data[20] = ssFull5x5.e2x5Left * e5x5Inverse;
   data[21] = ssFull5x5.e2x5Right * e5x5Inverse;
   data[22] = ssFull5x5.e2x5Top * e5x5Inverse;
   data[23] = ssFull5x5.e2x5Bottom * e5x5Inverse;
   data[24] = ele.nSaturatedXtals();
   data[25] = std::max(0, numberOfClusters);
  
   if (isEB) {
     int iEta, iPhi;
     getSeedCrysCoord(*seedClus, iEta, iPhi);
     int signIEta = iEta > 0 ? +1 : -1;
     data[26] = iEta;
     data[27] = iPhi;
     data[28] = (iEta - signIEta) % 5;
     data[29] = (iPhi - 1) % 2;
     const int iEtaCorr = iEta - (iEta > 0 ? +1 : -1);
     const int iEtaCorr26 = iEta - (iEta > 0 ? +26 : -26);
     data[30] = std::abs(iEta) <= 25 ? iEtaCorr % 20 : iEtaCorr26 % 20;
     data[31] = (iPhi - 1) % 20;
   } else {
     int iX, iY;
     getSeedCrysCoord(*seedClus, iX, iY);
     data[26] = iX;
     data[27] = iY;
     data[28] = rawESEnergy / rawEnergy;
   }
  
   return data;
 }

References funct::abs(), data, reco::deltaPhi(), reco::GsfElectron::ShowerShape::e5x5, reco::CaloCluster::eta(), reco::GsfElectron::full5x5_showerShape(), getSeedCrysCoord(), reco::GsfElectron::hcalOverEcalBc(), L1TowerCalibrationProducer_cfi::iEta, reco::GsfElectron::isEB(), SiStripPI::max, reco::GsfElectron::nSaturatedXtals(), reco::CaloCluster::phi(), rhoValue_, and reco::GsfElectron::superCluster().

Referenced by modifyObject().

◆ getRegData() [2/2]

std::array< float, 32 > EGRegressionModifierV3::getRegData ( const reco::Photon & pho ) const

private

Definition at line 263 of file EGRegressionModifierV3.cc.

                                                                                   {
   std::array<float, 32> data;
  
   const reco::SuperClusterRef& superClus = pho.superCluster();
   const edm::Ptr<reco::CaloCluster>& seedClus = superClus->seed();
  
   const bool isEB = pho.isEB();
   const double rawEnergy = superClus->rawEnergy();
   const double rawESEnergy = superClus->preshowerEnergy();
   const int numberOfClusters = superClus->clusters().size();
   const auto& ssFull5x5 = pho.full5x5_showerShapeVariables();
  
   float e5x5Inverse = ssFull5x5.e5x5 != 0. ? vdt::fast_inv(ssFull5x5.e5x5) : 0.;
  
   data[0] = rawEnergy;
   data[1] = superClus->etaWidth();
   data[2] = superClus->phiWidth();
   data[3] = superClus->seed()->energy() / rawEnergy;
   data[4] = ssFull5x5.e5x5 / rawEnergy;
   //interestingly enough this differs from electrons where it uses cone based
   //naively Sam would have thought using cone based is even worse than tower based
   data[5] = pho.hadronicOverEm();
   data[6] = rhoValue_;
   data[7] = seedClus->eta() - superClus->position().Eta();
   data[8] = reco::deltaPhi(seedClus->phi(), superClus->position().Phi());
   data[9] = pho.full5x5_r9();
   data[10] = ssFull5x5.sigmaIetaIeta;
   //interestingly sigmaIEtaIPhi differs in defination here from
   //electron & sc definations of sigmaIEtaIPhi
   data[11] = ssFull5x5.sigmaIetaIphi;
   data[12] = ssFull5x5.sigmaIphiIphi;
   data[13] = ssFull5x5.maxEnergyXtal * e5x5Inverse;
   data[14] = ssFull5x5.e2nd * e5x5Inverse;
   data[15] = ssFull5x5.eTop * e5x5Inverse;
   data[16] = ssFull5x5.eBottom * e5x5Inverse;
   data[17] = ssFull5x5.eLeft * e5x5Inverse;
   data[18] = ssFull5x5.eRight * e5x5Inverse;
   data[19] = ssFull5x5.e2x5Max * e5x5Inverse;
   data[20] = ssFull5x5.e2x5Left * e5x5Inverse;
   data[21] = ssFull5x5.e2x5Right * e5x5Inverse;
   data[22] = ssFull5x5.e2x5Top * e5x5Inverse;
   data[23] = ssFull5x5.e2x5Bottom * e5x5Inverse;
   data[24] = pho.nSaturatedXtals();
   data[25] = std::max(0, numberOfClusters);
  
   if (isEB) {
     int iEta, iPhi;
     getSeedCrysCoord(*seedClus, iEta, iPhi);
     data[26] = iEta;
     data[27] = iPhi;
     int signIEta = iEta > 0 ? +1 : -1;
     data[28] = (iEta - signIEta) % 5;
     data[29] = (iPhi - 1) % 2;
     const int iEtaCorr = iEta - (iEta > 0 ? +1 : -1);
     const int iEtaCorr26 = iEta - (iEta > 0 ? +26 : -26);
     data[30] = std::abs(iEta) <= 25 ? iEtaCorr % 20 : iEtaCorr26 % 20;
     data[31] = (iPhi - 1) % 20;
   } else {
     int iX, iY;
     getSeedCrysCoord(*seedClus, iX, iY);
     data[26] = iX;
     data[27] = iY;
     data[28] = rawESEnergy / rawEnergy;
   }
  
   return data;
 }

References funct::abs(), data, reco::deltaPhi(), reco::Photon::ShowerShape::e5x5, reco::CaloCluster::eta(), reco::Photon::full5x5_r9(), reco::Photon::full5x5_showerShapeVariables(), getSeedCrysCoord(), reco::Photon::hadronicOverEm(), L1TowerCalibrationProducer_cfi::iEta, reco::Photon::isEB(), SiStripPI::max, reco::Photon::nSaturatedXtals(), reco::CaloCluster::phi(), rhoValue_, and reco::Photon::superCluster().

◆ getSeedCrysCoord()

void EGRegressionModifierV3::getSeedCrysCoord	(	const reco::CaloCluster &	clus,
		int &	iEtaOrX,
		int &	iPhiOrY
	)		const

private

Definition at line 331 of file EGRegressionModifierV3.cc.

                                                                                                            {
   iEtaOrX = 0;
   iPhiOrY = 0;
  
   const bool isEB = clus.seed().subdetId() == EcalBarrel;
  
   if (useClosestToCentreSeedCrysDef_) {
     float dummy;
     if (isEB) {
       egammaTools::localEcalClusterCoordsEB(clus, *caloGeomHandle_, dummy, dummy, iEtaOrX, iPhiOrY, dummy, dummy);
     } else {
       egammaTools::localEcalClusterCoordsEE(clus, *caloGeomHandle_, dummy, dummy, iEtaOrX, iPhiOrY, dummy, dummy);
     }
   } else {
     if (isEB) {
       const EBDetId ebId(clus.seed());
       iEtaOrX = ebId.ieta();
       iPhiOrY = ebId.iphi();
     } else {
       const EEDetId eeId(clus.seed());
       iEtaOrX = eeId.ix();
       iPhiOrY = eeId.iy();
     }
   }
 }

References caloGeomHandle_, EcalBarrel, EBDetId::ieta(), EEDetId::ix(), egammaTools::localEcalClusterCoordsEB(), egammaTools::localEcalClusterCoordsEE(), reco::CaloCluster::seed(), DetId::subdetId(), and useClosestToCentreSeedCrysDef_.

Referenced by getRegData().

◆ modifyObject() [1/4]

void EGRegressionModifierV3::modifyObject ( pat::Electron & ele ) const

finalvirtual

Reimplemented from ModifyObjectValueBase.

Definition at line 152 of file EGRegressionModifierV3.cc.

                                                                 {
   modifyObject(static_cast<reco::GsfElectron&>(ele));
 }

References modifyObject().

◆ modifyObject() [2/4]

void EGRegressionModifierV3::modifyObject ( pat::Photon & pho ) const

finalvirtual

Reimplemented from ModifyObjectValueBase.

Definition at line 197 of file EGRegressionModifierV3.cc.

197 { modifyObject(static_cast<reco::Photon&>(pho)); }

References modifyObject().

◆ modifyObject() [3/4]

void EGRegressionModifierV3::modifyObject ( reco::GsfElectron & ele ) const

finalvirtual

Reimplemented from ModifyObjectValueBase.

Definition at line 99 of file EGRegressionModifierV3.cc.

                                                                     {
   //check if we have specified an electron regression correction and
   //return the object unmodified if so
   if (!eleRegs_)
     return;
  
   const reco::SuperClusterRef& superClus = ele.superCluster();
  
   // skip HGCAL for now
   if (superClus->seed()->seed().det() == DetId::Forward)
     return;
  
   // do not apply corrections in case of missing info (slimmed MiniAOD electrons)
   if (!superClus->clusters().isAvailable())
     return;
  
   //check if fbrem is filled as its needed for E/p combination so abort if its set to the default value
   //this will be the case for <5 (or current cuts) for miniAOD electrons
   if (ele.fbrem() == reco::GsfElectron::ClassificationVariables::kDefaultValue)
     return;
  
   auto regData = getRegData(ele);
   const float rawEnergy = superClus->rawEnergy();
   const float rawESEnergy = superClus->preshowerEnergy();
   //bug here, it should include the ES, kept for backwards compat
   const float rawEt = rawEnergy * superClus->position().rho() / superClus->position().r();
   const bool isSaturated = ele.nSaturatedXtals() != 0;
  
   const float ecalMean = eleRegs_->ecalOnlyMean(rawEt, ele.isEB(), isSaturated, regData.data());
   const float ecalMeanCorr = ecalMean > 0. ? ecalMean : 1.0;
   //as the sample is trained flat in pt, the regression's only source of very high energy
   //electrons is in the high endcap and therefore it gives a very poor resolution estimate
   //to any electrons with this energy, regardless of their actual eta
   //hence this lovely hack
   if (ele.isEB() && maxRawEnergyForLowPtEBSigma_ >= 0 && eleRegs_->ecalOnlySigma.useLowEtBin(rawEt, isSaturated)) {
     regData[0] = std::min(regData[0], maxRawEnergyForLowPtEBSigma_);
   }
   if (!ele.isEB() && maxRawEnergyForLowPtEESigma_ >= 0 && eleRegs_->ecalOnlySigma.useLowEtBin(rawEt, isSaturated)) {
     regData[0] = std::min(regData[0], maxRawEnergyForLowPtEESigma_);
   }
   const float ecalSigma = eleRegs_->ecalOnlySigma(rawEt, ele.isEB(), isSaturated, regData.data());
  
   const float corrEnergy = (rawEnergy + rawESEnergy) * ecalMeanCorr;
   const float corrEnergyErr = corrEnergy * ecalSigma;
  
   ele.setCorrectedEcalEnergy(corrEnergy);
   ele.setCorrectedEcalEnergyError(corrEnergyErr);
  
   std::pair<float, float> combEnergyAndErr = eleRegs_->epComb.combine(ele);
   const math::XYZTLorentzVector newP4 = ele.p4() * combEnergyAndErr.first / ele.p4().t();
   ele.correctMomentum(newP4, ele.trackMomentumError(), combEnergyAndErr.second);
 }

References reco::GsfElectron::correctMomentum(), eleRegs_, reco::GsfElectron::fbrem(), DetId::Forward, getRegData(), edm::Ref< C, T, F >::isAvailable(), reco::GsfElectron::isEB(), CastorSimpleRecAlgoImpl::isSaturated(), reco::GsfElectron::ClassificationVariables::kDefaultValue, maxRawEnergyForLowPtEBSigma_, maxRawEnergyForLowPtEESigma_, min(), reco::GsfElectron::nSaturatedXtals(), reco::GsfElectron::p4(), reco::GsfElectron::setCorrectedEcalEnergy(), reco::GsfElectron::setCorrectedEcalEnergyError(), reco::GsfElectron::superCluster(), and reco::GsfElectron::trackMomentumError().

Referenced by modifyObject().

◆ modifyObject() [4/4]

void EGRegressionModifierV3::modifyObject ( reco::Photon & pho ) const

finalvirtual

Reimplemented from ModifyObjectValueBase.

Definition at line 156 of file EGRegressionModifierV3.cc.

                                                                {
   //check if we have specified an photon regression correction and
   //return the object unmodified if so
   if (!phoRegs_)
     return;
  
   const reco::SuperClusterRef& superClus = pho.superCluster();
  
   // skip HGCAL for now
   if (superClus->seed()->seed().det() == DetId::Forward)
     return;
  
   // do not apply corrections in case of missing info (happens for some slimmed MiniAOD photons)
   if (!superClus->clusters().isAvailable())
     return;
  
   auto regData = getRegData(pho);
  
   const float rawEnergy = superClus->rawEnergy();
   const float rawESEnergy = superClus->preshowerEnergy();
   //bug here, it should include the ES, kept for backwards compat
   const float rawEt = rawEnergy * superClus->position().rho() / superClus->position().r();
   const bool isSaturated = pho.nSaturatedXtals();
   const float ecalMean = phoRegs_->ecalOnlyMean(rawEt, pho.isEB(), isSaturated, regData.data());
   const float ecalMeanCorr = ecalMean > 0. ? ecalMean : 1.0;
  
   //see the electrons for explaination of this lovely feature
   if (pho.isEB() && maxRawEnergyForLowPtEBSigma_ >= 0 && phoRegs_->ecalOnlySigma.useLowEtBin(rawEt, isSaturated)) {
     regData[0] = std::min(regData[0], maxRawEnergyForLowPtEBSigma_);
   }
   if (!pho.isEB() && maxRawEnergyForLowPtEESigma_ >= 0 && phoRegs_->ecalOnlySigma.useLowEtBin(rawEt, isSaturated)) {
     regData[0] = std::min(regData[0], maxRawEnergyForLowPtEESigma_);
   }
   const float ecalSigma = phoRegs_->ecalOnlySigma(rawEt, pho.isEB(), isSaturated, regData.data());
  
   const double corrEnergy = (rawEnergy + rawESEnergy) * ecalMeanCorr;
   const double corrEnergyErr = corrEnergy * ecalSigma;
  
   pho.setCorrectedEnergy(reco::Photon::P4type::regression2, corrEnergy, corrEnergyErr, true);
 }

References DetId::Forward, getRegData(), edm::Ref< C, T, F >::isAvailable(), reco::Photon::isEB(), CastorSimpleRecAlgoImpl::isSaturated(), maxRawEnergyForLowPtEBSigma_, maxRawEnergyForLowPtEESigma_, min(), reco::Photon::nSaturatedXtals(), phoRegs_, reco::Photon::setCorrectedEnergy(), and reco::Photon::superCluster().

◆ setEvent()

void EGRegressionModifierV3::setEvent ( const edm::Event & evt )

finalvirtual

Reimplemented from ModifyObjectValueBase.

Definition at line 88 of file EGRegressionModifierV3.cc.

88 { rhoValue_ = evt.get(rhoToken_); }

References edm::Event::get(), rhoToken_, and rhoValue_.

◆ setEventContent()

void EGRegressionModifierV3::setEventContent ( const edm::EventSetup & iSetup )

finalvirtual

Reimplemented from ModifyObjectValueBase.

Definition at line 90 of file EGRegressionModifierV3.cc.

                                                                         {
   if (eleRegs_)
     eleRegs_->setEventContent(iSetup);
   if (phoRegs_)
     phoRegs_->setEventContent(iSetup);
   if (useClosestToCentreSeedCrysDef_)
     iSetup.get<CaloGeometryRecord>().get(caloGeomHandle_);
 }

References caloGeomHandle_, eleRegs_, edm::EventSetup::get(), get, phoRegs_, and useClosestToCentreSeedCrysDef_.

Member Data Documentation

◆ caloGeomHandle_

edm::ESHandle<CaloGeometry> EGRegressionModifierV3::caloGeomHandle_

private

Definition at line 66 of file EGRegressionModifierV3.cc.

Referenced by getSeedCrysCoord(), and setEventContent().

◆ eleRegs_

std::unique_ptr<EleRegs> EGRegressionModifierV3::eleRegs_

private

Definition at line 57 of file EGRegressionModifierV3.cc.

Referenced by EGRegressionModifierV3(), modifyObject(), and setEventContent().

◆ maxRawEnergyForLowPtEBSigma_

float EGRegressionModifierV3::maxRawEnergyForLowPtEBSigma_

private

Definition at line 64 of file EGRegressionModifierV3.cc.

Referenced by modifyObject().

◆ maxRawEnergyForLowPtEESigma_

float EGRegressionModifierV3::maxRawEnergyForLowPtEESigma_

private

Definition at line 65 of file EGRegressionModifierV3.cc.

Referenced by modifyObject().

◆ phoRegs_

std::unique_ptr<PhoRegs> EGRegressionModifierV3::phoRegs_

private

Definition at line 58 of file EGRegressionModifierV3.cc.

Referenced by EGRegressionModifierV3(), modifyObject(), and setEventContent().

◆ rhoToken_

edm::EDGetTokenT<double> EGRegressionModifierV3::rhoToken_

private

Definition at line 61 of file EGRegressionModifierV3.cc.

Referenced by setEvent().

◆ rhoValue_

float EGRegressionModifierV3::rhoValue_

private

Definition at line 60 of file EGRegressionModifierV3.cc.

Referenced by getRegData(), and setEvent().

◆ useClosestToCentreSeedCrysDef_

bool EGRegressionModifierV3::useClosestToCentreSeedCrysDef_

private

Definition at line 63 of file EGRegressionModifierV3.cc.

Referenced by getSeedCrysCoord(), and setEventContent().

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EGRegressionModifierV3()

◆ ~EGRegressionModifierV3()

Member Function Documentation

◆ getRegData() [1/2]

◆ getRegData() [2/2]

◆ getSeedCrysCoord()

◆ modifyObject() [1/4]

◆ modifyObject() [2/4]

◆ modifyObject() [3/4]

◆ modifyObject() [4/4]

◆ setEvent()

◆ setEventContent()

Member Data Documentation

◆ caloGeomHandle_

◆ eleRegs_

◆ maxRawEnergyForLowPtEBSigma_

◆ maxRawEnergyForLowPtEESigma_

◆ phoRegs_

◆ rhoToken_

◆ rhoValue_

◆ useClosestToCentreSeedCrysDef_