Selects hadrons and partons from a collection of GenParticles. More...

#include <PhysicsTools/JetMCAlgos/plugins/HadronAndPartonSelector.cc>

Inheritance diagram for HadronAndPartonSelector:

Public Member Functions
	HadronAndPartonSelector (const edm::ParameterSet &)

	~HadronAndPartonSelector () override

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

Public Member Functions inherited from edm::stream::EDProducerBase
	EDProducerBase ()

ModuleDescription const &	moduleDescription () const

virtual	~EDProducerBase ()

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 ()

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, std::unordered_multimap< std::string, edm::ProductResolverIndex > const &iIndicies, std::string const &moduleLabel)

virtual	~ProducerBase () noexcept(false)

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 const &)=delete

	EDConsumerBase (EDConsumerBase &&)=default

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::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const

EDConsumerBase const &	operator= (EDConsumerBase const &)=delete

EDConsumerBase &	operator= (EDConsumerBase &&)=default

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

virtual	~EDConsumerBase () noexcept(false)

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

Static Public Member Functions inherited from edm::stream::EDProducerBase
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

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

Private Attributes
bool	fullChainPhysPartons_

const edm::EDGetTokenT< reco::GenParticleCollection >	particlesToken_

std::string	partonMode_

PartonSelectorPtr	partonSelector_

bool	partonSelectorSet_

const edm::EDGetTokenT< GenEventInfoProduct >	srcToken_

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

Public Types inherited from edm::stream::EDProducerBase
typedef EDProducerAdaptorBase	ModuleType

Public Types inherited from edm::ProducerBase
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

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 ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

Detailed Description

Selects hadrons and partons from a collection of GenParticles.

This producer selects hadrons, partons, and leptons from a collection of GenParticles and stores vectors of EDM references to these particles in the event. The following hadrons are selected:

b hadrons that do not have other b hadrons as daughters
c hadrons that do not have other c hadrons as daughters

Older Fortran Monte Carlo generators (Pythia6 and Herwig6) follow the HEPEVT [1] particle status code convention while newer C++ Monte Carlo generators (Pythia8, Herwig++, and Sherpa) follow the HepMC [2] particle status code convention. However, both conventions give considerable freedom in defining the status codes of intermediate particle states. Hence, the parton selection is generator-dependent and is described in each of the parton selectors separately.

Using the provenance information of the GenEventInfoProduct, the producer attempts to automatically determine what generator was used to hadronize events and based on that information decides what parton selection mode to use. It is also possible to enforce any of the supported parton selection modes.

The selected hadrons and partons are finally used by the JetFlavourClustering producer to determine the jet flavour.

The following leptons are selected:

status==1 electrons and muons
status==2 taus

[1] http://cepa.fnal.gov/psm/stdhep/ [2] http://lcgapp.cern.ch/project/simu/HepMC/

Definition at line 79 of file HadronAndPartonSelector.cc.

Constructor & Destructor Documentation

HadronAndPartonSelector::HadronAndPartonSelector ( const edm::ParameterSet & iConfig )

explicit

Definition at line 106 of file HadronAndPartonSelector.cc.

References partonSelector_, and partonSelectorSet_.

                                                                                :
 
   srcToken_(mayConsume<GenEventInfoProduct>( iConfig.getParameter<edm::InputTag>("src") )),
   particlesToken_(consumes<reco::GenParticleCollection>( iConfig.getParameter<edm::InputTag>("particles") )),
   partonMode_(iConfig.getParameter<std::string>("partonMode")),
   fullChainPhysPartons_(iConfig.getParameter<bool>("fullChainPhysPartons"))
 
 {
    //register your products
    produces<reco::GenParticleRefVector>( "bHadrons" );
    produces<reco::GenParticleRefVector>( "cHadrons" );
    produces<reco::GenParticleRefVector>( "algorithmicPartons" );
    produces<reco::GenParticleRefVector>( "physicsPartons" );
    produces<reco::GenParticleRefVector>( "leptons" );
 
    partonSelectorSet_=false;
    partonSelector_=nullptr;
 }

HadronAndPartonSelector::~HadronAndPartonSelector ( )

override

Definition at line 126 of file HadronAndPartonSelector.cc.

 {
 
    // do anything here that needs to be done at desctruction time
    // (e.g. close files, deallocate resources etc.)
 
 }

Member Function Documentation

void HadronAndPartonSelector::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 277 of file HadronAndPartonSelector.cc.

References edm::ConfigurationDescriptions::addDefault(), DEFINE_FWK_MODULE, and edm::ParameterSetDescription::setUnknown().

                                                                                     {
   //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 desc;
   desc.setUnknown();
   descriptions.addDefault(desc);
 }

void HadronAndPartonSelector::produce	(	edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)

overrideprivate

Definition at line 141 of file HadronAndPartonSelector.cc.

References AK4GenJetFlavourInfos_cfi::bHadrons, AK4GenJetFlavourInfos_cfi::cHadrons, Exception, fullChainPhysPartons_, edm::Event::getByToken(), edm::Event::getProvenance(), CandMCTagUtils::hasBottom(), CandMCTagUtils::hasCharm(), mps_fire::i, edm::HandleBase::id(), reco::isElectron(), reco::isMuon(), CandMCTagUtils::isParton(), reco::isTau(), edm::HandleBase::isValid(), AK4GenJetFlavourInfos_cfi::leptons, edm::moduleName(), eostools::move(), HadronAndPartonSelector_cfi::particles, particlesToken_, partonMode_, AK4CaloJetsMCFlavour_cff::partons, partonSelector_, partonSelectorSet_, edm::Event::put(), srcToken_, and AlCaHLTBitMon_QueryRunRegistry::string.

 {
    // determine hadronizer type (done only once per job)
    if( partonMode_=="Auto" )
    {
      edm::Handle<GenEventInfoProduct> genEvtInfoProduct;
      iEvent.getByToken(srcToken_, genEvtInfoProduct);
 
      std::string moduleName = "";
      if( genEvtInfoProduct.isValid() ) {
        const edm::Provenance& prov = iEvent.getProvenance(genEvtInfoProduct.id());
        moduleName = edm::moduleName(prov);
      }
 
      if( moduleName.find("Pythia6")!=std::string::npos )
        partonMode_="Pythia6";
      else if( moduleName.find("Pythia8")!=std::string::npos )
        partonMode_="Pythia8";
      else if( moduleName.find("Herwig6")!=std::string::npos )
        partonMode_="Herwig6";
      else if( moduleName.find("ThePEG")!=std::string::npos )
        partonMode_="Herwig++";
      else if( moduleName.find("Sherpa")!=std::string::npos )
        partonMode_="Sherpa";
      else
        partonMode_="Undefined";
    }
 
    // set the parton selection mode (done only once per job)
    if( !partonSelectorSet_ )
    {
      if ( partonMode_=="Undefined" )
        edm::LogWarning("UndefinedPartonMode") << "Could not automatically determine the hadronizer type and set the correct parton selection mode. Parton-based jet flavour will not be defined.";
      else if ( partonMode_=="Pythia6" )
      {
        partonSelector_ = PartonSelectorPtr( new Pythia6PartonSelector() );
        edm::LogInfo("PartonModeDefined") << "Using Pythia6 parton selection mode.";
      }
      else if ( partonMode_=="Pythia8" )
      {
        partonSelector_ = PartonSelectorPtr( new Pythia8PartonSelector() );
        edm::LogInfo("PartonModeDefined") << "Using Pythia8 parton selection mode.";
      }
      else if ( partonMode_=="Herwig6" )
      {
        partonSelector_ = PartonSelectorPtr( new Herwig6PartonSelector() );
        edm::LogInfo("PartonModeDefined") << "Using Herwig6 parton selection mode.";
      }
      else if ( partonMode_=="Herwig++" )
      {
        partonSelector_ = PartonSelectorPtr( new HerwigppPartonSelector() );
        edm::LogInfo("PartonModeDefined") << "Using Herwig++ parton selection mode.";
      }
      else if ( partonMode_=="Sherpa" )
      {
        partonSelector_ = PartonSelectorPtr( new SherpaPartonSelector() );
        edm::LogInfo("PartonModeDefined") << "Using Sherpa parton selection mode.";
      }
      else
        throw cms::Exception("InvalidPartonMode") <<"Parton selection mode is invalid: " << partonMode_ << ", use Auto | Pythia6 | Pythia8 | Herwig6 | Herwig++ | Sherpa" << std::endl;
 
      partonSelectorSet_=true;
    }
 
    edm::Handle<reco::GenParticleCollection> particles;
    iEvent.getByToken(particlesToken_, particles);
 
    auto bHadrons = std::make_unique<reco::GenParticleRefVector>();
    auto cHadrons = std::make_unique<reco::GenParticleRefVector>();
    auto partons  = std::make_unique<reco::GenParticleRefVector>();
    auto physicsPartons  = std::make_unique<reco::GenParticleRefVector>();
    auto leptons  = std::make_unique<reco::GenParticleRefVector>();
 
    // loop over particles and select b and c hadrons and leptons
    for(reco::GenParticleCollection::const_iterator it = particles->begin(); it != particles->end(); ++it)
    {
      // if b hadron
      if( CandMCTagUtils::hasBottom( *it ) )
      {
        // check if any of the daughters is also a b hadron
        bool hasbHadronDaughter = false;
        for(size_t i=0; i < it->numberOfDaughters(); ++i)
        {
          if( CandMCTagUtils::hasBottom( *(it->daughter(i)) ) ) { hasbHadronDaughter = true; break; }
        }
        if( hasbHadronDaughter ) continue; // skip excited b hadrons that have other b hadrons as daughters
 
        bHadrons->push_back( reco::GenParticleRef( particles, it - particles->begin() ) );
      }
 
      // if c hadron
      if( CandMCTagUtils::hasCharm( *it ) )
      {
        // check if any of the daughters is also a c hadron
        bool hascHadronDaughter = false;
        for(size_t i=0; i < it->numberOfDaughters(); ++i)
        {
          if( CandMCTagUtils::hasCharm( *(it->daughter(i)) ) ) { hascHadronDaughter = true; break; }
        }
        if( hascHadronDaughter ) continue; // skip excited c hadrons that have other c hadrons as daughters
 
        cHadrons->push_back( reco::GenParticleRef( particles, it - particles->begin() ) );
      }
 
      // status==1 electrons and muons
      if( ( reco::isElectron( *it ) || reco::isMuon( *it ) ) && it->status()==1 )
        leptons->push_back( reco::GenParticleRef( particles, it - particles->begin() ) );
 
      // status==2 taus
      if( reco::isTau( *it ) && it->status()==2 )
        leptons->push_back( reco::GenParticleRef( particles, it - particles->begin() ) );
    }
 
    // select partons
    if ( partonMode_!="Undefined" ) {
      partonSelector_->run(particles,partons);
      for(reco::GenParticleCollection::const_iterator it = particles->begin(); it != particles->end(); ++it)
      {
       if(!fullChainPhysPartons_)
       {
          if( !(it->status()==3 || (( partonMode_=="Pythia8" ) && (it->status()==23)))) continue;
       }
        if( !CandMCTagUtils::isParton( *it ) ) continue;  // skip particle if not a parton
        physicsPartons->push_back( reco::GenParticleRef( particles, it - particles->begin() ) );
      }
    }
 
    iEvent.put(std::move(bHadrons), "bHadrons" );
    iEvent.put(std::move(cHadrons), "cHadrons" );
    iEvent.put(std::move(partons),  "algorithmicPartons" );
    iEvent.put(std::move(physicsPartons),  "physicsPartons" );
    iEvent.put(std::move(leptons),  "leptons" );
 }

Member Data Documentation

bool HadronAndPartonSelector::fullChainPhysPartons_

private

Definition at line 94 of file HadronAndPartonSelector.cc.

Referenced by produce().

const edm::EDGetTokenT<reco::GenParticleCollection> HadronAndPartonSelector::particlesToken_

private

Definition at line 91 of file HadronAndPartonSelector.cc.

Referenced by produce().

std::string HadronAndPartonSelector::partonMode_

private

Definition at line 93 of file HadronAndPartonSelector.cc.

Referenced by produce().

PartonSelectorPtr HadronAndPartonSelector::partonSelector_

private

Definition at line 96 of file HadronAndPartonSelector.cc.

Referenced by HadronAndPartonSelector(), and produce().

bool HadronAndPartonSelector::partonSelectorSet_

private

Definition at line 95 of file HadronAndPartonSelector.cc.

Referenced by HadronAndPartonSelector(), and produce().

const edm::EDGetTokenT<GenEventInfoProduct> HadronAndPartonSelector::srcToken_

private

Definition at line 90 of file HadronAndPartonSelector.cc.

Referenced by produce().

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation