Produces a list containing a single vertex selected by some criteria. More...

#include "PhysicsTools/PatAlgos/plugins/PATSingleVertexSelector.h"

Inheritance diagram for pat::PATSingleVertexSelector:

Public Member Functions
virtual bool	filter (edm::Event &iEvent, const edm::EventSetup &iSetup) override

	PATSingleVertexSelector (const edm::ParameterSet &iConfig)

	~PATSingleVertexSelector ()

Public Member Functions inherited from edm::EDFilter
	EDFilter ()

ModuleDescription const &	moduleDescription () const

virtual	~EDFilter ()

Public Member Functions inherited from edm::ProducerBase
	ProducerBase ()

void	registerProducts (ProducerBase , ProductRegistry , ModuleDescription const &)

std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...

virtual	~ProducerBase ()

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 (const std::string &iProcessName, std::vector< const char * > &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 Types
typedef StringCutObjectSelector < reco::Candidate >	CandSel

enum	Mode { First, NearestToCand, FromCand, FromBeamSpot }

typedef StringCutObjectSelector < reco::Vertex >	VtxSel

Private Member Functions
std::auto_ptr< std::vector < reco::Vertex > >	filter_ (Mode mode, const edm::Event &iEvent, const edm::EventSetup &iSetup)

bool	hasMode_ (Mode mode) const

Static Private Member Functions
static Mode	parseMode (const std::string &name)

Private Attributes
edm::EDGetTokenT< reco::BeamSpot >	beamSpotToken_

const reco::Candidate *	bestCand_

std::vector< edm::EDGetTokenT < edm::View< reco::Candidate > > >	candidatesToken_

std::auto_ptr< CandSel >	candPreselection_

bool	doFilterEvents_

std::vector< Mode >	modes_

std::vector< const reco::Vertex * >	selVtxs_

edm::EDGetTokenT< std::vector < reco::Vertex > >	verticesToken_

std::auto_ptr< VtxSel >	vtxPreselection_

Additional Inherited Members
Public Types inherited from edm::EDFilter
typedef EDFilter	ModuleType

Public Types inherited from edm::ProducerBase
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

Static Public Member Functions inherited from edm::EDFilter
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &)

Protected Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

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

Produces a list containing a single vertex selected by some criteria.

Author: Giovanni Petrucciani

Version

Id:: PATSingleVertexSelector.h,v 1.5 2011/06/15 11:47:25 friis Exp

Definition at line 26 of file PATSingleVertexSelector.h.

Member Typedef Documentation

typedef StringCutObjectSelector<reco::Candidate> pat::PATSingleVertexSelector::CandSel

private

Definition at line 38 of file PATSingleVertexSelector.h.

typedef StringCutObjectSelector<reco::Vertex> pat::PATSingleVertexSelector::VtxSel

private

Definition at line 37 of file PATSingleVertexSelector.h.

Member Enumeration Documentation

enum pat::PATSingleVertexSelector::Mode

private

Enumerator
First
NearestToCand
FromCand
FromBeamSpot

Definition at line 36 of file PATSingleVertexSelector.h.

36 { First, NearestToCand, FromCand, FromBeamSpot };

pat::PATSingleVertexSelector::FromBeamSpot

Definition: PATSingleVertexSelector.h:36

pat::PATSingleVertexSelector::FromCand

Definition: PATSingleVertexSelector.h:36

pat::PATSingleVertexSelector::First

Definition: PATSingleVertexSelector.h:36

pat::PATSingleVertexSelector::NearestToCand

Definition: PATSingleVertexSelector.h:36

Constructor & Destructor Documentation

PATSingleVertexSelector::PATSingleVertexSelector ( const edm::ParameterSet & iConfig )

explicit

Definition at line 29 of file PATSingleVertexSelector.cc.

References candidatesToken_, candPreselection_, edm::EDConsumerBase::consumes(), edm::ParameterSet::exists(), edm::ParameterSet::existsAs(), First, FromCand, edm::ParameterSet::getParameter(), hasMode_(), modes_, NearestToCand, parseMode(), AlCaHLTBitMon_QueryRunRegistry::string, GlobalPosition_Frontier_DevDB_cff::tag, edm::vector_transform(), verticesToken_, and vtxPreselection_.

   : doFilterEvents_(false)
 {
    using namespace std;
 
    modes_.push_back( parseMode(iConfig.getParameter<std::string>("mode")) );
    if (iConfig.exists("fallbacks")) {
       vector<string> modes = iConfig.getParameter<vector<string> >("fallbacks");
       for (vector<string>::const_iterator it = modes.begin(), ed = modes.end(); it != ed; ++it) {
         modes_.push_back( parseMode(*it) );
       }
    }
    if (hasMode_(First) || hasMode_(NearestToCand)) {
         verticesToken_ = consumes<vector<reco::Vertex> >(iConfig.getParameter<edm::InputTag>("vertices"));
         if (iConfig.existsAs<string>("vertexPreselection")) {
             string presel = iConfig.getParameter<string>("vertexPreselection");
             if (!presel.empty()) vtxPreselection_ = auto_ptr<VtxSel>(new VtxSel(presel));
         }
    }
    if (hasMode_(NearestToCand) || hasMode_(FromCand)) {
         candidatesToken_ = edm::vector_transform(iConfig.getParameter<vector<edm::InputTag> >("candidates"), [this](edm::InputTag const & tag){return consumes<edm::View<reco::Candidate> >(tag);});
         if (iConfig.existsAs<string>("candidatePreselection")) {
             string presel = iConfig.getParameter<string>("candidatePreselection");
             if (!presel.empty()) candPreselection_ = auto_ptr<CandSel>(new CandSel(presel));
         }
    }
    if (hasMode_(FromBeamSpot)) {
         beamSpotToken_ = consumes<reco::BeamSpot>(iConfig.getParameter<edm::InputTag>("beamSpot"));
    }
 
    if ( iConfig.exists("filter") ) doFilterEvents_ = iConfig.getParameter<bool>("filter");
 
    produces<vector<reco::Vertex> >();
 }

PATSingleVertexSelector::~PATSingleVertexSelector ( )

Definition at line 65 of file PATSingleVertexSelector.cc.

66 {

67 }

Member Function Documentation

bool PATSingleVertexSelector::filter	(	edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)

overridevirtual

Implements edm::EDFilter.

Definition at line 74 of file PATSingleVertexSelector.cc.

References bestCand_, candidatesToken_, candPreselection_, doFilterEvents_, filter_(), First, FromCand, edm::Event::getByToken(), hasMode_(), modes_, NearestToCand, edm::Event::put(), query::result, selVtxs_, HLT_25ns14e33_v1_cff::vertices, verticesToken_, and vtxPreselection_.

                                                                                {
     using namespace edm;
     using namespace std;
 
     // Clear
     selVtxs_.clear(); bestCand_ = 0;
 
     // Gather data from the Event
     // -- vertex data --
     if (hasMode_(First) || hasMode_(NearestToCand)) {
         Handle<vector<reco::Vertex> > vertices;
         iEvent.getByToken(verticesToken_, vertices);
         for (vector<reco::Vertex>::const_iterator itv = vertices->begin(), edv = vertices->end(); itv != edv; ++itv) {
             if ((vtxPreselection_.get() != 0) && !((*vtxPreselection_)(*itv)) ) continue;
             selVtxs_.push_back( &*itv );
         }
     }
     // -- candidate data --
     if (hasMode_(NearestToCand) || hasMode_(FromCand)) {
        vector<pair<double, const reco::Candidate *> > cands;
        for (vector<edm::EDGetTokenT<edm::View<reco::Candidate> > >::const_iterator itt = candidatesToken_.begin(), edt = candidatesToken_.end(); itt != edt; ++itt) {
           Handle<View<reco::Candidate> > theseCands;
           iEvent.getByToken(*itt, theseCands);
           for (View<reco::Candidate>::const_iterator itc = theseCands->begin(), edc = theseCands->end(); itc != edc; ++itc) {
             if ((candPreselection_.get() != 0) && !((*candPreselection_)(*itc))) continue;
             cands.push_back( pair<double, const reco::Candidate *>(-itc->pt(), &*itc) );
           }
        }
        if (!cands.empty()) bestCand_ = cands.front().second;
     }
 
     bool passes = false;
     auto_ptr<vector<reco::Vertex> > result;
     // Run main mode + possible fallback modes
     for (std::vector<Mode>::const_iterator itm = modes_.begin(), endm = modes_.end(); itm != endm; ++itm) {
         result = filter_(*itm, iEvent, iSetup);
         // Check if we got any vertices.  If so, take them.
         if (result->size()) {
           passes = true;
           break;
         }
     }
     iEvent.put(result);
     // Check if we want to apply the EDFilter
     if (doFilterEvents_)
       return passes;
     else return true;
 }

std::auto_ptr< std::vector< reco::Vertex > > PATSingleVertexSelector::filter_	(	Mode	mode,
		const edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)

private

Definition at line 124 of file PATSingleVertexSelector.cc.

References funct::abs(), SiPixelRawToDigiRegional_cfi::beamSpot, beamSpotToken_, bestCand_, First, FromBeamSpot, FromCand, edm::Event::getByToken(), NearestToCand, reco::Candidate::numberOfDaughters(), query::result, selVtxs_, reco::Candidate::vertex(), reco::Candidate::vertexChi2(), reco::Candidate::vertexCovariance(), reco::Candidate::vertexNdof(), reco::Candidate::vz(), and eostools::which().

Referenced by filter().

                                                                                                 {
     using namespace edm;
     using namespace std;
     std::auto_ptr<std::vector<reco::Vertex> > result(
         new std::vector<reco::Vertex>());
     switch(mode) {
         case First: {
             if (selVtxs_.empty()) return result;
             result->push_back(*selVtxs_.front());
             return result;
             }
         case FromCand: {
             if (bestCand_ == 0) return result;
             reco::Vertex vtx;
             if (typeid(*bestCand_) == typeid(reco::VertexCompositeCandidate)) {
                 vtx = reco::Vertex(bestCand_->vertex(), bestCand_->vertexCovariance(),
                         bestCand_->vertexChi2(), bestCand_->vertexNdof(), bestCand_->numberOfDaughters() );
             } else {
                 vtx = reco::Vertex(bestCand_->vertex(), reco::Vertex::Error(), 0, 0, 0);
             }
             result->push_back(vtx);
             return result;
             }
         case NearestToCand: {
             if (selVtxs_.empty() || (bestCand_ == 0)) return result;
             const reco::Vertex * which = 0;
             float dzmin = 9999.0;
             for (vector<const reco::Vertex *>::const_iterator itv = selVtxs_.begin(), edv = selVtxs_.end(); itv != edv; ++itv) {
                 float dz = std::abs((*itv)->z() - bestCand_->vz());
                 if (dz < dzmin) { dzmin = dz; which = *itv; }
             }
             if (which != 0) // actually it should not happen, but better safe than sorry
               result->push_back(*which);
             return result;
             }
         case FromBeamSpot: {
             Handle<reco::BeamSpot> beamSpot;
             iEvent.getByToken(beamSpotToken_, beamSpot);
             reco::Vertex bs(beamSpot->position(), beamSpot->covariance3D(), 0, 0, 0);
             result->push_back(bs);
             return result;
             }
         default:
             // Return an empty vector signifying no vertices found.
             return result;
     }
 }

bool PATSingleVertexSelector::hasMode_ ( Mode mode ) const

private

Definition at line 69 of file PATSingleVertexSelector.cc.

References spr::find(), alignBH_cfg::mode, and modes_.

Referenced by filter(), and PATSingleVertexSelector().

                                                       {
     return (std::find(modes_.begin(), modes_.end(), mode) != modes_.end());
 }

PATSingleVertexSelector::Mode PATSingleVertexSelector::parseMode ( const std::string & name )

staticprivate

Definition at line 14 of file PATSingleVertexSelector.cc.

References edm::hlt::Exception, First, FromBeamSpot, FromCand, and NearestToCand.

Referenced by PATSingleVertexSelector().

                                                         {
     if (mode == "firstVertex") {
         return First;
     } else if (mode == "nearestToCandidate") {
         return NearestToCand;
     } else if (mode == "fromCandidate") {
         return FromCand;
     } else if (mode == "beamSpot") {
         return FromBeamSpot;
     } else {
         throw cms::Exception("Configuration") << "PATSingleVertexSelector: Mode '" << mode << "' not recognized or not supported.\n";
     }
 }

Member Data Documentation

edm::EDGetTokenT<reco::BeamSpot> pat::PATSingleVertexSelector::beamSpotToken_

private

Definition at line 50 of file PATSingleVertexSelector.h.

Referenced by filter_().

const reco::Candidate* pat::PATSingleVertexSelector::bestCand_

private

Definition at line 53 of file PATSingleVertexSelector.h.

Referenced by filter(), and filter_().

std::vector<edm::EDGetTokenT<edm::View<reco::Candidate> > > pat::PATSingleVertexSelector::candidatesToken_

private

Definition at line 47 of file PATSingleVertexSelector.h.

Referenced by filter(), and PATSingleVertexSelector().

std::auto_ptr<CandSel> pat::PATSingleVertexSelector::candPreselection_

private

Definition at line 49 of file PATSingleVertexSelector.h.

Referenced by filter(), and PATSingleVertexSelector().

bool pat::PATSingleVertexSelector::doFilterEvents_

private

Definition at line 58 of file PATSingleVertexSelector.h.

Referenced by filter().

std::vector<Mode> pat::PATSingleVertexSelector::modes_

private

Definition at line 45 of file PATSingleVertexSelector.h.

Referenced by filter(), hasMode_(), and PATSingleVertexSelector().

std::vector<const reco::Vertex *> pat::PATSingleVertexSelector::selVtxs_

private

Definition at line 52 of file PATSingleVertexSelector.h.

Referenced by filter(), and filter_().

edm::EDGetTokenT<std::vector<reco::Vertex> > pat::PATSingleVertexSelector::verticesToken_

private

Definition at line 46 of file PATSingleVertexSelector.h.

Referenced by filter(), and PATSingleVertexSelector().

std::auto_ptr<VtxSel > pat::PATSingleVertexSelector::vtxPreselection_

private

Definition at line 48 of file PATSingleVertexSelector.h.

Referenced by filter(), and PATSingleVertexSelector().

Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation