ElectronMVAEstimatorRun2 Class Reference

#include <ElectronMVAEstimatorRun2.h>

Inheritance diagram for ElectronMVAEstimatorRun2:

Public Member Functions
	ElectronMVAEstimatorRun2 (const edm::ParameterSet &conf)
	ElectronMVAEstimatorRun2 (const std::string &mvaTag, const std::string &mvaName, const bool debug=false)
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
void	init (const std::vector< std::string > &weightFileNames)
float	mvaValue (const edm::Ptr< reco::Candidate > &candPtr, const edm::EventBase &iEvent) const override
void	setConsumes (edm::ConsumesCollector &&) const final
	~ElectronMVAEstimatorRun2 () override
Public Member Functions inherited from AnyMVAEstimatorRun2Base
	AnyMVAEstimatorRun2Base (const edm::ParameterSet &conf)
virtual	~AnyMVAEstimatorRun2Base ()

Private Attributes
std::vector< StringCutObjectSelector< reco::GsfElectron > >	categoryFunctions_
bool	debug_
std::vector< std::unique_ptr< const GBRForest > >	gbrForests_
const std::string	methodName_
MVAVariableManager< reco::GsfElectron >	mvaVarMngr_
const std::string	name_
int	nCategories_
std::vector< int >	nVariables_
const std::string	tag_
std::vector< std::vector< int > >	variables_

Detailed Description

Definition at line 9 of file ElectronMVAEstimatorRun2.h.

Constructor & Destructor Documentation

ElectronMVAEstimatorRun2::ElectronMVAEstimatorRun2

(

const edm::ParameterSet &

conf

)

Definition at line 3 of file ElectronMVAEstimatorRun2.cc.

References categoryFunctions_, Exception, edm::ParameterSet::getParameter(), mps_fire::i, init(), name_, nCategories_, TauGenJetsDecayModeSelectorAllHadrons_cfi::select, tag_, and mvaElectronID_Fall17_iso_V1_cff::weightFileNames.

                                                                             :
  AnyMVAEstimatorRun2Base(conf),
  name_(conf.getParameter<std::string>("mvaName")),
  tag_(conf.getParameter<std::string>("mvaTag")),
  nCategories_            (conf.getParameter<int>("nCategories")),
  methodName_             ("BDTG method"),
  mvaVarMngr_(conf.getParameter<std::string>("variableDefinition")),
  debug_(conf.getUntrackedParameter<bool>("debug", false))
{

  const std::vector <std::string> weightFileNames
    = conf.getParameter<std::vector<std::string> >("weightFileNames");

  const std::vector <std::string> categoryCutStrings
    = conf.getParameter<std::vector<std::string> >("categoryCuts");

  if( (int)(categoryCutStrings.size()) != nCategories_ )
    throw cms::Exception("MVA config failure: ")
      << "wrong number of category cuts in " << name_ << tag_ << std::endl;

  for (int i = 0; i < nCategories_; ++i) {
      StringCutObjectSelector<reco::GsfElectron> select(categoryCutStrings[i]);
      categoryFunctions_.push_back(select);
  }

  // Initialize GBRForests from weight files
  init(weightFileNames);

}

ElectronMVAEstimatorRun2::~ElectronMVAEstimatorRun2 ( )

override

Definition at line 89 of file ElectronMVAEstimatorRun2.cc.

Referenced by init().

                           {
}

ElectronMVAEstimatorRun2::ElectronMVAEstimatorRun2	(	const std::string &	mvaTag,
		const std::string &	mvaName,
		const bool	debug = false
	)

Definition at line 33 of file ElectronMVAEstimatorRun2.cc.

                                                                            :
  AnyMVAEstimatorRun2Base( edm::ParameterSet() ),
  name_                   (mvaName),
  tag_                    (mvaTag),
  methodName_             ("BDTG method"),
  debug_                  (debug) {
  }

Member Function Documentation

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

overridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 140 of file ElectronMVAEstimatorRun2.cc.

References categoryFunctions_, Exception, edm::Ptr< T >::get(), mps_fire::i, name_, nCategories_, and tag_.

Referenced by getTag(), and mvaValue().

                                                                                      {

  auto gsfEle = dynamic_cast<reco::GsfElectron const*>(candPtr.get());

  if( gsfEle == 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;
  }

  for (int i = 0; i < nCategories_; ++i) {
      if (categoryFunctions_[i](*gsfEle)) return i;
  }

  edm::LogWarning  ("MVA warning") <<
      "category not defined for particle with pt " << gsfEle->pt() << " GeV, eta " <<
          gsfEle->superCluster()->eta() << " in " << name_ << tag_;

  return -1;

}

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

inlinefinalvirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 28 of file ElectronMVAEstimatorRun2.h.

References name_.

Referenced by plotting.Plot::draw().

{ return name_; }

int ElectronMVAEstimatorRun2::getNCategories ( ) const

inlineoverridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 27 of file ElectronMVAEstimatorRun2.h.

References nCategories_.

{ return nCategories_; }

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

inlinefinalvirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 29 of file ElectronMVAEstimatorRun2.h.

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

{ return tag_; }

void ElectronMVAEstimatorRun2::init

(

const std::vector< std::string > &

weightFileNames

)

Definition at line 42 of file ElectronMVAEstimatorRun2.cc.

References gather_cfg::cout, GBRForestTools::createGBRForest(), debug_, Exception, gbrForests_, MVAVariableManager< ParticleType >::getVarIndex(), mps_fire::i, mvaVarMngr_, name_, nCategories_, nVariables_, tag_, variables_, and ~ElectronMVAEstimatorRun2().

Referenced by ElectronMVAEstimatorRun2().

                                                                               {

  if(debug_) {
    std::cout << " *** Inside " << name_ << tag_ << std::endl;
  }

  // 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);

    if(debug_) {
      std::cout << " *** Inside " << name_ << tag_ << std::endl;
      std::cout << " category " << i << " with nVariables " << nVariables_[i] << std::endl;
    }

    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);

    }
  }
}

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

overridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 104 of file ElectronMVAEstimatorRun2.cc.

References gather_cfg::cout, debug_, Exception, findCategory(), gbrForests_, MVAVariableManager< ParticleType >::getName(), MVAVariableManager< ParticleType >::getValue(), mps_fire::i, mvaVarMngr_, name_, nullptr, nVariables_, tag_, and variables_.

Referenced by setConsumes().

                                                                                   {

  const int iCategory = findCategory( candPtr );

  if (iCategory < 0) return -999;

  std::vector<float> vars;

  const edm::Ptr<reco::GsfElectron> gsfPtr{ candPtr };

  if( gsfPtr.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;
  }

  for (int i = 0; i < nVariables_[iCategory]; ++i) {
      vars.push_back(mvaVarMngr_.getValue(variables_[iCategory][i], gsfPtr, iEvent));
  }

  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()); // The BDT score

  if(debug_) {
    std::cout << " ### MVA " << response << std::endl << std::endl;
  }

  return response;
}

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

finalvirtual

Reimplemented from AnyMVAEstimatorRun2Base.

Definition at line 92 of file ElectronMVAEstimatorRun2.cc.

References MVAVariableManager< ParticleType >::getGlobalInputTags(), MVAVariableManager< ParticleType >::getHelperInputTags(), mvaValue(), 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);
  }
}

Member Data Documentation

std::vector<StringCutObjectSelector<reco::GsfElectron> > ElectronMVAEstimatorRun2::categoryFunctions_

private

Definition at line 51 of file ElectronMVAEstimatorRun2.h.

Referenced by ElectronMVAEstimatorRun2(), and findCategory().

bool ElectronMVAEstimatorRun2::debug_

private

Definition at line 66 of file ElectronMVAEstimatorRun2.h.

Referenced by init(), and mvaValue().

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

private

Definition at line 55 of file ElectronMVAEstimatorRun2.h.

Referenced by init(), and mvaValue().

const std::string ElectronMVAEstimatorRun2::methodName_

private

Definition at line 57 of file ElectronMVAEstimatorRun2.h.

MVAVariableManager<reco::GsfElectron> ElectronMVAEstimatorRun2::mvaVarMngr_

private

Definition at line 64 of file ElectronMVAEstimatorRun2.h.

Referenced by init(), mvaValue(), and setConsumes().

const std::string ElectronMVAEstimatorRun2::name_

private

Definition at line 42 of file ElectronMVAEstimatorRun2.h.

Referenced by ElectronMVAEstimatorRun2(), findCategory(), getName(), init(), and mvaValue().

int ElectronMVAEstimatorRun2::nCategories_

private

Definition at line 50 of file ElectronMVAEstimatorRun2.h.

Referenced by ElectronMVAEstimatorRun2(), findCategory(), getNCategories(), and init().

std::vector<int> ElectronMVAEstimatorRun2::nVariables_

private

Definition at line 52 of file ElectronMVAEstimatorRun2.h.

Referenced by init(), and mvaValue().

const std::string ElectronMVAEstimatorRun2::tag_

private

Definition at line 47 of file ElectronMVAEstimatorRun2.h.

Referenced by ElectronMVAEstimatorRun2(), findCategory(), getTag(), init(), and mvaValue().

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

private

Definition at line 62 of file ElectronMVAEstimatorRun2.h.

Referenced by init(), and mvaValue().