Representation of particles from a HepMC::GenEvent. More...

#include <Particle.hh>

Inheritance diagram for Particle:

Collaboration diagram for Particle:

Public Member Functions
	Particle ()
	Particle (PdgId pid, const FourMomentum &mom)
	Constructor without GenParticle.
	Particle (const GenParticle &gp)
	Constructor from a HepMC GenParticle.
	Particle (const GenParticle *gp)
	Constructor from a HepMC GenParticle pointer.
Basic particle specific properties
const GenParticle *	genParticle () const
	Get a const reference to the original GenParticle.
	operator const GenParticle * () const
	Cast operator for conversion to GenParticle*.
const FourMomentum &	momentum () const
	The momentum.
Particle &	setMomentum (const FourMomentum &momentum)
	Set the momentum.
Particle ID code accessors
PdgId	pid () const
	This Particle's PDG ID code.
PdgId	abspid () const
	Absolute value of the PDG ID code.
PdgId	pdgId () const
Particle species properties
double	charge () const
	The charge of this Particle.
int	threeCharge () const
	Three times the charge of this Particle (i.e. integer multiple of smallest quark charge).
bool	isHadron () const
	Is this a hadron?
bool	isMeson () const
	Is this a meson?
bool	isBaryon () const
	Is this a baryon?
bool	isLepton () const
	Is this a lepton?
bool	isNeutrino () const
	Is this a neutrino?
bool	hasBottom () const
	Does this (hadron) contain a b quark?
bool	hasCharm () const
	Does this (hadron) contain a c quark?
Ancestry properties
bool	hasAncestor (PdgId pdg_id) const
bool	fromDecay () const
	Determine whether the particle is from a hadron or tau decay.
bool	fromBottom () const
	Determine whether the particle is from a b-hadron decay.
bool	fromCharm () const
	Determine whether the particle is from a c-hadron decay.
bool	fromTau () const
	Determine whether the particle is from a tau decay.
Effective momentum accessors
	operator const FourMomentum & () const
	Cast operator for conversion to FourMomentum.
Convenience access to the effective 4-vector properties
Todo: Add a cast operator to FJ3 PseudoJet
double	E () const
	Get the energy directly.
double	energy () const
	Get the energy directly (alias).
double	pt () const
	Get the directly.
double	pT () const
	Get the directly (alias).
double	perp () const
	Get the directly (alias).
double	Et () const
	Get the directly.
double	mass () const
	Get the mass directly.
double	mass2 () const
	Get the mass**2 directly.
double	pseudorapidity () const
	Get the $\eta$ directly.
double	eta () const
	Get the $\eta$ directly (alias).
double	abspseudorapidity () const
	Get the $\|\eta\|$ directly.
double	abseta () const
	Get the $\|\eta\|$ directly (alias).
double	rapidity () const
	Get the directly.
double	rap () const
	Get the directly (alias).
double	absrapidity () const
	Get the directly.
double	absrap () const
	Get the directly (alias).
double	phi () const
	Get the $\phi$ directly.
Private Attributes
const GenParticle *	_original
	A pointer to the original GenParticle from which this Particle is projected.
PdgId	_id
	The PDG ID code for this Particle.
FourMomentum	_momentum
	The momentum of this projection of the Particle.

Detailed Description

Representation of particles from a HepMC::GenEvent.

Definition at line 17 of file Particle.hh.

Constructor & Destructor Documentation

Particle ( ) [inline]

Default constructor.

Deprecated:: A particle without info is useless. This only exists to keep STL containers happy.

Definition at line 22 of file Particle.hh.

      : ParticleBase(),
        _original(0), _id(0), _momentum()
    { }

Particle	(	PdgId	pid,
		const FourMomentum &	mom
	)		`[inline]`

Constructor without GenParticle.

Definition at line 28 of file Particle.hh.

      : ParticleBase(),
        _original(0), _id(pid), _momentum(mom)
    { }

Particle ( const GenParticle & gp ) [inline]

Constructor from a HepMC GenParticle.

Definition at line 34 of file Particle.hh.

      : ParticleBase(),
        _original(&gp), _id(gp.pdg_id()),
        _momentum(gp.momentum())
    { }

Particle ( const GenParticle * gp ) [inline]

Constructor from a HepMC GenParticle pointer.

Definition at line 41 of file Particle.hh.

      : ParticleBase(),
        _original(gp), _id(gp->pdg_id()),
        _momentum(gp->momentum())
    { }

Member Function Documentation

double abseta ( ) const [inline, inherited]

Get the $|\eta|$ directly (alias).

Definition at line 68 of file ParticleBase.hh.

References FourVector::abseta(), and ParticleBase::momentum().

Referenced by ATLAS_2011_S9225137::analyze().

{ return momentum().abseta(); }

PdgId abspid ( ) const [inline]

Absolute value of the PDG ID code.

Definition at line 80 of file Particle.hh.

References Particle::_id.

Referenced by LHCB_2013_I1218996::analyze().

{ return _id; }

double abspseudorapidity ( ) const [inline, inherited]

Get the $|\eta|$ directly.

Definition at line 66 of file ParticleBase.hh.

References FourVector::abspseudorapidity(), and ParticleBase::momentum().

{ return momentum().abspseudorapidity(); }

double absrap ( ) const [inline, inherited]

Get the $ |y| $ directly (alias).

Definition at line 77 of file ParticleBase.hh.

References FourMomentum::absrap(), and ParticleBase::momentum().

Referenced by ATLAS_2011_I930220::analyze(), and LHCB_2013_I1218996::analyze().

{ return momentum().absrap(); }

double absrapidity ( ) const [inline, inherited]

Get the $ |y| $ directly.

Definition at line 75 of file ParticleBase.hh.

References FourMomentum::absrapidity(), and ParticleBase::momentum().

{ return momentum().absrapidity(); }

double charge ( ) const [inline]

The charge of this Particle.

Definition at line 93 of file Particle.hh.

References Particle::pdgId().

Referenced by NeutralFinalState::project().

                          {
      return PID::charge(pdgId());
    }

double E ( ) const [inline, inherited]

Get the energy directly.

Definition at line 42 of file ParticleBase.hh.

References FourMomentum::E(), and ParticleBase::momentum().

Referenced by Jet::hadronicEnergy(), and Jet::neutralEnergy().

{ return momentum().E(); }

double energy ( ) const [inline, inherited]

Get the energy directly (alias).

Definition at line 44 of file ParticleBase.hh.

References FourMomentum::E(), and ParticleBase::momentum().

{ return momentum().E(); }

double Et ( ) const [inline, inherited]

Get the $ E_T $ directly.

Definition at line 54 of file ParticleBase.hh.

References FourMomentum::Et(), and ParticleBase::momentum().

Referenced by CDF_2004_S5839831::analyze(), CentralEtHCM::project(), and NeutralFinalState::project().

{ return momentum().Et(); }

double eta ( ) const [inline, inherited]

Get the $\eta$ directly (alias).

Definition at line 64 of file ParticleBase.hh.

References FourVector::eta(), and ParticleBase::momentum().

{ return momentum().eta(); }

bool fromBottom ( ) const

Determine whether the particle is from a b-hadron decay.

Note:: This question is valid in MC, but may not be perfectly answerable experimentally -- use this function with care when replicating experimental analyses!

Todo:: Shouldn't a const vertex be being returned? Ah, HepMC...

Definition at line 34 of file Particle.cc.

References Particle::genParticle(), Particle::hasBottom(), Particle::isHadron(), Rivet::particles(), and Particle::pid().

Referenced by LHCB_2013_I1218996::analyze().

                                  {
    /// @todo Shouldn't a const vertex be being returned? Ah, HepMC...
    GenVertex* prodVtx = genParticle()->production_vertex();
    if (prodVtx == NULL) return false;
    foreach (const GenParticle* ancestor, particles(prodVtx, HepMC::ancestors)) {
      const PdgId pid = ancestor->pdg_id();
      if (ancestor->status() == 2 && (PID::isHadron(pid) && PID::hasBottom(pid))) return true;
    }
    return false;
  }

bool fromCharm ( ) const

Determine whether the particle is from a c-hadron decay.

Note:: If a hadron contains b and c quarks it is considered a bottom hadron and NOT a charm hadron.; This question is valid in MC, but may not be perfectly answerable experimentally -- use this function with care when replicating experimental analyses!

Todo:: Shouldn't a const vertex be being returned? Ah, HepMC...

Definition at line 46 of file Particle.cc.

References Particle::genParticle(), Particle::hasBottom(), Particle::hasCharm(), Particle::isHadron(), Rivet::particles(), and Particle::pid().

                                 {
    /// @todo Shouldn't a const vertex be being returned? Ah, HepMC...
    GenVertex* prodVtx = genParticle()->production_vertex();
    if (prodVtx == NULL) return false;
    foreach (const GenParticle* ancestor, particles(prodVtx, HepMC::ancestors)) {
      const PdgId pid = ancestor->pdg_id();
      if (ancestor->status() == 2 && (PID::isHadron(pid) && PID::hasCharm(pid) && !PID::hasBottom(pid))) return true;
    }
    return false;
  }

bool fromDecay ( ) const

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 perfectly answerable experimentally -- use this function with care when replicating experimental analyses!

Todo:: Shouldn't a const vertex be being returned? Ah, HepMC...

Definition at line 22 of file Particle.cc.

References Particle::genParticle(), Particle::isHadron(), Rivet::particles(), Particle::pid(), and Rivet::PID::TAU.

Referenced by DressedLeptons::project().

                                 {
    /// @todo Shouldn't a const vertex be being returned? Ah, HepMC...
    GenVertex* prodVtx = genParticle()->production_vertex();
    if (prodVtx == NULL) return false;
    foreach (const GenParticle* ancestor, particles(prodVtx, HepMC::ancestors)) {
      const PdgId pid = ancestor->pdg_id();
      if (ancestor->status() == 2 && (PID::isHadron(pid) || abs(pid) == PID::TAU)) return true;
    }
    return false;
  }

bool fromTau ( ) const

Determine whether the particle is from a tau decay.

Note:: This question is valid in MC, but may not be perfectly answerable experimentally -- use this function with care when replicating experimental analyses!

Todo:: Shouldn't a const vertex be being returned? Ah, HepMC...

Definition at line 58 of file Particle.cc.

References Particle::genParticle(), Rivet::particles(), Particle::pid(), and Rivet::PID::TAU.

                               {
    /// @todo Shouldn't a const vertex be being returned? Ah, HepMC...
    GenVertex* prodVtx = genParticle()->production_vertex();
    if (prodVtx == NULL) return false;
    foreach (const GenParticle* ancestor, particles(prodVtx, HepMC::ancestors)) {
      const PdgId pid = ancestor->pdg_id();
      if (ancestor->status() == 2 && abs(pid) == PID::TAU) return true;
    }
    return false;
  }

const GenParticle* genParticle ( ) const [inline]

Get a const reference to the original GenParticle.

Definition at line 54 of file Particle.hh.

References Particle::_original.

Referenced by FinalState::accept(), BABAR_2003_I593379::analyze(), BABAR_2005_S6181155::analyze(), BELLE_2001_S4598261::analyze(), BELLE_2006_S6265367::analyze(), ARGUS_1993_S2653028::analyze(), H1_2000_S4129130::analyze(), ARGUS_1993_S2669951::analyze(), H1_1994_S2919893::analyze(), BABAR_2007_S7266081::analyze(), ATLAS_2011_S8994773::analyze(), ATLAS_2011_S9035664::analyze(), CDF_2008_S7540469::analyze(), D0_2010_S8570965::analyze(), ARGUS_1993_S2789213::analyze(), ATLAS_2010_S8894728::analyze(), InvMassFinalState::calc(), Jet::containsBottom(), Jet::containsCharm(), Jet::containsParticle(), ATLAS_2011_I944826::daughtersSurviveCuts(), Particle::fromBottom(), Particle::fromCharm(), Particle::fromDecay(), Particle::fromTau(), LHCB_2010_S8758301::getLongestLivedAncestor(), LHCB_2011_I917009::getMotherLifeTimeSum(), LHCB_2012_I1119400::getMotherLifeTimeSum(), ATLAS_2011_I944826::getPerpFlightDistance(), Particle::hasAncestor(), hasDecayedTo(), Particle::operator const GenParticle *(), MergedFinalState::project(), DISLepton::project(), DISFinalState::project(), PrimaryHadrons::project(), HeavyHadrons::project(), and VetoedFinalState::project().

                                           {
      return _original;
    }

bool hasAncestor ( PdgId pdg_id ) const

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!

Todo:: Neaten this up with C++11, via one waliker function and several uses with lamba tests

Todo:: Shouldn't a const vertex be being returned? Ah, HepMC...

Definition at line 11 of file Particle.cc.

References Particle::genParticle(), and Rivet::particles().

Referenced by ALICE_2011_S8909580::analyze(), ALICE_2011_S8945144::analyze(), and CMS_2011_S8978280::analyze().

                                               {
    /// @todo Shouldn't a const vertex be being returned? Ah, HepMC...
    GenVertex* prodVtx = genParticle()->production_vertex();
    if (prodVtx == 0) return false;
    foreach (const GenParticle* ancestor, particles(prodVtx, HepMC::ancestors)) {
      if (ancestor->pdg_id() == pdg_id) return true;
    }
    return false;
  }

bool hasBottom ( ) const [inline]

Does this (hadron) contain a b quark?

Definition at line 117 of file Particle.hh.

References Particle::pdgId().

Referenced by Particle::fromBottom(), and Particle::fromCharm().

{ return PID::hasBottom(pdgId()); }

bool hasCharm ( ) const [inline]

Does this (hadron) contain a c quark?

Definition at line 120 of file Particle.hh.

References Particle::pdgId().

Referenced by LHCB_2013_I1218996::analyze(), and Particle::fromCharm().

{ return PID::hasCharm(pdgId()); }

bool isBaryon ( ) const [inline]

Is this a baryon?

Definition at line 108 of file Particle.hh.

References Particle::pdgId().

{ return PID::isBaryon(pdgId()); }

bool isHadron ( ) const [inline]

Is this a hadron?

Definition at line 102 of file Particle.hh.

References Particle::pdgId().

Referenced by LHCB_2013_I1218996::analyze(), Particle::fromBottom(), Particle::fromCharm(), and Particle::fromDecay().

{ return PID::isHadron(pdgId()); }

bool isLepton ( ) const [inline]

Is this a lepton?

Definition at line 111 of file Particle.hh.

References Particle::pdgId().

{ return PID::isLepton(pdgId()); }

bool isMeson ( ) const [inline]

Is this a meson?

Definition at line 105 of file Particle.hh.

References Particle::pdgId().

{ return PID::isMeson(pdgId()); }

bool isNeutrino ( ) const [inline]

Is this a neutrino?

Definition at line 114 of file Particle.hh.

References Particle::pdgId().

{ return PID::isNeutrino(pdgId()); }

double mass ( ) const [inline, inherited]

Get the mass directly.

Definition at line 57 of file ParticleBase.hh.

References FourMomentum::mass(), and ParticleBase::momentum().

Referenced by ALICE_2011_S8945144::analyze().

{ return momentum().mass(); }

double mass2 ( ) const [inline, inherited]

Get the mass**2 directly.

Definition at line 59 of file ParticleBase.hh.

References FourMomentum::mass2(), and ParticleBase::momentum().

{ return momentum().mass2(); }

const FourMomentum& momentum ( ) const [inline, virtual]

The momentum.

Implements ParticleBase.

Definition at line 62 of file Particle.hh.

References Particle::_momentum.

                                         {
      return _momentum;
    }

operator const FourMomentum & ( ) const [inline, inherited]

Cast operator for conversion to FourMomentum.

Definition at line 31 of file ParticleBase.hh.

References ParticleBase::momentum().

{ return momentum(); }

operator const GenParticle * ( ) const [inline]

Cast operator for conversion to GenParticle*.

Definition at line 59 of file Particle.hh.

References Particle::genParticle().

{ return genParticle(); }

PdgId pdgId ( ) const [inline]

This Particle's PDG ID code (alias). pid/abspid form is nicer (don't need to remember lower/upper case, doesn't visually stick out in the code, etc. ...)

Definition at line 84 of file Particle.hh.

References Particle::_id.

{ return _id; }

double perp ( ) const [inline, inherited]

Get the $ p_T $ directly (alias).

Definition at line 51 of file ParticleBase.hh.

References ParticleBase::pt().

{ return pt(); }

double phi ( ) const [inline, inherited]

Get the $\phi$ directly.

Definition at line 80 of file ParticleBase.hh.

References ParticleBase::momentum(), and FourVector::phi().

Referenced by CDF_2001_S4751469::analyze().

{ return momentum().phi(); }

PdgId pid ( ) const [inline]

This Particle's PDG ID code.

Definition at line 78 of file Particle.hh.

References Particle::_id.

Referenced by Particle::fromBottom(), Particle::fromCharm(), Particle::fromDecay(), and Particle::fromTau().

{ return _id; }

double pseudorapidity ( ) const [inline, inherited]

Get the $\eta$ directly.

Definition at line 62 of file ParticleBase.hh.

References FourVector::eta(), and ParticleBase::momentum().

{ return momentum().eta(); }

double pt ( ) const [inline, inherited]

Get the $ p_T $ directly.

Definition at line 47 of file ParticleBase.hh.

References ParticleBase::momentum(), and FourMomentum::pt().

Referenced by ParticleBase::perp(), and ParticleBase::pT().

{ return momentum().pt(); }

double pT ( ) const [inline, inherited]

Get the $ p_T $ directly (alias).

Definition at line 49 of file ParticleBase.hh.

References ParticleBase::pt().

{ return pt(); }

double rap ( ) const [inline, inherited]

Get the $ y $ directly (alias).

Definition at line 73 of file ParticleBase.hh.

References ParticleBase::momentum(), and FourMomentum::rapidity().

{ return momentum().rapidity(); }

double rapidity ( ) const [inline, inherited]

Get the $ y $ directly.

Definition at line 71 of file ParticleBase.hh.

References ParticleBase::momentum(), and FourMomentum::rapidity().

{ return momentum().rapidity(); }

Particle& setMomentum ( const FourMomentum & momentum ) [inline]

Set the momentum.

Definition at line 66 of file Particle.hh.

References Particle::_momentum, and Particle::momentum().

Referenced by ClusteredLepton::addPhoton(), and DISFinalState::project().

                                                        {
      _momentum = momentum;
      return *this;
    }

int threeCharge ( ) const [inline]

Three times the charge of this Particle (i.e. integer multiple of smallest quark charge).

Definition at line 97 of file Particle.hh.

References Particle::pdgId().

                            {
      return PID::threeCharge(pdgId());
    }

Member Data Documentation

PdgId _id [private]

The PDG ID code for this Particle.

Definition at line 191 of file Particle.hh.

Referenced by Particle::abspid(), Particle::pdgId(), and Particle::pid().

FourMomentum _momentum [private]

The momentum of this projection of the Particle.

Definition at line 194 of file Particle.hh.

Referenced by Particle::momentum(), and Particle::setMomentum().

const GenParticle* _original [private]

A pointer to the original GenParticle from which this Particle is projected.

Definition at line 188 of file Particle.hh.

Referenced by Particle::genParticle().

The documentation for this class was generated from the following files:

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation