CMS 3D CMS Logo

List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
PhotonMVAEstimator Class Reference
Inheritance diagram for PhotonMVAEstimator:
AnyMVAEstimatorRun2Base

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< ThreadSafeStringCut< StringCutObjectSelector< reco::Photon >, reco::Photon > > categoryFunctions_
 
std::unique_ptr< EffectiveAreaseffectiveAreas_
 
std::vector< std::unique_ptr< const GBRForest > > gbrForests_
 
MVAVariableManager< reco::PhotonmvaVarMngr_
 
int nCategories_
 
std::vector< int > nVariables_
 
double phoIsoCutoff_
 
std::vector< double > phoIsoPtScalingCoeff_
 
std::vector< std::vector< int > > variables_
 

Detailed Description

Definition at line 13 of file PhotonMVAEstimator.cc.

Constructor & Destructor Documentation

◆ PhotonMVAEstimator()

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

Definition at line 50 of file PhotonMVAEstimator.cc.

51  : AnyMVAEstimatorRun2Base(conf), mvaVarMngr_(conf.getParameter<std::string>("variableDefinition")) {
52  //
53  // Construct the MVA estimators
54  //
55  if (getTag() == "Run2Spring16NonTrigV1") {
57  std::make_unique<EffectiveAreas>((conf.getParameter<edm::FileInPath>("effAreasConfigFile")).fullPath());
58  phoIsoPtScalingCoeff_ = conf.getParameter<std::vector<double>>("phoIsoPtScalingCoeff");
59  phoIsoCutoff_ = conf.getParameter<double>("phoIsoCutoff");
60  }
61 
62  const auto weightFileNames = conf.getParameter<std::vector<std::string>>("weightFileNames");
63  const auto categoryCutStrings = conf.getParameter<std::vector<std::string>>("categoryCuts");
64 
65  if ((int)(categoryCutStrings.size()) != getNCategories())
66  throw cms::Exception("MVA config failure: ")
67  << "wrong number of category cuts in PhotonMVAEstimator" << getTag() << std::endl;
68 
69  for (auto const& cut : categoryCutStrings)
70  categoryFunctions_.emplace_back(cut);
71 
72  // Initialize GBRForests
73  if (static_cast<int>(weightFileNames.size()) != getNCategories())
74  throw cms::Exception("MVA config failure: ")
75  << "wrong number of weightfiles in PhotonMVAEstimator" << getTag() << std::endl;
76 
77  gbrForests_.clear();
78  // Create a TMVA reader object for each category
79  for (int i = 0; i < getNCategories(); i++) {
80  std::vector<int> variablesInCategory;
81 
82  std::vector<std::string> variableNamesInCategory;
83  gbrForests_.push_back(createGBRForest(weightFileNames[i], variableNamesInCategory));
84 
85  nVariables_.push_back(variableNamesInCategory.size());
86 
87  variables_.push_back(variablesInCategory);
88 
89  for (int j = 0; j < nVariables_[i]; ++j) {
90  int index = mvaVarMngr_.getVarIndex(variableNamesInCategory[j]);
91  if (index == -1) {
92  throw cms::Exception("MVA config failure: ")
93  << "Concerning PhotonMVAEstimator" << getTag() << std::endl
94  << "Variable " << variableNamesInCategory[j] << " not found in variable definition file!" << std::endl;
95  }
96  variables_[i].push_back(index);
97  }
98  }
99 }

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 17 of file PhotonMVAEstimator.cc.

17 {};

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 145 of file PhotonMVAEstimator.cc.

145  {
146  const reco::Photon* phoPtr = dynamic_cast<const reco::Photon*>(candPtr);
147  if (phoPtr == nullptr) {
148  throw cms::Exception("MVA failure: ")
149  << " given particle is expected to be reco::Photon or pat::Photon," << std::endl
150  << " but appears to be neither" << std::endl;
151  }
152 
153  return findCategory(*phoPtr);
154 }

References Exception.

Referenced by mvaValue().

◆ findCategory() [2/2]

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

Definition at line 156 of file PhotonMVAEstimator.cc.

156  {
157  for (int i = 0; i < getNCategories(); ++i) {
159  return i;
160  }
161 
162  edm::LogWarning("MVA warning") << "category not defined for particle with pt " << photon.pt() << " GeV, eta "
163  << photon.superCluster()->eta() << " in PhotonMVAEstimator" << getTag();
164 
165  return -1;
166 }

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 101 of file PhotonMVAEstimator.cc.

103  {
104  const reco::Photon* phoPtr = dynamic_cast<const reco::Photon*>(candPtr);
105  if (phoPtr == nullptr) {
106  throw cms::Exception("MVA failure: ")
107  << " given particle is expected to be reco::Photon or pat::Photon," << std::endl
108  << " but appears to be neither" << std::endl;
109  }
110 
111  iCategory = findCategory(phoPtr);
112 
113  std::vector<float> vars;
114 
115  for (int i = 0; i < nVariables_[iCategory]; ++i) {
116  vars.push_back(mvaVarMngr_.getValue(variables_[iCategory][i], *phoPtr, auxVars));
117  }
118 
119  // Special case for Spring16!
120  if (getTag() == "Run2Spring16NonTrigV1" and iCategory == 1) { // Endcap category
121  // Raw value for EB only, because of loss of transparency in EE
122  // for endcap MVA only in 2016
123  double eA = effectiveAreas_->getEffectiveArea(std::abs(phoPtr->superCluster()->eta()));
124  double phoIsoCorr = vars[10] - eA * (double)vars[9] - phoIsoPtScalingCoeff_.at(1) * phoPtr->pt();
125  vars[10] = TMath::Max(phoIsoCorr, phoIsoCutoff_);
126  }
127 
128  if (isDebug()) {
129  std::cout << " *** Inside PhotonMVAEstimator" << getTag() << std::endl;
130  std::cout << " category " << iCategory << std::endl;
131  for (int i = 0; i < nVariables_[iCategory]; ++i) {
132  std::cout << " " << mvaVarMngr_.getName(variables_[iCategory][i]) << " " << vars[i] << std::endl;
133  }
134  }
135 
136  const float response = gbrForests_.at(iCategory)->GetResponse(vars.data());
137 
138  if (isDebug()) {
139  std::cout << " ### MVA " << response << std::endl << std::endl;
140  }
141 
142  return response;
143 }

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<ThreadSafeStringCut<StringCutObjectSelector<reco::Photon>, reco::Photon> > PhotonMVAEstimator::categoryFunctions_
private

Definition at line 31 of file PhotonMVAEstimator.cc.

Referenced by findCategory(), and PhotonMVAEstimator().

◆ effectiveAreas_

std::unique_ptr<EffectiveAreas> PhotonMVAEstimator::effectiveAreas_
private

Definition at line 45 of file PhotonMVAEstimator.cc.

Referenced by mvaValue(), and PhotonMVAEstimator().

◆ gbrForests_

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

Definition at line 35 of file PhotonMVAEstimator.cc.

Referenced by mvaValue(), and PhotonMVAEstimator().

◆ mvaVarMngr_

MVAVariableManager<reco::Photon> PhotonMVAEstimator::mvaVarMngr_
private

Definition at line 42 of file PhotonMVAEstimator.cc.

Referenced by mvaValue(), and PhotonMVAEstimator().

◆ nCategories_

int PhotonMVAEstimator::nCategories_
private

Definition at line 30 of file PhotonMVAEstimator.cc.

◆ nVariables_

std::vector<int> PhotonMVAEstimator::nVariables_
private

Definition at line 32 of file PhotonMVAEstimator.cc.

Referenced by mvaValue(), and PhotonMVAEstimator().

◆ phoIsoCutoff_

double PhotonMVAEstimator::phoIsoCutoff_
private

Definition at line 47 of file PhotonMVAEstimator.cc.

Referenced by mvaValue(), and PhotonMVAEstimator().

◆ phoIsoPtScalingCoeff_

std::vector<double> PhotonMVAEstimator::phoIsoPtScalingCoeff_
private

Definition at line 46 of file PhotonMVAEstimator.cc.

Referenced by mvaValue(), and PhotonMVAEstimator().

◆ variables_

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

Definition at line 39 of file PhotonMVAEstimator.cc.

Referenced by mvaValue(), and PhotonMVAEstimator().

PhotonMVAEstimator::categoryFunctions_
std::vector< ThreadSafeStringCut< StringCutObjectSelector< reco::Photon >, reco::Photon > > categoryFunctions_
Definition: PhotonMVAEstimator.cc:31
AnyMVAEstimatorRun2Base::AnyMVAEstimatorRun2Base
AnyMVAEstimatorRun2Base(const edm::ParameterSet &conf)
Definition: AnyMVAEstimatorRun2Base.h:14
muons2muons_cfi.photon
photon
Definition: muons2muons_cfi.py:28
mps_fire.i
i
Definition: mps_fire.py:355
reco::Photon::superCluster
reco::SuperClusterRef superCluster() const override
Ref to SuperCluster.
PhotonMVAEstimator::variables_
std::vector< std::vector< int > > variables_
Definition: PhotonMVAEstimator.cc:39
TkAlMuonSelectors_cfi.cut
cut
Definition: TkAlMuonSelectors_cfi.py:5
MVAVariableManager::getValue
float getValue(int index, const ParticleType &particle, const std::vector< float > &auxVariables) const
Definition: MVAVariableManager.h:51
PhotonMVAEstimator::gbrForests_
std::vector< std::unique_ptr< const GBRForest > > gbrForests_
Definition: PhotonMVAEstimator.cc:35
gather_cfg.cout
cout
Definition: gather_cfg.py:144
createGBRForest
std::unique_ptr< const GBRForest > createGBRForest(const std::string &weightsFile)
Definition: GBRForestTools.cc:244
reco::LeafCandidate::pt
double pt() const final
transverse momentum
Definition: LeafCandidate.h:146
PhotonMVAEstimator::phoIsoPtScalingCoeff_
std::vector< double > phoIsoPtScalingCoeff_
Definition: PhotonMVAEstimator.cc:46
PhotonMVAEstimator::phoIsoCutoff_
double phoIsoCutoff_
Definition: PhotonMVAEstimator.cc:47
MVAVariableManager::getName
const std::string & getName(int index) const
Definition: MVAVariableManager.h:47
edm::FileInPath
Definition: FileInPath.h:64
vars
vars
Definition: DeepTauId.cc:163
AnyMVAEstimatorRun2Base::isDebug
bool isDebug() const
Definition: AnyMVAEstimatorRun2Base.h:46
AlCaHLTBitMon_QueryRunRegistry.string
string
Definition: AlCaHLTBitMon_QueryRunRegistry.py:256
edm::LogWarning
Definition: MessageLogger.h:141
MVAVariableManager::getVarIndex
int getVarIndex(const std::string &name)
Definition: MVAVariableManager.h:38
PhotonMVAEstimator::effectiveAreas_
std::unique_ptr< EffectiveAreas > effectiveAreas_
Definition: PhotonMVAEstimator.cc:45
AnyMVAEstimatorRun2Base::getNCategories
int getNCategories() const
Definition: AnyMVAEstimatorRun2Base.h:39
AnyMVAEstimatorRun2Base::getTag
const std::string & getTag() const
Definition: AnyMVAEstimatorRun2Base.h:44
Max
T Max(T a, T b)
Definition: MathUtil.h:44
PhotonMVAEstimator::mvaVarMngr_
MVAVariableManager< reco::Photon > mvaVarMngr_
Definition: PhotonMVAEstimator.cc:42
reco::Photon
Definition: Photon.h:21
edm::ParameterSet::getParameter
T getParameter(std::string const &) const
mvaElectronID_Fall17_iso_V1_cff.weightFileNames
weightFileNames
Definition: mvaElectronID_Fall17_iso_V1_cff.py:89
Exception
Definition: hltDiff.cc:246
PhotonMVAEstimator::nVariables_
std::vector< int > nVariables_
Definition: PhotonMVAEstimator.cc:32
AlignmentPI::index
index
Definition: AlignmentPayloadInspectorHelper.h:46
cms::Exception
Definition: Exception.h:70
funct::abs
Abs< T >::type abs(const T &t)
Definition: Abs.h:22
dqmiolumiharvest.j
j
Definition: dqmiolumiharvest.py:66
PhotonMVAEstimator::findCategory
int findCategory(const reco::Candidate *candPtr) const override
Definition: PhotonMVAEstimator.cc:145