#include <RecoVertex/PrimaryVertexProducer/src/PrimaryVertexProducer.cc>

Inheritance diagram for PrimaryVertexProducer:

Classes
struct	algo

Public Member Functions
edm::ParameterSet	config () const

	PrimaryVertexProducer (const edm::ParameterSet &)

void	produce (edm::Event &, const edm::EventSetup &) override

	~PrimaryVertexProducer () override

Public Member Functions inherited from edm::stream::EDProducer<>
	EDProducer ()=default

Public Member Functions inherited from edm::stream::EDProducerBase
	EDProducerBase ()

ModuleDescription const &	moduleDescription () const

	~EDProducerBase () override

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

std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const

	ProducerBase ()

std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const

void	registerProducts (ProducerBase , ProductRegistry , ModuleDescription const &)

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

void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)

virtual	~ProducerBase () noexcept(false)

Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const

void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...

	EDConsumerBase ()

	EDConsumerBase (EDConsumerBase const &)=delete

	EDConsumerBase (EDConsumerBase &&)=default

ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const

void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const

void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const

std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const

EDConsumerBase const &	operator= (EDConsumerBase const &)=delete

EDConsumerBase &	operator= (EDConsumerBase &&)=default

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

virtual	~EDConsumerBase () noexcept(false)

Private Attributes
std::vector< algo >	algorithms

edm::EDGetTokenT< reco::BeamSpot >	bsToken

bool	f4D

bool	fVerbose

edm::ParameterSet	theConfig

TrackClusterizerInZ *	theTrackClusterizer

TrackFilterForPVFindingBase *	theTrackFilter

edm::EDGetTokenT< edm::ValueMap< float > >	trkTimeResosToken

edm::EDGetTokenT< edm::ValueMap< float > >	trkTimesToken

edm::EDGetTokenT< reco::TrackCollection >	trkToken

Additional Inherited Members
Public Types inherited from edm::stream::EDProducer<>
typedef CacheContexts< T... >	CacheTypes

typedef CacheTypes::GlobalCache	GlobalCache

typedef AbilityChecker< T... >	HasAbility

typedef CacheTypes::LuminosityBlockCache	LuminosityBlockCache

typedef LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >	LuminosityBlockContext

typedef CacheTypes::LuminosityBlockSummaryCache	LuminosityBlockSummaryCache

typedef CacheTypes::RunCache	RunCache

typedef RunContextT< RunCache, GlobalCache >	RunContext

typedef CacheTypes::RunSummaryCache	RunSummaryCache

Public Types inherited from edm::stream::EDProducerBase
typedef EDProducerAdaptorBase	ModuleType

Public Types inherited from edm::ProducerBase
using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const , const char , edm::ProductResolverIndex >>

typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

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

Description: steers tracker primary vertex reconstruction and storage

Implementation: <Notes on="" implementation>="">

Definition at line 56 of file PrimaryVertexProducer.h.

Constructor & Destructor Documentation

PrimaryVertexProducer::PrimaryVertexProducer ( const edm::ParameterSet & conf )

Definition at line 21 of file PrimaryVertexProducer.cc.

References electronCleaner_cfi::algorithm, algorithms, bsToken, edm::ParameterSet::exists(), f4D, PrimaryVertexProducer::algo::fitter, fVerbose, edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), PrimaryVertexProducer::algo::label, PrimaryVertexProducer::algo::minNdof, AlCaHLTBitMon_QueryRunRegistry::string, theTrackClusterizer, theTrackFilter, trkTimeResosToken, trkTimesToken, trkToken, PrimaryVertexProducer::algo::useBeamConstraint, HIPixelAdaptiveVertex_cfi::vertexCollections, and PrimaryVertexProducer::algo::vertexSelector.

   :theConfig(conf)
 {
 
   fVerbose   = conf.getUntrackedParameter<bool>("verbose", false);
 
   trkToken = consumes<reco::TrackCollection>(conf.getParameter<edm::InputTag>("TrackLabel"));
   bsToken = consumes<reco::BeamSpot>(conf.getParameter<edm::InputTag>("beamSpotLabel"));
   f4D = false;
 
   // select and configure the track selection
   std::string trackSelectionAlgorithm=conf.getParameter<edm::ParameterSet>("TkFilterParameters").getParameter<std::string>("algorithm");
   if(trackSelectionAlgorithm=="filter"){
     theTrackFilter= new TrackFilterForPVFinding( conf.getParameter<edm::ParameterSet>("TkFilterParameters") );
   }else if (trackSelectionAlgorithm=="filterWithThreshold"){
     theTrackFilter= new HITrackFilterForPVFinding(conf.getParameter<edm::ParameterSet>("TkFilterParameters"));
   }else{
     throw VertexException("PrimaryVertexProducerAlgorithm: unknown track selection algorithm: " + trackSelectionAlgorithm);  
   }
 
 
   // select and configure the track clusterizer
   std::string clusteringAlgorithm=conf.getParameter<edm::ParameterSet>("TkClusParameters").getParameter<std::string>("algorithm");
   if (clusteringAlgorithm=="gap"){
     theTrackClusterizer = new GapClusterizerInZ(conf.getParameter<edm::ParameterSet>("TkClusParameters").getParameter<edm::ParameterSet>("TkGapClusParameters"));
   }else if(clusteringAlgorithm=="DA"){
     theTrackClusterizer = new DAClusterizerInZ(conf.getParameter<edm::ParameterSet>("TkClusParameters").getParameter<edm::ParameterSet>("TkDAClusParameters"));
   } 
   // provide the vectorized version of the clusterizer, if supported by the build
    else if(clusteringAlgorithm == "DA_vect") {
     theTrackClusterizer = new DAClusterizerInZ_vect(conf.getParameter<edm::ParameterSet>("TkClusParameters").getParameter<edm::ParameterSet>("TkDAClusParameters"));
   } else if( clusteringAlgorithm=="DA2D_vect" ) {
     theTrackClusterizer = new DAClusterizerInZT_vect(conf.getParameter<edm::ParameterSet>("TkClusParameters").getParameter<edm::ParameterSet>("TkDAClusParameters"));
     f4D = true;
   }
 
   else{
     throw VertexException("PrimaryVertexProducerAlgorithm: unknown clustering algorithm: " + clusteringAlgorithm);  
   }
 
   if( f4D ) {
     trkTimesToken     = consumes<edm::ValueMap<float> >(conf.getParameter<edm::InputTag>("TrackTimesLabel") );
     trkTimeResosToken = consumes<edm::ValueMap<float> >(conf.getParameter<edm::InputTag>("TrackTimeResosLabel") );    
   }
 
 
   // select and configure the vertex fitters
   if (conf.exists("vertexCollections")){
     std::vector<edm::ParameterSet> vertexCollections =conf.getParameter< std::vector<edm::ParameterSet> >("vertexCollections");
 
     for( std::vector< edm::ParameterSet >::const_iterator algoconf = vertexCollections.begin(); algoconf != vertexCollections.end(); algoconf++){
       
       algo algorithm;
       std::string fitterAlgorithm = algoconf->getParameter<std::string>("algorithm");
       if (fitterAlgorithm=="KalmanVertexFitter") {
     algorithm.fitter= new KalmanVertexFitter();
       } else if( fitterAlgorithm=="AdaptiveVertexFitter") {
     algorithm.fitter= new AdaptiveVertexFitter( GeometricAnnealing( algoconf->getParameter<double>("chi2cutoff")));
       } else {
     throw VertexException("PrimaryVertexProducerAlgorithm: unknown algorithm: " + fitterAlgorithm);  
       }
       algorithm.label = algoconf->getParameter<std::string>("label");
       algorithm.minNdof = algoconf->getParameter<double>("minNdof");
       algorithm.useBeamConstraint=algoconf->getParameter<bool>("useBeamConstraint");
       algorithm.vertexSelector=new VertexCompatibleWithBeam(VertexDistanceXY(), algoconf->getParameter<double>("maxDistanceToBeam"));
       algorithms.push_back(algorithm);
       
       produces<reco::VertexCollection>(algorithm.label);
     }
   }else{
     edm::LogWarning("MisConfiguration")<<"this module's configuration has changed, please update to have a vertexCollections=cms.VPSet parameter.";
 
     algo algorithm;
     std::string fitterAlgorithm = conf.getParameter<std::string>("algorithm");
     if (fitterAlgorithm=="KalmanVertexFitter") {
       algorithm.fitter= new KalmanVertexFitter();
     } else if( fitterAlgorithm=="AdaptiveVertexFitter") {
       algorithm.fitter= new AdaptiveVertexFitter();
     } else {
       throw VertexException("PrimaryVertexProducerAlgorithm: unknown algorithm: " + fitterAlgorithm);  
     }
     algorithm.label = "";
     algorithm.minNdof = conf.getParameter<double>("minNdof");
     algorithm.useBeamConstraint=conf.getParameter<bool>("useBeamConstraint");
     
     algorithm.vertexSelector=new VertexCompatibleWithBeam(VertexDistanceXY(), conf.getParameter<edm::ParameterSet>("PVSelParameters").getParameter<double>("maxDistanceToBeam"));
 
     algorithms.push_back(algorithm);
     produces<reco::VertexCollection>(algorithm.label);
   }
  
 
 }

PrimaryVertexProducer::~PrimaryVertexProducer ( )

override

Definition at line 116 of file PrimaryVertexProducer.cc.

References electronCleaner_cfi::algorithm, algorithms, theTrackClusterizer, and theTrackFilter.

                                               {
   if (theTrackFilter) delete theTrackFilter;
   if (theTrackClusterizer) delete theTrackClusterizer;
   for( std::vector <algo>::const_iterator algorithm=algorithms.begin(); algorithm!=algorithms.end(); algorithm++){
     if (algorithm->fitter) delete algorithm->fitter;
     if (algorithm->vertexSelector) delete algorithm->vertexSelector;
   }
 }

Member Function Documentation

edm::ParameterSet PrimaryVertexProducer::config ( void ) const

inline

Definition at line 64 of file PrimaryVertexProducer.h.

References theConfig.

64 { return theConfig; }

PrimaryVertexProducer::theConfig

edm::ParameterSet theConfig

Definition: PrimaryVertexProducer.h:82

void PrimaryVertexProducer::produce	(	edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)

override

Definition at line 127 of file PrimaryVertexProducer.cc.

References electronCleaner_cfi::algorithm, algorithms, ecalDrivenElectronSeedsParameters_cff::beamSpot, bsToken, TrackClusterizerInZ::clusterize(), fastPrimaryVertexProducer_cfi::clusters, gather_cfg::cout, GlobalErrorBase< T, ErrorWeightType >::cxx(), GlobalErrorBase< T, ErrorWeightType >::cyy(), GlobalErrorBase< T, ErrorWeightType >::czz(), DEFINE_FWK_MODULE, TransientVertex::degreesOfFreedom(), VertexState::error(), f4D, fVerbose, edm::EventSetup::get(), edm::Event::getByToken(), edm::HandleBase::isValid(), TransientVertex::isValid(), GlobalErrorBase< T, ErrorWeightType >::matrix(), GlobalErrorBase< T, ErrorWeightType >::matrix4D(), eostools::move(), TransientVertex::originalTracks(), reco::BeamSpot::position(), TransientVertex::position(), TransientVertex::positionError(), edm::Handle< T >::product(), edm::Event::put(), mps_fire::result, reco::BeamSpot::rotatedCovariance3D(), TrackFilterForPVFindingBase::select(), theTrackClusterizer, theTrackFilter, TransientVertex::time(), ntuplemaker::time, TransientVertex::totalChiSquared(), trkTimeResosToken, trkTimesToken, trkToken, findQualityFiles::v, w, PV3DBase< T, PVType, FrameType >::x(), PV3DBase< T, PVType, FrameType >::y(), and PV3DBase< T, PVType, FrameType >::z().

 {
 
   // get the BeamSpot, it will alwys be needed, even when not used as a constraint
   reco::BeamSpot beamSpot;
   edm::Handle<reco::BeamSpot> recoBeamSpotHandle;
   iEvent.getByToken(bsToken,recoBeamSpotHandle);
   if (recoBeamSpotHandle.isValid()){
     beamSpot = *recoBeamSpotHandle;
   }else{
     edm::LogError("UnusableBeamSpot") << "No beam spot available from EventSetup";
   }
 
   bool validBS = true;
   VertexState beamVertexState(beamSpot);
   if ( (beamVertexState.error().cxx() <= 0.) || 
        (beamVertexState.error().cyy() <= 0.) ||
        (beamVertexState.error().czz() <= 0.) ) {
     validBS = false;
     edm::LogError("UnusableBeamSpot") << "Beamspot with invalid errors "<<beamVertexState.error().matrix();
   }
 
 
   // get RECO tracks from the event
   // `tks` can be used as a ptr to a reco::TrackCollection
   edm::Handle<reco::TrackCollection> tks;
   iEvent.getByToken(trkToken, tks);
 
 
   // interface RECO tracks to vertex reconstruction
   edm::ESHandle<TransientTrackBuilder> theB;
   iSetup.get<TransientTrackRecord>().get("TransientTrackBuilder",theB);
   std::vector<reco::TransientTrack> t_tks;
 
   if( f4D ) {
     edm::Handle<edm::ValueMap<float> > trackTimesH;
     edm::Handle<edm::ValueMap<float> > trackTimeResosH;    
     iEvent.getByToken(trkTimesToken, trackTimesH);
     iEvent.getByToken(trkTimeResosToken, trackTimeResosH);
     t_tks = (*theB).build(tks, beamSpot, *(trackTimesH.product()), *(trackTimeResosH.product()));
   } else {
     t_tks = (*theB).build(tks, beamSpot);
   }
   if(fVerbose) {std::cout << "RecoVertex/PrimaryVertexProducer"
              << "Found: " << t_tks.size() << " reconstructed tracks" << "\n";
   }
 
 
   // select tracks
   std::vector<reco::TransientTrack> && seltks = theTrackFilter->select( t_tks );
 
   // clusterize tracks in Z
   std::vector< std::vector<reco::TransientTrack> > && clusters =  theTrackClusterizer->clusterize(seltks);
 
   if (fVerbose){std::cout <<  " clustering returned  "<< clusters.size() << " clusters  from " << seltks.size() << " selected tracks" <<std::endl;}
 
 
   // vertex fits
   for( std::vector <algo>::const_iterator algorithm=algorithms.begin(); algorithm!=algorithms.end(); algorithm++){
 
 
     auto result = std::make_unique<reco::VertexCollection>();
     reco::VertexCollection & vColl = (*result);
 
 
     std::vector<TransientVertex> pvs;
     for (std::vector< std::vector<reco::TransientTrack> >::const_iterator iclus
        = clusters.begin(); iclus != clusters.end(); iclus++) {
       
       double meantime = 0.;
       double expv_x2 = 0.;
       double normw = 0.;  
       if( f4D ) {
         for( const auto& tk : *iclus ) {
           const double time = tk.timeExt();
           const double inverr = 1.0/tk.dtErrorExt();
           const double w = inverr*inverr;
           meantime += time*w;
           expv_x2  += time*time*w;
           normw    += w;
         }
         meantime = meantime/normw;
         expv_x2 = expv_x2/normw;
       }
       const double time_var = ( f4D ? expv_x2 - meantime*meantime : 0. ); 
 
 
       TransientVertex v; 
       if( algorithm->useBeamConstraint && validBS &&((*iclus).size()>1) ){
         
     v = algorithm->fitter->vertex(*iclus, beamSpot);
     
         if( f4D ) {
           if( v.isValid() ) {
             auto err = v.positionError().matrix4D();
             err(3,3) = time_var/(double)iclus->size();        
             v = TransientVertex(v.position(),meantime,err,v.originalTracks(),v.totalChiSquared());
           }
         }
     
       }else if( !(algorithm->useBeamConstraint) && ((*iclus).size()>1) ) {
               
     v = algorithm->fitter->vertex(*iclus);
         
         if( f4D ) {
           if( v.isValid() ) {
             auto err = v.positionError().matrix4D();
             err(3,3) = time_var/(double)iclus->size();          
             v = TransientVertex(v.position(),meantime,err,v.originalTracks(),v.totalChiSquared());
           }
         }
     
       }// else: no fit ==> v.isValid()=False
 
 
       if (fVerbose){
     if (v.isValid()) {
           std::cout << "x,y,z";
           if (f4D) std::cout << ",t";
           std::cout << "=" << v.position().x() <<" " << v.position().y() << " " <<  v.position().z();
           if (f4D) std::cout << " " << v.time();
           std::cout  << " cluster size = " << (*iclus).size() << std::endl;
         }
     else{
       std::cout <<"Invalid fitted vertex,  cluster size=" << (*iclus).size() << std::endl;
     }
       }
 
       if ( v.isValid() 
            && (v.degreesOfFreedom()>=algorithm->minNdof) 
        && (!validBS || (*(algorithm->vertexSelector))(v,beamVertexState))
            ) pvs.push_back(v);
     }// end of cluster loop
 
     if(fVerbose){
       std::cout << "PrimaryVertexProducerAlgorithm::vertices  candidates =" << pvs.size() << std::endl;
     }
 
 
     if (clusters.size()>2 && clusters.size() > 2*pvs.size()) 
       edm::LogWarning("PrimaryVertexProducer") << "more than half of candidate vertices lost " << pvs.size()  << ' ' << clusters.size();
 
     if (pvs.empty() && seltks.size()>5) 
        edm::LogWarning("PrimaryVertexProducer") << "no vertex found with " << seltks.size() << " tracks and " << clusters.size() <<" vertex-candidates";    
 
     // sort vertices by pt**2  vertex (aka signal vertex tagging)
     if(pvs.size()>1){
       sort(pvs.begin(), pvs.end(), VertexHigherPtSquared());
     }
 
 
 
     // convert transient vertices returned by the theAlgo to (reco) vertices
     for (std::vector<TransientVertex>::const_iterator iv = pvs.begin();
      iv != pvs.end(); iv++) {
       reco::Vertex v = *iv;
       vColl.push_back(v);
     }
 
     if (vColl.empty()) {
       GlobalError bse(beamSpot.rotatedCovariance3D());
       if ( (bse.cxx() <= 0.) || 
        (bse.cyy() <= 0.) ||
        (bse.czz() <= 0.) ) {
     AlgebraicSymMatrix33 we;
     we(0,0)=10000; we(1,1)=10000; we(2,2)=10000;
     vColl.push_back(reco::Vertex(beamSpot.position(), we,0.,0.,0));
     if(fVerbose){
       std::cout <<"RecoVertex/PrimaryVertexProducer: "
             << "Beamspot with invalid errors "<<bse.matrix()<<std::endl;
       std::cout << "Will put Vertex derived from dummy-fake BeamSpot into Event.\n";
     }
       } else {
     vColl.push_back(reco::Vertex(beamSpot.position(), 
                      beamSpot.rotatedCovariance3D(),0.,0.,0));
     if(fVerbose){
       std::cout <<"RecoVertex/PrimaryVertexProducer: "
             << " will put Vertex derived from BeamSpot into Event.\n";
     }
       }
     }
 
     if(fVerbose){
       int ivtx=0;
       for(reco::VertexCollection::const_iterator v=vColl.begin(); 
       v!=vColl.end(); ++v){
     std::cout << "recvtx "<< ivtx++ 
           << "#trk " << std::setw(3) << v->tracksSize()
           << " chi2 " << std::setw(4) << v->chi2() 
           << " ndof " << std::setw(3) << v->ndof() 
           << " x "  << std::setw(6) << v->position().x() 
           << " dx " << std::setw(6) << v->xError()
           << " y "  << std::setw(6) << v->position().y() 
           << " dy " << std::setw(6) << v->yError()
           << " z "  << std::setw(6) << v->position().z() 
           << " dz " << std::setw(6) << v->zError();
         if( f4D ) {
           std::cout << " t " << std::setw(6) << v->t()
                     << " dt " << std::setw(6) << v->tError();
         }
         std::cout << std::endl;
       }
     }
 
     iEvent.put(std::move(result), algorithm->label); 
   }
   
 }