pat::VertexAssociation Class Reference

Analysis-level structure for vertex-related information. More...

#include "DataFormats/PatCandidates/interface/Vertexing.h"

Public Member Functions
const Measurement1DFloat &	dr () const
	Distance between the object and the vertex in the transverse plane, and it's error. More...
const Measurement1DFloat &	dz () const
bool	hasErrors () const
	True if the errors on dr and dz have been set, false if they're nulls. More...
bool	hasTrack () const
	Returns 'true' if a reference to a track was stored in this VertexAssociation. More...
bool	hasTransverseIP () const
	True if the transverse distance was computed for this VertexAssociation. More...
bool	isAvailable () const
	Return 'true' if the reco::Vertex is available in the file, false if it has been dropped. More...
bool	isNonnull () const
	Return 'true' unless this is a null association (that is, no vertex) More...
bool	isNull () const
	Return 'true' if this is a null association (that is, no vertex) More...
const reco::Vertex &	operator* () const
	Return the vertex (that is, you can do "const reco::Vertex &vtx = *assoc") More...
const reco::Vertex *	operator-> () const
	Allows VertexAssociation to behave like a vertex ref (e.g. to do "assoc->position()") More...
void	setDistances (const AlgebraicVector3 &dist, const AlgebraicSymMatrix33 &err)
	Set dz and dr given the distance and the 3x3 total covariance matrix of the distance. More...
template<typename T1 , typename T2 >
void	setDistances (const T1 &p1, const T2 &p2, const AlgebraicSymMatrix33 &err)
void	setDr (const Measurement1DFloat &dr)
void	setDr (const Measurement1D &dr)
void	setDz (const Measurement1DFloat &dz)
void	setDz (const Measurement1D &dz)
const reco::Track *	track () const
	Returns a C++ pointer to the track stored in this vertex (can be a null pointer) More...
const reco::TrackBaseRef &	trackRef () const
	Returns a reference to the track stored in this vertex (can be null) More...
const reco::Vertex *	vertex () const
	Returns a pointer to the vertex, or a null pointer if there is no vertex (null association) More...
	VertexAssociation ()
	Create a null vertx association. More...
	VertexAssociation (const reco::VertexRef &vertex)
	Create a vertex association given a ref to a vertex. More...
	VertexAssociation (const reco::VertexRef &vertex, const reco::TrackBaseRef &tk)
const reco::VertexRef &	vertexRef () const
	Returns the reference to the vertex (can be a null reference) More...

Private Attributes
Measurement1DFloat	dr_
Measurement1DFloat	dz_
reco::TrackBaseRef	track_
reco::VertexRef	vertex_

Detailed Description

Analysis-level structure for vertex-related information.

pat::VertexAssociation holds a reference to a vertex and extended information like the distance between the object and the vertex.

For convenience, pat::VertexAssociation behaves like a VertexRef, that is (*assoc) is a reco::Vertex.

The original proposal is at https://hypernews.cern.ch/HyperNews/CMS/get/physTools/587.html

Author

Giovanni Petrucciani

Definition at line 25 of file Vertexing.h.

Constructor & Destructor Documentation

VertexAssociation() [1/3]

pat::VertexAssociation::VertexAssociation ( )

inline

Create a null vertx association.

Definition at line 28 of file Vertexing.h.

{}

VertexAssociation() [2/3]

pat::VertexAssociation::VertexAssociation ( const reco::VertexRef &  vertex )

inline

Create a vertex association given a ref to a vertex.

Definition at line 30 of file Vertexing.h.

: vertex_(vertex) {}

VertexAssociation() [3/3]

pat::VertexAssociation::VertexAssociation ( const reco::VertexRef &  vertex, const reco::TrackBaseRef &  tk  )

inline

Create a vertex association given a ref to a vertex and a reference to a track object Note: you also have to set the distances, they can be computed by the VertexAssociation itself because it requires access to the magnetic field and other condition data.

Definition at line 34 of file Vertexing.h.

: vertex_(vertex), track_(tk) {}

Member Function Documentation

dr()

const Measurement1DFloat& pat::VertexAssociation::dr ( ) const

inline

Distance between the object and the vertex in the transverse plane, and it's error.

Definition at line 62 of file Vertexing.h.

References dr_.

Referenced by pat::VertexAssociationSelector::operator()(), and setDr().

{ return dr_; }

dz()

const Measurement1DFloat& pat::VertexAssociation::dz ( ) const

inline

Distance between the object and the vertex along the Z axis, and it's error. Note 1: if the BeamSpot was used as Vertex, the error includes the BeamSpot spread!

Definition at line 60 of file Vertexing.h.

References dz_.

Referenced by Electron.Electron::cutBasedId(), ntupleDataFormat.Track::dzPull(), pat::VertexAssociationSelector::operator()(), and setDz().

{ return dz_; }

hasErrors()

bool pat::VertexAssociation::hasErrors ( ) const

inline

True if the errors on dr and dz have been set, false if they're nulls.

Definition at line 66 of file Vertexing.h.

References dr_, dz_, Measurement1DFloat::error(), and hasTransverseIP().

{ return (dz_.error() != 0) && (!hasTransverseIP() || dr_.error() != 0); }

hasTrack()

bool pat::VertexAssociation::hasTrack ( ) const

inline

Returns 'true' if a reference to a track was stored in this VertexAssociation.

Definition at line 52 of file Vertexing.h.

References edm::RefToBase< T >::isNull(), and track_.

Referenced by track().

{ return !track_.isNull(); }

hasTransverseIP()

bool pat::VertexAssociation::hasTransverseIP ( ) const

inline

True if the transverse distance was computed for this VertexAssociation.

Definition at line 64 of file Vertexing.h.

References dr_, and Measurement1DFloat::value().

Referenced by hasErrors().

{ return (dr_.value() != 0); }

isAvailable()

bool pat::VertexAssociation::isAvailable ( ) const

inline

Return 'true' if the reco::Vertex is available in the file, false if it has been dropped.

Definition at line 41 of file Vertexing.h.

References edm::Ref< C, T, F >::isAvailable(), and vertex_.

{ return vertex_.isAvailable(); }

isNonnull()

bool pat::VertexAssociation::isNonnull ( ) const

inline

Return 'true' unless this is a null association (that is, no vertex)

Definition at line 39 of file Vertexing.h.

References edm::Ref< C, T, F >::isNonnull(), and vertex_.

{ return vertex_.isNonnull(); }

isNull()

bool pat::VertexAssociation::isNull ( ) const

inline

Return 'true' if this is a null association (that is, no vertex)

Definition at line 37 of file Vertexing.h.

References edm::Ref< C, T, F >::isNull(), and vertex_.

Referenced by pat::VertexAssociationSelector::operator()().

{ return vertex_.isNull(); }

operator*()

const reco::Vertex& pat::VertexAssociation::operator* ( void  ) const

inline

Return the vertex (that is, you can do "const reco::Vertex &vtx = *assoc")

Definition at line 43 of file Vertexing.h.

References operator->().

{ return *operator->(); }

operator->()

const reco::Vertex* pat::VertexAssociation::operator-> ( ) const

inline

Allows VertexAssociation to behave like a vertex ref (e.g. to do "assoc->position()")

Definition at line 45 of file Vertexing.h.

References edm::Ref< C, T, F >::get(), edm::Ref< C, T, F >::isNull(), and vertex_.

Referenced by operator*().

{ return vertex_.isNull() ? nullptr : vertex_.get(); }

setDistances() [1/2]

void VertexAssociation::setDistances	(	const AlgebraicVector3 &	dist,
		const AlgebraicSymMatrix33 &	err
	)

Set dz and dr given the distance and the 3x3 total covariance matrix of the distance.

Definition at line 5 of file Vertexing.cc.

References funct::abs(), submitPVResolutionJobs::err, setDr(), setDz(), and mathSSE::sqrt().

Referenced by setDistances().

                                                                                                  {
  setDz(Measurement1DFloat(std::abs(dist[2]), std::sqrt(err(2, 2))));

  AlgebraicVector3 dist2D(dist[0], dist[1], 0);
  float d2 = dist2D[0] * dist2D[0] + dist2D[1] * dist2D[1];
  setDr(Measurement1DFloat(sqrt(d2), sqrt(ROOT::Math::Similarity(dist2D, err) / d2)));
}

setDistances() [2/2]

template<typename T1 , typename T2 >

void pat::VertexAssociation::setDistances ( const T1 &  p1, const T2 &  p2, const AlgebraicSymMatrix33 &  err  )

inline

Set dz and dr given the two points (object and vertex) and the 3x3 total covariance matrix of the distance The covariance matrix must already include the covariance matrix of the vertex 'p1', 'p2' can be anything that has methods .x(), .y(), .z() (e.g. GlobalPoint, Vertex, ...)

Definition at line 78 of file Vertexing.h.

References submitPVResolutionJobs::err, LaserDQM_cfg::p1, SiStripOfflineCRack_cfg::p2, and setDistances().

                                                                                   {
      AlgebraicVector3 dist(p1.x() - p2.x(), p1.y() - p2.y(), p1.z() - p2.z());
      setDistances(dist, err);
    }

setDr() [1/2]

void pat::VertexAssociation::setDr ( const Measurement1DFloat &  dr )

inline

Definition at line 69 of file Vertexing.h.

References dr(), and dr_.

Referenced by setDistances().

{ dr_ = dr; }

setDr() [2/2]

void pat::VertexAssociation::setDr ( const Measurement1D &  dr )

inline

Definition at line 71 of file Vertexing.h.

References dr(), dr_, Measurement1DFloat::error(), and Measurement1DFloat::value().

{ dr_ = Measurement1DFloat(dr.value(), dr.error()); }

setDz() [1/2]

void pat::VertexAssociation::setDz ( const Measurement1DFloat &  dz )

inline

Definition at line 68 of file Vertexing.h.

References dz(), and dz_.

Referenced by setDistances().

{ dz_ = dz; }

setDz() [2/2]

void pat::VertexAssociation::setDz ( const Measurement1D &  dz )

inline

Definition at line 70 of file Vertexing.h.

References dz(), dz_, Measurement1DFloat::error(), and Measurement1DFloat::value().

{ dz_ = Measurement1DFloat(dz.value(), dz.error()); }

track()

const reco::Track* pat::VertexAssociation::track ( ) const

inline

Returns a C++ pointer to the track stored in this vertex (can be a null pointer)

Definition at line 56 of file Vertexing.h.

References edm::RefToBase< T >::get(), hasTrack(), and track_.

{ return hasTrack() ? track_.get() : nullptr; }

trackRef()

const reco::TrackBaseRef& pat::VertexAssociation::trackRef ( ) const

inline

Returns a reference to the track stored in this vertex (can be null)

Definition at line 54 of file Vertexing.h.

References track_.

{ return track_; }

vertex()

const reco::Vertex* pat::VertexAssociation::vertex ( ) const

inline

Returns a pointer to the vertex, or a null pointer if there is no vertex (null association)

Definition at line 50 of file Vertexing.h.

References edm::Ref< C, T, F >::get(), edm::Ref< C, T, F >::isNull(), and vertex_.

Referenced by Tau.Tau::dxy().

{ return vertex_.isNull() ? nullptr : vertex_.get(); }

vertexRef()

const reco::VertexRef& pat::VertexAssociation::vertexRef ( ) const

inline

Returns the reference to the vertex (can be a null reference)

Definition at line 48 of file Vertexing.h.

References vertex_.

{ return vertex_; }

Member Data Documentation

dr_

Measurement1DFloat pat::VertexAssociation::dr_

private

Definition at line 89 of file Vertexing.h.

Referenced by dr(), hasErrors(), hasTransverseIP(), and setDr().

dz_

Measurement1DFloat pat::VertexAssociation::dz_

private

Definition at line 89 of file Vertexing.h.

Referenced by dz(), hasErrors(), and setDz().

track_

reco::TrackBaseRef pat::VertexAssociation::track_

private

Definition at line 92 of file Vertexing.h.

Referenced by hasTrack(), track(), and trackRef().

vertex_

reco::VertexRef pat::VertexAssociation::vertex_

private

Definition at line 88 of file Vertexing.h.

Referenced by isAvailable(), isNonnull(), isNull(), operator->(), vertex(), and vertexRef().