Representation of a clustered jet of particles. More...

#include <Jet.hh>

Inheritance diagram for Jet:

Collaboration diagram for Jet:

Public Member Functions
Constructors
	Jet ()
	Jet (const vector< Particle > &particles, const FourMomentum &pjet)
	Set all the jet data, with full particle information.
Access jet constituents
Todo: Add a constructor from PseudoJet
size_t	size () const
	Number of particles in this jet.
vector< Particle > &	particles ()
	Get the particles in this jet.
const vector< Particle > &	particles () const
	Get the particles in this jet (const version)
bool	containsParticle (const Particle &particle) const
	Check whether this jet contains a particular particle.
bool	containsParticleId (PdgId pid) const
	Check whether this jet contains a certain particle type.
bool	containsParticleId (const vector< PdgId > &pids) const
	Check whether this jet contains at least one of certain particle types.
bool	containsCharm () const
	Check whether this jet contains a charm-flavoured hadron (or decay products from one).
bool	containsBottom () const
	Check whether this jet contains a bottom-flavoured hadron (or decay products from one).
Access additional effective jet 4-vector properties
const FourMomentum &	momentum () const
	Get equivalent single momentum four-vector.
double	totalEnergy () const
	Get the total energy of this jet.
double	neutralEnergy () const
	Get the energy carried in this jet by neutral particles.
double	hadronicEnergy () const
	Get the energy carried in this jet by hadrons.
Set the jet constituents and properties
Jet &	setState (const vector< Particle > &particles, const FourMomentum &pjet)
	Set all the jet data, with full particle information.
Jet &	setMomentum (const FourMomentum &momentum)
	Set the effective 4-momentum of the jet.
Jet &	setParticles (const vector< Particle > &particles)
	Set the particles collection with full particle information.
Jet &	clear ()
	Reset this jet as empty.
Effective momentum accessors
const FourMomentum &	mom () const
	Get equivalent single momentum four-vector (const) (alias).
	operator const FourMomentum & () const
	Cast operator for conversion to FourMomentum.
Convenience access to the effective 4-vector properties
Todo: Add a converter and 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	pt2 () const
	Get the directly.
double	pT2 () const
	Get the directly (alias).
double	perp2 () 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	azimuthalAngle (const PhiMapping mapping=ZERO_2PI) const
	Azimuthal angle $\phi$ .
double	phi (const PhiMapping mapping=ZERO_2PI) const
	Get the $\phi$ directly.
Vector3	p3 () const
	Get the 3-momentum directly.
double	px () const
	x component of momentum.
double	py () const
	y component of momentum.
double	pz () const
	z component of momentum.
double	polarAngle () const
	Angle subtended by the 3-vector and the z-axis.
double	theta () const
	Synonym for polarAngle.
double	angle (const ParticleBase &v) const
	Angle between this vector and another.
double	angle (const FourVector &v) const
	Angle between this vector and another.
double	angle (const Vector3 &v3) const
	Angle between this vector and another (3-vector)
Private Attributes
Particles	_particles
	Full particle information including tracks, ID etc. (caching PseudoJet properties)
FourMomentum	_momentum
	Effective jet 4-vector (caching PseudoJet properties)

Detailed Description

Representation of a clustered jet of particles.

Definition at line 15 of file Jet.hh.

Constructor & Destructor Documentation

Jet ( ) [inline]

Definition at line 21 of file Jet.hh.

References Jet::clear().

: ParticleBase() { clear(); }

Jet	(	const vector< Particle > &	particles,
		const FourMomentum &	pjet
	)		`[inline]`

Set all the jet data, with full particle information.

Definition at line 24 of file Jet.hh.

References Jet::setState().

      : ParticleBase() {
      setState(particles, pjet);
    }

Member Function Documentation

double abseta ( ) const [inline, inherited]

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

Definition at line 77 of file ParticleBase.hh.

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

{ return momentum().abseta(); }

double abspseudorapidity ( ) const [inline, inherited]

Get the $|\eta|$ directly.

Definition at line 75 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 86 of file ParticleBase.hh.

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

{ return momentum().absrap(); }

double absrapidity ( ) const [inline, inherited]

Get the $ |y| $ directly.

Definition at line 84 of file ParticleBase.hh.

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

{ return momentum().absrapidity(); }

double angle ( const ParticleBase & v ) const [inline, inherited]

Angle between this vector and another.

Definition at line 112 of file ParticleBase.hh.

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

Referenced by H1_2000_S4129130::analyze(), and H1_1994_S2919893::analyze().

{ return momentum().angle(v.momentum()); }

double angle ( const FourVector & v ) const [inline, inherited]

Angle between this vector and another.

Definition at line 114 of file ParticleBase.hh.

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

{ return momentum().angle(v); }

double angle ( const Vector3 & v3 ) const [inline, inherited]

Angle between this vector and another (3-vector)

Definition at line 116 of file ParticleBase.hh.

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

{ return momentum().angle(v3); }

double azimuthalAngle ( const PhiMapping mapping = ZERO_2PI ) const [inline, inherited]

Azimuthal angle $\phi$ .

Definition at line 89 of file ParticleBase.hh.

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

Referenced by ATLAS_2012_I1112263::analyze(), ATLAS_2012_I1095236::analyze(), ATLAS_2012_I1204447::analyze(), ATLAS_2012_CONF_2012_001::analyze(), and ATLAS_2012_I943401::analyze().

{ return momentum().azimuthalAngle(mapping); }

Jet & clear ( )

Reset this jet as empty.

Definition at line 117 of file Jet.cc.

References Jet::_momentum, and Jet::_particles.

Referenced by Jet::Jet().

                  {
    //_momenta.clear();
    _particles.clear();
    _momentum = FourMomentum();
    return *this;
  }

bool containsBottom ( ) const

Check whether this jet contains a bottom-flavoured hadron (or decay products from one).

Definition at line 100 of file Jet.cc.

References Rivet::PID::BQUARK, Particle::genParticle(), Rivet::PID::hasBottom(), Rivet::PID::isHadron(), Rivet::particles(), Jet::particles(), Rivet::pi, and Particle::pid().

Referenced by CDF_2008_S7782535::analyze(), EXAMPLE::analyze(), ATLAS_2012_I1126136::analyze(), MC_TTBAR::analyze(), ATLAS_2011_CONF_2011_098::analyze(), ATLAS_2012_I1112263::analyze(), ATLAS_2012_I1095236::analyze(), and MC_VH2BB::analyze().

                                 {
    foreach (const Particle& p, particles()) {
      const PdgId pid = p.pid();
      if (abs(pid) == PID::BQUARK) return true;
      if (PID::isHadron(pid) && PID::hasBottom(pid)) return true;
      HepMC::GenVertex* gv = p.genParticle()->production_vertex();
      if (gv) {
        foreach (const GenParticle* pi, Rivet::particles(gv, HepMC::ancestors)) {
          const PdgId pid2 = pi->pdg_id();
          if (PID::isHadron(pid2) && PID::hasBottom(pid2)) return true;
        }
      }
    }
    return false;
  }

bool containsCharm ( ) const

Check whether this jet contains a charm-flavoured hadron (or decay products from one).

Definition at line 83 of file Jet.cc.

References Rivet::PID::CQUARK, Particle::genParticle(), Rivet::PID::hasCharm(), Rivet::PID::isHadron(), Rivet::particles(), Jet::particles(), Rivet::pi, and Particle::pid().

                                {
    foreach (const Particle& p, particles()) {
      const PdgId pid = p.pid();
      if (abs(pid) == PID::CQUARK) return true;
      if (PID::isHadron(pid) && PID::hasCharm(pid)) return true;
      HepMC::GenVertex* gv = p.genParticle()->production_vertex();
      if (gv) {
        foreach (const GenParticle* pi, Rivet::particles(gv, HepMC::ancestors)) {
          const PdgId pid2 = pi->pdg_id();
          if (PID::isHadron(pid2) && PID::hasCharm(pid2)) return true;
        }
      }
    }
    return false;
  }

bool containsParticle ( const Particle & particle ) const

Check whether this jet contains a particular particle.

Definition at line 29 of file Jet.cc.

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

                                                           {
    const int barcode = particle.genParticle()->barcode();
    foreach (const Particle& p, particles()) {
      if (p.genParticle()->barcode() == barcode) return true;
    }
    return false;
  }

bool containsParticleId ( PdgId pid ) const

Check whether this jet contains a certain particle type.

Definition at line 38 of file Jet.cc.

References Jet::particles(), and Particle::pid().

                                              {
    foreach (const Particle& p, particles()) {
      if (p.pid() == pid) return true;
    }
    return false;
  }

bool containsParticleId ( const vector< PdgId > & pids ) const

Check whether this jet contains at least one of certain particle types.

Definition at line 46 of file Jet.cc.

References Jet::particles(), and Particle::pid().

                                                              {
    foreach (const Particle& p, particles()) {
      foreach (PdgId pid, pids) {
        if (p.pid() == pid) return true;
      }
    }
    return false;
  }

double E ( ) const [inline, inherited]

Get the energy directly.

Definition at line 44 of file ParticleBase.hh.

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

Referenced by H1_2000_S4129130::analyze(), SLD_2004_S5693039::analyze(), CMS_2012_I1184941::analyze(), OPAL_1998_S3780481::analyze(), SLD_1999_S3743934::analyze(), OPAL_2000_S4418603::analyze(), ARGUS_1993_S2669951::analyze(), OPAL_1997_S3608263::analyze(), H1_1994_S2919893::analyze(), SLD_1996_S3398250::analyze(), OPAL_2002_S5361494::analyze(), DELPHI_2000_S4328825::analyze(), CMS_2011_S9215166::analyze(), MC_PHOTONINC::analyze(), MC_PHOTONKTSPLITTINGS::analyze(), OPAL_1998_S3749908::analyze(), D0_2006_S6438750::analyze(), ALEPH_1996_S3196992::analyze(), MC_PHOTONJETS::analyze(), MC_PHOTONS::analyze(), ATLAS_2012_I1082009::analyze(), LHCB_2013_I1208105::analyze(), ARGUS_1993_S2789213::analyze(), ALEPH_1999_S4193598::analyze(), CMS_2013_I1218372::analyze(), ATLAS_2011_S9108483::analyze(), MC_GENERIC::analyze(), ATLAS_2012_I1190891::analyze(), D0_2008_S7719523::analyze(), ATLAS_2012_CONF_2012_109::analyze(), ALEPH_1996_S3486095::analyze(), ALEPH_2004_S5765862::analyze(), DELPHI_1996_S3430090::analyze(), Jet::hadronicEnergy(), Jet::neutralEnergy(), and ALEPH_1996_S3196992::particleInJet().

{ return momentum().E(); }

double energy ( ) const [inline, inherited]

Get the energy directly (alias).

Definition at line 46 of file ParticleBase.hh.

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

{ return momentum().E(); }

double Et ( ) const [inline, inherited]

double eta ( ) const [inline, inherited]

Get the $\eta$ directly (alias).

Definition at line 73 of file ParticleBase.hh.

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

{ return momentum().eta(); }

double hadronicEnergy ( ) const

Get the energy carried in this jet by hadrons.

Definition at line 71 of file Jet.cc.

References ParticleBase::E(), Rivet::PID::isHadron(), Jet::particles(), and Particle::pid().

                                   {
    double e_hadr = 0.0;
    foreach (const Particle& p, particles()) {
      const PdgId pid = p.pid();
      if (PID::isHadron(pid)) {
        e_hadr += p.E();
      }
    }
    return e_hadr;
  }

double mass ( ) const [inline, inherited]

Get the mass directly.

Definition at line 66 of file ParticleBase.hh.

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

Referenced by ALICE_2011_S8945144::analyze(), ARGUS_1993_S2669951::analyze(), ATLAS_2012_I1119557::analyze(), ARGUS_1993_S2789213::analyze(), and MC_VH2BB::analyze().

{ return momentum().mass(); }

double mass2 ( ) const [inline, inherited]

Get the mass**2 directly.

Definition at line 68 of file ParticleBase.hh.

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

{ return momentum().mass2(); }

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

Get equivalent single momentum four-vector (const) (alias).

Definition at line 28 of file ParticleBase.hh.

References ParticleBase::momentum().

{ return momentum(); };

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

Get equivalent single momentum four-vector.

Implements ParticleBase.

Definition at line 69 of file Jet.hh.

References Jet::_momentum.

{ return _momentum; }

double neutralEnergy ( ) const

Get the energy carried in this jet by neutral particles.

Todo:: Jet::containsMatch(Matcher m) { ... if m(pid) return true; ... }

Definition at line 59 of file Jet.cc.

References ParticleBase::E(), Jet::particles(), Particle::pid(), and Rivet::PID::threeCharge().

Referenced by STAR_2009_UE_HELEN::analyze().

                                  {
    double e_neutral = 0.0;
    foreach (const Particle& p, particles()) {
      const PdgId pid = p.pid();
      if (PID::threeCharge(pid) == 0) {
        e_neutral += p.E();
      }
    }
    return e_neutral;
  }

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(); }

Vector3 p3 ( ) const [inline, inherited]

Get the 3-momentum directly.

Definition at line 95 of file ParticleBase.hh.

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

Referenced by ARGUS_1993_S2653028::analyze(), OPAL_1994_S2927284::analyze(), SLD_2004_S5693039::analyze(), OPAL_1998_S3780481::analyze(), SLD_1999_S3743934::analyze(), ARGUS_1993_S2669951::analyze(), OPAL_1995_S3198391::analyze(), ALEPH_2002_S4823664::analyze(), CMS_2011_S8957746::analyze(), DELPHI_1999_S3960137::analyze(), OPAL_1996_S3257789::analyze(), OPAL_1998_S3702294::analyze(), BABAR_2007_S7266081::analyze(), DELPHI_1995_S3137023::analyze(), ATLAS_2010_CONF_2010_049::analyze(), OPAL_1998_S3749908::analyze(), OPAL_1997_S3396100::analyze(), ATLAS_2012_I1082009::analyze(), ARGUS_1993_S2789213::analyze(), ATLAS_2012_I1183818::analyze(), ATLAS_2012_I1124167::analyze(), TASSO_1990_S2148048::analyze(), ALEPH_1996_S3486095::analyze(), ALEPH_2004_S5765862::analyze(), DELPHI_1996_S3430090::analyze(), and ATLAS_2012_I1091481::getPionEnergy().

{ return momentum().vector3(); }

vector<Particle>& particles ( ) [inline]

Get the particles in this jet.

Definition at line 42 of file Jet.hh.

References Jet::_particles.

Referenced by ATLAS_2010_CONF_2010_049::analyze(), ATLAS_2013_I1243871::analyze(), ATLAS_2011_I919017::analyze(), JetShape::calc(), Jet::containsBottom(), Jet::containsCharm(), Jet::containsParticle(), Jet::containsParticleId(), Jet::hadronicEnergy(), Jet::neutralEnergy(), and Jet::setParticles().

{ return _particles; }

const vector<Particle>& particles ( ) const [inline]

Get the particles in this jet (const version)

Definition at line 45 of file Jet.hh.

References Jet::_particles.

{ return _particles; }

double perp ( ) const [inline, inherited]

double perp2 ( ) const [inline, inherited]

Get the $ p_T^2 $ directly (alias).

Definition at line 60 of file ParticleBase.hh.

References ParticleBase::pt2().

{ return pt2(); }

double phi ( const PhiMapping mapping = ZERO_2PI ) const [inline, inherited]

Get the $\phi$ directly.

Definition at line 91 of file ParticleBase.hh.

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

{ return momentum().phi(mapping); }

double polarAngle ( ) const [inline, inherited]

Angle subtended by the 3-vector and the z-axis.

Definition at line 107 of file ParticleBase.hh.

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

{ return momentum().polarAngle(); }

double pseudorapidity ( ) const [inline, inherited]

Get the $\eta$ directly.

Definition at line 71 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 49 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 51 of file ParticleBase.hh.

References ParticleBase::pt().

{ return pt(); }

double pt2 ( ) const [inline, inherited]

Get the $ p_T^2 $ directly.

Definition at line 56 of file ParticleBase.hh.

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

Referenced by ParticleBase::perp2(), and ParticleBase::pT2().

{ return momentum().pt2(); }

double pT2 ( ) const [inline, inherited]

Get the $ p_T^2 $ directly (alias).

Definition at line 58 of file ParticleBase.hh.

References ParticleBase::pt2().

Referenced by ATLAS_2011_S9108483::analyze().

{ return pt2(); }

double px ( ) const [inline, inherited]

x component of momentum.

Definition at line 100 of file ParticleBase.hh.

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

Referenced by ATLAS_2012_CONF_2012_104::analyze(), ATLAS_2012_I1095236::analyze(), ATLAS_2012_I1180197::analyze(), and ALEPH_1996_S3196992::particleInJet().

{ return momentum().x(); }

double py ( ) const [inline, inherited]

y component of momentum.

Definition at line 102 of file ParticleBase.hh.

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

Referenced by ATLAS_2012_CONF_2012_104::analyze(), ATLAS_2012_I1095236::analyze(), ATLAS_2012_I1180197::analyze(), and ALEPH_1996_S3196992::particleInJet().

{ return momentum().y(); }

double pz ( ) const [inline, inherited]

z component of momentum.

Definition at line 104 of file ParticleBase.hh.

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

Referenced by SFM_1984_S1178091::analyze(), ATLAS_2011_S9108483::analyze(), and ALEPH_1996_S3196992::particleInJet().

{ return momentum().z(); }

double rap ( ) const [inline, inherited]

Get the $ y $ directly (alias).

Definition at line 82 of file ParticleBase.hh.

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

{ return momentum().rapidity(); }

double rapidity ( ) const [inline, inherited]

Jet & setMomentum ( const FourMomentum & momentum )

Set the effective 4-momentum of the jet.

Definition at line 17 of file Jet.cc.

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

Referenced by Jet::setState().

                                                    {
    _momentum = momentum;
    return *this;
  }

Jet & setParticles ( const vector< Particle > & particles )

Set the particles collection with full particle information.

Definition at line 23 of file Jet.cc.

References Jet::_particles, and Jet::particles().

Referenced by Jet::setState().

                                                          {
    _particles = particles;
    return *this;
  }

Jet & setState	(	const vector< Particle > &	particles,
		const FourMomentum &	pjet
	)

Set all the jet data, with full particle information.

Definition at line 10 of file Jet.cc.

References Jet::setMomentum(), and Jet::setParticles().

Referenced by Jet::Jet().

                                                                                {
    setParticles(particles);
    setMomentum(pjet);
    return *this;
  }

size_t size ( ) const [inline]

Number of particles in this jet.

Definition at line 39 of file Jet.hh.

References Jet::_particles.

Referenced by MC_TTBAR::analyze().