Page MenuHomeHEPForge
Files F19251376

Particle.hh
No OneTemporary
Actions

Size
10 KB
Referenced Files
None
Subscribers
None

Particle.hh
View Options

// -*- C++ -*-
#ifndef RIVET_Particle_HH
#define RIVET_Particle_HH
#include "Rivet/Rivet.hh"
#include "Rivet/Particle.fhh"
#include "Rivet/ParticleBase.hh"
#include "Rivet/ParticleName.hh"
#include "Rivet/Math/Vectors.hh"
#include "Rivet/Tools/Logging.hh"
namespace Rivet {
/// Representation of particles from a HepMC::GenEvent.
class Particle : public ParticleBase {
public:
/// Default constructor.
/// @deprecated A particle without info is useless. This only exists to keep STL containers happy.
Particle()
: ParticleBase(),
_original(0), _id(0), _momentum()
{ }
/// Constructor without GenParticle.
Particle(PdgId pid, const FourMomentum& mom)
: ParticleBase(),
_original(0), _id(pid), _momentum(mom)
{ }
/// Constructor from a HepMC GenParticle.
Particle(const GenParticle& gp)
: ParticleBase(),
_original(&gp), _id(gp.pdg_id()),
_momentum(gp.momentum())
{ }
/// Constructor from a HepMC GenParticle pointer.
Particle(const GenParticle* gp)
: ParticleBase(),
_original(gp), _id(gp->pdg_id()),
_momentum(gp->momentum())
{ }
public:
/// Get a const reference to the original GenParticle.
const GenParticle* genParticle() const {
return _original;
}
/// The PDG ID code for this Particle.
PdgId pdgId() const {
return _id;
}
/// Set the momentum of this Particle.
Particle& setMomentum(const FourMomentum& momentum) {
_momentum = momentum;
return *this;
}
/// The momentum of this Particle.
const FourMomentum& momentum() const {
return _momentum;
}
/// The energy of this Particle.
double energy() const {
return momentum().E();
}
/// The mass of this Particle.
double mass() const {
return momentum().mass();
}
/// @todo Enable?
// /// The charge of this Particle.
// double charge() const {
// return PID::charge(*this);
// }
/// @todo Enable?
// /// Three times the charge of this Particle (i.e. integer multiple of smallest quark charge).
// int threeCharge() const {
// return PID::threeCharge(*this);
// }
/// Check whether a given PID is found in the GenParticle's ancestor list
///
/// @note This question is valid in MC, but may not be answerable
/// experimentally -- use this function with care when replicating
/// experimental analyses!
bool hasAncestor(PdgId pdg_id) const;
/// @brief Determine whether the particle is from a hadron or tau decay
///
/// Specifically, walk up the ancestor chain until a status 2 hadron or
/// tau is found, if at all.
///
/// @note This question is valid in MC, but may not be answerable
/// experimentally -- use this function with care when replicating
/// experimental analyses!
bool fromDecay() const;
/// @todo Add methods like fromS/C/BHadron(), fromTau()?
private:
/// A pointer to the original GenParticle from which this Particle is projected.
const GenParticle* _original;
/// The PDG ID code for this Particle.
PdgId _id;
/// The momentum of this projection of the Particle.
FourMomentum _momentum;
/// @todo Also store production and decay positions and make them available.
};
/// @name String representation
//@{
/// Print a ParticlePair as a string.
inline std::string toString(const ParticlePair& pair) {
stringstream out;
out << "["
<< PID::toParticleName(pair.first.pdgId()) << " @ "
<< pair.first.momentum().E()/GeV << " GeV, "
<< PID::toParticleName(pair.second.pdgId()) << " @ "
<< pair.second.momentum().E()/GeV << " GeV]";
return out.str();
}
/// Allow ParticlePair to be passed to an ostream.
inline std::ostream& operator<<(std::ostream& os, const ParticlePair& pp) {
os << toString(pp);
return os;
}
//@}
/// @name Comparison functors
//@{
/// Sort by descending transverse momentum, \f$ p_\perp \f$
inline bool cmpParticleByPt(const Particle& a, const Particle& b) {
return a.momentum().pT() > b.momentum().pT();
}
/// Sort by ascending transverse momentum, \f$ p_\perp \f$
inline bool cmpParticleByAscPt(const Particle& a, const Particle& b) {
return a.momentum().pT() < b.momentum().pT();
}
/// Sort by descending momentum, \f$ p \f$
inline bool cmpParticleByP(const Particle& a, const Particle& b) {
return a.momentum().vector3().mod() > b.momentum().vector3().mod();
}
/// Sort by ascending momentum, \f$ p \f$
inline bool cmpParticleByAscP(const Particle& a, const Particle& b) {
return a.momentum().vector3().mod() < b.momentum().vector3().mod();
}
/// Sort by descending transverse energy, \f$ E_\perp \f$
inline bool cmpParticleByEt(const Particle& a, const Particle& b) {
return a.momentum().Et() > b.momentum().Et();
}
/// Sort by ascending transverse energy, \f$ E_\perp \f$
inline bool cmpParticleByAscEt(const Particle& a, const Particle& b) {
return a.momentum().Et() < b.momentum().Et();
}
/// Sort by descending energy, \f$ E \f$
inline bool cmpParticleByE(const Particle& a, const Particle& b) {
return a.momentum().E() > b.momentum().E();
}
/// Sort by ascending energy, \f$ E \f$
inline bool cmpParticleByAscE(const Particle& a, const Particle& b) {
return a.momentum().E() < b.momentum().E();
}
/// Sort by descending pseudorapidity, \f$ \eta \f$
inline bool cmpParticleByDescPseudorapidity(const Particle& a, const Particle& b) {
return a.momentum().pseudorapidity() > b.momentum().pseudorapidity();
}
/// Sort by ascending pseudorapidity, \f$ \eta \f$
inline bool cmpParticleByAscPseudorapidity(const Particle& a, const Particle& b) {
return a.momentum().pseudorapidity() < b.momentum().pseudorapidity();
}
/// Sort by descending absolute pseudorapidity, \f$ |\eta| \f$
inline bool cmpParticleByDescAbsPseudorapidity(const Particle& a, const Particle& b) {
return fabs(a.momentum().pseudorapidity()) > fabs(b.momentum().pseudorapidity());
}
/// Sort by ascending absolute pseudorapidity, \f$ |\eta| \f$
inline bool cmpParticleByAscAbsPseudorapidity(const Particle& a, const Particle& b) {
return fabs(a.momentum().pseudorapidity()) < fabs(b.momentum().pseudorapidity());
}
/// Sort by descending rapidity, \f$ y \f$
inline bool cmpParticleByDescRapidity(const Particle& a, const Particle& b) {
return a.momentum().rapidity() > b.momentum().rapidity();
}
/// Sort by ascending rapidity, \f$ y \f$
inline bool cmpParticleByAscRapidity(const Particle& a, const Particle& b) {
return a.momentum().rapidity() < b.momentum().rapidity();
}
/// Sort by descending absolute rapidity, \f$ |y| \f$
inline bool cmpParticleByDescAbsRapidity(const Particle& a, const Particle& b) {
return fabs(a.momentum().rapidity()) > fabs(b.momentum().rapidity());
}
/// Sort by ascending absolute rapidity, \f$ |y| \f$
inline bool cmpParticleByAscAbsRapidity(const Particle& a, const Particle& b) {
return fabs(a.momentum().rapidity()) < fabs(b.momentum().rapidity());
}
//@}
inline double deltaR(const Particle& p1, const Particle& p2,
RapScheme scheme = PSEUDORAPIDITY) {
return deltaR(p1.momentum(), p2.momentum(), scheme);
}
inline double deltaR(const Particle& p, const FourMomentum& v,
RapScheme scheme = PSEUDORAPIDITY) {
return deltaR(p.momentum(), v, scheme);
}
inline double deltaR(const Particle& p, const FourVector& v,
RapScheme scheme = PSEUDORAPIDITY) {
return deltaR(p.momentum(), v, scheme);
}
inline double deltaR(const Particle& p, const Vector3& v) {
return deltaR(p.momentum(), v);
}
inline double deltaR(const Particle& p, double eta, double phi) {
return deltaR(p.momentum(), eta, phi);
}
inline double deltaR(const FourMomentum& v, const Particle& p,
RapScheme scheme = PSEUDORAPIDITY) {
return deltaR(v, p.momentum(), scheme);
}
inline double deltaR(const FourVector& v, const Particle& p,
RapScheme scheme = PSEUDORAPIDITY) {
return deltaR(v, p.momentum(), scheme);
}
inline double deltaR(const Vector3& v, const Particle& p) {
return deltaR(v, p.momentum());
}
inline double deltaR(double eta, double phi, const Particle& p) {
return deltaR(eta, phi, p.momentum());
}
inline double deltaPhi(const Particle& p1, const Particle& p2) {
return deltaPhi(p1.momentum(), p2.momentum());
}
inline double deltaPhi(const Particle& p, const FourMomentum& v) {
return deltaPhi(p.momentum(), v);
}
inline double deltaPhi(const Particle& p, const FourVector& v) {
return deltaPhi(p.momentum(), v);
}
inline double deltaPhi(const Particle& p, const Vector3& v) {
return deltaPhi(p.momentum(), v);
}
inline double deltaPhi(const Particle& p, double phi) {
return deltaPhi(p.momentum(), phi);
}
inline double deltaPhi(const FourMomentum& v, const Particle& p) {
return deltaPhi(v, p.momentum());
}
inline double deltaPhi(const FourVector& v, const Particle& p) {
return deltaPhi(v, p.momentum());
}
inline double deltaPhi(const Vector3& v, const Particle& p) {
return deltaPhi(v, p.momentum());
}
inline double deltaPhi(double phi, const Particle& p) {
return deltaPhi(phi, p.momentum());
}
inline double deltaEta(const Particle& p1, const Particle& p2) {
return deltaEta(p1.momentum(), p2.momentum());
}
inline double deltaEta(const Particle& p, const FourMomentum& v) {
return deltaEta(p.momentum(), v);
}
inline double deltaEta(const Particle& p, const FourVector& v) {
return deltaEta(p.momentum(), v);
}
inline double deltaEta(const Particle& p, const Vector3& v) {
return deltaEta(p.momentum(), v);
}
inline double deltaEta(const Particle& p, double eta) {
return deltaEta(p.momentum(), eta);
}
inline double deltaEta(const FourMomentum& v, const Particle& p) {
return deltaEta(v, p.momentum());
}
inline double deltaEta(const FourVector& v, const Particle& p) {
return deltaEta(v, p.momentum());
}
inline double deltaEta(const Vector3& v, const Particle& p) {
return deltaEta(v, p.momentum());
}
inline double deltaEta(double eta, const Particle& p) {
return deltaEta(eta, p.momentum());
}
}
#endif

File Metadata

Mime Type
text/x-c
Expires
Tue, Sep 30, 5:50 AM (1 d, 12 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
6566390
Default Alt Text
Particle.hh (10 KB)

Event Timeline

HEPForge.org · .