Module to analyze the particle listing as provided by common event generators. More...

Inheritance diagram for ParticleListDrawer:

Public Member Functions
void	analyze (const edm::Event &iEvent, const edm::EventSetup &iSetup) override

	ParticleListDrawer (const edm::ParameterSet &)

	~ParticleListDrawer () override

Public Member Functions inherited from edm::one::EDAnalyzer<>
	EDAnalyzer ()=default

	EDAnalyzer (const EDAnalyzer &)=delete

SerialTaskQueue *	globalLuminosityBlocksQueue () final

SerialTaskQueue *	globalRunsQueue () final

const EDAnalyzer &	operator= (const EDAnalyzer &)=delete

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsInputProcessBlocks () const final

bool	wantsProcessBlocks () const final

Public Member Functions inherited from edm::one::EDAnalyzerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

	EDAnalyzerBase ()

ModuleDescription const &	moduleDescription () const

bool	wantsStreamLuminosityBlocks () const

bool	wantsStreamRuns () const

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

	EDConsumerBase (EDConsumerBase &&)=default

ESResolverIndex const *	esGetTokenIndices (edm::Transition iTrans) const

std::vector< ESResolverIndex > 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 const &	operator= (EDConsumerBase const &)=delete

EDConsumerBase &	operator= (EDConsumerBase &&)=default

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

void	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

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

void	updateLookup (eventsetup::ESRecordsToProductResolverIndices const &)

virtual	~EDConsumerBase () noexcept(false)

Private Member Functions
std::string	getParticleName (int id) const

Private Attributes
int	maxEventsToPrint_

unsigned int	nEventAnalyzed_

edm::ESHandle< ParticleDataTable >	pdt_

edm::ESGetToken< ParticleDataTable, edm::DefaultRecord >	pdtToken_

bool	printFlags_

bool	printOnlyHardInteraction_

bool	printVertex_

edm::InputTag	src_

edm::EDGetTokenT< reco::CandidateView >	srcToken_

bool	useMessageLogger_

Additional Inherited Members
Public Types inherited from edm::one::EDAnalyzerBase
typedef EDAnalyzerBase	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

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

template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept

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 ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)

template<Transition Tr = Transition::Event>
constexpr auto	esConsumes ()

template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag)

template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...

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)

void	resetItemsToGetFrom (BranchType iType)

Detailed Description

Module to analyze the particle listing as provided by common event generators.

Module to analyze the particle listing as provided by common event generators equivalent to PYLIST(1) (from pythia). It is expected to run on vectors of reo::GenParticles. For an example of use have a look to:

PhysicsTools/HepMCCandAlgos/test/testParticleTreeDrawer.py

Caveats: Status 3 particles can have daughters both with status 2 and 3. In pythia this is not the same mother-daughter. The relations are correct but special care has to be taken when looking at mother-daughter relation which involve status 2 and 3 particles.

Definition at line 42 of file ParticleListDrawer.cc.

Constructor & Destructor Documentation

◆ ParticleListDrawer()

ParticleListDrawer::ParticleListDrawer ( const edm::ParameterSet & pset )

explicit

Definition at line 63 of file ParticleListDrawer.cc.

     : src_(pset.getParameter<InputTag>("src")),
       srcToken_(consumes<reco::CandidateView>(src_)),
       pdtToken_(esConsumes<ParticleDataTable, edm::DefaultRecord>()),
       maxEventsToPrint_(pset.getUntrackedParameter<int>("maxEventsToPrint", 1)),
       nEventAnalyzed_(0),
       printOnlyHardInteraction_(pset.getUntrackedParameter<bool>("printOnlyHardInteraction", false)),
       printVertex_(pset.getUntrackedParameter<bool>("printVertex", false)),
       printFlags_(pset.getUntrackedParameter<bool>("printFlags", false)),
       useMessageLogger_(pset.getUntrackedParameter<bool>("useMessageLogger", false)) {}

◆ ~ParticleListDrawer()

ParticleListDrawer::~ParticleListDrawer ( )

inlineoverride

Definition at line 45 of file ParticleListDrawer.cc.

45 {};

Member Function Documentation

◆ analyze()

void ParticleListDrawer::analyze	(	const edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)

overridevirtual

Implements edm::one::EDAnalyzerBase.

Definition at line 84 of file ParticleListDrawer.cc.

References visDQMUpload::buf, HLT_2023v12_cff::cands, gather_cfg::cout, Exception, spr::find(), newFWLiteAna::found, edm::EventSetup::getHandle(), getParticleName(), runTauDisplay::gp, heavyIonCSV_trainingSettings::idx, iEvent, edm::InputTag::label(), maxEventsToPrint_, nEventAnalyzed_, MillePedeFileConverter_cfg::out, AlCaHLTBitMon_ParallelJobs::p, HiggsValidation_cfi::particleName, ecalTrigSettings_cff::particles, pdt_, pdtToken_, printFlags_, printOnlyHardInteraction_, printVertex_, src_, srcToken_, and useMessageLogger_.

                                                                                     {
   Handle<reco::CandidateView> particles;
   iEvent.getByToken(srcToken_, particles);
   pdt_ = iSetup.getHandle(pdtToken_);
 
   if (maxEventsToPrint_ < 0 || nEventAnalyzed_ < static_cast<unsigned int>(maxEventsToPrint_)) {
     ostringstream out;
     char buf[256];
 
     out << endl << "[ParticleListDrawer] analysing particle collection " << src_.label() << endl;
 
     snprintf(buf,
              sizeof(buf),
              " idx  |    ID -       Name |Stat|  Mo1  Mo2  Da1  Da2 |nMo nDa|    pt       eta     phi   |     px       "
              "  py         pz        m     |");
     out << buf;
     if (printVertex_) {
       snprintf(buf, sizeof(buf), "        vx       vy        vz     |");
       out << buf;
     }
     out << endl;
 
     int idx = -1;
     int iMo1 = -1;
     int iMo2 = -1;
     int iDa1 = -1;
     int iDa2 = -1;
     vector<const reco::Candidate*> cands;
     vector<const Candidate*>::const_iterator found = cands.begin();
     for (CandidateView::const_iterator p = particles->begin(); p != particles->end(); ++p) {
       cands.push_back(&*p);
     }
 
     for (CandidateView::const_iterator p = particles->begin(); p != particles->end(); p++) {
       if (printOnlyHardInteraction_ && p->status() != 3)
         continue;
 
       // Particle Name
       int id = p->pdgId();
       string particleName = getParticleName(id);
 
       // Particle Index
       idx = p - particles->begin();
 
       // Particles Mothers and Daighters
       iMo1 = -1;
       iMo2 = -1;
       iDa1 = -1;
       iDa2 = -1;
       int nMo = p->numberOfMothers();
       int nDa = p->numberOfDaughters();
 
       found = find(cands.begin(), cands.end(), p->mother(0));
       if (found != cands.end())
         iMo1 = found - cands.begin();
 
       found = find(cands.begin(), cands.end(), p->mother(nMo - 1));
       if (found != cands.end())
         iMo2 = found - cands.begin();
 
       found = find(cands.begin(), cands.end(), p->daughter(0));
       if (found != cands.end())
         iDa1 = found - cands.begin();
 
       found = find(cands.begin(), cands.end(), p->daughter(nDa - 1));
       if (found != cands.end())
         iDa2 = found - cands.begin();
 
       char buf[2400];
       snprintf(
           buf,
           sizeof(buf),
           " %4d | %5d - %10s | %2d | %4d %4d %4d %4d | %2d %2d | %7.3f %10.3f %6.3f | %10.3f %10.3f %10.3f %8.3f |",
           idx,
           p->pdgId(),
           particleName.c_str(),
           p->status(),
           iMo1,
           iMo2,
           iDa1,
           iDa2,
           nMo,
           nDa,
           p->pt(),
           p->eta(),
           p->phi(),
           p->px(),
           p->py(),
           p->pz(),
           p->mass());
       out << buf;
 
       if (printVertex_) {
         snprintf(buf, sizeof(buf), " %10.3f %10.3f %10.3f |", p->vertex().x(), p->vertex().y(), p->vertex().z());
         out << buf;
       }
 
       if (printFlags_) {
         const reco::GenParticle* gp = dynamic_cast<const reco::GenParticle*>(&*p);
         if (!gp)
           throw cms::Exception("Unsupported", "Status flags can be printed only for reco::GenParticle objects\n");
         if (gp->isPromptFinalState())
           out << "  PromptFinalState";
         if (gp->isDirectPromptTauDecayProductFinalState())
           out << "  DirectPromptTauDecayProductFinalState";
         if (gp->isHardProcess())
           out << "  HardProcess";
         if (gp->fromHardProcessFinalState())
           out << "  HardProcessFinalState";
         if (gp->fromHardProcessBeforeFSR())
           out << "  HardProcessBeforeFSR";
         if (gp->statusFlags().isFirstCopy())
           out << "  FirstCopy";
         if (gp->isLastCopy())
           out << "  LastCopy";
         if (gp->isLastCopyBeforeFSR())
           out << "  LastCopyBeforeFSR";
       }
 
       out << endl;
     }
     nEventAnalyzed_++;
 
     if (useMessageLogger_)
       LogVerbatim("ParticleListDrawer") << out.str();
     else
       cout << out.str();
   }
 }

◆ getParticleName()

std::string ParticleListDrawer::getParticleName ( int id ) const

private

Definition at line 74 of file ParticleListDrawer.cc.

References l1ctLayer2EG_cff::id, pdt_, and contentValuesCheck::ss.

Referenced by analyze().

                                                           {
   const ParticleData* pd = pdt_->particle(id);
   if (!pd) {
     std::ostringstream ss;
     ss << "P" << id;
     return ss.str();
   } else
     return pd->name();
 }

Member Data Documentation

◆ maxEventsToPrint_

int ParticleListDrawer::maxEventsToPrint_

private

Definition at line 55 of file ParticleListDrawer.cc.

Referenced by analyze().

◆ nEventAnalyzed_

unsigned int ParticleListDrawer::nEventAnalyzed_

private

Definition at line 56 of file ParticleListDrawer.cc.

Referenced by analyze().

◆ pdt_

edm::ESHandle<ParticleDataTable> ParticleListDrawer::pdt_

private

Definition at line 53 of file ParticleListDrawer.cc.

Referenced by analyze(), and getParticleName().

◆ pdtToken_

edm::ESGetToken<ParticleDataTable, edm::DefaultRecord> ParticleListDrawer::pdtToken_

private

Definition at line 54 of file ParticleListDrawer.cc.

Referenced by analyze().

◆ printFlags_

bool ParticleListDrawer::printFlags_

private

Definition at line 59 of file ParticleListDrawer.cc.

Referenced by analyze().

◆ printOnlyHardInteraction_

bool ParticleListDrawer::printOnlyHardInteraction_

private

Definition at line 57 of file ParticleListDrawer.cc.

Referenced by analyze().

◆ printVertex_

bool ParticleListDrawer::printVertex_

private

Definition at line 58 of file ParticleListDrawer.cc.

Referenced by analyze().

◆ src_

edm::InputTag ParticleListDrawer::src_

private

Definition at line 51 of file ParticleListDrawer.cc.

Referenced by analyze().

◆ srcToken_

edm::EDGetTokenT<reco::CandidateView> ParticleListDrawer::srcToken_

private

Definition at line 52 of file ParticleListDrawer.cc.

Referenced by analyze().

◆ useMessageLogger_

bool ParticleListDrawer::useMessageLogger_

private

Definition at line 60 of file ParticleListDrawer.cc.

Referenced by analyze().

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ParticleListDrawer()

◆ ~ParticleListDrawer()

Member Function Documentation

◆ analyze()

◆ getParticleName()

Member Data Documentation

◆ maxEventsToPrint_

◆ nEventAnalyzed_

◆ pdt_

◆ pdtToken_

◆ printFlags_

◆ printOnlyHardInteraction_

◆ printVertex_

◆ src_

◆ srcToken_

◆ useMessageLogger_