reco::Particle Class Reference

#include <Particle.h>

Public Types
typedef int	Charge
	electric charge type More...
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 Member Functions
Vector	boostToCM () const
int	charge () const
	electric charge More...
double	energy () const
	energy More...
double	et () const
	transverse energy More...
double	eta () const
	momentum pseudorapidity More...
bool	longLived () const
	is long lived? More...
double	mass () const
	mass More...
double	massSqr () const
	mass squared More...
Vector	momentum () const
	spatial momentum vector More...
double	mt () const
	transverse mass More...
double	mtSqr () const
	transverse mass squared More...
Particle &	operator= (const Particle &rhs)
double	p () const
	magnitude of momentum vector More...
const LorentzVector &	p4 () const
	four-momentum Lorentz vector More...
	Particle ()
	default constructor More...
	Particle (Charge q, const LorentzVector &p4, const Point &vertex=Point(0, 0, 0), int pdgId=0, int status=0, bool integerCharge=true)
	constructor from values More...
	Particle (Charge q, const PolarLorentzVector &p4, const Point &vertex=Point(0, 0, 0), int pdgId=0, int status=0, bool integerCharge=true)
	constructor from values More...
	Particle (const Particle &srv)
int	pdgId () const
	PDG identifier. More...
double	phi () const
	momentum azimuthal angle More...
const PolarLorentzVector &	polarP4 () const
	four-momentum Lorentz vector More...
double	pt () const
	transverse momentum More...
double	px () const
	x coordinate of momentum vector More...
double	py () const
	y coordinate of momentum vector More...
double	pz () const
	z coordinate of momentum vector More...
double	rapidity () const
	repidity More...
void	setCharge (Charge q)
	set electric charge More...
void	setLongLived ()
	set long lived flag More...
void	setMass (double m)
	set particle mass More...
void	setP4 (const LorentzVector &p4)
	set 4-momentum More...
void	setP4 (const PolarLorentzVector &p4)
	set 4-momentum More...
void	setPdgId (int pdgId)
void	setPz (double pz)
	set Pz More...
void	setStatus (int status)
	set status word More...
void	setThreeCharge (Charge qx3)
	set electric charge More...
void	setVertex (const Point &vertex)
	set vertex More...
int	status () const
	status word More...
void	swap (Particle &other)
double	theta () const
	momentum polar angle More...
int	threeCharge () const
	electric charge More...
const Point &	vertex () const
	vertex position More...
double	vx () const
	x coordinate of vertex position More...
double	vy () const
	y coordinate of vertex position More...
double	vz () const
	z coordinate of vertex position More...
double	y () const
	repidity More...
virtual	~Particle ()
	destructor More...

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

Protected Member Functions
void	cacheCartesian () const
	set internal cache More...
void	cachePolar () const
	set internal cache More...
void	clearCache () const
	clear internal cache More...

Protected Attributes
float	eta_
float	mass_
std::atomic< LorentzVector * >	p4Cartesian_
	internal cache for p4 More...
std::atomic< PolarLorentzVector * >	p4Polar_
	internal cache for p4 More...
int	pdgId_
	PDG identifier. More...
float	phi_
float	pt_
	four-momentum Lorentz vector More...
Charge	qx3_
	electric charge More...
int	status_
	status word More...
Point	vertex_
	vertex position More...

Detailed Description

Base class describing a generic reconstructed particle its main subclass is Candidate

Author

Luca Lista, INFN

Definition at line 22 of file Particle.h.

Member Typedef Documentation

typedef int reco::Particle::Charge

electric charge type

Definition at line 25 of file Particle.h.

typedef math::XYZTLorentzVector reco::Particle::LorentzVector

Lorentz vector.

Definition at line 27 of file Particle.h.

typedef math::XYZPoint reco::Particle::Point

point in the space

Definition at line 31 of file Particle.h.

typedef math::PtEtaPhiMLorentzVector reco::Particle::PolarLorentzVector

Lorentz vector.

Definition at line 29 of file Particle.h.

typedef math::XYZVector reco::Particle::Vector

point in the space

Definition at line 33 of file Particle.h.

Constructor & Destructor Documentation

Particle::Particle

(

)

default constructor

Definition at line 9 of file Particle.cc.

  : qx3_(0), pt_(0), eta_(0), phi_(0), mass_(0),
    vertex_(0, 0, 0), pdgId_(0), status_(0),
    p4Polar_(nullptr), p4Cartesian_(nullptr)
{
}

Particle::Particle	(	Charge	q,
		const LorentzVector &	p4,
		const Point &	vertex = Point( 0, 0, 0 ),
		int	pdgId = 0,
		int	status = 0,
		bool	integerCharge = true
	)

constructor from values

Definition at line 16 of file Particle.cc.

References qx3_.

  : qx3_( q ), pt_( p4.pt() ), eta_( p4.eta() ), phi_( p4.phi() ), mass_( p4.mass() ),
    vertex_( vertex ), pdgId_( pdgId ), status_( status ),
    p4Polar_(nullptr), p4Cartesian_(nullptr)
{
    if ( integerCharge ) qx3_ *= 3;
}

Particle::Particle	(	Charge	q,
		const PolarLorentzVector &	p4,
		const Point &	vertex = Point( 0, 0, 0 ),
		int	pdgId = 0,
		int	status = 0,
		bool	integerCharge = true
	)

constructor from values

Definition at line 25 of file Particle.cc.

References qx3_.

  : qx3_( q ), pt_( p4.pt() ), eta_( p4.eta() ), phi_( p4.phi() ), mass_( p4.mass() ),
    vertex_( vertex ), pdgId_( pdgId ), status_( status ),
    p4Polar_(nullptr), p4Cartesian_(nullptr)
{
    if ( integerCharge ) qx3_ *= 3;
}

Particle::~Particle ( )

virtual

destructor

dtor

Definition at line 65 of file Particle.cc.

References clearCache().

                    {
    clearCache();
}

Particle::Particle

(

const Particle &

srv

)

Definition at line 34 of file Particle.cc.

  : qx3_(src.qx3_), pt_(src.pt_), eta_(src.eta_), phi_(src.phi_), mass_(src.mass_),
    vertex_(src.vertex_), pdgId_(src.pdgId_), status_(src.status_),
    p4Polar_(nullptr), p4Cartesian_(nullptr)
{
}

Member Function Documentation

Particle::Vector Particle::boostToCM

(

)

const

boost vector to boost a Lorentz vector to the particle center of mass system

Definition at line 102 of file Particle.cc.

References cacheCartesian(), and p4Cartesian_.

                                         {
    cacheCartesian();
    return (*p4Cartesian_.load(std::memory_order_acquire)).BoostToCM();
}

void Particle::cacheCartesian ( ) const

protected

set internal cache

Definition at line 281 of file Particle.cc.

References cachePolar(), p4Cartesian_, and p4Polar_.

Referenced by boostToCM(), energy(), momentum(), p(), p4(), px(), py(), pz(), setP4(), setPz(), and theta().

                                    {
    if(!p4Cartesian_.load(std::memory_order_acquire)) {
        cachePolar();
        std::unique_ptr<LorentzVector> ptr{new LorentzVector(*p4Polar_.load(std::memory_order_acquire))};
        LorentzVector* expected = nullptr;
        if( p4Cartesian_.compare_exchange_strong(expected, ptr.get(), std::memory_order_acq_rel) ) {
           ptr.release();
        }
    }
}

void Particle::cachePolar ( ) const

protected

set internal cache

Definition at line 271 of file Particle.cc.

References eta_, mass_, p4Polar_, phi_, and pt_.

Referenced by cacheCartesian(), et(), mt(), mtSqr(), polarP4(), rapidity(), setP4(), and setPz().

                                {
    if(!p4Polar_.load(std::memory_order_acquire)) {
        std::unique_ptr<PolarLorentzVector> ptr{new PolarLorentzVector(pt_,eta_,phi_,mass_)};
        PolarLorentzVector* expect = nullptr;
        if(p4Polar_.compare_exchange_strong(expect, ptr.get(), std::memory_order_acq_rel)) {
            ptr.release();
        }
    }
}

int Particle::charge

(

)

const

electric charge

Definition at line 70 of file Particle.cc.

References qx3_.

Referenced by ParticleReplacerZtautau::produce().

                           {
    return qx3_ / 3;
}

void Particle::clearCache ( ) const

protected

clear internal cache

Definition at line 292 of file Particle.cc.

References p4Cartesian_, and p4Polar_.

Referenced by setMass(), and ~Particle().

                                {
    delete p4Polar_.exchange(nullptr, std::memory_order_acq_rel);
    delete p4Cartesian_.exchange(nullptr, std::memory_order_acq_rel);
}

double Particle::energy

(

)

const

energy

Definition at line 112 of file Particle.cc.

References cacheCartesian(), and p4Cartesian_.

Referenced by EmDQMReco::analyze().

                              {
    cacheCartesian();
    return (*p4Cartesian_.load(std::memory_order_acquire)).E();
}

double Particle::et

(

)

const

transverse energy

Definition at line 117 of file Particle.cc.

References cachePolar(), and p4Polar_.

                          {
    cachePolar();
    return (*p4Polar_.load(std::memory_order_acquire)).Et();
}

double Particle::eta

(

)

const

momentum pseudorapidity

Definition at line 168 of file Particle.cc.

References eta_.

Referenced by Particle.Particle::__str__(), Muon.Muon::absEffAreaIso(), DQMExample_Step1::analyze(), Jet.Jet::jetID(), and Jet.Jet::puJetId().

                           {
    return eta_;
}

bool Particle::longLived

(

)

const

is long lived?

Definition at line 266 of file Particle.cc.

References longLivedTag, and status_.

                               {
    return status_ & longLivedTag;
}

double Particle::mass

(

)

const

mass

Definition at line 122 of file Particle.cc.

References mass_.

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

                            {
    return mass_;
}

double Particle::massSqr

(

)

const

mass squared

Definition at line 126 of file Particle.cc.

References mass_.

                               {
    return mass_ * mass_;
}

Particle::Vector Particle::momentum

(

)

const

spatial momentum vector

Definition at line 96 of file Particle.cc.

References cacheCartesian(), and p4Cartesian_.

                                        {
    cacheCartesian();
    return (*p4Cartesian_.load(std::memory_order_acquire)).Vect();
}

double Particle::mt

(

)

const

transverse mass

Definition at line 130 of file Particle.cc.

References cachePolar(), and p4Polar_.

                          {
    cachePolar();
    return (*p4Polar_.load(std::memory_order_acquire)).Mt();
}

double Particle::mtSqr

(

)

const

transverse mass squared

Definition at line 135 of file Particle.cc.

References cachePolar(), and p4Polar_.

                             {
    cachePolar();
    return (*p4Polar_.load(std::memory_order_acquire)).Mt2();
}

Particle & Particle::operator=

(

const Particle &

rhs

)

Definition at line 42 of file Particle.cc.

References swap(), and groupFilesInBlocks::temp.

                                       {
    Particle temp(rhs);
    temp.swap(*this);
    return *this;
}

double Particle::p

(

)

const

magnitude of momentum vector

Definition at line 107 of file Particle.cc.

References cacheCartesian(), P, and p4Cartesian_.

                         {
    cacheCartesian();
    return (*p4Cartesian_.load(std::memory_order_acquire)).P();
}

const Particle::LorentzVector & Particle::p4

(

)

const

four-momentum Lorentz vector

Definition at line 86 of file Particle.cc.

References cacheCartesian(), and p4Cartesian_.

Referenced by Tau.Tau::dxy(), Tau.Tau::dz(), Jet.Jet::jetID(), TtDilepLRSignalSelObservables::operator()(), TtSemiLRJetCombObservables::operator()(), CandidateTriggerObjectProducer::produce(), ParticleReplacerZtautau::produce(), setP4(), ParticleReplacerZtautau::transformMuMu2LepLep(), and ParticleReplacerZtautau::transformMuMu2TauNu().

                                                 {
    cacheCartesian();
    return (*p4Cartesian_.load(std::memory_order_acquire));
}

int Particle::pdgId

(

)

const

PDG identifier.

Definition at line 246 of file Particle.cc.

References pdgId_.

Referenced by Particle.Particle::__str__(), DQMExample_Step1::analyze(), ParticleReplacerZtautau::produce(), setPdgId(), ParticleReplacerZtautau::transformMuMu2LepLep(), and ParticleReplacerZtautau::transformMuMu2TauNu().

                          {
    return pdgId_;
}

double Particle::phi

(

)

const

momentum azimuthal angle

Definition at line 159 of file Particle.cc.

References phi_.

Referenced by Particle.Particle::__str__(), and DQMExample_Step1::analyze().

                           {
    return phi_;
}

const Particle::PolarLorentzVector & Particle::polarP4

(

)

const

four-momentum Lorentz vector

Definition at line 91 of file Particle.cc.

References cachePolar(), and p4Polar_.

                                                           {
    cachePolar();
    return (*p4Polar_.load(std::memory_order_acquire));
}

double Particle::pt

(

)

const

transverse momentum

Definition at line 155 of file Particle.cc.

References pt_.

Referenced by Particle.Particle::__str__(), DiObject.DiMuon::__str__(), DQMExample_Step1::analyze(), IsMuMatchedToHLTSingleMu(), HTauTauElectron.HTauTauElectron::looseIdForTriLeptonVeto(), Electron.Electron::mvaIDLoose(), Electron.Electron::mvaIDTight(), Lepton.Lepton::relEffAreaIso(), and Lepton.Lepton::relIso().

                          {
    return pt_;
}

double Particle::px

(

)

const

x coordinate of momentum vector

Definition at line 140 of file Particle.cc.

References cacheCartesian(), and p4Cartesian_.

Referenced by ParticleReplacerZtautau::produce().

                          {
    cacheCartesian();
    return (*p4Cartesian_.load(std::memory_order_acquire)).Px();
}

double Particle::py

(

)

const

y coordinate of momentum vector

Definition at line 145 of file Particle.cc.

References cacheCartesian(), and p4Cartesian_.

Referenced by ParticleReplacerZtautau::produce().

                          {
    cacheCartesian();
    return (*p4Cartesian_.load(std::memory_order_acquire)).Py();
}

double Particle::pz

(

)

const

z coordinate of momentum vector

Definition at line 150 of file Particle.cc.

References cacheCartesian(), and p4Cartesian_.

Referenced by ParticleReplacerZtautau::produce().

                          {
    cacheCartesian();
    return (*p4Cartesian_.load(std::memory_order_acquire)).Pz();
}

double Particle::rapidity

(

)

const

repidity

Definition at line 172 of file Particle.cc.

References cachePolar(), and p4Polar_.

Referenced by y().

                                {
    cachePolar();
    return (*p4Polar_.load(std::memory_order_acquire)).Rapidity();
}

void Particle::setCharge

(

Charge

q

)

set electric charge

Definition at line 74 of file Particle.cc.

References qx3_.

                                   {
    qx3_ = q * 3;
}

void Particle::setLongLived

(

)

set long lived flag

Definition at line 262 of file Particle.cc.

References longLivedTag, and status_.

                            {
    status_ |= longLivedTag;
}

void Particle::setMass

(

double

m

)

set particle mass

Definition at line 208 of file Particle.cc.

References clearCache(), m, and mass_.

                                 {
    mass_ = m;
    clearCache();
}

void Particle::setP4

(

const LorentzVector &

p4

)

set 4-momentum

Definition at line 182 of file Particle.cc.

References cacheCartesian(), cachePolar(), eta_, mass_, p4(), p4Cartesian_, p4Polar_, phi_, and pt_.

Referenced by ParticleReplacerZtautau::transformMuMu2LepLep(), and ParticleReplacerZtautau::transformMuMu2TauNu().

                                               {
    // ensure that we have non-null pointers
    cacheCartesian();
    *p4Cartesian_.load(std::memory_order_acquire) = p4;
    // ensure that we have non-null pointers
    cachePolar();
    *p4Polar_.load(std::memory_order_acquire) = p4;
    auto const* p4Polar = p4Polar_.load(std::memory_order_acquire);
    pt_ = p4Polar->pt();
    eta_ = p4Polar->eta();
    phi_ = p4Polar->phi();
    mass_ = p4Polar->mass();
}

void Particle::setP4

(

const PolarLorentzVector &

p4

)

set 4-momentum

Definition at line 196 of file Particle.cc.

References cachePolar(), eta_, mass_, p4(), p4Cartesian_, p4Polar_, phi_, and pt_.

                                                    {
    // ensure that we have non-null pointers
    cachePolar();
    *p4Polar_.load(std::memory_order_acquire) = p4;
    auto const* p4Polar = p4Polar_.load(std::memory_order_acquire);
    pt_ = p4Polar->pt();
    eta_ = p4Polar->eta();
    phi_ = p4Polar->phi();
    mass_ = p4Polar->mass();
    delete p4Cartesian_.exchange(nullptr, std::memory_order_acq_rel);
}

void Particle::setPdgId

(

int

pdgId

)

Definition at line 250 of file Particle.cc.

References pdgId(), and pdgId_.

Referenced by TtDilepEvtSolution::getLeptNeg(), TtDilepEvtSolution::getLeptPos(), ParticleReplacerZtautau::transformMuMu2LepLep(), and ParticleReplacerZtautau::transformMuMu2TauNu().

                                   {
    pdgId_ = pdgId;
}

void Particle::setPz

(

double

pz

)

set Pz

Definition at line 212 of file Particle.cc.

References cacheCartesian(), cachePolar(), eta_, mass_, p4Cartesian_, p4Polar_, phi_, and pt_.

                                {
    // ensure that we have non-null pointers
    cacheCartesian();
    (*p4Cartesian_.load(std::memory_order_acquire)).SetPz(pz);
    // ensure that we have non-null pointers
    cachePolar();
    (*p4Polar_.load(std::memory_order_acquire)) = (*p4Cartesian_.load(std::memory_order_acquire));
    auto const* p4Polar = p4Polar_.load(std::memory_order_acquire);
    pt_ = p4Polar->pt();
    eta_ = p4Polar->eta();
    phi_ = p4Polar->phi();
    mass_ = p4Polar->mass();
}

void Particle::setStatus

(

int

status

)

set status word

Definition at line 258 of file Particle.cc.

References status(), and status_.

Referenced by ParticleReplacerZtautau::produce(), ParticleReplacerZtautau::transformMuMu2LepLep(), and ParticleReplacerZtautau::transformMuMu2TauNu().

                                     {
    status_ = status;
}

void Particle::setThreeCharge

(

Charge

qx3

)

set electric charge

Definition at line 82 of file Particle.cc.

References qx3_.

                                          {
    qx3_ = qx3;
}

void Particle::setVertex

(

const Point &

vertex

)

set vertex

Definition at line 242 of file Particle.cc.

References vertex(), and vertex_.

                                               {
    vertex_ = vertex;
}

int Particle::status

(

)

const

status word

Definition at line 254 of file Particle.cc.

References status_.

Referenced by setStatus().

                           {
    return status_;
}

void Particle::swap

(

Particle &

other

)

Definition at line 48 of file Particle.cc.

References eta_, mass_, p4Cartesian_, p4Polar_, pdgId_, phi_, pt_, qx3_, status_, std::swap(), and vertex_.

Referenced by operator=().

                                   {
    std::swap(qx3_, other.qx3_);
    std::swap(pt_, other.pt_);
    std::swap(eta_, other.eta_);
    std::swap(phi_, other.phi_);
    std::swap(mass_, other.mass_);
    std::swap(vertex_, other.vertex_);
    std::swap(pdgId_, other.pdgId_);
    std::swap(status_, other.status_);
    other.p4Polar_.exchange(
            p4Polar_.exchange(other.p4Polar_, std::memory_order_acq_rel),
            std::memory_order_acq_rel);
    other.p4Cartesian_.exchange(
            p4Cartesian_.exchange(other.p4Cartesian_, std::memory_order_acq_rel),
            std::memory_order_acq_rel);
}

double Particle::theta

(

)

const

momentum polar angle

Definition at line 163 of file Particle.cc.

References cacheCartesian(), and p4Cartesian_.

Referenced by Tau.Tau::zImpact().

                             {
    cacheCartesian();
    return (*p4Cartesian_.load(std::memory_order_acquire)).Theta();
}

int Particle::threeCharge

(

)

const

electric charge

Definition at line 78 of file Particle.cc.

References qx3_.

                                {
    return qx3_;
}

const Particle::Point & Particle::vertex

(

)

const

vertex position

Definition at line 226 of file Particle.cc.

References vertex_.

Referenced by Tau.Tau::dxy(), Tau.Tau::dz(), ParticleReplacerZtautau::produce(), and setVertex().

                                             {
    return vertex_;
}

double Particle::vx

(

)

const

x coordinate of vertex position

Definition at line 230 of file Particle.cc.

References vertex_.

Referenced by ParticleReplacerParticleGun::produce().

                          {
    return vertex_.X();
}

double Particle::vy

(

)

const

y coordinate of vertex position

Definition at line 234 of file Particle.cc.

References vertex_.

Referenced by ParticleReplacerParticleGun::produce().

                          {
    return vertex_.Y();
}

double Particle::vz

(

)

const

z coordinate of vertex position

Definition at line 238 of file Particle.cc.

References vertex_.

Referenced by ParticleReplacerParticleGun::produce().

                          {
    return vertex_.Z();
}

double Particle::y

(

)

const

repidity

Definition at line 177 of file Particle.cc.

References rapidity().

Referenced by svgfig.Ellipse::__repr__(), Vispa.Gui.WidgetContainer.WidgetContainer::autosize(), Vispa.Gui.VispaWidget.VispaWidget::boundingRect(), geometryXMLparser.Alignable::pos(), and Vispa.Gui.ConnectableWidget.ConnectableWidget::positionizeMenuWidget().

                         {
    return rapidity();
}

Member Data Documentation

float reco::Particle::eta_

protected

Definition at line 135 of file Particle.h.

Referenced by cachePolar(), eta(), setP4(), setPz(), and swap().

const unsigned int Particle::longLivedTag = 65536

static

long lived flag

Definition at line 125 of file Particle.h.

Referenced by longLived(), and setLongLived().

float reco::Particle::mass_

protected

Definition at line 135 of file Particle.h.

Referenced by cachePolar(), mass(), massSqr(), setMass(), setP4(), setPz(), and swap().

std::atomic<LorentzVector*> reco::Particle::p4Cartesian_

mutableprotected

internal cache for p4

Definition at line 146 of file Particle.h.

Referenced by boostToCM(), cacheCartesian(), clearCache(), energy(), momentum(), p(), p4(), px(), py(), pz(), setP4(), setPz(), swap(), and theta().

std::atomic<PolarLorentzVector*> reco::Particle::p4Polar_

mutableprotected

internal cache for p4

Definition at line 144 of file Particle.h.

Referenced by cacheCartesian(), cachePolar(), clearCache(), et(), mt(), mtSqr(), polarP4(), rapidity(), setP4(), setPz(), and swap().

int reco::Particle::pdgId_

protected

PDG identifier.

Definition at line 139 of file Particle.h.

Referenced by pdgId(), setPdgId(), and swap().

float reco::Particle::phi_

protected

Definition at line 135 of file Particle.h.

Referenced by cachePolar(), phi(), setP4(), setPz(), and swap().

float reco::Particle::pt_

protected

four-momentum Lorentz vector

Definition at line 135 of file Particle.h.

Referenced by cachePolar(), pt(), setP4(), setPz(), and swap().

Charge reco::Particle::qx3_

protected

electric charge

Definition at line 133 of file Particle.h.

Referenced by charge(), Particle(), setCharge(), setThreeCharge(), swap(), and threeCharge().

int reco::Particle::status_

protected

status word

Definition at line 141 of file Particle.h.

Referenced by longLived(), setLongLived(), setStatus(), status(), and swap().

Point reco::Particle::vertex_

protected

vertex position

Definition at line 137 of file Particle.h.

Referenced by setVertex(), swap(), vertex(), vx(), vy(), and vz().