CMS 3D CMS Logo

List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
HadronAndPartonSelector Class Reference

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

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

Inheritance diagram for HadronAndPartonSelector:
edm::stream::EDProducer<>

Public Member Functions

 HadronAndPartonSelector (const edm::ParameterSet &)
 
 ~HadronAndPartonSelector () override
 
- Public Member Functions inherited from edm::stream::EDProducer<>
 EDProducer ()=default
 
bool hasAbilityToProduceInBeginLumis () const final
 
bool hasAbilityToProduceInBeginProcessBlocks () const final
 
bool hasAbilityToProduceInBeginRuns () const final
 
bool hasAbilityToProduceInEndLumis () const final
 
bool hasAbilityToProduceInEndProcessBlocks () const final
 
bool hasAbilityToProduceInEndRuns () const final
 

Static Public Member Functions

static void fillDescriptions (edm::ConfigurationDescriptions &descriptions)
 

Private Member Functions

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

Private Attributes

bool fullChainPhysPartons_
 
const edm::EDGetTokenT< reco::GenParticleCollectionparticlesToken_
 
std::string partonMode_
 
PartonSelectorPtr partonSelector_
 
bool partonSelectorSet_
 
const edm::EDGetTokenT< GenEventInfoProductsrcToken_
 

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, GlobalCacheLuminosityBlockContext
 
typedef CacheTypes::LuminosityBlockSummaryCache LuminosityBlockSummaryCache
 
typedef CacheTypes::RunCache RunCache
 
typedef RunContextT< RunCache, GlobalCacheRunContext
 
typedef CacheTypes::RunSummaryCache RunSummaryCache
 

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:

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:

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

Definition at line 78 of file HadronAndPartonSelector.cc.

Constructor & Destructor Documentation

◆ HadronAndPartonSelector()

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

Definition at line 105 of file HadronAndPartonSelector.cc.

106  :
107 
108  srcToken_(mayConsume<GenEventInfoProduct>(iConfig.getParameter<edm::InputTag>("src"))),
109  particlesToken_(consumes<reco::GenParticleCollection>(iConfig.getParameter<edm::InputTag>("particles"))),
110  partonMode_(iConfig.getParameter<std::string>("partonMode")),
111  fullChainPhysPartons_(iConfig.getParameter<bool>("fullChainPhysPartons"))
112 
113 {
114  //register your products
115  produces<reco::GenParticleRefVector>("bHadrons");
116  produces<reco::GenParticleRefVector>("cHadrons");
117  produces<reco::GenParticleRefVector>("algorithmicPartons");
118  produces<reco::GenParticleRefVector>("physicsPartons");
119  produces<reco::GenParticleRefVector>("leptons");
120 
121  partonSelectorSet_ = false;
122  partonSelector_ = nullptr;
123 }

References partonSelector_, and partonSelectorSet_.

◆ ~HadronAndPartonSelector()

HadronAndPartonSelector::~HadronAndPartonSelector ( )
override

Definition at line 125 of file HadronAndPartonSelector.cc.

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

Member Function Documentation

◆ fillDescriptions()

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

Definition at line 268 of file HadronAndPartonSelector.cc.

268  {
269  //The following says we do not know what parameters are allowed so do no validation
270  // Please change this to state exactly what you do use, even if it is no parameters
272  desc.setUnknown();
273  descriptions.addDefault(desc);
274 }

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

◆ produce()

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

Definition at line 135 of file HadronAndPartonSelector.cc.

135  {
136  // determine hadronizer type (done only once per job)
137  if (partonMode_ == "Auto") {
138  edm::Handle<GenEventInfoProduct> genEvtInfoProduct;
139  iEvent.getByToken(srcToken_, genEvtInfoProduct);
140 
141  std::string moduleName = "";
142  if (genEvtInfoProduct.isValid()) {
143  const edm::Provenance& prov = iEvent.getProvenance(genEvtInfoProduct.id());
144  moduleName = edm::moduleName(prov, iEvent.processHistory());
145  }
146 
147  if (moduleName.find("Pythia6") != std::string::npos)
148  partonMode_ = "Pythia6";
149  else if (moduleName.find("Pythia8") != std::string::npos)
150  partonMode_ = "Pythia8";
151  else if (moduleName.find("Herwig6") != std::string::npos)
152  partonMode_ = "Herwig6";
153  else if (moduleName.find("ThePEG") != std::string::npos)
154  partonMode_ = "Herwig++";
155  else if (moduleName.find("Herwig7") != std::string::npos)
156  partonMode_ = "Herwig++";
157  else if (moduleName.find("Sherpa") != std::string::npos)
158  partonMode_ = "Sherpa";
159  else
160  partonMode_ = "Undefined";
161  }
162 
163  // set the parton selection mode (done only once per job)
164  if (!partonSelectorSet_) {
165  if (partonMode_ == "Undefined")
166  edm::LogWarning("UndefinedPartonMode")
167  << "Could not automatically determine the hadronizer type and set the correct parton selection mode. "
168  "Parton-based jet flavour will not be defined.";
169  else if (partonMode_ == "Pythia6") {
171  edm::LogInfo("PartonModeDefined") << "Using Pythia6 parton selection mode.";
172  } else if (partonMode_ == "Pythia8") {
174  edm::LogInfo("PartonModeDefined") << "Using Pythia8 parton selection mode.";
175  } else if (partonMode_ == "Herwig6") {
177  edm::LogInfo("PartonModeDefined") << "Using Herwig6 parton selection mode.";
178  } else if (partonMode_ == "Herwig++") {
180  edm::LogInfo("PartonModeDefined") << "Using Herwig++ parton selection mode.";
181  } else if (partonMode_ == "Sherpa") {
183  edm::LogInfo("PartonModeDefined") << "Using Sherpa parton selection mode.";
184  } else
185  throw cms::Exception("InvalidPartonMode")
186  << "Parton selection mode is invalid: " << partonMode_
187  << ", use Auto | Pythia6 | Pythia8 | Herwig6 | Herwig++ | Sherpa" << std::endl;
188 
189  partonSelectorSet_ = true;
190  }
191 
193  iEvent.getByToken(particlesToken_, particles);
194 
195  auto bHadrons = std::make_unique<reco::GenParticleRefVector>();
196  auto cHadrons = std::make_unique<reco::GenParticleRefVector>();
197  auto partons = std::make_unique<reco::GenParticleRefVector>();
198  auto physicsPartons = std::make_unique<reco::GenParticleRefVector>();
199  auto leptons = std::make_unique<reco::GenParticleRefVector>();
200 
201  // loop over particles and select b and c hadrons and leptons
202  for (reco::GenParticleCollection::const_iterator it = particles->begin(); it != particles->end(); ++it) {
203  // if b hadron
204  if (CandMCTagUtils::hasBottom(*it)) {
205  // check if any of the daughters is also a b hadron
206  bool hasbHadronDaughter = false;
207  for (size_t i = 0; i < it->numberOfDaughters(); ++i) {
208  if (CandMCTagUtils::hasBottom(*(it->daughter(i)))) {
209  hasbHadronDaughter = true;
210  break;
211  }
212  }
213  if (hasbHadronDaughter)
214  continue; // skip excited b hadrons that have other b hadrons as daughters
215 
216  bHadrons->push_back(reco::GenParticleRef(particles, it - particles->begin()));
217  }
218 
219  // if c hadron
220  if (CandMCTagUtils::hasCharm(*it)) {
221  // check if any of the daughters is also a c hadron
222  bool hascHadronDaughter = false;
223  for (size_t i = 0; i < it->numberOfDaughters(); ++i) {
224  if (CandMCTagUtils::hasCharm(*(it->daughter(i)))) {
225  hascHadronDaughter = true;
226  break;
227  }
228  }
229  if (hascHadronDaughter)
230  continue; // skip excited c hadrons that have other c hadrons as daughters
231 
232  cHadrons->push_back(reco::GenParticleRef(particles, it - particles->begin()));
233  }
234 
235  // status==1 electrons and muons
236  if ((reco::isElectron(*it) || reco::isMuon(*it)) && it->status() == 1)
237  leptons->push_back(reco::GenParticleRef(particles, it - particles->begin()));
238 
239  // status==2 taus
240  if (reco::isTau(*it) && it->status() == 2)
241  leptons->push_back(reco::GenParticleRef(particles, it - particles->begin()));
242  }
243 
244  // select algorithmic partons
245  if (partonMode_ != "Undefined") {
247  }
248 
249  // select physics partons
250  for (reco::GenParticleCollection::const_iterator it = particles->begin(); it != particles->end(); ++it) {
251  if (!fullChainPhysPartons_) {
252  if (!(it->status() == 3 || ((partonMode_ == "Pythia8") && (it->status() == 23))))
253  continue;
254  }
255  if (!CandMCTagUtils::isParton(*it))
256  continue; // skip particle if not a parton
257  physicsPartons->push_back(reco::GenParticleRef(particles, it - particles->begin()));
258  }
259 
260  iEvent.put(std::move(bHadrons), "bHadrons");
261  iEvent.put(std::move(cHadrons), "cHadrons");
262  iEvent.put(std::move(partons), "algorithmicPartons");
263  iEvent.put(std::move(physicsPartons), "physicsPartons");
264  iEvent.put(std::move(leptons), "leptons");
265 }

References AK4GenJetFlavourInfos_cfi::bHadrons, AK4GenJetFlavourInfos_cfi::cHadrons, Exception, fullChainPhysPartons_, CandMCTagUtils::hasBottom(), CandMCTagUtils::hasCharm(), mps_fire::i, edm::HandleBase::id(), iEvent, reco::isElectron(), reco::isMuon(), CandMCTagUtils::isParton(), reco::isTau(), edm::HandleBase::isValid(), HLT_FULL_cff::leptons, EcalCalibMonitorClient_cfi::moduleName, edm::moduleName(), eostools::move(), ecalTrigSettings_cff::particles, particlesToken_, partonMode_, dqmAnalyzer_cff::partons, partonSelector_, partonSelectorSet_, srcToken_, and AlCaHLTBitMon_QueryRunRegistry::string.

Member Data Documentation

◆ fullChainPhysPartons_

bool HadronAndPartonSelector::fullChainPhysPartons_
private

Definition at line 93 of file HadronAndPartonSelector.cc.

Referenced by produce().

◆ particlesToken_

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

Definition at line 90 of file HadronAndPartonSelector.cc.

Referenced by produce().

◆ partonMode_

std::string HadronAndPartonSelector::partonMode_
private

Definition at line 92 of file HadronAndPartonSelector.cc.

Referenced by produce().

◆ partonSelector_

PartonSelectorPtr HadronAndPartonSelector::partonSelector_
private

Definition at line 95 of file HadronAndPartonSelector.cc.

Referenced by HadronAndPartonSelector(), and produce().

◆ partonSelectorSet_

bool HadronAndPartonSelector::partonSelectorSet_
private

Definition at line 94 of file HadronAndPartonSelector.cc.

Referenced by HadronAndPartonSelector(), and produce().

◆ srcToken_

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

Definition at line 89 of file HadronAndPartonSelector.cc.

Referenced by produce().

mps_fire.i
i
Definition: mps_fire.py:428
HerwigppPartonSelector
Herwig++ parton selector derived from the base parton selector.
Definition: HerwigppPartonSelector.h:10
reco::isElectron
bool isElectron(const Candidate &part)
Definition: pdgIdUtils.h:7
HLT_FULL_cff.leptons
leptons
Definition: HLT_FULL_cff.py:26349
HadronAndPartonSelector::partonSelector_
PartonSelectorPtr partonSelector_
Definition: HadronAndPartonSelector.cc:95
CandMCTagUtils::hasBottom
bool hasBottom(const reco::Candidate &c)
Definition: CandMCTag.cc:24
edm::ParameterSetDescription
Definition: ParameterSetDescription.h:52
HadronAndPartonSelector::partonSelectorSet_
bool partonSelectorSet_
Definition: HadronAndPartonSelector.cc:94
CandMCTagUtils::isParton
bool isParton(const reco::Candidate &c)
Definition: CandMCTag.cc:46
edm::LogInfo
Log< level::Info, false > LogInfo
Definition: MessageLogger.h:125
HadronAndPartonSelector::fullChainPhysPartons_
bool fullChainPhysPartons_
Definition: HadronAndPartonSelector.cc:93
edm::Handle
Definition: AssociativeIterator.h:50
edm::LogWarning
Log< level::Warning, false > LogWarning
Definition: MessageLogger.h:122
ecalTrigSettings_cff.particles
particles
Definition: ecalTrigSettings_cff.py:11
edm::Ref< GenParticleCollection >
dqmAnalyzer_cff.partons
partons
Definition: dqmAnalyzer_cff.py:27
HadronAndPartonSelector::particlesToken_
const edm::EDGetTokenT< reco::GenParticleCollection > particlesToken_
Definition: HadronAndPartonSelector.cc:90
AlCaHLTBitMon_QueryRunRegistry.string
string
Definition: AlCaHLTBitMon_QueryRunRegistry.py:256
Herwig6PartonSelector
Herwig6 parton selector derived from the base parton selector.
Definition: Herwig6PartonSelector.h:10
iEvent
int iEvent
Definition: GenABIO.cc:224
EcalCalibMonitorClient_cfi.moduleName
moduleName
Definition: EcalCalibMonitorClient_cfi.py:17
HadronAndPartonSelector::partonMode_
std::string partonMode_
Definition: HadronAndPartonSelector.cc:92
PartonSelectorPtr
std::shared_ptr< BasePartonSelector > PartonSelectorPtr
Definition: HadronAndPartonSelector.cc:72
submitPVResolutionJobs.desc
string desc
Definition: submitPVResolutionJobs.py:251
AK4GenJetFlavourInfos_cfi.cHadrons
cHadrons
Definition: AK4GenJetFlavourInfos_cfi.py:7
eostools.move
def move(src, dest)
Definition: eostools.py:511
CandMCTagUtils::hasCharm
bool hasCharm(const reco::Candidate &c)
Definition: CandMCTag.cc:35
Pythia8PartonSelector
Pythia8 parton selector derived from the base parton selector.
Definition: Pythia8PartonSelector.h:10
Pythia6PartonSelector
Pythia6 parton selector derived from the base parton selector.
Definition: Pythia6PartonSelector.h:10
Exception
Definition: hltDiff.cc:246
edm::ParameterSet::getParameter
T getParameter(std::string const &) const
Definition: ParameterSet.h:303
AK4GenJetFlavourInfos_cfi.bHadrons
bHadrons
Definition: AK4GenJetFlavourInfos_cfi.py:6
reco::isTau
bool isTau(const Candidate &part)
Definition: pdgIdUtils.h:11
edm::moduleName
std::string moduleName(Provenance const &provenance, ProcessHistory const &history)
Definition: Provenance.cc:27
edm::Provenance
Definition: Provenance.h:34
HadronAndPartonSelector::srcToken_
const edm::EDGetTokenT< GenEventInfoProduct > srcToken_
Definition: HadronAndPartonSelector.cc:89
edm::HandleBase::isValid
bool isValid() const
Definition: HandleBase.h:70
edm::ConfigurationDescriptions::addDefault
void addDefault(ParameterSetDescription const &psetDescription)
Definition: ConfigurationDescriptions.cc:99
edm::HandleBase::id
ProductID id() const
Definition: HandleBase.cc:29
SherpaPartonSelector
Sherpa parton selector derived from the base parton selector.
Definition: SherpaPartonSelector.h:10
edm::InputTag
Definition: InputTag.h:15
reco::isMuon
bool isMuon(const Candidate &part)
Definition: pdgIdUtils.h:9