CaloParticle Class Reference

#include <CaloParticle.h>

Public Types
typedef int	Charge
	electric charge type More...
typedef std::vector< SimTrack >::const_iterator	g4t_iterator
typedef reco::GenParticleRefVector::iterator	genp_iterator
	reference to reco::GenParticle More...
typedef math::XYZTLorentzVectorD	LorentzVector
	Lorentz vector. More...
typedef math::XYZPointD	Point
	point in the space More...
typedef math::PtEtaPhiMLorentzVector	PolarLorentzVector
	Lorentz vector. More...
typedef SimClusterRefVector::iterator	sc_iterator
typedef math::XYZVectorD	Vector
	point in the space More...

Public Member Functions
void	addG4Track (const SimTrack &t)
void	addGenParticle (const reco::GenParticleRef &ref)
void	addRecHitAndFraction (uint32_t hit, float fraction)
	add rechit with fraction More...
void	addSimCluster (const SimClusterRef &ref)
void	addSimHit (const PCaloHit &hit)
	add simhit's energy to cluster More...
math::XYZVectorF	boostToCM () const
	Vector to boost to the particle centre of mass frame. More...
	CaloParticle ()
	CaloParticle (const SimTrack &simtrk)
	CaloParticle (EncodedEventId eventID, uint32_t particleID)
float	charge () const
	Electric charge. Note this is taken from the first SimTrack only. More...
void	clearSimClusters ()
float	energy () const
	Energy. Note this is taken from the first SimTrack only. More...
float	et () const
	Transverse energy. Note this is taken from the first SimTrack only. More...
float	eta () const
	Momentum pseudorapidity. Note this is taken from the simtrack before the calorimeter. More...
EncodedEventId	eventId () const
	Signal source, crossing number. More...
g4t_iterator	g4Track_begin () const
g4t_iterator	g4Track_end () const
const std::vector< SimTrack > &	g4Tracks () const
genp_iterator	genParticle_begin () const
	iterators More...
genp_iterator	genParticle_end () const
const reco::GenParticleRefVector &	genParticles () const
std::vector< std::pair< uint32_t, float > >	hits_and_fractions () const
	Returns list of rechit IDs and fractions for this CaloParticle. More...
bool	longLived () const
	is long lived? More...
float	mass () const
	Mass. Note this is taken from the first SimTrack only. More...
float	massSqr () const
	Mass squared. Note this is taken from the first SimTrack only. More...
math::XYZVectorF	momentum () const
	spatial momentum vector More...
float	mt () const
	Transverse mass. Note this is taken from the first SimTrack only. More...
float	mtSqr () const
	Transverse mass squared. Note this is taken from the first SimTrack only. More...
int	numberOfRecHits () const
	Gives the total number of SimHits, in the cluster. More...
int	numberOfSimHits () const
	Gives the total number of SimHits, in the cluster. More...
float	p () const
	Magnitude of momentum vector. Note this is taken from the first SimTrack only. More...
const math::XYZTLorentzVectorF &	p4 () const
	Four-momentum Lorentz vector. Note this is taken from the first SimTrack only. More...
uint64_t	particleId () const
int	pdgId () const
	PDG ID. More...
float	phi () const
	Momentum azimuthal angle. Note this is taken from the first SimTrack only. More...
float	pt () const
	Transverse momentum. Note this is taken from the first SimTrack only. More...
float	px () const
	x coordinate of momentum vector. Note this is taken from the first SimTrack only. More...
float	py () const
	y coordinate of momentum vector. Note this is taken from the first SimTrack only. More...
float	pz () const
	z coordinate of momentum vector. Note this is taken from the first SimTrack only. More...
float	rapidity () const
	Rapidity. Note this is taken from the simtrack before the calorimeter. More...
sc_iterator	simCluster_begin () const
sc_iterator	simCluster_end () const
const SimClusterRefVector &	simClusters () const
float	simEnergy () const
	returns the accumulated sim energy in the cluster More...
int	status () const
	Status word. More...
float	theta () const
	Momentum polar angle. Note this is taken from the first SimTrack only. More...
int	threeCharge () const
	Gives charge in unit of quark charge (should be 3 times "charge()") More...
float	y () const
	Same as rapidity(). More...
	~CaloParticle ()

Static Public Attributes
static const unsigned int	longLivedTag = 65536
	long lived flag More...

Private Attributes
EncodedEventId	event_
std::vector< float >	fractions_
std::vector< SimTrack >	g4Tracks_
	references to G4 and reco::GenParticle tracks More...
reco::GenParticleRefVector	genParticles_
std::vector< uint32_t >	hits_
uint64_t	nsimhits_ {0}
uint32_t	particleId_ {0}
SimClusterRefVector	simClusters_
float	simhit_energy_ {0.f}
math::XYZTLorentzVectorF	theMomentum_

Friends
std::ostream &	operator<< (std::ostream &s, CaloParticle const &tp)

Detailed Description

Definition at line 16 of file CaloParticle.h.

Member Typedef Documentation

Charge

typedef int CaloParticle::Charge

electric charge type

Definition at line 20 of file CaloParticle.h.

g4t_iterator

typedef std::vector<SimTrack>::const_iterator CaloParticle::g4t_iterator

Definition at line 28 of file CaloParticle.h.

genp_iterator

typedef reco::GenParticleRefVector::iterator CaloParticle::genp_iterator

reference to reco::GenParticle

Definition at line 27 of file CaloParticle.h.

LorentzVector

typedef math::XYZTLorentzVectorD CaloParticle::LorentzVector

Lorentz vector.

Definition at line 21 of file CaloParticle.h.

Point

typedef math::XYZPointD CaloParticle::Point

point in the space

Definition at line 23 of file CaloParticle.h.

PolarLorentzVector

typedef math::PtEtaPhiMLorentzVector CaloParticle::PolarLorentzVector

Lorentz vector.

Definition at line 22 of file CaloParticle.h.

sc_iterator

typedef SimClusterRefVector::iterator CaloParticle::sc_iterator

Definition at line 29 of file CaloParticle.h.

Vector

typedef math::XYZVectorD CaloParticle::Vector

point in the space

Definition at line 24 of file CaloParticle.h.

Constructor & Destructor Documentation

CaloParticle() [1/3]

CaloParticle::CaloParticle

(

)

Definition at line 11 of file CaloParticle.cc.

                           {
  // No operation
}

CaloParticle() [2/3]

CaloParticle::CaloParticle

(

const SimTrack &

simtrk

)

Definition at line 15 of file CaloParticle.cc.

References addG4Track(), event_, CoreSimTrack::eventId(), CoreSimTrack::momentum(), particleId_, theMomentum_, and CoreSimTrack::trackId().

                                                 {
  addG4Track(simtrk);
  event_ = simtrk.eventId();
  particleId_ = simtrk.trackId();
  theMomentum_.SetPxPyPzE(
      simtrk.momentum().px(), simtrk.momentum().py(), simtrk.momentum().pz(), simtrk.momentum().E());
}

CaloParticle() [3/3]

CaloParticle::CaloParticle	(	EncodedEventId	eventID,
		uint32_t	particleID
	)

Definition at line 23 of file CaloParticle.cc.

References event_, EgammaObjectsElectrons_cfi::particleID, and particleId_.

                                                                      {
  event_ = eventID;
  particleId_ = particleID;
}

~CaloParticle()

CaloParticle::~CaloParticle

(

)

Definition at line 28 of file CaloParticle.cc.

{}

Member Function Documentation

addG4Track()

void CaloParticle::addG4Track ( const SimTrack &  t )

inline

Definition at line 61 of file CaloParticle.h.

References g4Tracks_, and submitPVValidationJobs::t.

Referenced by CaloParticle().

{ g4Tracks_.push_back(t); }

addGenParticle()

void CaloParticle::addGenParticle ( const reco::GenParticleRef &  ref )

inline

Definition at line 59 of file CaloParticle.h.

References genParticles_, and edm::RefVector< C, T, F >::push_back().

{ genParticles_.push_back(ref); }

addRecHitAndFraction()

void CaloParticle::addRecHitAndFraction ( uint32_t  hit, float  fraction  )

inline

add rechit with fraction

Definition at line 169 of file CaloParticle.h.

References HLT_2022v12_cff::fraction, fractions_, and hits_.

                                                          {
    hits_.emplace_back(hit);
    fractions_.emplace_back(fraction);
  }

addSimCluster()

void CaloParticle::addSimCluster ( const SimClusterRef &  ref )

inline

Definition at line 60 of file CaloParticle.h.

References edm::RefVector< C, T, F >::push_back(), and simClusters_.

{ simClusters_.push_back(ref); }

addSimHit()

void CaloParticle::addSimHit ( const PCaloHit &  hit )

inline

add simhit's energy to cluster

Definition at line 187 of file CaloParticle.h.

References nsimhits_, and simhit_energy_.

                                      {
    simhit_energy_ += hit.energy();
    ++nsimhits_;
  }

boostToCM()

math::XYZVectorF CaloParticle::boostToCM ( ) const

inline

Vector to boost to the particle centre of mass frame.

Definition at line 91 of file CaloParticle.h.

References p4().

{ return p4().BoostToCM(); }

charge()

float CaloParticle::charge ( void  ) const

inline

Electric charge. Note this is taken from the first SimTrack only.

Definition at line 79 of file CaloParticle.h.

References g4Tracks_.

Referenced by threeCharge().

{ return g4Tracks_[0].charge(); }

clearSimClusters()

void CaloParticle::clearSimClusters ( )

inline

Definition at line 76 of file CaloParticle.h.

References edm::RefVector< C, T, F >::clear(), and simClusters_.

{ simClusters_.clear(); }

energy()

float CaloParticle::energy ( void  ) const

inline

Energy. Note this is taken from the first SimTrack only.

Definition at line 98 of file CaloParticle.h.

References p4().

Referenced by HGVHistoProducerAlgo::fill_caloparticle_histos(), and Jet.Jet::rawEnergy().

{ return p4().E(); }

et()

float CaloParticle::et ( ) const

inline

Transverse energy. Note this is taken from the first SimTrack only.

Definition at line 101 of file CaloParticle.h.

References p4().

{ return p4().Et(); }

eta()

float CaloParticle::eta ( void  ) const

inline

Momentum pseudorapidity. Note this is taken from the simtrack before the calorimeter.

Definition at line 142 of file CaloParticle.h.

References p4().

Referenced by Particle.Particle::__str__(), HGVHistoProducerAlgo::fill_caloparticle_histos(), Jet.Jet::jetID(), and Jet.Jet::puJetId().

{ return p4().Eta(); }

eventId()

EncodedEventId CaloParticle::eventId ( ) const

inline

Signal source, crossing number.

Note this is taken from the first SimTrack only, but there shouldn't be any SimTracks from different crossings in the CaloParticle.

Definition at line 54 of file CaloParticle.h.

References event_.

Referenced by ntupleDataFormat.Event::eventIdStr().

{ return event_; }

g4Track_begin()

g4t_iterator CaloParticle::g4Track_begin ( ) const

inline

Definition at line 65 of file CaloParticle.h.

References g4Tracks_.

{ return g4Tracks_.begin(); }

g4Track_end()

g4t_iterator CaloParticle::g4Track_end ( ) const

inline

Definition at line 66 of file CaloParticle.h.

References g4Tracks_.

{ return g4Tracks_.end(); }

g4Tracks()

const std::vector<SimTrack>& CaloParticle::g4Tracks ( ) const

inline

Definition at line 74 of file CaloParticle.h.

References g4Tracks_.

Referenced by HGVHistoProducerAlgo::fill_caloparticle_histos().

{ return g4Tracks_; }

genParticle_begin()

genp_iterator CaloParticle::genParticle_begin ( ) const

inline

iterators

Definition at line 63 of file CaloParticle.h.

References edm::RefVector< C, T, F >::begin(), and genParticles_.

{ return genParticles_.begin(); }

genParticle_end()

genp_iterator CaloParticle::genParticle_end ( ) const

inline

Definition at line 64 of file CaloParticle.h.

References edm::RefVector< C, T, F >::end(), and genParticles_.

{ return genParticles_.end(); }

genParticles()

const reco::GenParticleRefVector& CaloParticle::genParticles ( ) const

inline

Definition at line 71 of file CaloParticle.h.

References genParticles_.

{ return genParticles_; }

hits_and_fractions()

std::vector<std::pair<uint32_t, float> > CaloParticle::hits_and_fractions ( ) const

inline

Returns list of rechit IDs and fractions for this CaloParticle.

Definition at line 175 of file CaloParticle.h.

References fractions_, hits_, mps_fire::i, and mps_fire::result.

                                                                 {
    std::vector<std::pair<uint32_t, float>> result;
    for (size_t i = 0; i < hits_.size(); ++i) {
      result.emplace_back(hits_[i], fractions_[i]);
    }
    return result;
  }

longLived()

bool CaloParticle::longLived ( ) const

inline

is long lived?

Definition at line 160 of file CaloParticle.h.

References longLivedTag, and status().

{ return status() & longLivedTag; }

mass()

float CaloParticle::mass ( ) const

inline

Mass. Note this is taken from the first SimTrack only.

Definition at line 104 of file CaloParticle.h.

References p4().

Referenced by Particle.Particle::__str__(), DiObject.DiMuon::__str__(), and massSqr().

{ return p4().M(); }

massSqr()

float CaloParticle::massSqr ( ) const

inline

Mass squared. Note this is taken from the first SimTrack only.

Definition at line 107 of file CaloParticle.h.

References mass(), and funct::pow().

{ return pow(mass(), 2); }

momentum()

math::XYZVectorF CaloParticle::momentum ( ) const

inline

spatial momentum vector

Definition at line 88 of file CaloParticle.h.

References p4().

{ return p4().Vect(); }

mt()

float CaloParticle::mt ( ) const

inline

Transverse mass. Note this is taken from the first SimTrack only.

Definition at line 110 of file CaloParticle.h.

References p4().

{ return p4().Mt(); }

mtSqr()

float CaloParticle::mtSqr ( ) const

inline

Transverse mass squared. Note this is taken from the first SimTrack only.

Definition at line 114 of file CaloParticle.h.

References p4().

{ return p4().Mt2(); }

numberOfRecHits()

int CaloParticle::numberOfRecHits ( void  ) const

inline

Gives the total number of SimHits, in the cluster.

Definition at line 166 of file CaloParticle.h.

References hits_.

{ return hits_.size(); }

numberOfSimHits()

int CaloParticle::numberOfSimHits ( ) const

inline

Gives the total number of SimHits, in the cluster.

Definition at line 163 of file CaloParticle.h.

References nsimhits_.

{ return nsimhits_; }

p()

float CaloParticle::p ( ) const

inline

Magnitude of momentum vector. Note this is taken from the first SimTrack only.

Definition at line 95 of file CaloParticle.h.

References p4().

Referenced by Electron.Electron::ptErr().

{ return p4().P(); }

p4()

const math::XYZTLorentzVectorF& CaloParticle::p4 ( ) const

inline

Four-momentum Lorentz vector. Note this is taken from the first SimTrack only.

Definition at line 85 of file CaloParticle.h.

References theMomentum_.

Referenced by boostToCM(), Tau.Tau::dxy_approx(), Tau.Tau::dz(), energy(), et(), eta(), mass(), momentum(), mt(), mtSqr(), p(), Lepton.Lepton::p4WithFSR(), phi(), pt(), px(), py(), pz(), rapidity(), and theta().

{ return theMomentum_; }

particleId()

uint64_t CaloParticle::particleId ( ) const

inline

Definition at line 56 of file CaloParticle.h.

References particleId_.

{ return particleId_; }

pdgId()

int CaloParticle::pdgId ( ) const

inline

PDG ID.

Returns the PDG ID of the first associated gen particle. If there are no gen particles associated then it returns type() from the first SimTrack.

Definition at line 43 of file CaloParticle.h.

References edm::RefVector< C, T, F >::begin(), edm::RefVector< C, T, F >::empty(), g4Tracks_, and genParticles_.

Referenced by Particle.Particle::__str__().

                    {
    if (genParticles_.empty())
      return g4Tracks_[0].type();
    else
      return (*genParticles_.begin())->pdgId();
  }

phi()

float CaloParticle::phi ( void  ) const

inline

Momentum azimuthal angle. Note this is taken from the first SimTrack only.

Definition at line 134 of file CaloParticle.h.

References p4().

Referenced by Particle.Particle::__str__(), HGVHistoProducerAlgo::fill_caloparticle_histos(), and ntupleDataFormat.Track::phiPull().

{ return p4().Phi(); }

pt()

float CaloParticle::pt ( ) const

inline

Transverse momentum. Note this is taken from the first SimTrack only.

Definition at line 130 of file CaloParticle.h.

References p4().

Referenced by Particle.Particle::__str__(), DiObject.DiMuon::__str__(), Photon.Photon::calScaledIsoValueExp(), Photon.Photon::calScaledIsoValueLin(), Photon.Photon::calScaledIsoValueQuadr(), HGVHistoProducerAlgo::fill_caloparticle_histos(), Electron.Electron::mvaIDLoose(), Electron.Electron::mvaIDRun2(), Electron.Electron::mvaIDTight(), Electron.Electron::ptErr(), ntupleDataFormat.Track::ptPull(), Lepton.Lepton::relIso(), Lepton.Lepton::relIsoFromEA(), Lepton.Lepton::relIsoR(), and Jet.Jet::setCorrP4().

{ return p4().Pt(); }

px()

float CaloParticle::px ( ) const

inline

x coordinate of momentum vector. Note this is taken from the first SimTrack only.

Definition at line 118 of file CaloParticle.h.

References p4().

{ return p4().Px(); }

py()

float CaloParticle::py ( ) const

inline

y coordinate of momentum vector. Note this is taken from the first SimTrack only.

Definition at line 122 of file CaloParticle.h.

References p4().

{ return p4().Py(); }

pz()

float CaloParticle::pz ( ) const

inline

z coordinate of momentum vector. Note this is taken from the first SimTrack only.

Definition at line 126 of file CaloParticle.h.

References p4().

{ return p4().Pz(); }

rapidity()

float CaloParticle::rapidity ( ) const

inline

Rapidity. Note this is taken from the simtrack before the calorimeter.

Definition at line 146 of file CaloParticle.h.

References p4().

Referenced by y().

{ return p4().Rapidity(); }

simCluster_begin()

sc_iterator CaloParticle::simCluster_begin ( ) const

inline

Definition at line 67 of file CaloParticle.h.

References edm::RefVector< C, T, F >::begin(), and simClusters_.

{ return simClusters_.begin(); }

simCluster_end()

sc_iterator CaloParticle::simCluster_end ( ) const

inline

Definition at line 68 of file CaloParticle.h.

References edm::RefVector< C, T, F >::end(), and simClusters_.

{ return simClusters_.end(); }

simClusters()

const SimClusterRefVector& CaloParticle::simClusters ( ) const

inline

Definition at line 72 of file CaloParticle.h.

References simClusters_.

Referenced by FWECaloParticleProxyBuilder::build(), FWCaloParticleProxyBuilder::build(), and HGVHistoProducerAlgo::fill_caloparticle_histos().

{ return simClusters_; }

simEnergy()

float CaloParticle::simEnergy ( ) const

inline

returns the accumulated sim energy in the cluster

Definition at line 184 of file CaloParticle.h.

References simhit_energy_.

{ return simhit_energy_; }

status()

int CaloParticle::status ( void  ) const

inline

Status word.

Returns status() from the first gen particle, or -99 if there are no gen particles attached.

Definition at line 155 of file CaloParticle.h.

References edm::RefVector< C, T, F >::empty(), genParticles_, and status().

Referenced by longLived(), and status().

{ return genParticles_.empty() ? -99 : (*genParticles_[0]).status(); }

theta()

float CaloParticle::theta ( void  ) const

inline

Momentum polar angle. Note this is taken from the first SimTrack only.

Definition at line 138 of file CaloParticle.h.

References p4().

Referenced by Tau.Tau::zImpact().

{ return p4().Theta(); }

threeCharge()

int CaloParticle::threeCharge ( ) const

inline

Gives charge in unit of quark charge (should be 3 times "charge()")

Definition at line 81 of file CaloParticle.h.

References charge(), and f.

{ return lrintf(3.f * charge()); }

y()

float CaloParticle::y ( ) const

inline

Same as rapidity().

Definition at line 149 of file CaloParticle.h.

References rapidity().

Referenced by svgfig.Ellipse::__repr__(), geometryXMLparser.Alignable::pos(), ntupleDataFormat._HitObject::r(), and ntupleDataFormat._HitObject::r3D().

{ return rapidity(); }

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  s, CaloParticle const &  tp  )

friend

Definition at line 30 of file CaloParticle.cc.

                                                              {
  s << "Calo Particle:" << std::endl;
  s << "CP momentum, q, ID, & Event #: " << tp.p4() << " " << tp.charge() << " " << tp.pdgId() << " "
    << tp.eventId().bunchCrossing() << "." << tp.eventId().event() << std::endl;

  for (CaloParticle::genp_iterator hepT = tp.genParticle_begin(); hepT != tp.genParticle_end(); ++hepT) {
    s << " HepMC Track Momentum " << (*hepT)->momentum().rho() << std::endl;
  }

  for (CaloParticle::g4t_iterator g4T = tp.g4Track_begin(); g4T != tp.g4Track_end(); ++g4T) {
    s << " Geant Track Momentum  " << g4T->momentum() << std::endl;
    s << " Geant Track ID & type " << g4T->trackId() << " " << g4T->type() << std::endl;
    if (g4T->type() != tp.pdgId()) {
      s << " Mismatch b/t CaloParticle and Geant types" << std::endl;
    }
  }
  s << "SimClusters in this CaloParticle: " << std::endl;
  for (auto itr = tp.simClusters_.begin(); itr != tp.simClusters_.end(); ++itr) {
    s << **itr;
  }
  s << std::endl;
  return s;
}

Member Data Documentation

event_

EncodedEventId CaloParticle::event_

private

Definition at line 194 of file CaloParticle.h.

Referenced by CaloParticle(), and eventId().

fractions_

std::vector<float> CaloParticle::fractions_

private

Definition at line 199 of file CaloParticle.h.

Referenced by addRecHitAndFraction(), and hits_and_fractions().

g4Tracks_

std::vector<SimTrack> CaloParticle::g4Tracks_

private

references to G4 and reco::GenParticle tracks

Definition at line 204 of file CaloParticle.h.

Referenced by addG4Track(), charge(), g4Track_begin(), g4Track_end(), g4Tracks(), and pdgId().

genParticles_

reco::GenParticleRefVector CaloParticle::genParticles_

private

Definition at line 205 of file CaloParticle.h.

Referenced by addGenParticle(), genParticle_begin(), genParticle_end(), genParticles(), pdgId(), and status().

hits_

std::vector<uint32_t> CaloParticle::hits_

private

Definition at line 198 of file CaloParticle.h.

Referenced by addRecHitAndFraction(), hits_and_fractions(), and numberOfRecHits().

longLivedTag

const unsigned int CaloParticle::longLivedTag = 65536

static

long lived flag

Definition at line 157 of file CaloParticle.h.

Referenced by longLived().

nsimhits_

uint64_t CaloParticle::nsimhits_ {0}

private

Definition at line 193 of file CaloParticle.h.

Referenced by addSimHit(), and numberOfSimHits().

particleId_

uint32_t CaloParticle::particleId_ {0}

private

Definition at line 196 of file CaloParticle.h.

Referenced by CaloParticle(), and particleId().

simClusters_

SimClusterRefVector CaloParticle::simClusters_

private

Definition at line 207 of file CaloParticle.h.

Referenced by addSimCluster(), clearSimClusters(), simCluster_begin(), simCluster_end(), and simClusters().

simhit_energy_

float CaloParticle::simhit_energy_ {0.f}

private

Definition at line 197 of file CaloParticle.h.

Referenced by addSimHit(), and simEnergy().

theMomentum_

math::XYZTLorentzVectorF CaloParticle::theMomentum_

private

Definition at line 201 of file CaloParticle.h.

Referenced by CaloParticle(), and p4().