Base class to all the history types. More...

#include <HistoryBase.h>

Inheritance diagram for HistoryBase:

Public Types
typedef std::vector< const HepMC::GenParticle * >	GenParticleTrail
	HepMC::GenParticle trail type. More...

typedef std::vector< const HepMC::GenVertex * >	GenVertexTrail
	GenVertex trail type. More...

typedef std::set< const HepMC::GenVertex * >	GenVertexTrailHelper
	GenVertex trail helper type. More...

typedef std::vector< const reco::GenParticle * >	RecoGenParticleTrail
	reco::GenParticle trail type. More...

typedef std::set< const reco::GenParticle * >	RecoGenParticleTrailHelper
	reco::GenParticle trail helper type. More...

typedef std::vector < TrackingParticleRef >	SimParticleTrail
	SimParticle trail type. More...

typedef std::vector < TrackingVertexRef >	SimVertexTrail
	SimVertex trail type. More...

Public Member Functions
void	depth (int d)
	Set the depth of the history. More...

bool	evaluate (TrackingParticleRef tpr)
	Evaluate track history using a TrackingParticleRef. More...

bool	evaluate (TrackingVertexRef tvr)
	Evaluate track history using a TrackingParticleRef. More...

const HepMC::GenParticle *	genParticle () const

GenParticleTrail const &	genParticleTrail () const
	Return all generated particle (HepMC::GenParticle) in the history. More...

GenVertexTrail const &	genVertexTrail () const
	Return all generated vertex in the history. More...

	HistoryBase ()

const reco::GenParticle *	recoGenParticle () const

RecoGenParticleTrail const &	recoGenParticleTrail () const
	Return all reco::GenParticle in the history. More...

const TrackingParticleRef &	simParticle () const
	Return the initial tracking particle from the history. More...

SimParticleTrail const &	simParticleTrail () const
	Return all the simulated particle in the history. More...

const TrackingVertexRef &	simVertex () const
	Return the initial tracking vertex from the history. More...

SimVertexTrail const &	simVertexTrail () const
	Return all the simulated vertices in the history. More...

Protected Attributes
GenParticleTrail	genParticleTrail_

GenVertexTrail	genVertexTrail_

GenVertexTrailHelper	genVertexTrailHelper_

RecoGenParticleTrail	recoGenParticleTrail_

RecoGenParticleTrailHelper	recoGenParticleTrailHelper_

SimParticleTrail	simParticleTrail_

SimVertexTrail	simVertexTrail_

Private Member Functions
void	resetTrails ()
	Reset trail functions. More...

void	resetTrails (TrackingParticleRef tpr)

void	traceGenHistory (HepMC::GenParticle const *)

void	traceGenHistory (HepMC::GenVertex const *)
	Trace all the simulated information for a given pointer to a GenVertex. More...

void	traceRecoGenHistory (reco::GenParticle const *)

bool	traceSimHistory (TrackingParticleRef const &, int)

bool	traceSimHistory (TrackingVertexRef const &, int)

Private Attributes
int	depth_

Detailed Description

Base class to all the history types.

Definition at line 12 of file HistoryBase.h.

Member Typedef Documentation

typedef std::vector<const HepMC::GenParticle *> HistoryBase::GenParticleTrail

HepMC::GenParticle trail type.

Definition at line 15 of file HistoryBase.h.

typedef std::vector<const HepMC::GenVertex *> HistoryBase::GenVertexTrail

GenVertex trail type.

Definition at line 24 of file HistoryBase.h.

typedef std::set<const HepMC::GenVertex *> HistoryBase::GenVertexTrailHelper

GenVertex trail helper type.

Definition at line 27 of file HistoryBase.h.

typedef std::vector<const reco::GenParticle *> HistoryBase::RecoGenParticleTrail

reco::GenParticle trail type.

Definition at line 18 of file HistoryBase.h.

typedef std::set<const reco::GenParticle *> HistoryBase::RecoGenParticleTrailHelper

reco::GenParticle trail helper type.

Definition at line 21 of file HistoryBase.h.

typedef std::vector<TrackingParticleRef> HistoryBase::SimParticleTrail

SimParticle trail type.

Definition at line 30 of file HistoryBase.h.

typedef std::vector<TrackingVertexRef> HistoryBase::SimVertexTrail

SimVertex trail type.

Definition at line 33 of file HistoryBase.h.

Constructor & Destructor Documentation

HistoryBase::HistoryBase ( )

inline

Definition at line 36 of file HistoryBase.h.

References depth_.

                 {
     // Default depth
     depth_ = -1;
   }

Member Function Documentation

void HistoryBase::depth ( int d )

inline

Set the depth of the history.

Definition at line 49 of file HistoryBase.h.

References ztail::d, and depth_.

Referenced by traceSimHistory(), TrackClassifier::TrackClassifier(), TrackingParticleBHadronRefSelector::TrackingParticleBHadronRefSelector(), and VertexClassifier::VertexClassifier().

49 { depth_ = d; }

ztail.d

tuple d

Definition: ztail.py:151

HistoryBase::depth_

int depth_

Definition: HistoryBase.h:127

bool HistoryBase::evaluate ( TrackingParticleRef tpr )

inline

Evaluate track history using a TrackingParticleRef.

Definition at line 96 of file HistoryBase.h.

References depth_, resetTrails(), and traceSimHistory().

Referenced by TrackHistory::evaluate(), VertexHistory::evaluate(), TrackingNtuple::fillTrackingParticles(), and TrackingParticleBHadronRefSelector::produce().

                                          {
     resetTrails(tpr);
     return traceSimHistory(tpr, depth_);
   }

bool HistoryBase::evaluate ( TrackingVertexRef tvr )

inline

Evaluate track history using a TrackingParticleRef.

Definition at line 109 of file HistoryBase.h.

References depth_, resetTrails(), and traceSimHistory().

                                        {
     resetTrails();
     return traceSimHistory(tvr, depth_);
   }

const HepMC::GenParticle* HistoryBase::genParticle ( ) const

inline

Returns a pointer to most primitive status 1 or 2 particle in the genParticleTrail_.

Definition at line 74 of file HistoryBase.h.

References genParticleTrail_.

Referenced by GenTrackMatcher::produce().

                                               {
     if (genParticleTrail_.empty())
       return nullptr;
     return genParticleTrail_[genParticleTrail_.size() - 1];
   }

GenParticleTrail const& HistoryBase::genParticleTrail ( ) const

inline

Return all generated particle (HepMC::GenParticle) in the history.

Definition at line 61 of file HistoryBase.h.

References genParticleTrail_.

Referenced by VertexHistoryAnalyzer::analyze(), TrackHistoryAnalyzer::analyze(), and TrackClassifier::vertexInformation().

61 { return genParticleTrail_; }

HistoryBase::genParticleTrail_

GenParticleTrail genParticleTrail_

Definition: HistoryBase.h:117

GenVertexTrail const& HistoryBase::genVertexTrail ( ) const

inline

Return all generated vertex in the history.

Definition at line 58 of file HistoryBase.h.

References genVertexTrail_.

Referenced by VertexHistoryAnalyzer::analyze(), TrackHistoryAnalyzer::analyze(), VertexClassifier::processesAtGenerator(), and VertexClassifier::vertexInformation().

58 { return genVertexTrail_; }

HistoryBase::genVertexTrail_

GenVertexTrail genVertexTrail_

Definition: HistoryBase.h:116

const reco::GenParticle* HistoryBase::recoGenParticle ( ) const

inline

Returns a pointer to most primitive status 1 or 2 particle in the recoGenParticleTrail_.

Definition at line 82 of file HistoryBase.h.

References recoGenParticleTrail_.

Referenced by TrackClassifier::hadronFlavor().

                                                  {
     if (recoGenParticleTrail_.empty())
       return nullptr;
     return recoGenParticleTrail_[recoGenParticleTrail_.size() - 1];
   }

RecoGenParticleTrail const& HistoryBase::recoGenParticleTrail ( ) const

inline

Return all reco::GenParticle in the history.

Definition at line 64 of file HistoryBase.h.

References recoGenParticleTrail_.

Referenced by TrackingNtuple::fillTrackingParticles(), TrackClassifier::processesAtGenerator(), and TrackingParticleBHadronRefSelector::produce().

64 { return recoGenParticleTrail_; }

HistoryBase::recoGenParticleTrail_

RecoGenParticleTrail recoGenParticleTrail_

Definition: HistoryBase.h:118

void HistoryBase::resetTrails ( )

inlineprivate

Reset trail functions.

Definition at line 149 of file HistoryBase.h.

References genParticleTrail_, genVertexTrail_, genVertexTrailHelper_, recoGenParticleTrail_, recoGenParticleTrailHelper_, simParticleTrail_, and simVertexTrail_.

Referenced by evaluate(), and resetTrails().

                      {
     simParticleTrail_.clear();
     simVertexTrail_.clear();
     genVertexTrail_.clear();
     genParticleTrail_.clear();
     recoGenParticleTrail_.clear();
     recoGenParticleTrailHelper_.clear();
     genVertexTrailHelper_.clear();
   }

void HistoryBase::resetTrails ( TrackingParticleRef tpr )

inlineprivate

Definition at line 159 of file HistoryBase.h.

References resetTrails(), and simParticleTrail_.

                                             {
     resetTrails();
     simParticleTrail_.push_back(tpr);
   }

const TrackingParticleRef& HistoryBase::simParticle ( ) const

inline

Return the initial tracking particle from the history.

Definition at line 67 of file HistoryBase.h.

References simParticleTrail_.

Referenced by TrackClassifier::reconstructionInformation(), and TrackClassifier::simulationInformation().

67 { return simParticleTrail_[0]; }

HistoryBase::simParticleTrail_

SimParticleTrail simParticleTrail_

Definition: HistoryBase.h:120

SimParticleTrail const& HistoryBase::simParticleTrail ( ) const

inline

Return all the simulated particle in the history.

Definition at line 55 of file HistoryBase.h.

References simParticleTrail_.

Referenced by VertexHistoryAnalyzer::analyze(), TrackHistoryAnalyzer::analyze(), TrackClassifier::processesAtSimulation(), TrackClassifier::qualityInformation(), and TrackClassifier::vertexInformation().

55 { return simParticleTrail_; }

HistoryBase::simParticleTrail_

SimParticleTrail simParticleTrail_

Definition: HistoryBase.h:120

const TrackingVertexRef& HistoryBase::simVertex ( ) const

inline

Return the initial tracking vertex from the history.

Definition at line 70 of file HistoryBase.h.

References simVertexTrail_.

Referenced by SVTagInfoValidationAnalyzer::analyze(), recoBSVTagInfoValidationAnalyzer::analyze(), and VertexClassifier::simulationInformation().

70 { return simVertexTrail_[0]; }

HistoryBase::simVertexTrail_

SimVertexTrail simVertexTrail_

Definition: HistoryBase.h:119

SimVertexTrail const& HistoryBase::simVertexTrail ( ) const

inline

Return all the simulated vertices in the history.

Definition at line 52 of file HistoryBase.h.

References simVertexTrail_.

Referenced by VertexHistoryAnalyzer::analyze(), TrackHistoryAnalyzer::analyze(), VertexClassifier::processesAtSimulation(), and VertexClassifier::vertexInformation().

52 { return simVertexTrail_; }

HistoryBase::simVertexTrail_

SimVertexTrail simVertexTrail_

Definition: HistoryBase.h:119

void HistoryBase::traceGenHistory ( HepMC::GenParticle const * genParticle )

private

Trace all the simulated information for a given pointer to a HepMC::GenParticle.

Definition at line 31 of file HistoryBase.cc.

References funct::abs(), depth_, and genParticleTrail_.

Referenced by traceGenHistory(), and traceSimHistory().

                                                                      {
   // Third stop criteria: status abs(depth_) particles after the hadronization.
   // The after hadronization is done by detecting the pdg_id pythia code from 88
   // to 99
   if (genParticle->status() <= abs(depth_) && (genParticle->pdg_id() < 88 || genParticle->pdg_id() > 99)) {
     genParticleTrail_.push_back(genParticle);
     // Get the producer vertex and trace it history
     traceGenHistory(genParticle->production_vertex());
   }
 }

void HistoryBase::traceGenHistory ( HepMC::GenVertex const * genVertex )

private

Trace all the simulated information for a given pointer to a GenVertex.

Definition at line 42 of file HistoryBase.cc.

References genVertexTrail_, genVertexTrailHelper_, and traceGenHistory().

                                                                  {
   // Verify if has a vertex associated
   if (genVertex) {
     // Skip if already exist in the collection
     if (genVertexTrailHelper_.find(genVertex) != genVertexTrailHelper_.end())
       return;
     // Add vertex to the history
     genVertexTrail_.push_back(genVertex);
     genVertexTrailHelper_.insert(genVertex);
     // Verify if the vertex has incoming particles
     if (genVertex->particles_in_size())
       traceGenHistory(*(genVertex->particles_in_const_begin()));
   }
 }

void HistoryBase::traceRecoGenHistory ( reco::GenParticle const * genParticle )

private

Trace all the simulated information for a given pointer to a reco::GenParticle.

Definition at line 7 of file HistoryBase.cc.

References funct::abs(), depth_, reco::CompositeRefCandidateT< D >::mother(), reco::LeafCandidate::pdgId(), recoGenParticleTrail_, recoGenParticleTrailHelper_, and reco::LeafCandidate::status().

Referenced by traceSimHistory().

                                                                         {
   // fill the trace of reco::GenParticle for correct reading of the History
   // flags etc. This is called from the TrackingParticle->genParticle_begin()
   // which is a reco::GenParticle
 
   // Take onlt genParticles with a status() smaller than "depth_". Typically
   // depth is 2 and so you trace back untill you reach the hard partons see for
   // status():
   // https://twiki.cern.ch/twiki/bin/view/CMSPublic/WorkBookGenParticleCandidate#GenPCand
   if (genParticle->status() <= abs(depth_) && (genParticle->pdgId() < 88 || genParticle->pdgId() > 99)) {
     // If the particle is already in the history, it is looping and you should
     // stop
     if (recoGenParticleTrailHelper_.find(genParticle) != recoGenParticleTrailHelper_.end()) {
       return;
     }
     recoGenParticleTrail_.push_back(genParticle);
     recoGenParticleTrailHelper_.insert(genParticle);
     // Get the genParticle's mother and trace its history
     if (genParticle->mother() != nullptr) {
       traceRecoGenHistory((const reco::GenParticle *)genParticle->mother());
     }
   }
 }

bool HistoryBase::traceSimHistory	(	TrackingParticleRef const &	trackingParticle,
		int	depth
	)

private

Trace all the simulated information for a given reference to a TrackingParticle.

Definition at line 57 of file HistoryBase.cc.

References depth(), depth_, LogDebug, and traceRecoGenHistory().

Referenced by evaluate(), and traceSimHistory().

                                                                                         {
   // first stop condition: if the required depth is reached
   if (depth == depth_ && depth_ >= 0)
     return true;
 
   // second stop condition: if a gen particle is associated to the TP
   if (!trackingParticle->genParticles().empty()) {
     LogDebug("TrackHistory") << "Particle " << trackingParticle->pdgId() << " has a GenParicle image." << std::endl;
 
     traceRecoGenHistory(&(**(trackingParticle->genParticle_begin())));
   }
 
   LogDebug("TrackHistory") << "No GenParticle image for " << trackingParticle->pdgId() << std::endl;
 
   // if no association between TP and genParticles is found: get a reference to
   // the TP's parent vertex and trace its history
   return traceSimHistory(trackingParticle->parentVertex(), depth);
 }

bool HistoryBase::traceSimHistory	(	TrackingVertexRef const &	trackingVertex,
		int	depth
	)

private

Trace all the simulated information for a given reference to a TrackingVertex.

Definition at line 76 of file HistoryBase.cc.

References spr::find(), edm::Ref< C, T, F >::isNonnull(), LogDebug, simParticleTrail_, simVertexTrail_, traceGenHistory(), and traceSimHistory().

                                                                                     {
   // verify if the parent vertex exists
   if (trackingVertex.isNonnull()) {
     // save the vertex in the trail
     simVertexTrail_.push_back(trackingVertex);
 
     if (!trackingVertex->sourceTracks().empty()) {
       LogDebug("TrackHistory") << "Moving on to the parent particle." << std::endl;
 
       // select the original source in case of combined vertices
       bool flag = false;
       TrackingVertex::tp_iterator itd, its;
 
       for (its = trackingVertex->sourceTracks_begin(); its != trackingVertex->sourceTracks_end(); its++) {
         for (itd = trackingVertex->daughterTracks_begin(); itd != trackingVertex->daughterTracks_end(); itd++)
           if (itd != its) {
             flag = true;
             break;
           }
         if (flag)
           break;
       }
 
       if (!flag)
         return false;
 
       // verify if the new particle is not in the trail (looping partiles)
       if (std::find(simParticleTrail_.begin(), simParticleTrail_.end(), *its) != simParticleTrail_.end()) {
         LogDebug("TrackHistory") << "WARNING: Looping track found." << std::endl;
         return false;
       }
 
       // save particle in the trail
       simParticleTrail_.push_back(*its);
       return traceSimHistory(*its, --depth);
     } else if (!trackingVertex->genVertices().empty()) {
       // navigate over all the associated generated vertexes
       LogDebug("TrackHistory") << "Vertex has " << trackingVertex->genVertices().size() << "GenVertex image."
                                << std::endl;
       for (TrackingVertex::genv_iterator ivertex = trackingVertex->genVertices_begin();
            ivertex != trackingVertex->genVertices_end();
            ++ivertex)
         traceGenHistory(&(**(ivertex)));
       return true;
     } else {
       LogDebug("TrackHistory") << "WARNING: Source track for tracking vertex cannot be found." << std::endl;
     }
   } else {
     LogDebug("TrackHistory") << " WARNING: Vertex cannot be found.";
   }
 
   return false;
 }