VertexHistory Class Reference

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 (TrackingVertexRef tvr)
	Evaluate track history using a TrackingParticleRef. More...
bool	evaluate (reco::VertexBaseRef)
	Evaluate reco::Vertex history using a given association. 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...
const HepMC::GenParticle *	genParticle () const
	Returns a pointer to most primitive status 1 or 2 particle. More...
GenParticleTrail const &	genParticleTrail () const
	Return all generated particle in the history. More...
GenVertexTrail const &	genVertexTrail () const
	Return all generated vertex in the history. More...
	HistoryBase ()
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...

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
	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 < TrackingParticleRef >	SimParticleTrail
	SimParticle trail type. More...
typedef std::vector < TrackingVertexRef >	SimVertexTrail
	SimVertex trail type. More...
Protected Member Functions inherited from HistoryBase
bool	evaluate (TrackingParticleRef tpr)
	Evaluate track history using a TrackingParticleRef. More...
bool	evaluate (TrackingVertexRef tvr)
	Evaluate track history using a TrackingParticleRef. More...
Protected Attributes inherited from HistoryBase
GenParticleTrail	genParticleTrail_
GenVertexTrail	genVertexTrail_
GenVertexTrailHelper	genVertexTrailHelper_
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	(	const edm::ParameterSet &	config,
		edm::ConsumesCollector &&	collector
	)

Constructor by pset.

Definition at line 6 of file VertexHistory.cc.

References bestMatchByMaxValue_, enableRecoToSim_, enableSimToReco_, edm::ParameterSet::getUntrackedParameter(), or, quality_, trackingTruth_, vertexAssociator_, and vertexProducer_.

  : 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.;
}

Member Function Documentation

bool VertexHistory::evaluate ( TrackingVertexRef  tvr )

inline

Evaluate track history using a TrackingParticleRef.

Definition at line 42 of file VertexHistory.h.

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

Referenced by VertexClassifier::evaluate().

    {
        if ( enableSimToReco_ )
        {

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

bool VertexHistory::evaluate

(

reco::VertexBaseRef

tv

)

Evaluate reco::Vertex history using a given association.

Definition at line 73 of file VertexHistory.cc.

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

{

    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;
}

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

Pre-process event information (for accessing reconstruction information)

Definition at line 39 of file VertexHistory.cc.

References enableRecoToSim_, enableSimToReco_, recoToSim_, simToReco_, trackingTruth_, vertexAssociator_, GoodVertex_cfg::vertexCollection, and vertexProducer_.

Referenced by VertexClassifier::newEvent().

{
    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);
        }

    }
}

double VertexHistory::quality ( void  ) const

inline

Return the quality of the match.

Definition at line 70 of file VertexHistory.h.

References quality_.

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

    {
        return quality_;
    }

const reco::VertexBaseRef& VertexHistory::recoVertex ( ) const

inline

Return a reference to the reconstructed track.

Definition at line 64 of file VertexHistory.h.

References recovertex_.

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

    {
        return recovertex_;
    }

Member Data Documentation

bool VertexHistory::bestMatchByMaxValue_

private

Definition at line 78 of file VertexHistory.h.

Referenced by evaluate(), and VertexHistory().

bool VertexHistory::enableRecoToSim_

private

Definition at line 80 of file VertexHistory.h.

Referenced by evaluate(), newEvent(), and VertexHistory().

bool VertexHistory::enableSimToReco_

private

Definition at line 80 of file VertexHistory.h.

Referenced by evaluate(), newEvent(), and VertexHistory().

double VertexHistory::quality_

private

Definition at line 82 of file VertexHistory.h.

Referenced by evaluate(), quality(), and VertexHistory().

reco::VertexRecoToSimCollection VertexHistory::recoToSim_

private

Definition at line 92 of file VertexHistory.h.

Referenced by evaluate(), and newEvent().

reco::VertexBaseRef VertexHistory::recovertex_

private

Definition at line 90 of file VertexHistory.h.

Referenced by evaluate(), and recoVertex().

reco::VertexSimToRecoCollection VertexHistory::simToReco_

private

Definition at line 94 of file VertexHistory.h.

Referenced by evaluate(), and newEvent().

edm::InputTag VertexHistory::trackingTruth_

private

Definition at line 86 of file VertexHistory.h.

Referenced by newEvent(), and VertexHistory().

edm::InputTag VertexHistory::vertexAssociator_

private

Definition at line 88 of file VertexHistory.h.

Referenced by newEvent(), and VertexHistory().

edm::InputTag VertexHistory::vertexProducer_

private

Definition at line 84 of file VertexHistory.h.

Referenced by newEvent(), and VertexHistory().