#include <PhotonMVAEstimatorRun2Spring16NonTrig.h>

Inheritance diagram for PhotonMVAEstimatorRun2Spring16NonTrig:

Classes
struct	AllVariables

Public Types
enum	mvaCategories { UNDEFINED = -1, CAT_EB = 0, CAT_EE = 1 }

Public Member Functions
void	constrainMVAVariables (AllVariables &) const

std::unique_ptr< const GBRForest >	createSingleReader (const int iCategory, const edm::FileInPath &weightFile)

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

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

const std::string &	getName () const final

int	getNCategories () const override

const std::string &	getTag () const final

bool	isEndcapCategory (int category) const

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

	PhotonMVAEstimatorRun2Spring16NonTrig (const edm::ParameterSet &conf)

void	setConsumes (edm::ConsumesCollector &&) const override

	~PhotonMVAEstimatorRun2Spring16NonTrig () 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	~AnyMVAEstimatorRun2Base ()

Public Attributes
const uint	nCategories = 2

Public Attributes inherited from AnyMVAEstimatorRun2Base
const edm::ParameterSet	_conf

Private Attributes
AllVariables	allMVAVars_

EffectiveAreas	effectiveAreas_

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

const std::string	MethodName_

const std::string	name_ = "PhotonMVAEstimatorRun2Spring16NonTrig"

const edm::InputTag	phoChargedIsolationLabel_

double	phoIsoCutoff_

std::vector< double >	phoIsoPtScalingCoeff_

const edm::InputTag	phoPhotonIsolationLabel_

const edm::InputTag	phoWorstChargedIsolationLabel_

const edm::InputTag	rhoLabel_

std::string	tag_

Detailed Description

Definition at line 23 of file PhotonMVAEstimatorRun2Spring16NonTrig.h.

Member Enumeration Documentation

enum PhotonMVAEstimatorRun2Spring16NonTrig::mvaCategories

Enumerator
UNDEFINED
CAT_EB
CAT_EE

Definition at line 30 of file PhotonMVAEstimatorRun2Spring16NonTrig.h.

                      {
     UNDEFINED = -1,
     CAT_EB  = 0,
     CAT_EE  = 1
   };

Constructor & Destructor Documentation

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

Definition at line 6 of file PhotonMVAEstimatorRun2Spring16NonTrig.cc.

References createSingleReader(), gbrForests_, edm::ParameterSet::getParameter(), mps_fire::i, nCategories, AlCaHLTBitMon_QueryRunRegistry::string, tag_, electrons_cff::weightFile, mvaElectronID_Fall17_iso_V1_cff::weightFileNames, and ~PhotonMVAEstimatorRun2Spring16NonTrig().

                                                                                                        :
   AnyMVAEstimatorRun2Base(conf),
   MethodName_("BDTG method"),
   phoChargedIsolationLabel_(conf.getParameter<edm::InputTag>("phoChargedIsolation")), 
   phoPhotonIsolationLabel_(conf.getParameter<edm::InputTag>("phoPhotonIsolation")), 
   phoWorstChargedIsolationLabel_(conf.getParameter<edm::InputTag>("phoWorstChargedIsolation")), 
   rhoLabel_(conf.getParameter<edm::InputTag>("rho")),
   effectiveAreas_( (conf.getParameter<edm::FileInPath>("effAreasConfigFile")).fullPath()),
   phoIsoPtScalingCoeff_(conf.getParameter<std::vector<double >>("phoIsoPtScalingCoeff")),
   phoIsoCutoff_(conf.getParameter<double>("phoIsoCutoff"))
 {
 
   //
   // Construct the MVA estimators
   //
   tag_ = conf.getParameter<std::string>("mvaTag");
 
   const std::vector <std::string> weightFileNames
     = conf.getParameter<std::vector<std::string> >("weightFileNames");
 
   if( weightFileNames.size() != nCategories )
     throw cms::Exception("MVA config failure: ")
       << "wrong number of weightfiles" << std::endl;
 
   gbrForests_.clear();
   // The method name is just a key to retrieve this method later, it is not
   // a control parameter for a reader (the full definition of the MVA type and
   // everything else comes from the xml weight files).
    
   // Create a TMVA reader object for each category
   for(uint 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( createSingleReader(i, weightFile ) );
 
   }
 
 }

PhotonMVAEstimatorRun2Spring16NonTrig::~PhotonMVAEstimatorRun2Spring16NonTrig ( )

override

Definition at line 49 of file PhotonMVAEstimatorRun2Spring16NonTrig.cc.

References mvaValue().

Referenced by PhotonMVAEstimatorRun2Spring16NonTrig().

49 {

50 }

Member Function Documentation

void PhotonMVAEstimatorRun2Spring16NonTrig::constrainMVAVariables ( AllVariables & ) const

Definition at line 321 of file PhotonMVAEstimatorRun2Spring16NonTrig.cc.

Referenced by fillMVAVariables(), and getTag().

                                                                                     {
 
   // Check that variables do not have crazy values
   
   // This function is currently empty as this specific MVA was not
   // developed with restricting variables to specific physical ranges.
   return;
 
 }

std::unique_ptr< const GBRForest > PhotonMVAEstimatorRun2Spring16NonTrig::createSingleReader	(	const int	iCategory,
		const edm::FileInPath &	weightFile
	)

Definition at line 132 of file PhotonMVAEstimatorRun2Spring16NonTrig.cc.

Referenced by isEndcapCategory(), and PhotonMVAEstimatorRun2Spring16NonTrig().

                                                                         {
 
   //
   // Create the reader  
   //
   TMVA::Reader tmpTMVAReader( "!Color:Silent:Error" );
 
   //
   // Configure all variables and spectators. Note: the order and names
   // must match what is found in the xml weights file!
   //
 
   tmpTMVAReader.AddVariable("scPhi", &allMVAVars_.scPhi);
   tmpTMVAReader.AddVariable("r9"        , &allMVAVars_.varR9);
   tmpTMVAReader.AddVariable("sigmaIetaIeta", &allMVAVars_.varSieie);
   tmpTMVAReader.AddVariable("covIEtaIPhi", &allMVAVars_.varSieip);
   tmpTMVAReader.AddVariable("s4", &allMVAVars_.varE2x2overE5x5);
   tmpTMVAReader.AddVariable("scEta" , &allMVAVars_.varSCEta);
   tmpTMVAReader.AddVariable("SCRawE"      , &allMVAVars_.varRawE);
   tmpTMVAReader.AddVariable("etaWidth", &allMVAVars_.varSCEtaWidth);
   tmpTMVAReader.AddVariable("phiWidth", &allMVAVars_.varSCPhiWidth);
   //Pileup
   tmpTMVAReader.AddVariable("rho"       , &allMVAVars_.varRho);
   //EB only, because of loss of transparency in EE
   if(!isEndcapCategory(iCategory)){
     tmpTMVAReader.AddVariable("CITK_isoPhotons" , &allMVAVars_.varPhoIsoRaw);
   }
   else{
     tmpTMVAReader.AddVariable("CITK_isoPhoCorrMax2p5", &allMVAVars_.varPhoIsoCorr);
   }
   //isolations in both EB and EE
   tmpTMVAReader.AddVariable("CITK_isoChargedHad"  , &allMVAVars_.varChIsoRaw);
   tmpTMVAReader.AddVariable("chgIsoWrtWorstVtx", &allMVAVars_.varWorstChRaw);
 
   // Endcap only variables
   if( isEndcapCategory(iCategory) ){
     tmpTMVAReader.AddVariable("esEffSigmaRR"      , &allMVAVars_.varESEffSigmaRR);
     tmpTMVAReader.AddVariable("esEnergy/SCRawE" , &allMVAVars_.varESEnOverRawE);
   }
 
   //
   // Book the method and set up the weights file
   //
   tmpTMVAReader.BookMVA(MethodName_ , weightFile.fullPath() );
 
   return std::unique_ptr<const GBRForest>( new GBRForest( dynamic_cast<TMVA::MethodBDT*>( tmpTMVAReader.FindMVA(MethodName_) ) ) );
 
 }

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

overridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 182 of file PhotonMVAEstimatorRun2Spring16NonTrig.cc.

Referenced by getTag(), and mvaValue().

                                                                                                                                             {
   
   // 
   // Declare all value maps corresponding to the above tokens
   //
   edm::Handle<edm::ValueMap<float> > full5x5SigmaIEtaIEtaMap;
   edm::Handle<edm::ValueMap<float> > full5x5SigmaIEtaIPhiMap;
   edm::Handle<edm::ValueMap<float> > full5x5E2x2Map;
   edm::Handle<edm::ValueMap<float> > full5x5E5x5Map;
   edm::Handle<edm::ValueMap<float> > esEffSigmaRRMap;
   //
   edm::Handle<edm::ValueMap<float> > phoChargedIsolationMap;
   edm::Handle<edm::ValueMap<float> > phoPhotonIsolationMap;
   edm::Handle<edm::ValueMap<float> > phoWorstChargedIsolationMap;
 
   // Rho will be pulled from the event content
   edm::Handle<double> rho;
 
   // Get the isolation maps
   iEvent.getByLabel(phoChargedIsolationLabel_, phoChargedIsolationMap);
   iEvent.getByLabel(phoPhotonIsolationLabel_, phoPhotonIsolationMap);
   iEvent.getByLabel(phoWorstChargedIsolationLabel_, phoWorstChargedIsolationMap);
 
   // Get rho
   iEvent.getByLabel(rhoLabel_,rho);
 
   // Make sure everything is retrieved successfully
   if(! ( phoChargedIsolationMap.isValid()
          && phoPhotonIsolationMap.isValid()
          && phoWorstChargedIsolationMap.isValid()
          && rho.isValid() ) )
     throw cms::Exception("MVA failure: ")
       << "Failed to retrieve event content needed for this MVA" 
       << std::endl
       << "Check python MVA configuration file and make sure all needed"
       << std::endl
       << "producers are running upstream" << std::endl;
 
   // Try to cast the particle into a reco particle.
   // This should work for both reco and pat.
   const edm::Ptr<reco::Photon> phoRecoPtr(particle);
   if( phoRecoPtr.isNull() )
     throw cms::Exception("MVA failure: ")
       << " given particle is expected to be reco::Photon or pat::Photon," << std::endl
       << " but appears to be neither" << std::endl;
 
   // Both pat and reco particles have exactly the same accessors.
   auto superCluster = phoRecoPtr->superCluster();
   // Full 5x5 cluster shapes. We could take some of this directly from
   // the photon object, but some of these are not available.
   float e2x2 = std::numeric_limits<float>::max();
   float e5x5 = std::numeric_limits<float>::max();
   float full5x5_sigmaIetaIeta = std::numeric_limits<float>::max();
   float full5x5_sigmaIetaIphi = std::numeric_limits<float>::max();
   float effSigmaRR = std::numeric_limits<float>::max();
 
   AllVariables allMVAVars;
 
   const auto& full5x5_pss = phoRecoPtr->full5x5_showerShapeVariables();
   e2x2 = full5x5_pss.e2x2;
   e5x5 = full5x5_pss.e5x5;
   full5x5_sigmaIetaIeta = full5x5_pss.sigmaIetaIeta;
   full5x5_sigmaIetaIphi = full5x5_pss.sigmaIetaIphi;
   effSigmaRR = full5x5_pss.effSigmaRR;
 
   allMVAVars.scPhi           = superCluster->phi();
   allMVAVars.varR9           = phoRecoPtr->r9() ;
   allMVAVars.varSieie        = full5x5_sigmaIetaIeta; 
   allMVAVars.varSieip        = full5x5_sigmaIetaIphi;
   allMVAVars.varE2x2overE5x5 = e2x2/e5x5;
   allMVAVars.varSCEta        = superCluster->eta(); 
   allMVAVars.varRawE         = superCluster->rawEnergy(); 
   allMVAVars.varSCEtaWidth   = superCluster->etaWidth(); 
   allMVAVars.varSCPhiWidth   = superCluster->phiWidth(); 
   allMVAVars.varESEnOverRawE = superCluster->preshowerEnergy() / superCluster->rawEnergy();
   allMVAVars.varESEffSigmaRR = effSigmaRR;
   allMVAVars.varRho          = *rho; 
   allMVAVars.varPhoIsoRaw    = (*phoPhotonIsolationMap)[phoRecoPtr];  
   allMVAVars.varChIsoRaw     = (*phoChargedIsolationMap)[phoRecoPtr];
   allMVAVars.varWorstChRaw   = (*phoWorstChargedIsolationMap)[phoRecoPtr];
 
   //photon iso corrected:
 
   double eA = effectiveAreas_.getEffectiveArea( std::abs(superCluster->eta()) );
   double phoIsoPtScalingCoeffVal = 0;
   if( !isEndcapCategory( findCategory ( particle ) ) ) 
     phoIsoPtScalingCoeffVal = phoIsoPtScalingCoeff_.at(0); // barrel case
   else
     phoIsoPtScalingCoeffVal =  phoIsoPtScalingCoeff_.at(1); //endcap case
   double phoIsoCorr = (*phoPhotonIsolationMap)[phoRecoPtr] - eA*(*rho) - phoIsoPtScalingCoeffVal*phoRecoPtr->pt();
 
   allMVAVars.varPhoIsoCorr = TMath::Max(phoIsoCorr, phoIsoCutoff_);
 
   constrainMVAVariables(allMVAVars);
   //
   // Important: the order of variables in the "vars" vector has to be EXACTLY
   // the same as in the .xml file defining the MVA.
   //
   std::vector<float> vars;
   if( isEndcapCategory( findCategory( particle ) ) ) {
     vars = std::move( packMVAVariables(
                        allMVAVars.scPhi,
                                        allMVAVars.varR9,
                                        allMVAVars.varSieie,
                                        allMVAVars.varSieip,
                                        allMVAVars.varE2x2overE5x5,
                                        allMVAVars.varSCEta,
                                        allMVAVars.varRawE,
                                        allMVAVars.varSCEtaWidth,
                                        allMVAVars.varSCPhiWidth,
                        allMVAVars.varRho,
                        allMVAVars.varPhoIsoCorr,
                        allMVAVars.varChIsoRaw,
                        allMVAVars.varWorstChRaw,
                        allMVAVars.varESEffSigmaRR,
                        allMVAVars.varESEnOverRawE
                        ) 
                       ); 
   } else {
     vars = std::move( packMVAVariables(
                        allMVAVars.scPhi,
                                        allMVAVars.varR9,
                                        allMVAVars.varSieie,
                                        allMVAVars.varSieip,
                                        allMVAVars.varE2x2overE5x5,
                                        allMVAVars.varSCEta,
                                        allMVAVars.varRawE,
                                        allMVAVars.varSCEtaWidth,
                                        allMVAVars.varSCPhiWidth,
                                        allMVAVars.varRho,
                                        allMVAVars.varPhoIsoRaw,
                                        allMVAVars.varChIsoRaw,
                                        allMVAVars.varWorstChRaw
                        ) 
                       );
   }
   return vars;
 }

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

overridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 92 of file PhotonMVAEstimatorRun2Spring16NonTrig.cc.

References funct::abs(), CAT_EB, CAT_EE, mvaElectronID_Fall17_iso_V1_cff::ebeeSplit, PVValHelper::eta, isEndcapCategory(), edm::Ptr< T >::isNull(), reco::Photon::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::Photon> phoRecoPtr = ( edm::Ptr<reco::Photon> )particle;
   if( phoRecoPtr.isNull() )
     throw cms::Exception("MVA failure: ")
       << " given particle is expected to be reco::Photon or pat::Photon," << std::endl
       << " but appears to be neither" << std::endl;
 
   float eta = phoRecoPtr->superCluster()->eta();
 
   //
   // Determine the category
   //
   int  iCategory = UNDEFINED;
   const float ebeeSplit = 1.479; // division between barrel and endcap
 
   if ( std::abs(eta) < ebeeSplit)  
     iCategory = CAT_EB;
   else
     iCategory = CAT_EE;
 
   return iCategory;
 }

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

inlinefinalvirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 72 of file PhotonMVAEstimatorRun2Spring16NonTrig.h.

References name_.

Referenced by plotting.Plot::draw().

72 { return name_; }

PhotonMVAEstimatorRun2Spring16NonTrig::name_

const std::string name_

Definition: PhotonMVAEstimatorRun2Spring16NonTrig.h:96

int PhotonMVAEstimatorRun2Spring16NonTrig::getNCategories ( ) const

inlineoverridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 70 of file PhotonMVAEstimatorRun2Spring16NonTrig.h.

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

70 { return nCategories; }

PhotonMVAEstimatorRun2Spring16NonTrig::nCategories

const uint nCategories

Definition: PhotonMVAEstimatorRun2Spring16NonTrig.h:29

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

inlinefinalvirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 73 of file PhotonMVAEstimatorRun2Spring16NonTrig.h.

References constrainMVAVariables(), fillMVAVariables(), findCategory(), iEvent, setConsumes(), and tag_.

73 { return tag_; }

PhotonMVAEstimatorRun2Spring16NonTrig::tag_

std::string tag_

Definition: PhotonMVAEstimatorRun2Spring16NonTrig.h:101

bool PhotonMVAEstimatorRun2Spring16NonTrig::isEndcapCategory ( int category ) const

Definition at line 119 of file PhotonMVAEstimatorRun2Spring16NonTrig.cc.

References CAT_EE, createSingleReader(), and GeomDetEnumerators::isEndcap().

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

                                      {
 
   // For this specific MVA the function is trivial, but kept for possible
   // future evolution to an MVA with more categories in eta
   bool isEndcap = false;
   if( category == CAT_EE )
     isEndcap = true;
 
   return isEndcap;
 }

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

overridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 53 of file PhotonMVAEstimatorRun2Spring16NonTrig.cc.

References debug, fillMVAVariables(), findCategory(), gbrForests_, isEndcapCategory(), eostools::move(), and mps_fire::result.

Referenced by ~PhotonMVAEstimatorRun2Spring16NonTrig().

                                                                               {  
 
   const int iCategory = findCategory( particle );
   const std::vector<float> vars = std::move( fillMVAVariables( particle, iEvent ) );  
   
   const float result = gbrForests_.at(iCategory)->GetClassifier(vars.data());
 
   // DEBUG
   const bool debug = false;
   // The list of variables here must match EXACTLY the list and order in the
   // packMVAVariables() call for barrel and endcap in this file.
   if( debug ){
     printf("Printout of the photon variable inputs for MVA:\n");
     printf("  varSCPhi_            %f\n", vars[0]   );
     printf("  varR9_            %f\n", vars[1]   ); 
     printf("  varSieie_         %f\n", vars[2]   );
     printf("  varSieip_         %f\n", vars[3]   ); 
     printf("  varE2x2overE5x5_  %f\n", vars[4]   ); 
     printf("  varSCEta_         %f\n", vars[5]   ); 
     printf("  varRawE_          %f\n", vars[6]   ); 
     printf("  varSCEtaWidth_    %f\n", vars[7]   ); 
     printf("  varSCPhiWidth_    %f\n", vars[8]  ); 
     printf("  varRho_           %f\n", vars[9]  );
     if( !isEndcapCategory( iCategory ) ) {
       printf("  varPhoIsoRaw_     %f\n", vars[10]  );
     } else {
       printf("  varPhoIsoRawCorr_  %f\n", vars[10]  ); // for endcap MVA only in 2016
     }
     printf("  varChIsoRaw_      %f\n", vars[11]  ); 
     printf("  varWorstChRaw_    %f\n", vars[12]  );
     if( isEndcapCategory( iCategory ) ) {
       printf("  varESEnOverRawE_  %f\n", vars[13]  ); // for endcap MVA only
       printf("  varESEffSigmaRR_  %f\n", vars[14]  ); // for endcap MVA only
     } 
   }
   
   return result;
 }

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

overridevirtual

Reimplemented from AnyMVAEstimatorRun2Base.

Definition at line 331 of file PhotonMVAEstimatorRun2Spring16NonTrig.cc.

References DEFINE_EDM_PLUGIN, phoChargedIsolationLabel_, phoPhotonIsolationLabel_, phoWorstChargedIsolationLabel_, and rhoLabel_.

Referenced by getTag().

                                                                                        {
   cc.consumes<edm::ValueMap<float> >(phoChargedIsolationLabel_);
   cc.consumes<edm::ValueMap<float> >(phoPhotonIsolationLabel_);
   cc.consumes<edm::ValueMap<float> >( phoWorstChargedIsolationLabel_);
   cc.consumes<double>(rhoLabel_);
 }