#include <PhotonMVAEstimator.h>

Inheritance diagram for PhotonMVAEstimator:

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

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

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

const std::string &	getName () const final

int	getNCategories () const override

const std::string &	getTag () const final

float	mvaValue (const edm::Ptr< reco::Candidate > &candPtr, const edm::EventBase &) const override

	PhotonMVAEstimator (const edm::ParameterSet &conf)

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

	~PhotonMVAEstimator () override

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

virtual	~AnyMVAEstimatorRun2Base ()

Public Attributes
const int	nCategories_ = 2

Private Attributes
const bool	debug_

const double	ebeeSplit_

std::unique_ptr< EffectiveAreas >	effectiveAreas_

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

const std::string	methodName_

MVAVariableManager< reco::Photon >	mvaVarMngr_

const std::string	name_

std::vector< int >	nVariables_

double	phoIsoCutoff_

std::vector< double >	phoIsoPtScalingCoeff_

const std::string	tag_

std::vector< std::vector< int > >	variables_

Detailed Description

Definition at line 22 of file PhotonMVAEstimator.h.

Member Enumeration Documentation

enum PhotonMVAEstimator::mvaCategories

Enumerator
CAT_EB
CAT_EE

Definition at line 29 of file PhotonMVAEstimator.h.

                      {
     CAT_EB  = 0,
     CAT_EE  = 1
   };

Constructor & Destructor Documentation

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

Definition at line 3 of file PhotonMVAEstimator.cc.

References GBRForestTools::createGBRForest(), effectiveAreas_, Exception, gbrForests_, edm::ParameterSet::getParameter(), MVAVariableManager< ParticleType >::getVarIndex(), mps_fire::i, mvaVarMngr_, name_, nCategories_, nVariables_, phoIsoCutoff_, phoIsoPtScalingCoeff_, tag_, variables_, mvaElectronID_Fall17_iso_V1_cff::weightFileNames, and ~PhotonMVAEstimator().

                                                                  :
   AnyMVAEstimatorRun2Base(conf),
   name_(conf.getParameter<std::string>("mvaName")),
   tag_(conf.getParameter<std::string>("mvaTag")),
   methodName_("BDTG method"),
   mvaVarMngr_(conf.getParameter<std::string>("variableDefinition")),
   ebeeSplit_ (conf.getParameter<double> ("ebeeSplit")),
   debug_(conf.getUntrackedParameter<bool>("debug", false))
 {
   //
   // Construct the MVA estimators
   //
   if (tag_ == "Run2Spring16NonTrigV1") {
       effectiveAreas_ = std::make_unique<EffectiveAreas>((conf.getParameter<edm::FileInPath>("effAreasConfigFile")).fullPath());
       phoIsoPtScalingCoeff_ = conf.getParameter<std::vector<double >>("phoIsoPtScalingCoeff");
       phoIsoCutoff_ = conf.getParameter<double>("phoIsoCutoff");
   }
 
   const std::vector <std::string> weightFileNames
     = conf.getParameter<std::vector<std::string> >("weightFileNames");
 
   // Initialize GBRForests
   if( (int)(weightFileNames.size()) != nCategories_ )
     throw cms::Exception("MVA config failure: ")
       << "wrong number of weightfiles in " << name_ << tag_ << std::endl;
 
   gbrForests_.clear();
   // Create a TMVA reader object for each category
   for(int i=0; i<nCategories_; i++){
 
     std::vector<std::string> variableNamesInCategory;
     std::vector<int> variablesInCategory;
 
     // Use unique_ptr so that all readers are properly cleaned up
     // when the vector clear() is called in the destructor
 
     gbrForests_.push_back( GBRForestTools::createGBRForest( weightFileNames[i], variableNamesInCategory ) );
 
     nVariables_.push_back(variableNamesInCategory.size());
 
     variables_.push_back(variablesInCategory);
 
     for (int j=0; j<nVariables_[i];++j) {
         int index = mvaVarMngr_.getVarIndex(variableNamesInCategory[j]);
         if(index == -1) {
             throw cms::Exception("MVA config failure: ")
                << "Concerning " << name_ << tag_ << std::endl
                << "Variable " << variableNamesInCategory[j]
                << " not found in variable definition file!" << std::endl;
         }
         variables_[i].push_back(index);
 
     }
   }
 }

PhotonMVAEstimator::~PhotonMVAEstimator ( )

override

Definition at line 60 of file PhotonMVAEstimator.cc.

References mvaValue().

Referenced by PhotonMVAEstimator().

60 {

61 }

Member Function Documentation

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

int PhotonMVAEstimator::findCategory ( const edm::Ptr< reco::Candidate > & candPtr ) const

overridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 107 of file PhotonMVAEstimator.cc.

References funct::abs(), CAT_EB, CAT_EE, ebeeSplit_, PVValHelper::eta, Exception, and edm::Ptr< T >::get().

Referenced by getTag(), and mvaValue().

                                                                                 {
 
   // Try to cast the particle into a reco particle.
   // This should work for both reco and pat.
   auto pho = dynamic_cast<reco::Photon const*>(candPtr.get());
 
   if( pho == nullptr) {
     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 = pho->superCluster()->eta();
 
   //
   // Determine the category
   //
   if ( std::abs(eta) < ebeeSplit_)
      return CAT_EB; 
   else
      return CAT_EE;
 }

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

inlinefinalvirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 45 of file PhotonMVAEstimator.h.

References name_.

Referenced by plotting.Plot::draw().

45 { return name_; }

PhotonMVAEstimator::name_

const std::string name_

Definition: PhotonMVAEstimator.h:59

int PhotonMVAEstimator::getNCategories ( ) const

inlineoverridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 44 of file PhotonMVAEstimator.h.

References nCategories_.

44 { return nCategories_; }

PhotonMVAEstimator::nCategories_

const int nCategories_

Definition: PhotonMVAEstimator.h:28

const std::string& PhotonMVAEstimator::getTag ( ) const

inlinefinalvirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 46 of file PhotonMVAEstimator.h.

References findCategory(), setConsumes(), and tag_.

46 { return tag_; }

PhotonMVAEstimator::tag_

const std::string tag_

Definition: PhotonMVAEstimator.h:64

float PhotonMVAEstimator::mvaValue	(	const edm::Ptr< reco::Candidate > &	candPtr,
		const edm::EventBase &	iEvent
	)		const

overridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 64 of file PhotonMVAEstimator.cc.

References funct::abs(), CAT_EE, gather_cfg::cout, debug_, effectiveAreas_, Exception, findCategory(), gbrForests_, MVAVariableManager< ParticleType >::getName(), MVAVariableManager< ParticleType >::getValue(), mps_fire::i, Max(), mvaVarMngr_, name_, nVariables_, phoIsoCutoff_, phoIsoPtScalingCoeff_, tag_, and variables_.

Referenced by ~PhotonMVAEstimator().

                                                                                  {
 
   const int iCategory = findCategory( candPtr );
 
   const edm::Ptr<reco::Photon> phoPtr{ candPtr };
   if( phoPtr.get() == nullptr) {
     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;
   }
 
   std::vector<float> vars;
 
   for (int i = 0; i < nVariables_[iCategory]; ++i) {
       vars.push_back(mvaVarMngr_.getValue(variables_[iCategory][i], phoPtr, iEvent));
   }
 
   // Special case for Spring16!
   if (tag_ == "Run2Spring16NonTrigV1" and iCategory == CAT_EE) {
       // Raw value for EB only, because of loss of transparency in EE
       // for endcap MVA only in 2016
       double eA = effectiveAreas_->getEffectiveArea( std::abs(phoPtr->superCluster()->eta()) );
       double phoIsoCorr = vars[10] - eA*(double)vars[9] - phoIsoPtScalingCoeff_.at(1) * phoPtr->pt();
       vars[10] = TMath::Max( phoIsoCorr, phoIsoCutoff_);
   }
 
   if(debug_) {
     std::cout << " *** Inside " << name_ << tag_ << std::endl;
     std::cout << " category " << iCategory << std::endl;
     for (int i = 0; i < nVariables_[iCategory]; ++i) {
         std::cout << " " << mvaVarMngr_.getName(variables_[iCategory][i]) << " " << vars[i] << std::endl;
     }
   }
 
   const float response = gbrForests_.at(iCategory)->GetResponse(vars.data());
 
   if(debug_) {
     std::cout << " ### MVA " << response << std::endl << std::endl;
   }
 
   return response;
 }

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

overridevirtual

Reimplemented from AnyMVAEstimatorRun2Base.

Definition at line 130 of file PhotonMVAEstimator.cc.

References DEFINE_EDM_PLUGIN, MVAVariableManager< ParticleType >::getGlobalInputTags(), MVAVariableManager< ParticleType >::getHelperInputTags(), mvaVarMngr_, and GlobalPosition_Frontier_DevDB_cff::tag.

Referenced by getTag().

                                                                     {
   // All tokens for event content needed by this MVA
   // Tags from the variable helper
   for (auto &tag : mvaVarMngr_.getHelperInputTags()) {
       cc.consumes<edm::ValueMap<float>>(tag);
   }
   for (auto &tag : mvaVarMngr_.getGlobalInputTags()) {
       cc.consumes<double>(tag);
   }
 }