MVAValueMapProducer< ParticleType > Class Template Reference

#include <MVAValueMapProducer.h>

Inheritance diagram for MVAValueMapProducer< ParticleType >:

Public Member Functions
	MVAValueMapProducer (const edm::ParameterSet &)
Public Member Functions inherited from edm::global::EDProducer<>
	EDProducer ()=default
	EDProducer (const EDProducer &)=delete
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginProcessBlocks () const final
bool	hasAbilityToProduceInBeginRuns () const final
bool	hasAbilityToProduceInEndLumis () const final
bool	hasAbilityToProduceInEndProcessBlocks () const final
bool	hasAbilityToProduceInEndRuns () const final
EDProducer &	operator= (const EDProducer &)=delete
bool	wantsGlobalLuminosityBlocks () const final
bool	wantsGlobalRuns () const final
bool	wantsInputProcessBlocks () const final
bool	wantsProcessBlocks () const final
bool	wantsStreamLuminosityBlocks () const final
bool	wantsStreamRuns () const final
Public Member Functions inherited from edm::global::EDProducerBase
	EDProducerBase ()
ModuleDescription const &	moduleDescription () const
	~EDProducerBase () override
Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const
	ProducerBase ()
std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const
std::vector< bool > const &	recordProvenanceList () const
void	registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...
void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
TypeLabelList const &	typeLabelList () const
	used by the fwk to register the list of products of this module More...
	~ProducerBase () noexcept(false) override
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...
	EDConsumerBase ()
	EDConsumerBase (EDConsumerBase &&)=default
	EDConsumerBase (EDConsumerBase const &)=delete
ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const
std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const
std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const
ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesWhoseProductsAreConsumed (std::array< std::vector< ModuleDescription const * > *, NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
EDConsumerBase &	operator= (EDConsumerBase &&)=default
EDConsumerBase const &	operator= (EDConsumerBase const &)=delete
bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)
virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)
Static Public Member Functions inherited from edm::global::EDProducerBase
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
void	produce (edm::StreamID, edm::Event &, const edm::EventSetup &) const override

Private Attributes
const edm::EDGetTokenT< edm::View< ParticleType > >	keysForValueMapsToken_
const std::vector< std::string >	mvaCategoriesMapNames_
const std::vector< std::unique_ptr< AnyMVAEstimatorRun2Base > >	mvaEstimators_
const std::vector< std::string >	mvaRawValueMapNames_
const std::vector< std::string >	mvaValueMapNames_
const edm::EDGetTokenT< edm::View< ParticleType > >	srcToken_
std::atomic< bool >	validated_ = false
const MVAVariableHelper	variableHelper_

Additional Inherited Members
Public Types inherited from edm::global::EDProducerBase
typedef EDProducerBase	ModuleType
Public Types inherited from edm::ProducerBase
using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const *, const char *, edm::ProductResolverIndex > >
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels
Protected Member Functions inherited from edm::ProducerBase
template<class ProductType >
BranchAliasSetterT< ProductType >	produces ()
	declare what type of product will make and with which optional label More...
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces ()
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces ()
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<BranchType B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<Transition B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
template<class ProductType >
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
ProducesCollector	producesCollector ()
Protected Member Functions inherited from edm::EDConsumerBase
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept
template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)
ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...
template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()
void	consumesMany (const TypeToGet &id)
template<BranchType B>
void	consumesMany (const TypeToGet &id)
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()
template<Transition Tr = Transition::Event>
constexpr auto	esConsumes () noexcept
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag) noexcept
template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

Detailed Description

template<class ParticleType>
class MVAValueMapProducer< ParticleType >

Definition at line 28 of file MVAValueMapProducer.h.

Constructor & Destructor Documentation

MVAValueMapProducer()

template<class ParticleType >

MVAValueMapProducer< ParticleType >::MVAValueMapProducer

(

const edm::ParameterSet &

iConfig

)

Definition at line 107 of file MVAValueMapProducer.h.

    : srcToken_(consumes<edm::View<ParticleType>>(iConfig.getParameter<edm::InputTag>("src"))),
      keysForValueMapsToken_(getKeysForValueMapsToken<ParticleType>(
          iConfig.getParameter<edm::InputTag>("keysForValueMaps"), consumesCollector())),
      mvaEstimators_(getMVAEstimators(iConfig.getParameterSetVector("mvaConfigurations"))),
      mvaValueMapNames_(getValueMapNames(iConfig.getParameterSetVector("mvaConfigurations"), "Values")),
      mvaRawValueMapNames_(getValueMapNames(iConfig.getParameterSetVector("mvaConfigurations"), "RawValues")),
      mvaCategoriesMapNames_(getValueMapNames(iConfig.getParameterSetVector("mvaConfigurations"), "Categories")),
      variableHelper_(consumesCollector()) {
  for (auto const& name : mvaValueMapNames_)
    produces<edm::ValueMap<float>>(name);
  for (auto const& name : mvaRawValueMapNames_)
    produces<edm::ValueMap<float>>(name);
  for (auto const& name : mvaCategoriesMapNames_)
    produces<edm::ValueMap<int>>(name);
}

References MVAValueMapProducer< ParticleType >::mvaCategoriesMapNames_, MVAValueMapProducer< ParticleType >::mvaRawValueMapNames_, MVAValueMapProducer< ParticleType >::mvaValueMapNames_, and Skims_PA_cff::name.

Member Function Documentation

fillDescriptions()

template<class ParticleType >

void MVAValueMapProducer< ParticleType >::fillDescriptions ( edm::ConfigurationDescriptions &  descriptions )

static

Definition at line 163 of file MVAValueMapProducer.h.

                                                                                                   {
  edm::ParameterSetDescription desc;
  desc.add<edm::InputTag>("src", {});
  desc.add<edm::InputTag>("keysForValueMaps", {});
  {
    //The following says we do not know what parameters are allowed so do no validation
    // Please change this to state exactly what you do use, even if it is no parameters
    edm::ParameterSetDescription mvaConfigurations;
    mvaConfigurations.setUnknown();
    desc.addVPSet("mvaConfigurations", mvaConfigurations);
  }
  descriptions.addDefault(desc);
}

References edm::ConfigurationDescriptions::addDefault(), submitPVResolutionJobs::desc, and ElectronMVAValueMapProducer_cfi::mvaConfigurations.

produce()

template<class ParticleType >

void MVAValueMapProducer< ParticleType >::produce ( edm::StreamID  , edm::Event &  iEvent, const edm::EventSetup &  iSetup  ) const

overrideprivatevirtual

Implements edm::global::EDProducerBase.

Definition at line 125 of file MVAValueMapProducer.h.

                                                                                   {
  std::vector<float> auxVariables = variableHelper_.getAuxVariables(iEvent);
 
  auto srcHandle = iEvent.getHandle(srcToken_);
  auto keysForValueMapsHandle =
      keysForValueMapsToken_.isUninitialized() ? srcHandle : iEvent.getHandle(keysForValueMapsToken_);
 
  // check if nothing is wrong with the data format of the candidates
  if (!validated_ && !srcHandle->empty()) {
    egammaTools::validateEgammaCandidate((*srcHandle)[0]);
    validated_ = true;
  }
 
  // Loop over MVA estimators
  for (unsigned iEstimator = 0; iEstimator < mvaEstimators_.size(); iEstimator++) {
    std::vector<float> mvaValues;
    std::vector<float> mvaRawValues;
    std::vector<int> mvaCategories;
 
    // Loop over particles
    for (auto const& cand : *srcHandle) {
      int cat = -1;  // Passed by reference to the mvaValue function to store the category
      const float response = mvaEstimators_[iEstimator]->mvaValue(&cand, auxVariables, cat);
      mvaRawValues.push_back(response);                             // The MVA score
      mvaValues.push_back(2.0 / (1.0 + exp(-2.0 * response)) - 1);  // MVA output between -1 and 1
      mvaCategories.push_back(cat);
    }  // end loop over particles
 
    writeValueMap(iEvent, keysForValueMapsHandle, mvaValues, mvaValueMapNames_[iEstimator]);
    writeValueMap(iEvent, keysForValueMapsHandle, mvaRawValues, mvaRawValueMapNames_[iEstimator]);
    writeValueMap(iEvent, keysForValueMapsHandle, mvaCategories, mvaCategoriesMapNames_[iEstimator]);
 
  }  // end loop over estimators
}

References eostools::cat(), JetChargeProducer_cfi::exp, iEvent, and egammaTools::validateEgammaCandidate().

Member Data Documentation

keysForValueMapsToken_

template<class ParticleType >

const edm::EDGetTokenT<edm::View<ParticleType> > MVAValueMapProducer< ParticleType >::keysForValueMapsToken_

private

Definition at line 38 of file MVAValueMapProducer.h.

mvaCategoriesMapNames_

template<class ParticleType >

const std::vector<std::string> MVAValueMapProducer< ParticleType >::mvaCategoriesMapNames_

private

Definition at line 46 of file MVAValueMapProducer.h.

Referenced by MVAValueMapProducer< ParticleType >::MVAValueMapProducer().

mvaEstimators_

template<class ParticleType >

const std::vector<std::unique_ptr<AnyMVAEstimatorRun2Base> > MVAValueMapProducer< ParticleType >::mvaEstimators_

private

Definition at line 41 of file MVAValueMapProducer.h.

mvaRawValueMapNames_

template<class ParticleType >

const std::vector<std::string> MVAValueMapProducer< ParticleType >::mvaRawValueMapNames_

private

Definition at line 45 of file MVAValueMapProducer.h.

Referenced by MVAValueMapProducer< ParticleType >::MVAValueMapProducer().

mvaValueMapNames_

template<class ParticleType >

const std::vector<std::string> MVAValueMapProducer< ParticleType >::mvaValueMapNames_

private

Definition at line 44 of file MVAValueMapProducer.h.

Referenced by MVAValueMapProducer< ParticleType >::MVAValueMapProducer().

srcToken_

template<class ParticleType >

const edm::EDGetTokenT<edm::View<ParticleType> > MVAValueMapProducer< ParticleType >::srcToken_

private

Definition at line 37 of file MVAValueMapProducer.h.

validated_

template<class ParticleType >

std::atomic<bool> MVAValueMapProducer< ParticleType >::validated_ = false

mutableprivate

Definition at line 51 of file MVAValueMapProducer.h.

variableHelper_

template<class ParticleType >

const MVAVariableHelper MVAValueMapProducer< ParticleType >::variableHelper_

private

Definition at line 49 of file MVAValueMapProducer.h.