ParticleListDrawer Class Reference

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 ()
Public Member Functions inherited from edm::EDAnalyzer
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
	EDAnalyzer ()
ModuleDescription const &	moduleDescription () const
std::string	workerType () const
virtual	~EDAnalyzer ()
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
	EDConsumerBase ()
ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesDependentUpon (std::string const &iProcessName, std::string const &iModuleLabel, bool iPrint, std::vector< char const * > &oModuleLabels) const
void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
virtual	~EDConsumerBase ()

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

Private Attributes
int	maxEventsToPrint_
unsigned int	nEventAnalyzed_
edm::ESHandle< ParticleDataTable >	pdt_
bool	printFlags_
bool	printOnlyHardInteraction_
bool	printVertex_
edm::InputTag	src_
edm::EDGetTokenT < reco::CandidateView >	srcToken_
bool	useMessageLogger_

Additional Inherited Members
Public Types inherited from edm::EDAnalyzer
typedef EDAnalyzer	ModuleType
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels
Static Public Member Functions inherited from edm::EDAnalyzer
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &)
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

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 ( const edm::ParameterSet &  pset )

explicit

Definition at line 62 of file ParticleListDrawer.cc.

                                                                   :
  src_(pset.getParameter<InputTag>("src")),
  srcToken_(consumes<reco::CandidateView>(src_)),
  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 ( )

inline

Definition at line 45 of file ParticleListDrawer.cc.

{};

Member Function Documentation

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

overridevirtual

Implements edm::EDAnalyzer.

Definition at line 84 of file ParticleListDrawer.cc.

References gather_cfg::cout, Exception, spr::find(), newFWLiteAna::found, reco::GenParticle::fromHardProcessBeforeFSR(), reco::GenParticle::fromHardProcessFinalState(), edm::Event::getByToken(), edm::EventSetup::getData(), getParticleName(), customizeTrackingMonitorSeedNumber::idx, reco::GenParticle::isDirectPromptTauDecayProductFinalState(), reco::GenStatusFlags::isFirstCopy(), reco::GenParticle::isHardProcess(), reco::GenParticle::isLastCopy(), reco::GenParticle::isLastCopyBeforeFSR(), reco::GenParticle::isPromptFinalState(), edm::InputTag::label(), maxEventsToPrint_, nEventAnalyzed_, GenerateHcalLaserBadRunList::out, AlCaHLTBitMon_ParallelJobs::p, pdt_, printFlags_, printOnlyHardInteraction_, printVertex_, src_, srcToken_, reco::GenParticle::statusFlags(), and useMessageLogger_.

                                                                                    {
  Handle<reco::CandidateView> particles;
  iEvent.getByToken(srcToken_, particles );
  iSetup.getData( pdt_ );

  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, 256, " idx  |    ID -       Name |Stat|  Mo1  Mo2  Da1  Da2 |nMo nDa|    pt       eta     phi   |     px         py         pz        m     |");
    out << buf;
    if (printVertex_) {
      snprintf(buf, 256, "        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[256];
      snprintf(buf, 256,
         " %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, 256, " %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();
  }
}

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

private

Definition at line 73 of file ParticleListDrawer.cc.

References 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

int ParticleListDrawer::maxEventsToPrint_

private

Definition at line 54 of file ParticleListDrawer.cc.

Referenced by analyze().

unsigned int ParticleListDrawer::nEventAnalyzed_

private

Definition at line 55 of file ParticleListDrawer.cc.

Referenced by analyze().

edm::ESHandle<ParticleDataTable> ParticleListDrawer::pdt_

private

Definition at line 53 of file ParticleListDrawer.cc.

Referenced by analyze(), and getParticleName().

bool ParticleListDrawer::printFlags_

private

Definition at line 58 of file ParticleListDrawer.cc.

Referenced by analyze().

bool ParticleListDrawer::printOnlyHardInteraction_

private

Definition at line 56 of file ParticleListDrawer.cc.

Referenced by analyze().

bool ParticleListDrawer::printVertex_

private

Definition at line 57 of file ParticleListDrawer.cc.

Referenced by analyze().

edm::InputTag ParticleListDrawer::src_

private

Definition at line 51 of file ParticleListDrawer.cc.

Referenced by analyze().

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

private

Definition at line 52 of file ParticleListDrawer.cc.

Referenced by analyze().

bool ParticleListDrawer::useMessageLogger_

private

Definition at line 59 of file ParticleListDrawer.cc.

Referenced by analyze().