ConfigurableTrimmedVertexFinder Class Reference

#include <ConfigurableTrimmedVertexFinder.h>

Inheritance diagram for ConfigurableTrimmedVertexFinder:

Public Member Functions
ConfigurableTrimmedVertexFinder *	clone () const override
	ConfigurableTrimmedVertexFinder (const VertexFitter< 5 > *vf, const VertexUpdator< 5 > *vu, const VertexTrackCompatibilityEstimator< 5 > *ve)
int	maxNbOfVertices () const
float	ptCut () const
void	setMaxNbOfVertices (int max)
void	setParameters (const edm::ParameterSet &)
void	setPtCut (float cut)
void	setTrackCompatibilityCut (float cut)
void	setTrackCompatibilityToSV (float cut)
void	setVertexFitProbabilityCut (float cut)
float	trackCompatibilityCut () const
float	trackCompatibilityToSV () const
const TrimmedTrackFilter &	trackFilter () const
float	vertexFitProbabilityCut () const
std::vector< TransientVertex >	vertices (const std::vector< reco::TransientTrack > &tracks) const override
std::vector< TransientVertex >	vertices (const std::vector< reco::TransientTrack > &tracks, const reco::BeamSpot &spot) const override
std::vector< TransientVertex >	vertices (const std::vector< reco::TransientTrack > &tracks, std::vector< reco::TransientTrack > &unused, const reco::BeamSpot &spot, bool use_spot) const
	~ConfigurableTrimmedVertexFinder () override
Public Member Functions inherited from VertexReconstructor
	VertexReconstructor ()
virtual std::vector< TransientVertex >	vertices (const std::vector< reco::TransientTrack > &primaries, const std::vector< reco::TransientTrack > &tracks, const reco::BeamSpot &spot) const
virtual	~VertexReconstructor ()

Protected Member Functions
virtual void	analyseClusterFinder (const std::vector< TransientVertex > &vts, const std::vector< reco::TransientTrack > &remain) const
virtual void	analyseFoundVertices (const std::vector< TransientVertex > &vts) const
virtual void	analyseInputTracks (const std::vector< reco::TransientTrack > &tracks) const
virtual void	analyseVertexCandidates (const std::vector< TransientVertex > &vts) const
virtual void	resetEvent (const std::vector< reco::TransientTrack > &tracks) const

Private Member Functions
std::vector< TransientVertex >	clean (const std::vector< TransientVertex > &candidates) const
std::vector< TransientVertex >	vertexCandidates (const std::vector< reco::TransientTrack > &tracks, std::vector< reco::TransientTrack > &unused, const reco::BeamSpot &spot, bool use_spot) const
virtual std::vector< TransientVertex >	vertices (const std::vector< reco::TransientTrack > &t, const reco::BeamSpot &) const
virtual std::vector< TransientVertex >	vertices (const std::vector< reco::TransientTrack > &) const=0
virtual std::vector< TransientVertex >	vertices (const std::vector< reco::TransientTrack > &primaries, const std::vector< reco::TransientTrack > &tracks, const reco::BeamSpot &spot) const

Private Attributes
TrimmedVertexFinder	theClusterFinder
TrimmedTrackFilter	theFilter
int	theMaxNbOfVertices
float	theTrackCompatibilityToPV
float	theTrackCompatibilityToSV
float	theVtxFitProbCut

Detailed Description

Algorithm to find a series of distinct vertices among the given set of tracks. The technique is:
1) use TrimmedTrackFilter to select tracks above a certain pT;
2) use TrimmedVertexFinder to split the set of tracks into a cluster of compatible tracks and a set of remaining tracks;
3) repeat 2) with the remaining set, and repeat as long as (a) a cluster of compatible tracks can be found or (b) the maximum number of clusters asked for is reached;
4) reject vertices with a low fit probability.

This algorithm has 5 parameters that can be set at runtime via the corresponding set() methods, or a ParameterSet:

• "ptCut" (default: 1.5 GeV/c) which defines the minimum pT of the tracks used to make vertices. This value overrides the corresponding configurable parameter of the TrimmedTrackFilter used internally.
  
• "trackCompatibilityCut" (default: 0.05) which defines the probability below which a track is considered incompatible with the 1st vertex candidate formed. This value overrides the corresponding configurable parameter of the TrimmedVertexFinder used internally.
  
• "trackCompatibilityToSV" (default: 0.01) which defines the probability below which a track is considered incompatible with the next vertex candidates formed. This value overrides the corresponding configurable parameter of the TrimmedVertexFinder used internally.
  
• "vertexFitProbabilityCut" (default: 0.01) which defines the probability below which a vertex is rejected.
  
• "maxNbOfVertices" (default: 0) which defines the maximum number of vertices searched for. 0 means all vertices which can be found.

Definition at line 44 of file ConfigurableTrimmedVertexFinder.h.

Constructor & Destructor Documentation

ConfigurableTrimmedVertexFinder()

ConfigurableTrimmedVertexFinder::ConfigurableTrimmedVertexFinder	(	const VertexFitter< 5 > *	vf,
		const VertexUpdator< 5 > *	vu,
		const VertexTrackCompatibilityEstimator< 5 > *	ve
	)

Definition at line 6 of file ConfigurableTrimmedVertexFinder.cc.

References TrimmedTrackFilter::setPtCut(), and theFilter.

Referenced by clone().

    : theClusterFinder(vf, vu, ve),
      theVtxFitProbCut(0.01),
      theTrackCompatibilityToPV(0.05),
      theTrackCompatibilityToSV(0.01),
      theMaxNbOfVertices(0) {
  // default pt cut is 1.5 GeV
  theFilter.setPtCut(1.5);
}

~ConfigurableTrimmedVertexFinder()

ConfigurableTrimmedVertexFinder::~ConfigurableTrimmedVertexFinder ( )

inlineoverride

Definition at line 50 of file ConfigurableTrimmedVertexFinder.h.

{}

Member Function Documentation

analyseClusterFinder()

virtual void ConfigurableTrimmedVertexFinder::analyseClusterFinder ( const std::vector< TransientVertex > &  vts, const std::vector< reco::TransientTrack > &  remain  ) const

inlineprotectedvirtual

Definition at line 90 of file ConfigurableTrimmedVertexFinder.h.

Referenced by vertexCandidates().

                                                                                       {}

analyseFoundVertices()

virtual void ConfigurableTrimmedVertexFinder::analyseFoundVertices ( const std::vector< TransientVertex > &  vts ) const

inlineprotectedvirtual

Definition at line 95 of file ConfigurableTrimmedVertexFinder.h.

Referenced by vertices().

{}

analyseInputTracks()

virtual void ConfigurableTrimmedVertexFinder::analyseInputTracks ( const std::vector< reco::TransientTrack > &  tracks ) const

inlineprotectedvirtual

Definition at line 88 of file ConfigurableTrimmedVertexFinder.h.

Referenced by vertices().

{}

analyseVertexCandidates()

virtual void ConfigurableTrimmedVertexFinder::analyseVertexCandidates ( const std::vector< TransientVertex > &  vts ) const

inlineprotectedvirtual

Definition at line 93 of file ConfigurableTrimmedVertexFinder.h.

Referenced by vertices().

{}

clean()

std::vector< TransientVertex > ConfigurableTrimmedVertexFinder::clean ( const std::vector< TransientVertex > &  candidates ) const

private

Definition at line 119 of file ConfigurableTrimmedVertexFinder.cc.

References HLT_2023v12_cff::candidates, ChiSquaredProbability(), mps_fire::i, EgammaValidation_Wenu_cff::sel, and theVtxFitProbCut.

Referenced by vertices().

                                                        {
  std::vector<TransientVertex> sel;
  for (std::vector<TransientVertex>::const_iterator i = candidates.begin(); i != candidates.end(); i++) {
    if (ChiSquaredProbability((*i).totalChiSquared(), (*i).degreesOfFreedom()) > theVtxFitProbCut) {
      sel.push_back(*i);
    }
  }

  return sel;
}

clone()

ConfigurableTrimmedVertexFinder* ConfigurableTrimmedVertexFinder::clone ( void  ) const

inlineoverridevirtual

Clone method

Implements VertexReconstructor.

Definition at line 83 of file ConfigurableTrimmedVertexFinder.h.

References ConfigurableTrimmedVertexFinder().

{ return new ConfigurableTrimmedVertexFinder(*this); }

maxNbOfVertices()

int ConfigurableTrimmedVertexFinder::maxNbOfVertices ( ) const

inline

Definition at line 69 of file ConfigurableTrimmedVertexFinder.h.

References theMaxNbOfVertices.

Referenced by KalmanTrimmedVertexFinder::maxNbOfVertices().

{ return theMaxNbOfVertices; }

ptCut()

float ConfigurableTrimmedVertexFinder::ptCut ( ) const

inline

Access to parameters

Definition at line 64 of file ConfigurableTrimmedVertexFinder.h.

References TrimmedTrackFilter::ptCut(), and theFilter.

Referenced by KalmanTrimmedVertexFinder::ptCut().

{ return theFilter.ptCut(); }

resetEvent()

virtual void ConfigurableTrimmedVertexFinder::resetEvent ( const std::vector< reco::TransientTrack > &  tracks ) const

inlineprotectedvirtual

Definition at line 86 of file ConfigurableTrimmedVertexFinder.h.

Referenced by vertices().

{}

setMaxNbOfVertices()

void ConfigurableTrimmedVertexFinder::setMaxNbOfVertices ( int  max )

inline

Definition at line 79 of file ConfigurableTrimmedVertexFinder.h.

References SiStripPI::max, and theMaxNbOfVertices.

Referenced by KalmanTrimmedVertexFinder::setMaxNbOfVertices().

{ theMaxNbOfVertices = max; }

setParameters()

void ConfigurableTrimmedVertexFinder::setParameters

(

const edm::ParameterSet &

s

)

Set parameters

Definition at line 18 of file ConfigurableTrimmedVertexFinder.cc.

References alignCSCRings::s, TrimmedTrackFilter::setPtCut(), theFilter, theMaxNbOfVertices, theTrackCompatibilityToPV, theTrackCompatibilityToSV, and theVtxFitProbCut.

                                                                            {
  theFilter.setPtCut(s.getParameter<double>("ptCut"));
  theTrackCompatibilityToPV = s.getParameter<double>("trackCompatibilityToPVcut");
  theTrackCompatibilityToSV = s.getParameter<double>("trackCompatibilityToSVcut");
  theVtxFitProbCut = s.getParameter<double>("vtxFitProbCut");
  theMaxNbOfVertices = s.getParameter<int>("maxNbOfVertices");
}

setPtCut()

void ConfigurableTrimmedVertexFinder::setPtCut ( float  cut )

inline

Definition at line 75 of file ConfigurableTrimmedVertexFinder.h.

References DMR_cfg::cut, TrimmedTrackFilter::setPtCut(), and theFilter.

Referenced by KalmanTrimmedVertexFinder::setPtCut().

{ theFilter.setPtCut(cut); }

setTrackCompatibilityCut()

void ConfigurableTrimmedVertexFinder::setTrackCompatibilityCut ( float  cut )

inline

Definition at line 76 of file ConfigurableTrimmedVertexFinder.h.

References DMR_cfg::cut, and theTrackCompatibilityToPV.

Referenced by KalmanTrimmedVertexFinder::setTrackCompatibilityCut().

{ theTrackCompatibilityToPV = cut; }

setTrackCompatibilityToSV()

void ConfigurableTrimmedVertexFinder::setTrackCompatibilityToSV ( float  cut )

inline

Definition at line 77 of file ConfigurableTrimmedVertexFinder.h.

References DMR_cfg::cut, and theTrackCompatibilityToSV.

Referenced by KalmanTrimmedVertexFinder::setTrackCompatibilityToSV().

{ theTrackCompatibilityToSV = cut; }

setVertexFitProbabilityCut()

void ConfigurableTrimmedVertexFinder::setVertexFitProbabilityCut ( float  cut )

inline

Definition at line 78 of file ConfigurableTrimmedVertexFinder.h.

References DMR_cfg::cut, and theVtxFitProbCut.

Referenced by KalmanTrimmedVertexFinder::setVertexFitProbabilityCut().

{ theVtxFitProbCut = cut; }

trackCompatibilityCut()

float ConfigurableTrimmedVertexFinder::trackCompatibilityCut ( ) const

inline

Definition at line 66 of file ConfigurableTrimmedVertexFinder.h.

References theTrackCompatibilityToPV.

Referenced by KalmanTrimmedVertexFinder::trackCompatibilityCut().

{ return theTrackCompatibilityToPV; }

trackCompatibilityToSV()

float ConfigurableTrimmedVertexFinder::trackCompatibilityToSV ( ) const

inline

Definition at line 67 of file ConfigurableTrimmedVertexFinder.h.

References theTrackCompatibilityToSV.

Referenced by KalmanTrimmedVertexFinder::trackCompatibilityToSV().

{ return theTrackCompatibilityToSV; }

trackFilter()

const TrimmedTrackFilter& ConfigurableTrimmedVertexFinder::trackFilter ( ) const

inline

Definition at line 65 of file ConfigurableTrimmedVertexFinder.h.

References theFilter.

{ return theFilter; }

vertexCandidates()

std::vector< TransientVertex > ConfigurableTrimmedVertexFinder::vertexCandidates ( const std::vector< reco::TransientTrack > &  tracks, std::vector< reco::TransientTrack > &  unused, const reco::BeamSpot &  spot, bool  use_spot  ) const

private

Definition at line 65 of file ConfigurableTrimmedVertexFinder.cc.

References analyseClusterFinder(), createfilelist::int, gpuVertexFinder::iv, TrimmedVertexFinder::setTrackCompatibilityCut(), theClusterFinder, theMaxNbOfVertices, theTrackCompatibilityToPV, theTrackCompatibilityToSV, DiMuonV_cfg::tracks, and TrimmedVertexFinder::vertices().

Referenced by vertices().

                                                                                                    {
  std::vector<TransientVertex> cand;

  std::vector<TransientTrack> remain = tracks;

  while (true) {
    float tkCompCut = (cand.empty() ? theTrackCompatibilityToPV : theTrackCompatibilityToSV);

    //    std::cout << "PVR:compat cut " << tkCompCut << std::endl;
    theClusterFinder.setTrackCompatibilityCut(tkCompCut);
    //    std::cout << "PVCF:compat cut after setting "
    //   << theClusterFinder.trackCompatibilityCut() << std::endl;

    std::vector<TransientVertex> newVertices;
    if (cand.empty() && use_spot) {
      newVertices = theClusterFinder.vertices(remain, spot);
    } else {
      newVertices = theClusterFinder.vertices(remain);
    }
    if (newVertices.empty())
      break;

    analyseClusterFinder(newVertices, remain);

    for (std::vector<TransientVertex>::const_iterator iv = newVertices.begin(); iv != newVertices.end(); iv++) {
      if (iv->originalTracks().size() > 1) {
        cand.push_back(*iv);
      } else {
        // candidate has too few tracks - get them back into the vector
        for (std::vector<TransientTrack>::const_iterator trk = iv->originalTracks().begin();
             trk != iv->originalTracks().end();
             ++trk) {
          unused.push_back(*trk);
        }
      }
    }

    // when max number of vertices reached, stop
    if (theMaxNbOfVertices != 0) {
      if (cand.size() >= (unsigned int)theMaxNbOfVertices)
        break;
    }
  }

  for (std::vector<TransientTrack>::const_iterator it = remain.begin(); it != remain.end(); it++) {
    unused.push_back(*it);
  }

  return cand;
}

vertexFitProbabilityCut()

float ConfigurableTrimmedVertexFinder::vertexFitProbabilityCut ( ) const

inline

Definition at line 68 of file ConfigurableTrimmedVertexFinder.h.

References theVtxFitProbCut.

Referenced by KalmanTrimmedVertexFinder::vertexFitProbabilityCut().

{ return theVtxFitProbCut; }

vertices() [1/6]

std::vector< TransientVertex > ConfigurableTrimmedVertexFinder::vertices ( const std::vector< reco::TransientTrack > &  ) const

overridevirtual

Reconstruct vertices

Implements VertexReconstructor.

Definition at line 26 of file ConfigurableTrimmedVertexFinder.cc.

References DiMuonV_cfg::tracks.

Referenced by KalmanTrimmedVertexFinder::vertices(), and vertices().

                                                                                                                  {
  std::vector<TransientTrack> remaining;

  return vertices(tracks, remaining, reco::BeamSpot(), false);
}

vertices() [2/6]

std::vector< TransientVertex > ConfigurableTrimmedVertexFinder::vertices ( const std::vector< reco::TransientTrack > &  t, const reco::BeamSpot &    ) const

overridevirtual

Reconstruct vertices, exploiting the beamspot constraint for the primary vertex

Reimplemented from VertexReconstructor.

Definition at line 32 of file ConfigurableTrimmedVertexFinder.cc.

References DiMuonV_cfg::tracks, and vertices().

                                                                                                       {
  std::vector<TransientTrack> remaining;
  return vertices(tracks, remaining, spot, true);
}

vertices() [3/6]

std::vector< TransientVertex > ConfigurableTrimmedVertexFinder::vertices	(	const std::vector< reco::TransientTrack > &	tracks,
		std::vector< reco::TransientTrack > &	unused,
		const reco::BeamSpot &	spot,
		bool	use_spot
	)		const

Definition at line 38 of file ConfigurableTrimmedVertexFinder.cc.

References python.cmstools::all(), analyseFoundVertices(), analyseInputTracks(), analyseVertexCandidates(), clean(), filtered(), resetEvent(), EgammaValidation_Wenu_cff::sel, theFilter, DiMuonV_cfg::tracks, and vertexCandidates().

                                                                                            {
  resetEvent(tracks);
  analyseInputTracks(tracks);

  std::vector<TransientTrack> filtered;
  for (std::vector<TransientTrack>::const_iterator it = tracks.begin(); it != tracks.end(); it++) {
    if (theFilter(*it)) {
      filtered.push_back(*it);
    } else {
      unused.push_back(*it);
    }
  }

  std::vector<TransientVertex> all = vertexCandidates(filtered, unused, spot, use_spot);

  analyseVertexCandidates(all);

  std::vector<TransientVertex> sel = clean(all);

  analyseFoundVertices(sel);

  return sel;
}

vertices() [4/6]

virtual std::vector<TransientVertex> VertexReconstructor::vertices

inlineprivate

Reconstruct vertices, but exploit the fact that you know that some tracks cannot come from a secondary vertex. primaries Tracks that cannot come from a secondary vertex (but can, in principle, be non-primaries, also). tracks These are the tracks that are of unknown origin. These tracks are subjected to pattern recognition. spot A beamspot constraint is mandatory in this method.

Definition at line 39 of file VertexReconstructor.h.

                                                                                {
    return vertices(tracks, spot);
  }

vertices() [5/6]

virtual std::vector<TransientVertex> VertexReconstructor::vertices

private

Reconstruct vertices

vertices() [6/6]

virtual std::vector<TransientVertex> VertexReconstructor::vertices

inlineprivate

Reconstruct vertices, exploiting the beamspot constraint for the primary vertex

Definition at line 25 of file VertexReconstructor.h.

                                                                            {
    return vertices(t);
  }

Member Data Documentation

theClusterFinder

TrimmedVertexFinder ConfigurableTrimmedVertexFinder::theClusterFinder

mutableprivate

Definition at line 114 of file ConfigurableTrimmedVertexFinder.h.

Referenced by vertexCandidates().

theFilter

TrimmedTrackFilter ConfigurableTrimmedVertexFinder::theFilter

private

Definition at line 119 of file ConfigurableTrimmedVertexFinder.h.

Referenced by ConfigurableTrimmedVertexFinder(), ptCut(), setParameters(), setPtCut(), trackFilter(), and vertices().

theMaxNbOfVertices

int ConfigurableTrimmedVertexFinder::theMaxNbOfVertices

private

Definition at line 118 of file ConfigurableTrimmedVertexFinder.h.

Referenced by maxNbOfVertices(), setMaxNbOfVertices(), setParameters(), and vertexCandidates().

theTrackCompatibilityToPV

float ConfigurableTrimmedVertexFinder::theTrackCompatibilityToPV

private

Definition at line 116 of file ConfigurableTrimmedVertexFinder.h.

Referenced by setParameters(), setTrackCompatibilityCut(), trackCompatibilityCut(), and vertexCandidates().

theTrackCompatibilityToSV

float ConfigurableTrimmedVertexFinder::theTrackCompatibilityToSV

private

Definition at line 117 of file ConfigurableTrimmedVertexFinder.h.

Referenced by setParameters(), setTrackCompatibilityToSV(), trackCompatibilityToSV(), and vertexCandidates().

theVtxFitProbCut

float ConfigurableTrimmedVertexFinder::theVtxFitProbCut

private

Definition at line 115 of file ConfigurableTrimmedVertexFinder.h.

Referenced by clean(), setParameters(), setVertexFitProbabilityCut(), and vertexFitProbabilityCut().