#include <PhysicsTools/PatAlgos/plugins/BaseMVAValueMapProducer.cc>

Inheritance diagram for BaseMVAValueMapProducer< T >:

Public Member Functions
	BaseMVAValueMapProducer (const edm::ParameterSet &iConfig)

void	setValue (const std::string var, float val)

	~BaseMVAValueMapProducer () override

Public Member Functions inherited from edm::stream::EDProducer<>
	EDProducer ()=default

bool	hasAbilityToProduceInBeginLumis () const final

bool	hasAbilityToProduceInBeginRuns () const final

bool	hasAbilityToProduceInEndLumis () const final

bool	hasAbilityToProduceInEndRuns () const final

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

static edm::ParameterSetDescription	getDescription ()

Private Member Functions
void	beginStream (edm::StreamID) override

void	endStream () override

virtual void	fillAdditionalVariables (const T &)

void	produce (edm::Event &, const edm::EventSetup &) override

virtual void	readAdditionalCollections (edm::Event &, const edm::EventSetup &)
	to be implemented in derived classes, filling values for additional variables More...

Private Attributes
std::string	backend_

std::vector< std::pair< std::string, StringObjectFunction< T, true > > >	funcs_

tensorflow::GraphDef *	graph_

std::string	inputTensorName_

bool	isClassifier_

std::string	name_

std::vector< StringObjectFunction< std::vector< float > > >	output_formulas_

std::vector< std::string >	output_names_

std::string	outputTensorName_

std::map< std::string, size_t >	positions_

TMVA::Reader *	reader_

tensorflow::Session *	session_

std::string	singleThreadPool_

edm::EDGetTokenT< edm::View< T > >	src_

bool	tf_

bool	tmva_

std::vector< float >	values_

std::vector< std::string >	variablesOrder_

std::string	weightfilename_

Additional Inherited Members
Public Types inherited from edm::stream::EDProducer<>
typedef CacheContexts< T... >	CacheTypes

typedef CacheTypes::GlobalCache	GlobalCache

typedef AbilityChecker< T... >	HasAbility

typedef CacheTypes::LuminosityBlockCache	LuminosityBlockCache

typedef LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >	LuminosityBlockContext

typedef CacheTypes::LuminosityBlockSummaryCache	LuminosityBlockSummaryCache

typedef CacheTypes::RunCache	RunCache

typedef RunContextT< RunCache, GlobalCache >	RunContext

typedef CacheTypes::RunSummaryCache	RunSummaryCache

Detailed Description

template<typename T>
class BaseMVAValueMapProducer< T >

Description: [one line class summary]

Implementation: [Notes on implementation]

Definition at line 56 of file BaseMVAValueMapProducer.h.

Constructor & Destructor Documentation

◆ BaseMVAValueMapProducer()

template<typename T>

BaseMVAValueMapProducer< T >::BaseMVAValueMapProducer ( const edm::ParameterSet & iConfig )

inlineexplicit

Definition at line 58 of file BaseMVAValueMapProducer.h.

       : src_(consumes<edm::View<T>>(iConfig.getParameter<edm::InputTag>("src"))),
         variablesOrder_(iConfig.getParameter<std::vector<std::string>>("variablesOrder")),
         singleThreadPool_(iConfig.getParameter<std::string>("singleThreadPool")),
         name_(iConfig.getParameter<std::string>("name")),
         backend_(iConfig.getParameter<std::string>("backend")),
         weightfilename_(iConfig.getParameter<edm::FileInPath>("weightFile").fullPath()),
         isClassifier_(iConfig.getParameter<bool>("isClassifier")),
         tmva_(backend_ == "TMVA"),
         tf_(backend_ == "TF") {
     if (tmva_)
       reader_ = new TMVA::Reader();
     edm::ParameterSet const& varsPSet = iConfig.getParameter<edm::ParameterSet>("variables");
     for (const std::string& vname : varsPSet.getParameterNamesForType<std::string>()) {
       funcs_.emplace_back(
           std::pair<std::string, StringObjectFunction<T, true>>(vname, varsPSet.getParameter<std::string>(vname)));
     }
  
     values_.resize(variablesOrder_.size());
     size_t i = 0;
     for (const auto& v : variablesOrder_) {
       positions_[v] = i;
       if (tmva_)
         reader_->AddVariable(v, (&values_.front()) + i);
       i++;
     }
     //      reader_.BookMVA(name_,iConfig.getParameter<edm::FileInPath>("weightFile").fullPath() );
     if (tmva_) {
       reco::details::loadTMVAWeights(reader_, name_, weightfilename_);
     } else if (tf_) {
       tensorflow::setLogging("3");
       graph_ = tensorflow::loadGraphDef(weightfilename_);
       inputTensorName_ = iConfig.getParameter<std::string>("inputTensorName");
       outputTensorName_ = iConfig.getParameter<std::string>("outputTensorName");
       output_names_ = iConfig.getParameter<std::vector<std::string>>("outputNames");
       for (const auto& s : iConfig.getParameter<std::vector<std::string>>("outputFormulas")) {
         output_formulas_.push_back(StringObjectFunction<std::vector<float>>(s));
       }
       size_t nThreads = iConfig.getParameter<unsigned int>("nThreads");
       session_ = tensorflow::createSession(graph_, nThreads);
  
     } else {
       throw cms::Exception("ConfigError") << "Only 'TF' and 'TMVA' backends are supported\n";
     }
     if (tmva_)
       produces<edm::ValueMap<float>>();
     else {
       for (const auto& n : output_names_) {
         produces<edm::ValueMap<float>>(n);
       }
     }
   }

◆ ~BaseMVAValueMapProducer()

template<typename T>

BaseMVAValueMapProducer< T >::~BaseMVAValueMapProducer ( )

inlineoverride

Definition at line 110 of file BaseMVAValueMapProducer.h.

110 {}

Member Function Documentation

◆ beginStream()

template<typename T>

void BaseMVAValueMapProducer< T >::beginStream ( edm::StreamID )

inlineoverrideprivate

Definition at line 121 of file BaseMVAValueMapProducer.h.

121 {};

◆ endStream()

template<typename T>

void BaseMVAValueMapProducer< T >::endStream ( )

inlineoverrideprivate

Definition at line 123 of file BaseMVAValueMapProducer.h.

123 {};

◆ fillAdditionalVariables()

template<typename T>

virtual void BaseMVAValueMapProducer< T >::fillAdditionalVariables ( const T & )

inlineprivatevirtual

Reimplemented in BJetEnergyRegressionMVA.

Definition at line 127 of file BaseMVAValueMapProducer.h.

127 {}

◆ fillDescriptions()

template<typename T >

void BaseMVAValueMapProducer< T >::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 225 of file BaseMVAValueMapProducer.h.

                                                                                             {
   edm::ParameterSetDescription desc = getDescription();
   std::string modname;
   if (typeid(T) == typeid(pat::Jet))
     modname += "Jet";
   else if (typeid(T) == typeid(pat::Muon))
     modname += "Muon";
   else if (typeid(T) == typeid(pat::Electron))
     modname += "Ele";
   modname += "BaseMVAValueMapProducer";
   descriptions.add(modname, desc);
 }

◆ getDescription()

template<typename T >

edm::ParameterSetDescription BaseMVAValueMapProducer< T >::getDescription ( )

static

Definition at line 201 of file BaseMVAValueMapProducer.h.

                                                                       {
   edm::ParameterSetDescription desc;
   desc.add<edm::InputTag>("src")->setComment("input physics object collection");
   desc.add<std::vector<std::string>>("variablesOrder")->setComment("ordered list of MVA input variable names");
   desc.add<std::string>("name")->setComment("output score variable name");
   desc.add<bool>("isClassifier")->setComment("is a classifier discriminator");
   edm::ParameterSetDescription variables;
   variables.setAllowAnything();
   desc.add<edm::ParameterSetDescription>("variables", variables)->setComment("list of input variable definitions");
   desc.add<edm::FileInPath>("weightFile")->setComment("xml weight file");
   desc.add<std::string>("backend", "TMVA")->setComment("TMVA or TF");
   desc.add<std::string>("inputTensorName", "")->setComment("Name of tensorflow input tensor in the model");
   desc.add<std::string>("outputTensorName", "")->setComment("Name of tensorflow output tensor in the model");
   desc.add<std::vector<std::string>>("outputNames", std::vector<std::string>())
       ->setComment("Names of the output values to be used in the output valuemap");
   desc.add<std::vector<std::string>>("outputFormulas", std::vector<std::string>())
       ->setComment("Formulas to be used to post process the output");
   desc.add<unsigned int>("nThreads", 1)->setComment("number of threads");
   desc.add<std::string>("singleThreadPool", "no_threads");
  
   return desc;
 }

Referenced by BJetEnergyRegressionMVA::fillDescriptions().

◆ produce()

template<typename T >

void BaseMVAValueMapProducer< T >::produce	(	edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)

overrideprivate

Definition at line 152 of file BaseMVAValueMapProducer.h.

                                                                                       {
   edm::Handle<edm::View<T>> src;
   iEvent.getByToken(src_, src);
   readAdditionalCollections(iEvent, iSetup);
   std::vector<std::vector<float>> mvaOut((tmva_) ? 1 : output_names_.size());
   for (auto& v : mvaOut)
     v.reserve(src->size());
  
   for (auto const& o : *src) {
     for (auto const& p : funcs_) {
       setValue(p.first, p.second(o));
     }
     fillAdditionalVariables(o);
     if (tmva_) {
       mvaOut[0].push_back(isClassifier_ ? reader_->EvaluateMVA(name_) : reader_->EvaluateRegression(name_)[0]);
     }
     if (tf_) {
       //currently support only one input sensor to reuse the TMVA like config
       tensorflow::TensorShape input_size{1, (long long int)positions_.size()};
       tensorflow::NamedTensorList input_tensors;
       input_tensors.resize(1);
       input_tensors[0] =
           tensorflow::NamedTensor(inputTensorName_, tensorflow::Tensor(tensorflow::DT_FLOAT, input_size));
       for (size_t j = 0; j < values_.size(); j++) {
         input_tensors[0].second.matrix<float>()(0, j) = values_[j];
       }
       std::vector<tensorflow::Tensor> outputs;
       std::vector<std::string> names;
       names.push_back(outputTensorName_);
       tensorflow::run(session_, input_tensors, names, &outputs, singleThreadPool_);
       std::vector<float> tmpOut;
       for (int k = 0; k < outputs.at(0).matrix<float>().dimension(1); k++)
         tmpOut.push_back(outputs.at(0).matrix<float>()(0, k));
       for (size_t k = 0; k < output_names_.size(); k++)
         mvaOut[k].push_back(output_formulas_[k](tmpOut));
     }
   }
   size_t k = 0;
   for (auto& m : mvaOut) {
     std::unique_ptr<edm::ValueMap<float>> mvaV(new edm::ValueMap<float>());
     edm::ValueMap<float>::Filler filler(*mvaV);
     filler.insert(src, m.begin(), m.end());
     filler.fill();
     iEvent.put(std::move(mvaV), (tmva_) ? "" : output_names_[k]);
     k++;
   }
 }

◆ readAdditionalCollections()

template<typename T>

virtual void BaseMVAValueMapProducer< T >::readAdditionalCollections	(	edm::Event &	,
		const edm::EventSetup &
	)

inlineprivatevirtual

to be implemented in derived classes, filling values for additional variables

Reimplemented in BJetEnergyRegressionMVA.

Definition at line 126 of file BaseMVAValueMapProducer.h.

126 {}

◆ setValue()

template<typename T>

void BaseMVAValueMapProducer< T >::setValue	(	const std::string	var,
		float	val
	)

inline

Definition at line 112 of file BaseMVAValueMapProducer.h.

                                                 {
     if (positions_.find(var) != positions_.end())
       values_[positions_[var]] = val;
   }

Member Data Documentation

◆ backend_

template<typename T>

std::string BaseMVAValueMapProducer< T >::backend_

private

Definition at line 140 of file BaseMVAValueMapProducer.h.

◆ funcs_

template<typename T>

std::vector<std::pair<std::string, StringObjectFunction<T, true> > > BaseMVAValueMapProducer< T >::funcs_

private

Definition at line 131 of file BaseMVAValueMapProducer.h.

Referenced by BaseMVAValueMapProducer< pat::Jet >::BaseMVAValueMapProducer().

◆ graph_

template<typename T>

tensorflow::GraphDef* BaseMVAValueMapProducer< T >::graph_

private

Definition at line 135 of file BaseMVAValueMapProducer.h.

Referenced by BaseMVAValueMapProducer< pat::Jet >::BaseMVAValueMapProducer().

◆ inputTensorName_

template<typename T>

std::string BaseMVAValueMapProducer< T >::inputTensorName_

private

Definition at line 145 of file BaseMVAValueMapProducer.h.

Referenced by BaseMVAValueMapProducer< pat::Jet >::BaseMVAValueMapProducer().

◆ isClassifier_

template<typename T>

bool BaseMVAValueMapProducer< T >::isClassifier_

private

Definition at line 142 of file BaseMVAValueMapProducer.h.

◆ name_

template<typename T>

std::string BaseMVAValueMapProducer< T >::name_

private

Definition at line 139 of file BaseMVAValueMapProducer.h.

Referenced by BaseMVAValueMapProducer< pat::Jet >::BaseMVAValueMapProducer().

◆ output_formulas_

template<typename T>

std::vector<StringObjectFunction<std::vector<float> > > BaseMVAValueMapProducer< T >::output_formulas_

private

Definition at line 148 of file BaseMVAValueMapProducer.h.

Referenced by BaseMVAValueMapProducer< pat::Jet >::BaseMVAValueMapProducer().

◆ output_names_

template<typename T>

std::vector<std::string> BaseMVAValueMapProducer< T >::output_names_

private

Definition at line 147 of file BaseMVAValueMapProducer.h.

Referenced by BaseMVAValueMapProducer< pat::Jet >::BaseMVAValueMapProducer().

◆ outputTensorName_

template<typename T>

std::string BaseMVAValueMapProducer< T >::outputTensorName_

private

Definition at line 146 of file BaseMVAValueMapProducer.h.

Referenced by BaseMVAValueMapProducer< pat::Jet >::BaseMVAValueMapProducer().

◆ positions_

template<typename T>

std::map<std::string, size_t> BaseMVAValueMapProducer< T >::positions_

private

Definition at line 130 of file BaseMVAValueMapProducer.h.

Referenced by BaseMVAValueMapProducer< pat::Jet >::BaseMVAValueMapProducer(), and BaseMVAValueMapProducer< pat::Jet >::setValue().

◆ reader_

template<typename T>

TMVA::Reader* BaseMVAValueMapProducer< T >::reader_

private

Definition at line 134 of file BaseMVAValueMapProducer.h.

Referenced by BaseMVAValueMapProducer< pat::Jet >::BaseMVAValueMapProducer().

◆ session_

template<typename T>

tensorflow::Session* BaseMVAValueMapProducer< T >::session_

private

Definition at line 136 of file BaseMVAValueMapProducer.h.

Referenced by BaseMVAValueMapProducer< pat::Jet >::BaseMVAValueMapProducer().

◆ singleThreadPool_

template<typename T>

std::string BaseMVAValueMapProducer< T >::singleThreadPool_

private

Definition at line 137 of file BaseMVAValueMapProducer.h.

◆ src_

template<typename T>

edm::EDGetTokenT<edm::View<T> > BaseMVAValueMapProducer< T >::src_

private

Definition at line 129 of file BaseMVAValueMapProducer.h.

◆ tf_

template<typename T>

bool BaseMVAValueMapProducer< T >::tf_

private

Definition at line 144 of file BaseMVAValueMapProducer.h.

Referenced by BaseMVAValueMapProducer< pat::Jet >::BaseMVAValueMapProducer().

◆ tmva_

template<typename T>

bool BaseMVAValueMapProducer< T >::tmva_

private

Definition at line 143 of file BaseMVAValueMapProducer.h.

Referenced by BaseMVAValueMapProducer< pat::Jet >::BaseMVAValueMapProducer().

◆ values_

template<typename T>

std::vector<float> BaseMVAValueMapProducer< T >::values_

private

Definition at line 133 of file BaseMVAValueMapProducer.h.

Referenced by BaseMVAValueMapProducer< pat::Jet >::BaseMVAValueMapProducer(), and BaseMVAValueMapProducer< pat::Jet >::setValue().

◆ variablesOrder_

template<typename T>

std::vector<std::string> BaseMVAValueMapProducer< T >::variablesOrder_

private

Definition at line 132 of file BaseMVAValueMapProducer.h.

Referenced by BaseMVAValueMapProducer< pat::Jet >::BaseMVAValueMapProducer().

◆ weightfilename_

template<typename T>

std::string BaseMVAValueMapProducer< T >::weightfilename_

private

Definition at line 141 of file BaseMVAValueMapProducer.h.

Referenced by BaseMVAValueMapProducer< pat::Jet >::BaseMVAValueMapProducer().

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<typename T> class BaseMVAValueMapProducer< T >

Constructor & Destructor Documentation

◆ BaseMVAValueMapProducer()

◆ ~BaseMVAValueMapProducer()

Member Function Documentation

◆ beginStream()

◆ endStream()

◆ fillAdditionalVariables()

◆ fillDescriptions()

◆ getDescription()

◆ produce()

◆ readAdditionalCollections()

◆ setValue()

Member Data Documentation

◆ backend_

◆ funcs_

◆ graph_

◆ inputTensorName_

◆ isClassifier_

◆ name_

◆ output_formulas_

◆ output_names_

◆ outputTensorName_

◆ positions_

◆ reader_

◆ session_

◆ singleThreadPool_

◆ src_

◆ tf_

◆ tmva_

◆ values_

◆ variablesOrder_

◆ weightfilename_

template<typename T>
class BaseMVAValueMapProducer< T >