pat::helper::VertexingHelper Class Reference

Produces and/or checks pat::VertexAssociation's. More...

#include "PhysicsTools/PatAlgos/interface/VertexingHelper.h"

Public Member Functions
bool	enabled () const
	returns true if this was given a non dummy configuration More...
void	newEvent (const edm::Event &event)
	To be called for each new event, reads in the vertex collection. More...
void	newEvent (const edm::Event &event, const edm::EventSetup &setup)
template<typename AnyCandRef >
pat::VertexAssociation	operator() (const AnyCandRef &) const
	VertexingHelper ()
	VertexingHelper (const edm::ParameterSet &iConfig, edm::ConsumesCollector &&iC)

Private Member Functions
pat::VertexAssociation	associate (const reco::Candidate &) const
reco::TrackBaseRef	getTrack_ (const reco::Candidate &c) const
	Get out the track from the Candidate / RecoCandidate / PFCandidate. More...

Private Attributes
pat::VertexAssociationSelector	assoSelector_
	selector of associations More...
bool	enabled_
	true if it has non null configuration More...
bool	playback_
	true if it's just reading the associations from the event More...
edm::ESHandle< TransientTrackBuilder >	ttBuilder_
bool	useTracks_
	use tracks inside candidates More...
edm::EDGetTokenT< edm::ValueMap< pat::VertexAssociation > >	vertexAssociationsToken_
edm::Handle< edm::ValueMap< pat::VertexAssociation > >	vertexAssoMap_
edm::Handle< reco::VertexCollection >	vertexHandle_
edm::EDGetTokenT< reco::VertexCollection >	verticesToken_

Detailed Description

Produces and/or checks pat::VertexAssociation's.

The VertexingHelper produces pat::VertexAssociation, or reads them from the event, and can use them to select if a candidate is good or not.

Author

Giovanni Petrucciani

Version

Id

VertexingHelper.h,v 1.3 2008/06/06 14:13:40 gpetrucc Exp

Definition at line 50 of file VertexingHelper.h.

Constructor & Destructor Documentation

VertexingHelper() [1/2]

pat::helper::VertexingHelper::VertexingHelper ( )

inline

Definition at line 52 of file VertexingHelper.h.

: enabled_(false) {}

VertexingHelper() [2/2]

pat::helper::VertexingHelper::VertexingHelper	(	const edm::ParameterSet &	iConfig,
		edm::ConsumesCollector &&	iC
	)

Definition at line 11 of file VertexingHelper.cc.

                                                                                                   {
  if (!iConfig.empty()) {
    enabled_ = true;
    if (iConfig.existsAs<edm::InputTag>("vertexAssociations") == iConfig.existsAs<edm::InputTag>("vertices")) {
      throw cms::Exception("Configuration") << "VertexingHelper: you must configure either 'vertices' (to produce "
                                               "associations) or 'vertexAssociations' (to read them from disk), "
                                            << "you can't specify both, nor you can specify none!\n";
    }
 
    if (iConfig.existsAs<edm::InputTag>("vertexAssociations")) {
      playback_ = true;
      vertexAssociationsToken_ = iC.consumes<edm::ValueMap<pat::VertexAssociation> >(
          iConfig.getParameter<edm::InputTag>("vertexAssociations"));
    }
    if (iConfig.existsAs<edm::InputTag>("vertices")) {  // vertex have been specified, so run on the fly
      playback_ = false;
      verticesToken_ = iC.consumes<reco::VertexCollection>(iConfig.getParameter<edm::InputTag>("vertices"));
      // ------ MODE ------------------
      useTracks_ = iConfig.getParameter<bool>("useTracks");
      // ------ CUTS (fully optional) ------------------
    }
    assoSelector_ = reco::modules::make<pat::VertexAssociationSelector>(iConfig);
  } else {
    enabled_ = false;
  }
}

References assoSelector_, edm::ParameterSet::empty(), enabled_, Exception, edm::ParameterSet::existsAs(), edm::ParameterSet::getParameter(), playback_, useTracks_, vertexAssociationsToken_, and verticesToken_.

Member Function Documentation

associate()

pat::VertexAssociation pat::helper::VertexingHelper::associate ( const reco::Candidate &  c ) const

private

Try to associated this candidate to a vertex. If no association is found passing all cuts, return a null association

Definition at line 52 of file VertexingHelper.cc.

                                                                                     {
  if (playback_)
    throw cms::Exception("Configuration")
        << "VertexingHelper: if this module was configured to read associations from the event,"
        << " you must use 'operator()' passing a candidate ref, and not 'associate()' directly!\n";
 
  reco::VertexCollection::const_iterator vtx, end;
  size_t ivtx;
  reco::TrackBaseRef tk;
  reco::TransientTrack tt;
  if (useTracks_) {
    if (!ttBuilder_.isValid())
      throw cms::Exception("Configuration")
          << "VertexingHelper: If you use 'useTracks', you must call newEvent(iEvent,iSetup)!\n";
    tk = getTrack_(c);
    if (tk.isNull())
      return pat::VertexAssociation();
    tt = ttBuilder_->build(*tk);
  }
  for (vtx = vertexHandle_->begin(), end = vertexHandle_->end(), ivtx = 0; vtx != end; ++vtx, ++ivtx) {
    pat::VertexAssociation association(reco::VertexRef(vertexHandle_, ivtx), tk);
    if (useTracks_ == false) {
      association.setDistances(c.vertex(), vtx->position(), vtx->error());
    } else {
      GlobalPoint vtxGP(vtx->x(), vtx->y(), vtx->z());  // need to convert XYZPoint to GlobalPoint
      TrajectoryStateClosestToPoint tscp = tt.trajectoryStateClosestToPoint(vtxGP);
      GlobalPoint trackPos = tscp.theState().position();
      AlgebraicSymMatrix33 trackErr = tscp.theState().cartesianError().matrix().Sub<AlgebraicSymMatrix33>(0, 0);
      association.setDistances(trackPos, vtx->position(), trackErr + vtx->error());
    }
    if (assoSelector_(association))
      return association;
  }
  return pat::VertexAssociation();
}

References c, mps_fire::end, Exception, edm::RefToBase< T >::isNull(), groupFilesInBlocks::tt, and extraflags_cff::vtx.

enabled()

bool pat::helper::VertexingHelper::enabled ( ) const

inline

returns true if this was given a non dummy configuration

Definition at line 56 of file VertexingHelper.h.

{ return enabled_; }

References enabled_.

Referenced by pat::PATGenericParticleProducer::produce().

getTrack_()

reco::TrackBaseRef pat::helper::VertexingHelper::getTrack_ ( const reco::Candidate &  c ) const

private

Get out the track from the Candidate / RecoCandidate / PFCandidate.

Definition at line 88 of file VertexingHelper.cc.

                                                                                 {
  const reco::RecoCandidate *rc = dynamic_cast<const reco::RecoCandidate *>(&c);
  if (rc != nullptr) {
    return rc->bestTrackRef();
  }
  const reco::PFCandidate *pfc = dynamic_cast<const reco::PFCandidate *>(&c);
  if (pfc != nullptr) {
    return reco::TrackBaseRef(pfc->trackRef());
  }
 
  return reco::TrackBaseRef();
}

References reco::RecoCandidate::bestTrackRef(), c, and reco::PFCandidate::trackRef().

newEvent() [1/2]

void pat::helper::VertexingHelper::newEvent

(

const edm::Event &

event

)

To be called for each new event, reads in the vertex collection.

Definition at line 38 of file VertexingHelper.cc.

                                                              {
  if (playback_) {
    iEvent.getByToken(vertexAssociationsToken_, vertexAssoMap_);
  } else {
    iEvent.getByToken(verticesToken_, vertexHandle_);
  }
}

References iEvent.

Referenced by pat::PATVertexAssociationProducer::produce(), and pat::PATGenericParticleProducer::produce().

newEvent() [2/2]

void pat::helper::VertexingHelper::newEvent	(	const edm::Event &	event,
		const edm::EventSetup &	setup
	)

To be called for each new event, reads in the vertex collection and the tracking info You need this if 'useTrack' is true

Definition at line 46 of file VertexingHelper.cc.

                                                                                           {
  newEvent(iEvent);
  if (!playback_)
    iSetup.get<TransientTrackRecord>().get("TransientTrackBuilder", ttBuilder_);
}

References edm::EventSetup::get(), get, and iEvent.

operator()()

template<typename AnyCandRef >

pat::VertexAssociation pat::helper::VertexingHelper::operator()

(

const AnyCandRef &

cand

)

const

Return true if this candidate is associated to a valid vertex AnyCandRef should be a Ref<>, RefToBase<> or Ptr to a Candidate object

Definition at line 101 of file VertexingHelper.h.

                                                                                          {
      if (playback_) {
        const pat::VertexAssociation &assoc = (*vertexAssoMap_)[cand];
        return assoSelector_(assoc) ? assoc : pat::VertexAssociation();
      } else {
        return associate(*cand);
      }
    }

References trackingPlots::assoc.

Member Data Documentation

assoSelector_

pat::VertexAssociationSelector pat::helper::VertexingHelper::assoSelector_

private

selector of associations

Definition at line 78 of file VertexingHelper.h.

Referenced by VertexingHelper().

enabled_

bool pat::helper::VertexingHelper::enabled_

private

true if it has non null configuration

Definition at line 72 of file VertexingHelper.h.

Referenced by enabled(), and VertexingHelper().

playback_

bool pat::helper::VertexingHelper::playback_

private

true if it's just reading the associations from the event

Definition at line 75 of file VertexingHelper.h.

Referenced by VertexingHelper().

ttBuilder_

edm::ESHandle<TransientTrackBuilder> pat::helper::VertexingHelper::ttBuilder_

private

Definition at line 85 of file VertexingHelper.h.

useTracks_

bool pat::helper::VertexingHelper::useTracks_

private

use tracks inside candidates

Definition at line 84 of file VertexingHelper.h.

Referenced by VertexingHelper().

vertexAssociationsToken_

edm::EDGetTokenT<edm::ValueMap<pat::VertexAssociation> > pat::helper::VertexingHelper::vertexAssociationsToken_

private

Definition at line 88 of file VertexingHelper.h.

Referenced by VertexingHelper().

vertexAssoMap_

edm::Handle<edm::ValueMap<pat::VertexAssociation> > pat::helper::VertexingHelper::vertexAssoMap_

private

Definition at line 89 of file VertexingHelper.h.

vertexHandle_

edm::Handle<reco::VertexCollection> pat::helper::VertexingHelper::vertexHandle_

private

Definition at line 82 of file VertexingHelper.h.

verticesToken_

edm::EDGetTokenT<reco::VertexCollection> pat::helper::VertexingHelper::verticesToken_

private

Definition at line 81 of file VertexingHelper.h.

Referenced by VertexingHelper().