PhotonMVAEstimator Class Reference

Inheritance diagram for PhotonMVAEstimator:

Public Member Functions
int	findCategory (const reco::Candidate *candPtr) const override
float	mvaValue (const reco::Candidate *candPtr, std::vector< float > const &auxVars, int &iCategory) const override
	PhotonMVAEstimator (const edm::ParameterSet &conf)
	~PhotonMVAEstimator () 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 ()

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

Private Member Functions
int	findCategory (reco::Photon const &photon) const

Private Attributes
std::vector< ThreadSafeFunctor< StringCutObjectSelector< reco::Photon > > >	categoryFunctions_
std::unique_ptr< EffectiveAreas >	effectiveAreas_
std::vector< std::unique_ptr< const GBRForest > >	gbrForests_
MVAVariableManager< reco::Photon >	mvaVarMngr_
int	nCategories_
std::vector< int >	nVariables_
double	phoIsoCutoff_
std::vector< double >	phoIsoPtScalingCoeff_
std::vector< std::vector< int > >	variables_

Detailed Description

Definition at line 15 of file PhotonMVAEstimator.cc.

Constructor & Destructor Documentation

PhotonMVAEstimator()

PhotonMVAEstimator::PhotonMVAEstimator

(

const edm::ParameterSet &

conf

)

Definition at line 52 of file PhotonMVAEstimator.cc.

    : AnyMVAEstimatorRun2Base(conf),
      mvaVarMngr_(conf.getParameter<std::string>("variableDefinition"), MVAVariableHelper::indexMap()) {
  //
  // Construct the MVA estimators
  //
  if (getTag() == "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 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 PhotonMVAEstimator" << getTag() << std::endl;
 
  for (auto const& cut : categoryCutStrings)
    categoryFunctions_.emplace_back(cut);
 
  // Initialize GBRForests
  if (static_cast<int>(weightFileNames.size()) != getNCategories())
    throw cms::Exception("MVA config failure: ")
        << "wrong number of weightfiles in PhotonMVAEstimator" << getTag() << std::endl;
 
  gbrForests_.clear();
  // Create a TMVA reader object for each category
  for (int i = 0; i < getNCategories(); i++) {
    std::vector<int> variablesInCategory;
 
    std::vector<std::string> variableNamesInCategory;
    gbrForests_.push_back(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 PhotonMVAEstimator" << getTag() << std::endl
            << "Variable " << variableNamesInCategory[j] << " not found in variable definition file!" << std::endl;
      }
      variables_[i].push_back(index);
    }
  }
}

References categoryFunctions_, createGBRForest(), TkAlMuonSelectors_cfi::cut, effectiveAreas_, Exception, gbrForests_, AnyMVAEstimatorRun2Base::getNCategories(), edm::ParameterSet::getParameter(), AnyMVAEstimatorRun2Base::getTag(), MVAVariableManager< ParticleType >::getVarIndex(), mps_fire::i, dqmiolumiharvest::j, mvaVarMngr_, nVariables_, phoIsoCutoff_, phoIsoPtScalingCoeff_, variables_, and mvaElectronID_Fall17_iso_V1_cff::weightFileNames.

~PhotonMVAEstimator()

PhotonMVAEstimator::~PhotonMVAEstimator ( )

inlineoverride

Definition at line 19 of file PhotonMVAEstimator.cc.

{};

Member Function Documentation

fillDescriptions()

static void PhotonMVAEstimator::fillDescriptions ( edm::ConfigurationDescriptions &  descriptions )

static

findCategory() [1/2]

int PhotonMVAEstimator::findCategory ( const reco::Candidate *  candPtr ) const

overridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 149 of file PhotonMVAEstimator.cc.

                                                                       {
  const reco::Photon* phoPtr = dynamic_cast<const reco::Photon*>(candPtr);
  if (phoPtr == 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;
  }
 
  return findCategory(*phoPtr);
}

References Exception.

Referenced by mvaValue().

findCategory() [2/2]

int PhotonMVAEstimator::findCategory ( reco::Photon const &  photon ) const

private

Definition at line 160 of file PhotonMVAEstimator.cc.

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

References categoryFunctions_, AnyMVAEstimatorRun2Base::getNCategories(), AnyMVAEstimatorRun2Base::getTag(), mps_fire::i, and muons2muons_cfi::photon.

mvaValue()

float PhotonMVAEstimator::mvaValue ( const reco::Candidate *  candPtr, std::vector< float > const &  auxVars, int &  iCategory  ) const

overridevirtual

Implements AnyMVAEstimatorRun2Base.

Definition at line 104 of file PhotonMVAEstimator.cc.

                                                         {
  const reco::Photon* phoPtr = dynamic_cast<const reco::Photon*>(candPtr);
  if (phoPtr == 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;
  }
 
  iCategory = findCategory(phoPtr);
 
  std::vector<float> vars;
 
  vars.reserve(nVariables_[iCategory]);
  for (int i = 0; i < nVariables_[iCategory]; ++i) {
    vars.push_back(mvaVarMngr_.getValue(variables_[iCategory][i], *phoPtr, auxVars));
  }
 
  // Special case for Spring16!
  if (getTag() == "Run2Spring16NonTrigV1" and iCategory == 1) {  // Endcap category
    // 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 (isDebug()) {
    std::cout << " *** Inside PhotonMVAEstimator" << 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());
 
  if (isDebug()) {
    std::cout << " ### MVA " << response << std::endl << std::endl;
  }
 
  return response;
}

References funct::abs(), gather_cfg::cout, effectiveAreas_, Exception, findCategory(), gbrForests_, MVAVariableManager< ParticleType >::getName(), AnyMVAEstimatorRun2Base::getTag(), MVAVariableManager< ParticleType >::getValue(), mps_fire::i, AnyMVAEstimatorRun2Base::isDebug(), Max(), mvaVarMngr_, nVariables_, phoIsoCutoff_, phoIsoPtScalingCoeff_, reco::LeafCandidate::pt(), reco::Photon::superCluster(), and variables_.

Member Data Documentation

categoryFunctions_

std::vector<ThreadSafeFunctor<StringCutObjectSelector<reco::Photon> > > PhotonMVAEstimator::categoryFunctions_

private

Definition at line 33 of file PhotonMVAEstimator.cc.

Referenced by findCategory(), and PhotonMVAEstimator().

effectiveAreas_

std::unique_ptr<EffectiveAreas> PhotonMVAEstimator::effectiveAreas_

private

Definition at line 47 of file PhotonMVAEstimator.cc.

Referenced by mvaValue(), and PhotonMVAEstimator().

gbrForests_

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

private

Definition at line 37 of file PhotonMVAEstimator.cc.

Referenced by mvaValue(), and PhotonMVAEstimator().

mvaVarMngr_

MVAVariableManager<reco::Photon> PhotonMVAEstimator::mvaVarMngr_

private

Definition at line 44 of file PhotonMVAEstimator.cc.

Referenced by mvaValue(), and PhotonMVAEstimator().

nCategories_

int PhotonMVAEstimator::nCategories_

private

Definition at line 32 of file PhotonMVAEstimator.cc.

nVariables_

std::vector<int> PhotonMVAEstimator::nVariables_

private

Definition at line 34 of file PhotonMVAEstimator.cc.

Referenced by mvaValue(), and PhotonMVAEstimator().

phoIsoCutoff_

double PhotonMVAEstimator::phoIsoCutoff_

private

Definition at line 49 of file PhotonMVAEstimator.cc.

Referenced by mvaValue(), and PhotonMVAEstimator().

phoIsoPtScalingCoeff_

std::vector<double> PhotonMVAEstimator::phoIsoPtScalingCoeff_

private

Definition at line 48 of file PhotonMVAEstimator.cc.

Referenced by mvaValue(), and PhotonMVAEstimator().

variables_

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

private

Definition at line 41 of file PhotonMVAEstimator.cc.

Referenced by mvaValue(), and PhotonMVAEstimator().