This class traces the simulated and generated history of a given track. More...

#include <VertexHistory.h>

Inheritance diagram for VertexHistory:

Public Member Functions
bool	evaluate (reco::VertexBaseRef)
	Evaluate reco::Vertex history using a given association. More...

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

void	newEvent (const edm::Event &, const edm::EventSetup &)
	Pre-process event information (for accessing reconstruction information) More...

double	quality () const
	Return the quality of the match. More...

const reco::VertexBaseRef &	recoVertex () const
	Return a reference to the reconstructed track. More...

	VertexHistory (const edm::ParameterSet &, edm::ConsumesCollector &&)
	Constructor by pset. More...

Public Member Functions inherited from HistoryBase
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

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

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

	HistoryBase ()

const reco::GenParticle *	recoGenParticle () const

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

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

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

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

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

Private Attributes
bool	bestMatchByMaxValue_

bool	enableRecoToSim_

bool	enableSimToReco_

double	quality_

reco::VertexRecoToSimCollection	recoToSim_

reco::VertexBaseRef	recovertex_

reco::VertexSimToRecoCollection	simToReco_

edm::InputTag	trackingTruth_

edm::InputTag	vertexAssociator_

edm::InputTag	vertexProducer_

Additional Inherited Members
Public Types inherited from HistoryBase
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...

Protected Attributes inherited from HistoryBase
GenParticleTrail	genParticleTrail_

GenVertexTrail	genVertexTrail_

GenVertexTrailHelper	genVertexTrailHelper_

RecoGenParticleTrail	recoGenParticleTrail_

RecoGenParticleTrailHelper	recoGenParticleTrailHelper_

SimParticleTrail	simParticleTrail_

SimVertexTrail	simVertexTrail_

Detailed Description

This class traces the simulated and generated history of a given track.

Definition at line 18 of file VertexHistory.h.

Constructor & Destructor Documentation

◆ VertexHistory()

VertexHistory::VertexHistory	(	const edm::ParameterSet &	config,
		edm::ConsumesCollector &&	collector
	)

Constructor by pset.

Definition at line 6 of file VertexHistory.cc.

                                                                                             : HistoryBase() {
   // Name of the track collection
   vertexProducer_ = config.getUntrackedParameter<edm::InputTag>("vertexProducer");
  
   // Name of the traking pariticle collection
   trackingTruth_ = config.getUntrackedParameter<edm::InputTag>("trackingTruth");
  
   // Vertex association record
   vertexAssociator_ = config.getUntrackedParameter<edm::InputTag>("vertexAssociator");
  
   // Association by max. value
   bestMatchByMaxValue_ = config.getUntrackedParameter<bool>("bestMatchByMaxValue");
  
   // Enable RecoToSim association
   enableRecoToSim_ = config.getUntrackedParameter<bool>("enableRecoToSim");
  
   // Enable SimToReco association
   enableSimToReco_ = config.getUntrackedParameter<bool>("enableSimToReco");
  
   if (enableRecoToSim_ or enableSimToReco_) {
     collector.consumes<edm::View<reco::Vertex>>(vertexProducer_);
     collector.consumes<TrackingVertexCollection>(trackingTruth_);
     collector.consumes<reco::VertexToTrackingVertexAssociator>(vertexAssociator_);
   }
  
   quality_ = 0.;
 }

References bestMatchByMaxValue_, enableRecoToSim_, enableSimToReco_, or, quality_, trackingTruth_, vertexAssociator_, and vertexProducer_.

Member Function Documentation

◆ evaluate() [1/2]

bool VertexHistory::evaluate ( reco::VertexBaseRef tv )

Evaluate reco::Vertex history using a given association.

Definition at line 60 of file VertexHistory.cc.

                                                  {
   if (!enableRecoToSim_)
     return false;
  
   std::pair<TrackingVertexRef, double> result = match(tv, recoToSim_, bestMatchByMaxValue_);
  
   TrackingVertexRef tvr(result.first);
   quality_ = result.second;
  
   if (!tvr.isNull()) {
     HistoryBase::evaluate(tvr);
  
     recovertex_ = tv;
  
     return true;
   }
  
   return false;
 }

References bestMatchByMaxValue_, enableRecoToSim_, HistoryBase::evaluate(), edm::Ref< C, T, F >::isNull(), match(), quality_, recoToSim_, recovertex_, and mps_fire::result.

◆ evaluate() [2/2]

bool VertexHistory::evaluate ( TrackingVertexRef tvr )

inline

Evaluate track history using a TrackingParticleRef.

Definition at line 38 of file VertexHistory.h.

                                        {
     if (enableSimToReco_) {
       std::pair<reco::VertexBaseRef, double> result = match(tvr, simToReco_, bestMatchByMaxValue_);
       recovertex_ = result.first;
       quality_ = result.second;
     }
     return HistoryBase::evaluate(tvr);
   }

References bestMatchByMaxValue_, enableSimToReco_, HistoryBase::evaluate(), match(), quality_, recovertex_, mps_fire::result, and simToReco_.

Referenced by VertexClassifier::evaluate().

◆ newEvent()

void VertexHistory::newEvent	(	const edm::Event &	event,
		const edm::EventSetup &	setup
	)

Pre-process event information (for accessing reconstruction information)

Definition at line 34 of file VertexHistory.cc.

                                                                               {
   if (enableRecoToSim_ || enableSimToReco_) {
     // Vertex collection
     edm::Handle<edm::View<reco::Vertex>> vertexCollection;
     event.getByLabel(vertexProducer_, vertexCollection);
  
     // Tracking particle information
     edm::Handle<TrackingVertexCollection> TVCollection;
     event.getByLabel(trackingTruth_, TVCollection);
  
     // Get the track associator
     edm::Handle<reco::VertexToTrackingVertexAssociator> vertexAssociator;
     event.getByLabel(vertexAssociator_, vertexAssociator);
  
     if (enableRecoToSim_) {
       // Calculate the map between recovertex -> simvertex
       recoToSim_ = vertexAssociator->associateRecoToSim(vertexCollection, TVCollection);
     }
  
     if (enableSimToReco_) {
       // Calculate the map between recovertex <- simvertex
       simToReco_ = vertexAssociator->associateSimToReco(vertexCollection, TVCollection);
     }
   }
 }