#include <ElectronMVAEstimatorRun2Phys14NonTrig.h>

Inheritance diagram for ElectronMVAEstimatorRun2Phys14NonTrig:

Classes
struct	AllVariables

Public Types
enum	mvaCategories { UNDEFINED = -1, CAT_EB1_PT5to10 = 0, CAT_EB2_PT5to10 = 1, CAT_EE_PT5to10 = 2, CAT_EB1_PT10plus = 3, CAT_EB2_PT10plus = 4, CAT_EE_PT10plus = 5 }

Public Member Functions
void	constrainMVAVariables (AllVariables &vars) const

	ElectronMVAEstimatorRun2Phys14NonTrig (const edm::ParameterSet &conf)

std::vector< float >	fillMVAVariables (const edm::Ptr< reco::Candidate > &particle, const edm::Event &) const override

int	findCategory (const edm::Ptr< reco::Candidate > &particle) const override

const std::string &	getName () const final

int	getNCategories () const final

const std::string &	getTag () const final

bool	isEndcapCategory (int category) const

float	mvaValue (const edm::Ptr< reco::Candidate > &particle, const edm::Event &evt) const override

	~ElectronMVAEstimatorRun2Phys14NonTrig () override

Public Member Functions inherited from AnyMVAEstimatorRun2Base
	AnyMVAEstimatorRun2Base (const edm::ParameterSet &conf)

virtual void	getEventContent (const edm::Event &iEvent) const final

template<typename... Args>
std::vector< float >	packMVAVariables (const Args...args) const

virtual void	setConsumes (edm::ConsumesCollector &&cc) const

virtual	~AnyMVAEstimatorRun2Base ()

Static Public Attributes
static int	nCategories = 6

Private Attributes
AllVariables	_allMVAVars

std::vector< std::unique_ptr< const GBRForest > >	_gbrForests

std::string	_MethodName

const std::string	_name = "ElectronMVAEstimatorRun2Phys14NonTrig"

std::string	_tag

Additional Inherited Members
Public Attributes inherited from AnyMVAEstimatorRun2Base
const edm::ParameterSet	_conf

Detailed Description

Definition at line 13 of file ElectronMVAEstimatorRun2Phys14NonTrig.h.

Member Enumeration Documentation

enum ElectronMVAEstimatorRun2Phys14NonTrig::mvaCategories

Enumerator
UNDEFINED
CAT_EB1_PT5to10
CAT_EB2_PT5to10
CAT_EE_PT5to10
CAT_EB1_PT10plus
CAT_EB2_PT10plus
CAT_EE_PT10plus

Definition at line 20 of file ElectronMVAEstimatorRun2Phys14NonTrig.h.

                      {
     UNDEFINED = -1,
     CAT_EB1_PT5to10  = 0,
     CAT_EB2_PT5to10  = 1,
     CAT_EE_PT5to10   = 2,
     CAT_EB1_PT10plus = 3,
     CAT_EB2_PT10plus = 4,
     CAT_EE_PT10plus  = 5
   };

Constructor & Destructor Documentation

ElectronMVAEstimatorRun2Phys14NonTrig::ElectronMVAEstimatorRun2Phys14NonTrig ( const edm::ParameterSet & conf )

Definition at line 10 of file ElectronMVAEstimatorRun2Phys14NonTrig.cc.

References _gbrForests, _MethodName, _tag, GBRForestTools::createGBRForest(), Exception, edm::ParameterSet::getParameter(), mps_fire::i, nCategories, AlCaHLTBitMon_QueryRunRegistry::string, electrons_cff::weightFile, mvaElectronID_Fall17_iso_V1_cff::weightFileNames, and ~ElectronMVAEstimatorRun2Phys14NonTrig().

                                                                                                        :
   AnyMVAEstimatorRun2Base(conf) {
 
   _tag = conf.getParameter<std::string>("mvaTag");
   
   const std::vector <std::string> weightFileNames
     = conf.getParameter<std::vector<std::string> >("weightFileNames");
 
   if( (int)(weightFileNames.size()) != nCategories )
     throw cms::Exception("MVA config failure: ")
       << "wrong number of weightfiles" << std::endl;
 
   _gbrForests.clear();
   _MethodName = "BDTG method";
   // Create a TMVA reader object for each category
   for(int i=0; i<nCategories; i++){
 
     // Use unique_ptr so that all readers are properly cleaned up
     // when the vector clear() is called in the destructor
 
     edm::FileInPath weightFile( weightFileNames[i] );
     _gbrForests.push_back( GBRForestTools::createGBRForest(weightFile ) );
 
   }
 
 }

ElectronMVAEstimatorRun2Phys14NonTrig::~ElectronMVAEstimatorRun2Phys14NonTrig ( )

override

Definition at line 38 of file ElectronMVAEstimatorRun2Phys14NonTrig.cc.

References mvaValue().

Referenced by ElectronMVAEstimatorRun2Phys14NonTrig().

38 {

39 }

Member Function Documentation

void ElectronMVAEstimatorRun2Phys14NonTrig::constrainMVAVariables ( AllVariables & vars ) const

Definition at line 251 of file ElectronMVAEstimatorRun2Phys14NonTrig.cc.

Referenced by fillMVAVariables(), and getTag().

                                                                                           {
 
   // Check that variables do not have crazy values
 
   if(vars.fbrem < -1.)
     vars.fbrem = -1.;
   
   vars.deta = std::abs(vars.deta);
   if(vars.deta > 0.06)
     vars.deta = 0.06;
   
   vars.dphi = std::abs(vars.dphi);
   if(vars.dphi > 0.6)
     vars.dphi = 0.6;
   
   if(vars.EoP > 20.)
     vars.EoP = 20.;
   
   if(vars.eleEoPout > 20.)
     vars.eleEoPout = 20.;
     
   vars.detacalo = std::abs(vars.detacalo);
   if(vars.detacalo > 0.2)
     vars.detacalo = 0.2;
   
   if(vars.OneMinusE1x5E5x5 < -1.)
     vars.OneMinusE1x5E5x5 = -1;
   
   if(vars.OneMinusE1x5E5x5 > 2.)
     vars.OneMinusE1x5E5x5 = 2.; 
     
   if(vars.R9 > 5)
     vars.R9 = 5;
   
   if(vars.gsfchi2 > 200.)
     vars.gsfchi2 = 200;
     
   if(vars.kfchi2 > 10.)
     vars.kfchi2 = 10.;
 }

std::vector< float > ElectronMVAEstimatorRun2Phys14NonTrig::fillMVAVariables	(	const edm::Ptr< reco::Candidate > &	particle,
		const edm::Event &
	)		const

overridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 136 of file ElectronMVAEstimatorRun2Phys14NonTrig.cc.

Referenced by getTag(), and mvaValue().

                                                                                 {
 
   // Try to cast the particle into a reco particle.
   // This should work for both reco and pat.
   const edm::Ptr<reco::GsfElectron> eleRecoPtr = ( edm::Ptr<reco::GsfElectron> )particle;
   if( eleRecoPtr.get() == nullptr )
     throw cms::Exception("MVA failure: ")
       << " given particle is expected to be reco::GsfElectron or pat::Electron," << std::endl
       << " but appears to be neither" << std::endl;
 
   // the instance of the variables that we will manipulate
   AllVariables allMVAVars;
 
   // Both pat and reco particles have exactly the same accessors, so we use a reco ptr 
   // throughout the code, with a single exception as of this writing, handled separately below.
   auto superCluster = eleRecoPtr->superCluster();
 
   // To get to CTF track information in pat::Electron, we have to have the pointer
   // to pat::Electron, it is not accessible from the pointer to reco::GsfElectron.
   // This behavior is reported and is expected to change in the future (post-7.4.5 some time).
   bool validKF= false; 
   reco::TrackRef myTrackRef = eleRecoPtr->closestCtfTrackRef();
   const edm::Ptr<pat::Electron> elePatPtr(eleRecoPtr);
   // Check if this is really a pat::Electron, and if yes, get the track ref from this new
   // pointer instead
   if( elePatPtr.get() != nullptr )
     myTrackRef = elePatPtr->closestCtfTrackRef();
   validKF = (myTrackRef.isAvailable() && (myTrackRef.isNonnull()) );  
 
   allMVAVars.kfhits         = (validKF) ? myTrackRef->hitPattern().trackerLayersWithMeasurement() : -1. ;
   // Pure ECAL -> shower shapes
   allMVAVars.see            = eleRecoPtr->full5x5_sigmaIetaIeta();
   allMVAVars.spp            = eleRecoPtr->full5x5_sigmaIphiIphi();
   allMVAVars.OneMinusE1x5E5x5 = 1. - eleRecoPtr->full5x5_e1x5() / eleRecoPtr->full5x5_e5x5();
   allMVAVars.R9             = eleRecoPtr->full5x5_r9();
   allMVAVars.etawidth       = superCluster->etaWidth();
   allMVAVars.phiwidth       = superCluster->phiWidth();
   allMVAVars.HoE            = eleRecoPtr->hadronicOverEm();
   // Endcap only variables
   allMVAVars.PreShowerOverRaw  = superCluster->preshowerEnergy() / superCluster->rawEnergy();
   //Pure tracking variables
   allMVAVars.kfchi2          = (validKF) ? myTrackRef->normalizedChi2() : 0;
   allMVAVars.gsfchi2         = eleRecoPtr->gsfTrack()->normalizedChi2();
   // Energy matching
   allMVAVars.fbrem           = eleRecoPtr->fbrem();
   allMVAVars.EoP             = eleRecoPtr->eSuperClusterOverP();
   allMVAVars.eleEoPout       = eleRecoPtr->eEleClusterOverPout();
   allMVAVars.IoEmIoP         = (1.0/eleRecoPtr->ecalEnergy()) - (1.0 / eleRecoPtr->p());
   // Geometrical matchings
   allMVAVars.deta            = eleRecoPtr->deltaEtaSuperClusterTrackAtVtx();
   allMVAVars.dphi            = eleRecoPtr->deltaPhiSuperClusterTrackAtVtx();
   allMVAVars.detacalo        = eleRecoPtr->deltaEtaSeedClusterTrackAtCalo();
   // Spectator variables  
   allMVAVars.pt              = eleRecoPtr->pt();
   const float scEta = superCluster->eta();
   constexpr float ebeeSplit = 1.479;
   allMVAVars.isBarrel        = ( std::abs(scEta) < ebeeSplit );
   allMVAVars.isEndcap        = ( std::abs(scEta) >= ebeeSplit );
   allMVAVars.SCeta           = scEta;
 
   constrainMVAVariables(allMVAVars);
 
   std::vector<float> vars;
 
   if( isEndcapCategory( findCategory(particle) ) ) {
     vars = packMVAVariables( allMVAVars.kfhits,
                                         allMVAVars.see,
                                         allMVAVars.spp,
                                         allMVAVars.OneMinusE1x5E5x5,
                                         allMVAVars.R9,
                                         allMVAVars.etawidth,
                                         allMVAVars.phiwidth,
                                         allMVAVars.HoE,
                                         allMVAVars.PreShowerOverRaw,
                                         allMVAVars.kfchi2,
                                         allMVAVars.gsfchi2,
                                         allMVAVars.fbrem,
                                         allMVAVars.EoP,
                                         allMVAVars.eleEoPout,
                                         allMVAVars.IoEmIoP,
                                         allMVAVars.deta,
                                         allMVAVars.dphi,
                                         allMVAVars.detacalo,
                                         allMVAVars.pt,
                                         allMVAVars.isBarrel,
                                         allMVAVars.isEndcap,
                                         allMVAVars.SCeta );
   } else {
     vars = packMVAVariables( allMVAVars.kfhits,
                                         allMVAVars.see,
                                         allMVAVars.spp,
                                         allMVAVars.OneMinusE1x5E5x5,
                                         allMVAVars.R9,
                                         allMVAVars.etawidth,
                                         allMVAVars.phiwidth,
                                         allMVAVars.HoE,
                                         allMVAVars.kfchi2,
                                         allMVAVars.gsfchi2,
                                         allMVAVars.fbrem,
                                         allMVAVars.EoP,
                                         allMVAVars.eleEoPout,
                                         allMVAVars.IoEmIoP,
                                         allMVAVars.deta,
                                         allMVAVars.dphi,
                                         allMVAVars.detacalo,
                                         allMVAVars.pt,
                                         allMVAVars.isBarrel,
                                         allMVAVars.isEndcap,
                                         allMVAVars.SCeta );
   }
 
   return vars;
 }

int ElectronMVAEstimatorRun2Phys14NonTrig::findCategory ( const edm::Ptr< reco::Candidate > & particle ) const

overridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 82 of file ElectronMVAEstimatorRun2Phys14NonTrig.cc.

References funct::abs(), CAT_EB1_PT10plus, CAT_EB1_PT5to10, CAT_EB2_PT10plus, CAT_EB2_PT5to10, CAT_EE_PT10plus, CAT_EE_PT5to10, constexpr, mvaElectronID_Fall17_iso_V1_cff::ebeeSplit, mvaElectronID_Fall17_iso_V1_cff::ebSplit, PVValHelper::eta, edm::Ptr< T >::get(), isEndcapCategory(), nullptr, EnergyCorrector::pt, reco::LeafCandidate::pt(), mvaElectronID_Fall17_iso_V1_cff::ptSplit, reco::GsfElectron::superCluster(), and UNDEFINED.

Referenced by fillMVAVariables(), getTag(), and mvaValue().

                                                                                                    {
   
   // Try to cast the particle into a reco particle.
   // This should work for both reco and pat.
   const edm::Ptr<reco::GsfElectron> eleRecoPtr = ( edm::Ptr<reco::GsfElectron> )particle;
   if( eleRecoPtr.get() == nullptr )
     throw cms::Exception("MVA failure: ")
       << " given particle is expected to be reco::GsfElectron or pat::Electron," << std::endl
       << " but appears to be neither" << std::endl;
 
   const float pt = eleRecoPtr->pt();
   const float eta = eleRecoPtr->superCluster()->eta();
 
   //
   // Determine the category
   //
   int  iCategory = UNDEFINED;
   constexpr float ptSplit = 10;   // we have above and below 10 GeV categories
   constexpr float ebSplit = 0.800;// barrel is split into two regions
   constexpr float ebeeSplit = 1.479; // division between barrel and endcap
 
   if (pt < ptSplit && std::abs(eta) < ebSplit)  
     iCategory = CAT_EB1_PT5to10;
 
   if (pt < ptSplit && std::abs(eta) >= ebSplit && std::abs(eta) < ebeeSplit)
     iCategory = CAT_EB2_PT5to10;
 
   if (pt < ptSplit && std::abs(eta) >= ebeeSplit) 
     iCategory = CAT_EE_PT5to10;
 
   if (pt >= ptSplit && std::abs(eta) < ebSplit) 
     iCategory = CAT_EB1_PT10plus;
 
   if (pt >= ptSplit && std::abs(eta) >= ebSplit && std::abs(eta) < ebeeSplit)
     iCategory = CAT_EB2_PT10plus;
 
   if (pt >= ptSplit && std::abs(eta) >= ebeeSplit) 
     iCategory = CAT_EE_PT10plus;
   
   return iCategory;
 }

const std::string& ElectronMVAEstimatorRun2Phys14NonTrig::getName ( void ) const

inlinefinalvirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 72 of file ElectronMVAEstimatorRun2Phys14NonTrig.h.

References _name.

Referenced by plotting.Plot::draw().

72 { return _name; }

ElectronMVAEstimatorRun2Phys14NonTrig::_name

const std::string _name

Definition: ElectronMVAEstimatorRun2Phys14NonTrig.h:88

int ElectronMVAEstimatorRun2Phys14NonTrig::getNCategories ( ) const

inlinefinalvirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 70 of file ElectronMVAEstimatorRun2Phys14NonTrig.h.

References taus_updatedMVAIds_cff::category, isEndcapCategory(), and nCategories.

70 { return nCategories; }

ElectronMVAEstimatorRun2Phys14NonTrig::nCategories

static int nCategories

Definition: ElectronMVAEstimatorRun2Phys14NonTrig.h:19

const std::string& ElectronMVAEstimatorRun2Phys14NonTrig::getTag ( void ) const

inlinefinalvirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 73 of file ElectronMVAEstimatorRun2Phys14NonTrig.h.

References _tag, constrainMVAVariables(), fillMVAVariables(), and findCategory().

73 { return _tag; }

ElectronMVAEstimatorRun2Phys14NonTrig::_tag

std::string _tag

Definition: ElectronMVAEstimatorRun2Phys14NonTrig.h:92

bool ElectronMVAEstimatorRun2Phys14NonTrig::isEndcapCategory ( int category ) const

Definition at line 125 of file ElectronMVAEstimatorRun2Phys14NonTrig.cc.

References CAT_EE_PT10plus, CAT_EE_PT5to10, and GeomDetEnumerators::isEndcap().

Referenced by fillMVAVariables(), findCategory(), and getNCategories().

                                       {
 
   bool isEndcap = false;
   if( category == CAT_EE_PT5to10 || category == CAT_EE_PT10plus )
     isEndcap = true;
 
   return isEndcap;
 }

float ElectronMVAEstimatorRun2Phys14NonTrig::mvaValue	(	const edm::Ptr< reco::Candidate > &	particle,
		const edm::Event &	evt
	)		const

overridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 42 of file ElectronMVAEstimatorRun2Phys14NonTrig.cc.

References _gbrForests, _MethodName, constexpr, gather_cfg::cout, debug, fillMVAVariables(), findCategory(), and mps_fire::result.

Referenced by ~ElectronMVAEstimatorRun2Phys14NonTrig().

                                                                             {
   
   const int iCategory = findCategory( particle );
   const std::vector<float> vars = fillMVAVariables( particle, evt );
   const float result = _gbrForests.at(iCategory)->GetResponse(vars.data()); // The BDT score
 
   constexpr bool debug = false;
   if(debug) {
     std::cout << " *** Inside the class _MethodName " << _MethodName << std::endl;
     std::cout << " bin " << iCategory
           << " fbrem "    << vars[11]  //_allMVAVars.fbrem
               << " kfchi2 "   << vars[9]  //_allMVAVars.kfchi2
               << " mykfhits " << vars[0]  //_allMVAVars.kfhits
               << " gsfchi2 "  << vars[10]  //_allMVAVars.gsfchi2
               << " deta "     << vars[15]  //_allMVAVars.deta
               << " dphi "     << vars[16]  //_allMVAVars.dphi
               << " detacalo " << vars[17]  //_allMVAVars.detacalo
               << " see "      << vars[1]  //_allMVAVars.see
               << " spp "      << vars[2]  //_allMVAVars.spp
               << " etawidth " << vars[5]  //_allMVAVars.etawidth
               << " phiwidth " << vars[6] // _allMVAVars.phiwidth
               << " OneMinusE1x5E5x5 " << vars[3] //_allMVAVars.OneMinusE1x5E5x5
               << " R9 "        << vars[4] //_allMVAVars.R9
               << " HoE "       << vars[7] //_allMVAVars.HoE
               << " EoP "       << vars[12] //_allMVAVars.EoP
               << " IoEmIoP "   << vars[14] //_allMVAVars.IoEmIoP
               << " eleEoPout " << vars[13] // _allMVAVars.eleEoPout
       //<< " d0 " << _allMVAVars.d0
       //   << " ip3d " << _allMVAVars.ip3d
               << " eta "       << vars[21] //_allMVAVars.SCeta
               << " isBarrel "  << vars[19] //_allMVAVars.isBarrel
               << " isEndcap "  << vars[20] //_allMVAVars.isEndcap
           << " pt "        << vars[18] //_allMVAVars.pt
               << std::endl;
     std::cout << " ### MVA " << result << std::endl;
   }
 
   return result;
 }