CMS 3D CMS Logo

List of all members | Public Member Functions | Private Member Functions | Private Attributes
reco::TrackJet Class Reference

Jets made out of tracks. More...

#include <TrackJet.h>

Inheritance diagram for reco::TrackJet:
reco::Jet reco::CompositePtrCandidate reco::LeafCandidate reco::Candidate

Public Member Functions

TrackJetclone () const override
 Polymorphic clone. More...
 
bool fromHardVertex () const
 check jet to be associated to the hard primary vertex More...
 
size_t numberOfTracks () const
 Number of track daughters. More...
 
const reco::VertexRef primaryVertex () const
 get associated primary vertex More...
 
std::string print () const override
 Print object. More...
 
void resetCharge ()
 calculate and set the charge by adding up the constituting track charges More...
 
void setPrimaryVertex (const reco::VertexRef &vtx)
 set associated primary vertex More...
 
virtual edm::Ptr< reco::Tracktrack (size_t i) const
 Return Ptr to the track costituent. More...
 
 TrackJet ()
 Default constructor. More...
 
 TrackJet (const LorentzVector &fP4, const Point &fVertex)
 Constructor without constituents. More...
 
 TrackJet (const LorentzVector &fP4, const Point &fVertex, const Jet::Constituents &fConstituents)
 Constructor from RecoChargedRefCandidate constituents. More...
 
std::vector< edm::Ptr< reco::Track > > tracks () const
 Return pointers to all track costituents. More...
 
 ~TrackJet () override
 Destructor. More...
 
- Public Member Functions inherited from reco::Jet
float constituentEtaPhiSpread () const
 
float constituentPtDistribution () const
 
float etaetaMoment () const
 eta-eta second moment, ET weighted More...
 
float etaphiMoment () const
 eta-phi second moment, ET weighted More...
 
EtaPhiMoments etaPhiStatistics () const
 eta-phi statistics, ET weighted More...
 
float etInAnnulus (float fRmin, float fRmax) const
 ET in annulus between rmin and rmax around jet direction. More...
 
virtual Constituents getJetConstituents () const
 list of constituents More...
 
virtual std::vector< const reco::Candidate * > getJetConstituentsQuick () const
 quick list of constituents More...
 
bool isJet () const override
 
 Jet ()
 Default constructor. More...
 
 Jet (const LorentzVector &fP4, const Point &fVertex)
 Initiator. More...
 
 Jet (const LorentzVector &fP4, const Point &fVertex, const Constituents &fConstituents)
 
virtual float jetArea () const
 get jet area More...
 
float maxDistance () const
 maximum distance from jet to constituent More...
 
int nCarrying (float fFraction) const
 return # of constituent carrying fraction of energy More...
 
virtual int nConstituents () const
 

of constituents

More...
 
virtual int nPasses () const
 number of passes taken by algorithm More...
 
float phiphiMoment () const
 phi-phi second moment, ET weighted More...
 
virtual float pileup () const
 pileup energy contribution as calculated by algorithm More...
 
virtual void scaleEnergy (double fScale)
 scale energy of the jet More...
 
virtual void setJetArea (float fArea)
 set jet area More...
 
virtual void setNPasses (int fPasses)
 Set number of passes taken by algorithm. More...
 
virtual void setPileup (float fEnergy)
 Set pileup energy contribution as calculated by algorithm. More...
 
 ~Jet () override
 Destructor. More...
 
- Public Member Functions inherited from reco::CompositePtrCandidate
void addDaughter (const CandidatePtr &)
 add a daughter via a reference More...
 
void clearDaughters ()
 clear daughter references More...
 
 CompositePtrCandidate ()
 default constructor More...
 
 CompositePtrCandidate (Charge q, const LorentzVector &p4, const Point &vtx=Point(0, 0, 0), int pdgId=0, int status=0, bool integerCharge=true)
 constructor from values More...
 
 CompositePtrCandidate (Charge q, const PolarLorentzVector &p4, const Point &vtx=Point(0, 0, 0), int pdgId=0, int status=0, bool integerCharge=true)
 constructor from values More...
 
 CompositePtrCandidate (const Candidate &p)
 constructor from a Candidate More...
 
const Candidatedaughter (size_type) const override
 return daughter at a given position, i = 0, ... numberOfDaughters() - 1 (read only mode) More...
 
Candidatedaughter (size_type) override
 return daughter at a given position, i = 0, ... numberOfDaughters() - 1 More...
 
CandidatePtr daughterPtr (size_type i) const
 reference to daughter at given position More...
 
const daughtersdaughterPtrVector () const
 references to daughtes More...
 
const Candidatemother (size_t i=0) const override
 return pointer to mother More...
 
size_t numberOfDaughters () const override
 number of daughters More...
 
size_t numberOfMothers () const override
 number of mothers More...
 
size_type numberOfSourceCandidatePtrs () const override
 
CandidatePtr sourceCandidatePtr (size_type i) const override
 
 ~CompositePtrCandidate () override
 destructor More...
 
- Public Member Functions inherited from reco::LeafCandidate
Vector boostToCM () const final
 
int charge () const final
 electric charge More...
 
void construct (int qx3, float pt, float eta, float phi, float mass, const Point &vtx, int pdgId, int status)
 
const Candidatedaughter (size_type) const override
 return daughter at a given position (throws an exception) More...
 
Candidatedaughter (size_type) override
 return daughter at a given position (throws an exception) More...
 
Candidatedaughter (const std::string &s) override
 return daughter with a specified role name More...
 
const Candidatedaughter (const std::string &s) const override
 return daughter with a specified role name More...
 
double energy () const final
 energy More...
 
double et () const final
 transverse energy More...
 
double et2 () const final
 transverse energy squared (use this for cut!) More...
 
double eta () const final
 momentum pseudorapidity More...
 
void fillVertexCovariance (CovarianceMatrix &v) const override
 fill SMatrix More...
 
template<typename T >
T get () const
 get a component More...
 
template<typename T , typename Tag >
T get () const
 get a component More...
 
template<typename T >
T get (size_type i) const
 get a component More...
 
template<typename T , typename Tag >
T get (size_type i) const
 get a component More...
 
bool hasMasterClone () const override
 
bool hasMasterClonePtr () const override
 
bool isCaloMuon () const override
 
bool isConvertedPhoton () const override
 
bool isElectron () const override
 
bool isGlobalMuon () const override
 
bool isMuon () const override
 
bool isPhoton () const override
 
bool isStandAloneMuon () const override
 
bool isTrackerMuon () const override
 
 LeafCandidate ()
 
 LeafCandidate (const Candidate &c)
 
template<typename... Args>
 LeafCandidate (Args &&...args)
 
 LeafCandidate (LeafCandidate &rh)
 
 LeafCandidate (LeafCandidate &&)=default
 
 LeafCandidate (LeafCandidate const &)=default
 
bool longLived () const final
 is long lived? More...
 
double mass () const final
 mass More...
 
bool massConstraint () const final
 do mass constraint? More...
 
double massSqr () const final
 mass squared More...
 
const CandidateBaseRefmasterClone () const override
 
const CandidatePtrmasterClonePtr () const override
 
template<typename Ref >
Ref masterRef () const
 cast master clone reference to a concrete type More...
 
Vector momentum () const final
 spatial momentum vector More...
 
const Candidatemother (size_type) const override
 return mother at a given position (throws an exception) More...
 
double mt () const final
 transverse mass More...
 
double mtSqr () const final
 transverse mass squared More...
 
template<typename T >
size_type numberOf () const
 number of components More...
 
template<typename T , typename Tag >
size_type numberOf () const
 number of components More...
 
size_t numberOfDaughters () const override
 number of daughters More...
 
size_t numberOfMothers () const override
 number of mothers More...
 
size_t numberOfSourceCandidatePtrs () const override
 
LeafCandidateoperator= (LeafCandidate &&)=default
 
LeafCandidateoperator= (LeafCandidate const &)=default
 
double p () const final
 magnitude of momentum vector More...
 
const LorentzVectorp4 () const final
 four-momentum Lorentz vector More...
 
int pdgId () const final
 PDG identifier. More...
 
double phi () const final
 momentum azimuthal angle More...
 
const PolarLorentzVectorpolarP4 () const final
 four-momentum Lorentz vector More...
 
double pt () const final
 transverse momentum More...
 
double px () const final
 x coordinate of momentum vector More...
 
double py () const final
 y coordinate of momentum vector More...
 
double pz () const final
 z coordinate of momentum vector More...
 
double rapidity () const final
 rapidity More...
 
void setCharge (Charge q) final
 set electric charge More...
 
void setLongLived () final
 
void setMass (double m) final
 set particle mass More...
 
void setMassConstraint () final
 
void setP4 (const LorentzVector &p4) final
 set 4-momentum More...
 
void setP4 (const PolarLorentzVector &p4) final
 set 4-momentum More...
 
void setPdgId (int pdgId) final
 
void setPz (double pz) final
 
void setStatus (int status) final
 set status word More...
 
void setThreeCharge (Charge qx3) final
 set electric charge More...
 
void setVertex (const Point &vertex) override
 set vertex More...
 
CandidatePtr sourceCandidatePtr (size_type i) const override
 
int status () const final
 status word More...
 
double theta () const final
 momentum polar angle More...
 
int threeCharge () const final
 electric charge More...
 
const Pointvertex () const override
 vertex position (overwritten by PF...) More...
 
double vertexChi2 () const override
 chi-squares More...
 
double vertexCovariance (int i, int j) const override
 (i, j)-th element of error matrix, i, j = 0, ... 2 More...
 
CovarianceMatrix vertexCovariance () const final
 return SMatrix More...
 
double vertexNdof () const override
 
double vertexNormalizedChi2 () const override
 chi-squared divided by n.d.o.f. More...
 
double vx () const override
 x coordinate of vertex position More...
 
double vy () const override
 y coordinate of vertex position More...
 
double vz () const override
 z coordinate of vertex position More...
 
double y () const final
 rapidity More...
 
 ~LeafCandidate () override
 destructor More...
 
- Public Member Functions inherited from reco::Candidate
const_iterator begin () const
 first daughter const_iterator More...
 
iterator begin ()
 first daughter iterator More...
 
virtual const TrackbestTrack () const
 
 Candidate ()
 default constructor More...
 
virtual float dxyError () const
 uncertainty on dxy More...
 
virtual float dzError () const
 uncertainty on dz More...
 
const_iterator end () const
 last daughter const_iterator More...
 
iterator end ()
 last daughter iterator More...
 
template<typename T >
T get () const
 get a component More...
 
template<typename T , typename Tag >
T get () const
 get a component More...
 
template<typename T >
T get (size_type i) const
 get a component More...
 
template<typename T , typename Tag >
T get (size_type i) const
 get a component More...
 
template<typename Ref >
Ref masterRef () const
 cast master clone reference to a concrete type More...
 
template<typename T >
size_type numberOf () const
 number of components More...
 
template<typename T , typename Tag >
size_type numberOf () const
 number of components More...
 
virtual void setSourceCandidatePtr (const CandidatePtr &ptr)
 Set the ptr to the source Candidate. More...
 
virtual ~Candidate ()
 destructor More...
 

Private Member Functions

bool overlap (const Candidate &dummy) const override
 Polymorphic overlap. More...
 

Private Attributes

reco::VertexRef vtx_
 Associated primary vertex. More...
 

Additional Inherited Members

- Public Types inherited from reco::Jet
typedef edm::Ptr< CandidateConstituent
 
typedef std::vector< ConstituentConstituents
 
- Public Types inherited from reco::CompositePtrCandidate
typedef std::vector< CandidatePtrdaughters
 collection of references to daughters More...
 
typedef std::vector< CandidatePtrmothers
 collection of references to daughters More...
 
- Public Types inherited from reco::LeafCandidate
typedef int Charge
 electric charge type More...
 
typedef CandidateCollection daughters
 collection of daughter candidates More...
 
typedef unsigned int index
 
typedef math::XYZTLorentzVector LorentzVector
 Lorentz vector. More...
 
typedef math::XYZPoint Point
 point in the space More...
 
typedef math::PtEtaPhiMLorentzVector PolarLorentzVector
 Lorentz vector. More...
 
typedef math::XYZVector Vector
 point in the space More...
 
- Public Types inherited from reco::Candidate
enum  { dimension = 3 }
 
enum  { size = dimension * (dimension + 1)/2 }
 matix size More...
 
typedef int Charge
 electric charge type More...
 
typedef candidate::const_iterator const_iterator
 
typedef math::Error< dimension >::type CovarianceMatrix
 covariance error matrix (3x3) More...
 
typedef unsigned int index
 index type More...
 
typedef candidate::iterator iterator
 
typedef math::XYZTLorentzVector LorentzVector
 Lorentz vector. More...
 
typedef math::XYZPoint Point
 point in the space More...
 
typedef math::PtEtaPhiMLorentzVector PolarLorentzVector
 Lorentz vector. More...
 
typedef size_t size_type
 
typedef math::XYZVector Vector
 point in the space More...
 
- Static Public Member Functions inherited from reco::Jet
static float detectorEta (float fZVertex, float fPhysicsEta)
 static function to convert physics eta to detector eta More...
 
static Candidate::LorentzVector detectorP4 (const Candidate::Point &vertex, const Candidate &inParticle)
 
static float physicsEta (float fZVertex, float fDetectorEta)
 static function to convert detector eta to physics eta More...
 
static Candidate::LorentzVector physicsP4 (const Candidate::Point &newVertex, const Candidate &inParticle, const Candidate::Point &oldVertex=Candidate::Point(0, 0, 0))
 

Detailed Description

Jets made out of tracks.

TrackJet represents Jets with tracks as constituents. The consitutents are in this case RecoChargedRefCandidates, that preserve the Refs to the original tracks. Those Refs are used to provide transparent access to the tracks.

Author
Steven Lowette

Definition at line 27 of file TrackJet.h.

Constructor & Destructor Documentation

reco::TrackJet::TrackJet ( )

Default constructor.

Definition at line 8 of file TrackJet.cc.

9  : reco::Jet()
10 {
11 }
reco::TrackJet::TrackJet ( const LorentzVector fP4,
const Point fVertex 
)

Constructor without constituents.

Definition at line 14 of file TrackJet.cc.

15  : reco::Jet(fP4, fVertex)
16 {
17 }
reco::TrackJet::TrackJet ( const LorentzVector fP4,
const Point fVertex,
const Jet::Constituents fConstituents 
)

Constructor from RecoChargedRefCandidate constituents.

Definition at line 20 of file TrackJet.cc.

References resetCharge().

21  : reco::Jet(fP4, fVertex, fConstituents)
22 {
23  this->resetCharge();
24 }
void resetCharge()
calculate and set the charge by adding up the constituting track charges
Definition: TrackJet.cc:66
reco::TrackJet::~TrackJet ( )
inlineoverride

Destructor.

Definition at line 38 of file TrackJet.h.

References clone().

38 {}

Member Function Documentation

reco::TrackJet * reco::TrackJet::clone ( void  ) const
overridevirtual

Polymorphic clone.

Reimplemented from reco::CompositePtrCandidate.

Definition at line 28 of file TrackJet.cc.

Referenced by ~TrackJet().

28  {
29  return new reco::TrackJet(*this);
30 }
Jets made out of tracks.
Definition: TrackJet.h:27
bool reco::TrackJet::fromHardVertex ( ) const
inline

check jet to be associated to the hard primary vertex

Definition at line 56 of file TrackJet.h.

References overlap(), primaryVertex(), print(), and AlCaHLTBitMon_QueryRunRegistry::string.

56 { return (this->primaryVertex().index() == 0); }
unsigned int index
Definition: LeafCandidate.h:31
const reco::VertexRef primaryVertex() const
get associated primary vertex
Definition: TrackJet.cc:75
size_t reco::TrackJet::numberOfTracks ( ) const
inline

Number of track daughters.

Definition at line 43 of file TrackJet.h.

References mps_fire::i, reco::CompositePtrCandidate::numberOfDaughters(), primaryVertex(), resetCharge(), setPrimaryVertex(), track(), tracks(), and badGlobalMuonTaggersAOD_cff::vtx.

43 { return numberOfDaughters(); }
size_t numberOfDaughters() const override
number of daughters
bool reco::TrackJet::overlap ( const Candidate dummy) const
overrideprivatevirtual

Polymorphic overlap.

Reimplemented from reco::CompositePtrCandidate.

Definition at line 85 of file TrackJet.cc.

Referenced by fromHardVertex().

85  {
86  return false;
87 }
const reco::VertexRef reco::TrackJet::primaryVertex ( ) const

get associated primary vertex

Definition at line 75 of file TrackJet.cc.

References vtx_.

Referenced by fromHardVertex(), numberOfTracks(), and print().

75  {
76  return vtx_;
77 }
reco::VertexRef vtx_
Associated primary vertex.
Definition: TrackJet.h:69
std::string reco::TrackJet::print ( void  ) const
overridevirtual

Print object.

Reimplemented from reco::Jet.

Definition at line 90 of file TrackJet.cc.

References mps_fire::i, MillePedeFileConverter_cfg::out, primaryVertex(), reco::Jet::print(), and tracks().

Referenced by fromHardVertex().

90  {
91  std::ostringstream out;
92  out << Jet::print() // generic jet info
93  << " TrackJet specific:" << std::endl;
94  if (primaryVertex().get()) {
95  out << " Associated PV:"
96  << " x=" << primaryVertex()->x()
97  << " y=" << primaryVertex()->y()
98  << " z=" << primaryVertex()->z() << std::endl;
99  } else {
100  out << " Associated PV not available on the event" << std::endl;
101  }
102  std::vector<edm::Ptr<reco::Track> > thetracks = tracks();
103  for (unsigned i = 0; i < thetracks.size (); i++) {
104  if (thetracks[i].get ()) {
105  out << " #" << i
106  << " px=" << thetracks[i]->px()
107  << " py=" << thetracks[i]->py()
108  << " pz=" << thetracks[i]->pz()
109  << " eta=" << thetracks[i]->eta()
110  << " phi=" << thetracks[i]->phi() << std::endl;
111  }
112  else {
113  out << " #" << i << " track is not available in the event" << std::endl;
114  }
115  }
116  return out.str();
117 }
virtual std::string print() const
Print object.
std::vector< edm::Ptr< reco::Track > > tracks() const
Return pointers to all track costituents.
Definition: TrackJet.cc:59
const reco::VertexRef primaryVertex() const
get associated primary vertex
Definition: TrackJet.cc:75
void reco::TrackJet::resetCharge ( )

calculate and set the charge by adding up the constituting track charges

Definition at line 66 of file TrackJet.cc.

References reco::Candidate::begin(), reco::LeafCandidate::charge(), reco::Candidate::end(), and reco::LeafCandidate::setCharge().

Referenced by numberOfTracks(), and TrackJet().

66  {
68  for ( reco::Candidate::const_iterator ida = this->begin(); ida != this->end(); ++ida ) {
69  charge += ida->charge();
70  }
71  this->setCharge(charge);
72 }
int charge() const final
electric charge
Definition: LeafCandidate.h:91
void setCharge(Charge q) final
set electric charge
Definition: LeafCandidate.h:93
const_iterator end() const
last daughter const_iterator
Definition: Candidate.h:146
const_iterator begin() const
first daughter const_iterator
Definition: Candidate.h:144
int Charge
electric charge type
Definition: LeafCandidate.h:21
void reco::TrackJet::setPrimaryVertex ( const reco::VertexRef vtx)

set associated primary vertex

Definition at line 80 of file TrackJet.cc.

References badGlobalMuonTaggersAOD_cff::vtx, and vtx_.

Referenced by numberOfTracks(), and FastjetJetProducer::produceTrackJets().

80  {
81  vtx_ = vtx;
82 }
reco::VertexRef vtx_
Associated primary vertex.
Definition: TrackJet.h:69
edm::Ptr< reco::Track > reco::TrackJet::track ( size_t  i) const
virtual

Return Ptr to the track costituent.

Definition at line 34 of file TrackJet.cc.

References reco::CompositePtrCandidate::dau, reco::CompositePtrCandidate::daughterPtr(), Exception, edm::Ptr< T >::get(), edm::Ref< C, T, F >::get(), edm::Ref< C, T, F >::id(), edm::Ptr< T >::isAvailable(), edm::Ptr< T >::isNonnull(), edm::Ref< C, T, F >::key(), and reco::RecoChargedRefCandidate::track().

Referenced by numberOfTracks(), and tracks().

34  {
36  // check the daughter to be ok
37  if ( dau.isNonnull() && dau.isAvailable() ) {
38  // convert to concrete candidate type
39  const RecoChargedRefCandidate* trkCand = dynamic_cast <const RecoChargedRefCandidate*> (dau.get());
40  // check the candidate is of the right type
41  if (trkCand) {
42  // check the track link in the recochargedcandidate to be there
43  if (trkCand->track().get()) {
44  // ok, return pointer to the originating track
45  return edm::Ptr<reco::Track> ( trkCand->track().id(), trkCand->track().get(), trkCand->track().key() );
46  } else {
47  throw cms::Exception("TrackRef unavailable") << "TrackJet consituent track not in the event.";
48  }
49  } else {
50  throw cms::Exception("Invalid Constituent") << "TrackJet constituent is not of RecoChargedRefCandidate type";
51  }
52  // otherwise return empty ptr
53  } else {
54  return edm::Ptr<reco::Track>();
55  }
56 }
CandidatePtr daughterPtr(size_type i) const
reference to daughter at given position
daughters dau
collection of references to daughters
edm::Ptr< Candidate > Constituent
Definition: Jet.h:22
std::vector< edm::Ptr< reco::Track > > reco::TrackJet::tracks ( void  ) const

Return pointers to all track costituents.

Definition at line 59 of file TrackJet.cc.

References mps_fire::i, reco::CompositePtrCandidate::numberOfDaughters(), mps_fire::result, and track().

Referenced by numberOfTracks(), and print().

59  {
60  std::vector <edm::Ptr<reco::Track> > result;
61  for (unsigned i = 0; i < numberOfDaughters (); i++) result.push_back (track (i));
62  return result;
63 }
size_t numberOfDaughters() const override
number of daughters
virtual edm::Ptr< reco::Track > track(size_t i) const
Return Ptr to the track costituent.
Definition: TrackJet.cc:34

Member Data Documentation

reco::VertexRef reco::TrackJet::vtx_
private

Associated primary vertex.

Definition at line 69 of file TrackJet.h.

Referenced by primaryVertex(), and setPrimaryVertex().