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
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.
Convenience access to the effective 4-vector properties
double	energy () const
	Get the energy directly.
double	E () const
	Get the energy directly.
double	pT () const
	Get the directly.
double	Et () const
	Get the directly.
double	mass () const
	Get the mass directly.
double	pseudorapidity () const
	Get the $\eta$ directly.
double	eta () const
	Get the $\eta$ directly.
double	rapidity () const
	Get the $\eta$ directly.
double	phi () const
	Get the $\phi$ directly.
Private Attributes
Particles	_particles
	Full particle information including tracks, ID etc.
FourMomentum	_momentum
	Effective jet 4-vector.

Detailed Description

Representation of a clustered jet of particles.

Definition at line 12 of file Jet.hh.

Constructor & Destructor Documentation

Jet ( ) [inline]

Definition at line 18 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 21 of file Jet.hh.

References Jet::setState().

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

Member Function Documentation

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(), Particle::pdgId(), and Rivet::pi.

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.pdgId();
      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(), Particle::pdgId(), and Rivet::pi.

                                {
    foreach (const Particle& p, particles()) {
      const PdgId pid = p.pdgId();
      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::pdgId().

                                              {
    foreach (const Particle& p, particles()) {
      if (p.pdgId() == 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::pdgId().

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

double E ( ) const [inline, inherited]

Get the energy directly.

Definition at line 39 of file ParticleBase.hh.

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

Referenced by Rivet::cmpJetsByAscE(), Rivet::cmpJetsByE(), Jet::hadronicEnergy(), and Jet::neutralEnergy().

{ return momentum().E(); }

double energy ( ) const [inline, inherited]

Get the energy directly.

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

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

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

{ return momentum().Et(); }

double eta ( ) const [inline, inherited]

Get the $\eta$ directly.

Definition at line 53 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::pdgId().

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

double mass ( ) const [inline, inherited]

Get the mass directly.

Definition at line 48 of file ParticleBase.hh.

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

Referenced by ALICE_2011_S8945144::analyze().

{ return momentum().mass(); }

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

Get equivalent single momentum four-vector.

Implements ParticleBase.

Definition at line 63 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::pdgId(), 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.pdgId();
      if (PID::threeCharge(pid) == 0) {
        e_neutral += p.E();
      }
    }
    return e_neutral;
  }

vector<Particle>& particles ( ) [inline]

Get the particles in this jet.

Definition at line 36 of file Jet.hh.

References Jet::_particles.

Referenced by ATLAS_2010_CONF_2010_049::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 39 of file Jet.hh.

References Jet::_particles.

{ return _particles; }

double phi ( ) const [inline, inherited]

Get the $\phi$ directly.

Definition at line 59 of file ParticleBase.hh.

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

Referenced by CDF_2001_S4751469::analyze().

{ return momentum().phi(); }

double pseudorapidity ( ) const [inline, inherited]

Get the $\eta$ directly.

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

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

{ return momentum().pT(); }

double rapidity ( ) const [inline, inherited]

Get the $\eta$ directly.

Definition at line 56 of file ParticleBase.hh.

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

{ return momentum().rapidity(); }

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 33 of file Jet.hh.

References Jet::_particles.

Referenced by MC_TTBAR::analyze().