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, int nCategories, const std::string &variableDefinition, const std::vector< std::string > &categoryCutStrings, const std::vector< std::string > &weightFileNames, bool debug=false)
int	findCategory (const reco::Candidate *candidate) const override
float	mvaValue (const reco::Candidate *candidate, float rho, int &iCategory) const
float	mvaValue (const reco::Candidate *candidate, std::vector< float > const &auxVariables, int &iCategory) const override
	~ElectronMVAEstimatorRun2 () override
Public Member Functions inherited from AnyMVAEstimatorRun2Base
	AnyMVAEstimatorRun2Base (const ::std::string &mvaName, const ::std::string &mvaTag, int nCategories, bool debug)
	AnyMVAEstimatorRun2Base (const edm::ParameterSet &conf)
const std::string &	getName () const
int	getNCategories () const
const std::string &	getTag () const
bool	isDebug () const
float	mvaValue (const reco::Candidate *candidate, std::vector< float > const &auxVariables) const
virtual	~AnyMVAEstimatorRun2Base ()

Private Member Functions
int	findCategory (reco::GsfElectron const &electron) const
void	init (const std::vector< std::string > &weightFileNames)

Private Attributes
std::vector< ThreadSafeStringCut< StringCutObjectSelector< reco::GsfElectron >, reco::GsfElectron > >	categoryFunctions_
std::vector< std::unique_ptr< const GBRForest > >	gbrForests_
MVAVariableManager< reco::GsfElectron >	mvaVarMngr_
std::vector< int >	nVariables_
std::vector< std::vector< int > >	variables_

Detailed Description

Definition at line 16 of file ElectronMVAEstimatorRun2.h.

Constructor & Destructor Documentation

ElectronMVAEstimatorRun2() [1/2]

ElectronMVAEstimatorRun2::ElectronMVAEstimatorRun2

(

const edm::ParameterSet &

conf

)

Definition at line 3 of file ElectronMVAEstimatorRun2.cc.

    : AnyMVAEstimatorRun2Base(conf), mvaVarMngr_(conf.getParameter<std::string>("variableDefinition")) {
  const auto weightFileNames = conf.getParameter<std::vector<std::string> >("weightFileNames");
  const auto categoryCutStrings = conf.getParameter<std::vector<std::string> >("categoryCuts");
 
  if ((int)(categoryCutStrings.size()) != getNCategories())
    throw cms::Exception("MVA config failure: ")
        << "wrong number of category cuts in ElectronMVAEstimatorRun2" << getTag() << std::endl;
 
  for (int i = 0; i < getNCategories(); ++i) {
    categoryFunctions_.emplace_back(categoryCutStrings[i]);
  }
 
  // Initialize GBRForests from weight files
  init(weightFileNames);
}

References categoryFunctions_, AnyMVAEstimatorRun2Base::getNCategories(), edm::ParameterSet::getParameter(), AnyMVAEstimatorRun2Base::getTag(), mps_fire::i, init(), and mvaElectronID_Fall17_iso_V1_cff::weightFileNames.

~ElectronMVAEstimatorRun2()

ElectronMVAEstimatorRun2::~ElectronMVAEstimatorRun2 ( )

inlineoverride

Definition at line 20 of file ElectronMVAEstimatorRun2.h.

{};

ElectronMVAEstimatorRun2() [2/2]

ElectronMVAEstimatorRun2::ElectronMVAEstimatorRun2	(	const std::string &	mvaTag,
		const std::string &	mvaName,
		int	nCategories,
		const std::string &	variableDefinition,
		const std::vector< std::string > &	categoryCutStrings,
		const std::vector< std::string > &	weightFileNames,
		bool	debug = false
	)

Definition at line 20 of file ElectronMVAEstimatorRun2.cc.

    : AnyMVAEstimatorRun2Base(mvaName, mvaTag, nCategories, debug), mvaVarMngr_(variableDefinition) {
  if ((int)(categoryCutStrings.size()) != getNCategories())
    throw cms::Exception("MVA config failure: ")
        << "wrong number of category cuts in " << getName() << getTag() << std::endl;
 
  for (auto const& cut : categoryCutStrings)
    categoryFunctions_.emplace_back(cut);
  init(weightFileNames);
}

References categoryFunctions_, TkAlMuonSelectors_cfi::cut, AnyMVAEstimatorRun2Base::getName(), AnyMVAEstimatorRun2Base::getNCategories(), AnyMVAEstimatorRun2Base::getTag(), init(), and mvaElectronID_Fall17_iso_V1_cff::weightFileNames.

Member Function Documentation

findCategory() [1/2]

int ElectronMVAEstimatorRun2::findCategory ( const reco::Candidate *  candidate ) const

overridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 117 of file ElectronMVAEstimatorRun2.cc.

                                                                               {
  const reco::GsfElectron* electron = dynamic_cast<reco::GsfElectron const*>(candidate);
 
  if (electron == 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;
  }
 
  return findCategory(*electron);
}

References metsig::electron, and Exception.

Referenced by mvaValue().

findCategory() [2/2]

int ElectronMVAEstimatorRun2::findCategory ( reco::GsfElectron const &  electron ) const

private

Definition at line 129 of file ElectronMVAEstimatorRun2.cc.

                                                                                {
  for (int i = 0; i < getNCategories(); ++i) {
    if (categoryFunctions_[i](electron))
      return i;
  }
 
  edm::LogWarning("MVA warning") << "category not defined for particle with pt " << electron.pt() << " GeV, eta "
                                 << electron.superCluster()->eta() << " in ElectronMVAEstimatorRun2" << getTag();
 
  return -1;
}

References categoryFunctions_, metsig::electron, AnyMVAEstimatorRun2Base::getNCategories(), AnyMVAEstimatorRun2Base::getTag(), and mps_fire::i.

init()

void ElectronMVAEstimatorRun2::init ( const std::vector< std::string > &  weightFileNames )

private

Definition at line 37 of file ElectronMVAEstimatorRun2.cc.

                                                                               {
  if (isDebug()) {
    std::cout << " *** Inside ElectronMVAEstimatorRun2" << getTag() << std::endl;
  }
 
  // Initialize GBRForests
  if ((int)(weightFileNames.size()) != getNCategories())
    throw cms::Exception("MVA config failure: ")
        << "wrong number of weightfiles in ElectronMVAEstimatorRun2" << getTag() << std::endl;
 
  gbrForests_.clear();
  // Create a TMVA reader object for each category
  for (int i = 0; i < getNCategories(); i++) {
    std::vector<int> variablesInCategory;
 
    // Use unique_ptr so that all readers are properly cleaned up
    // when the vector clear() is called in the destructor
 
    std::vector<std::string> variableNamesInCategory;
    gbrForests_.push_back(createGBRForest(weightFileNames[i], variableNamesInCategory));
 
    nVariables_.push_back(variableNamesInCategory.size());
 
    variables_.push_back(variablesInCategory);
 
    if (isDebug()) {
      std::cout << " *** Inside ElectronMVAEstimatorRun2" << getTag() << 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 ElectronMVAEstimatorRun2" << getTag() << std::endl
            << "Variable " << variableNamesInCategory[j] << " not found in variable definition file!" << std::endl;
      }
      variables_[i].push_back(index);
    }
  }
}

References gather_cfg::cout, createGBRForest(), Exception, gbrForests_, AnyMVAEstimatorRun2Base::getNCategories(), AnyMVAEstimatorRun2Base::getTag(), MVAVariableManager< ParticleType >::getVarIndex(), mps_fire::i, AnyMVAEstimatorRun2Base::isDebug(), dqmiolumiharvest::j, mvaVarMngr_, nVariables_, variables_, and mvaElectronID_Fall17_iso_V1_cff::weightFileNames.

Referenced by ElectronMVAEstimatorRun2().

mvaValue() [1/2]

float ElectronMVAEstimatorRun2::mvaValue ( const reco::Candidate *  candidate, float  rho, int &  iCategory  ) const

inline

Definition at line 36 of file ElectronMVAEstimatorRun2.h.

                                                                                  {
    return mvaValue(candidate, std::vector<float>{rho}, iCategory);
  }

References mvaValue(), and rho.

mvaValue() [2/2]

float ElectronMVAEstimatorRun2::mvaValue ( const reco::Candidate *  candidate, std::vector< float > const &  auxVariables, int &  iCategory  ) const

overridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 79 of file ElectronMVAEstimatorRun2.cc.

                                                               {
  const reco::GsfElectron* electron = dynamic_cast<const reco::GsfElectron*>(candidate);
 
  if (electron == 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;
  }
 
  iCategory = findCategory(electron);
 
  if (iCategory < 0)
    return -999;
 
  std::vector<float> vars;
 
  for (int i = 0; i < nVariables_[iCategory]; ++i) {
    vars.push_back(mvaVarMngr_.getValue(variables_[iCategory][i], *electron, auxVariables));
  }
 
  if (isDebug()) {
    std::cout << " *** Inside ElectronMVAEstimatorRun2" << getTag() << 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 (isDebug()) {
    std::cout << " ### MVA " << response << std::endl << std::endl;
  }
 
  return response;
}

References gather_cfg::cout, metsig::electron, Exception, findCategory(), gbrForests_, MVAVariableManager< ParticleType >::getName(), AnyMVAEstimatorRun2Base::getTag(), MVAVariableManager< ParticleType >::getValue(), mps_fire::i, AnyMVAEstimatorRun2Base::isDebug(), mvaVarMngr_, nVariables_, and variables_.

Referenced by mvaValue().

Member Data Documentation

categoryFunctions_

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

private

Definition at line 47 of file ElectronMVAEstimatorRun2.h.

Referenced by ElectronMVAEstimatorRun2(), and findCategory().

gbrForests_

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

private

Definition at line 51 of file ElectronMVAEstimatorRun2.h.

Referenced by init(), and mvaValue().

mvaVarMngr_

MVAVariableManager<reco::GsfElectron> ElectronMVAEstimatorRun2::mvaVarMngr_

private

Definition at line 57 of file ElectronMVAEstimatorRun2.h.

Referenced by init(), and mvaValue().

nVariables_

std::vector<int> ElectronMVAEstimatorRun2::nVariables_

private

Definition at line 48 of file ElectronMVAEstimatorRun2.h.

Referenced by init(), and mvaValue().

variables_

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

private

Definition at line 55 of file ElectronMVAEstimatorRun2.h.

Referenced by init(), and mvaValue().