rivet is hosted by Hepforge, IPPP Durham
Rivet  2.7.0
Public Member Functions | List of all members
Rivet::DressedLepton Class Reference

#include <DressedLeptons.hh>

Inheritance diagram for Rivet::DressedLepton:
Rivet::Particle Rivet::ParticleBase

Public Member Functions

 DressedLepton (const Particle &dlepton)
 Copy constructor (from Particle)
 
 DressedLepton (const Particle &lepton, const Particles &photons, bool momsum=true)
 
void addPhoton (const Particle &p, bool momsum=true)
 
const Particle & bareLepton () const
 Retrieve the bare lepton.
 
const Particle & constituentLepton () const
 
const Particles photons () const
 Retrieve the clustered photons.
 
const Particles constituentPhotons () const
 
- Public Member Functions inherited from Rivet::Particle
 Particle ()
 
 Particle (PdgId pid, const FourMomentum &mom, const FourVector &pos=FourVector())
 Constructor without GenParticle.
 
 Particle (const GenParticle *gp)
 Constructor from a HepMC GenParticle pointer.
 
 Particle (const GenParticle &gp)
 Constructor from a HepMC GenParticle reference.
 
const FourMomentum & momentum () const
 The momentum.
 
Particle & setMomentum (const FourMomentum &momentum)
 Set the momentum.
 
Particle & setMomentum (double E, double px, double py, double pz)
 Set the momentum via components.
 
Particle & transformBy (const LorentzTransform &lt)
 Apply an active Lorentz transform to this particle.
 
const FourVector & origin () const
 The origin position.
 
Particle & setOrigin (const FourVector &position)
 Set the origin position.
 
Particle & setOrigin (double t, double x, double y, double z)
 Set the origin position via components.
 
virtual fastjet::PseudoJet pseudojet () const
 Converter to FastJet3 PseudoJet.
 
 operator PseudoJet () const
 Cast operator to FastJet3 PseudoJet.
 
const GenParticle * genParticle () const
 Get a const pointer to the original GenParticle.
 
 operator const GenParticle * () const
 
PdgId pid () const
 This Particle's PDG ID code.
 
PdgId abspid () const
 Absolute value of the PDG ID code.
 
PdgId pdgId () const
 
double charge () const
 The charge of this Particle.
 
double abscharge () const
 The absolute charge of this Particle.
 
int charge3 () const
 Three times the charge of this Particle (i.e. integer multiple of smallest quark charge).
 
int threeCharge () const
 
int abscharge3 () const
 Three times the absolute charge of this Particle (i.e. integer multiple of smallest quark charge).
 
bool isCharged () const
 Is this Particle charged?
 
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 isChargedLepton () const
 Is this a charged 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?
 
bool isVisible () const
 Is this particle potentially visible in a detector?
 
bool isParton () const
 Is this a parton? (Hopefully not very often... fiducial FTW)
 
virtual void setConstituents (const Particles &cs, bool setmom=false)
 Set direct constituents of this particle.
 
virtual void addConstituent (const Particle &c, bool addmom=false)
 Add a single direct constituent to this particle.
 
virtual void addConstituents (const Particles &cs, bool addmom=false)
 Add direct constituents to this particle.
 
bool isComposite () const
 Determine if this Particle is a composite of other Rivet Particles.
 
const Particles & constituents () const
 Direct constituents of this particle, returned by reference. More...
 
const Particles constituents (const ParticleSorter &sorter) const
 Direct constituents of this particle, sorted by a functor. More...
 
const Particles constituents (const Cut &c) const
 Direct constituents of this particle, filtered by a Cut. More...
 
const Particles constituents (const Cut &c, const ParticleSorter &sorter) const
 Direct constituents of this particle, sorted by a functor. More...
 
const Particles constituents (const ParticleSelector &selector) const
 Direct constituents of this particle, filtered by a selection functor. More...
 
const Particles constituents (const ParticleSelector &selector, const ParticleSorter &sorter) const
 Direct constituents of this particle, filtered and sorted by functors. More...
 
Particles rawConstituents () const
 Fundamental constituents of this particle. More...
 
const Particles rawConstituents (const ParticleSorter &sorter) const
 Fundamental constituents of this particle, sorted by a functor. More...
 
const Particles rawConstituents (const Cut &c) const
 Fundamental constituents of this particle, filtered by a Cut. More...
 
const Particles rawConstituents (const Cut &c, const ParticleSorter &sorter) const
 Fundamental constituents of this particle, sorted by a functor. More...
 
const Particles rawConstituents (const ParticleSelector &selector) const
 Fundamental constituents of this particle, filtered by a selection functor. More...
 
const Particles rawConstituents (const ParticleSelector &selector, const ParticleSorter &sorter) const
 Fundamental constituents of this particle, filtered and sorted by functors. More...
 
Particles parents (const Cut &c=Cuts::OPEN) const
 
Particles parents (const ParticleSelector &f) const
 
bool hasParentWith (const ParticleSelector &f) const
 
bool hasParentWith (const Cut &c) const
 
bool hasParentWithout (const ParticleSelector &f) const
 
bool hasParentWithout (const Cut &c) const
 
bool hasParent (PdgId pid) const
 
Particles ancestors (const Cut &c=Cuts::OPEN, bool only_physical=true) const
 
Particles ancestors (const ParticleSelector &f, bool only_physical=true) const
 
bool hasAncestorWith (const ParticleSelector &f, bool only_physical=true) const
 
bool hasAncestorWith (const Cut &c, bool only_physical=true) const
 
bool hasAncestorWithout (const ParticleSelector &f, bool only_physical=true) const
 
bool hasAncestorWithout (const Cut &c, bool only_physical=true) const
 
bool hasAncestor (PdgId pid, bool only_physical=true) const
 
bool fromBottom () const
 Determine whether the particle is from a b-hadron decay. More...
 
bool fromCharm () const
 Determine whether the particle is from a c-hadron decay. More...
 
bool fromHadron () const
 Determine whether the particle is from a hadron decay. More...
 
bool fromTau (bool prompt_taus_only=false) const
 Determine whether the particle is from a tau decay. More...
 
bool fromPromptTau () const
 Determine whether the particle is from a prompt tau decay. More...
 
bool fromHadronicTau (bool prompt_taus_only=false) const
 Determine whether the particle is from a tau which decayed hadronically. More...
 
bool fromDecay () const
 Determine whether the particle is from a hadron or tau decay. More...
 
bool isDirect (bool allow_from_direct_tau=false, bool allow_from_direct_mu=false) const
 Shorthand definition of 'promptness' based on set definition flags. More...
 
bool isPrompt (bool allow_from_prompt_tau=false, bool allow_from_prompt_mu=false) const
 Alias for isDirect.
 
bool isStable () const
 Whether this particle is stable according to the generator.
 
Particles children (const Cut &c=Cuts::OPEN) const
 Get a list of the direct descendants from the current particle (with optional selection Cut) More...
 
Particles children (const ParticleSelector &f) const
 Get a list of the direct descendants from the current particle (with selector function)
 
bool hasChildWith (const ParticleSelector &f) const
 
bool hasChildWith (const Cut &c) const
 
bool hasChildWithout (const ParticleSelector &f) const
 
bool hasChildWithout (const Cut &c) const
 
Particles allDescendants (const Cut &c=Cuts::OPEN, bool remove_duplicates=true) const
 Get a list of all the descendants from the current particle (with optional selection Cut) More...
 
Particles allDescendants (const ParticleSelector &f, bool remove_duplicates=true) const
 Get a list of all the descendants from the current particle (with selector function)
 
bool hasDescendantWith (const ParticleSelector &f, bool remove_duplicates=true) const
 
bool hasDescendantWith (const Cut &c, bool remove_duplicates=true) const
 
bool hasDescendantWithout (const ParticleSelector &f, bool remove_duplicates=true) const
 
bool hasDescendantWithout (const Cut &c, bool remove_duplicates=true) const
 
Particles stableDescendants (const Cut &c=Cuts::OPEN) const
 
Particles stableDescendants (const ParticleSelector &f) const
 Get a list of all the stable descendants from the current particle (with selector function)
 
bool hasStableDescendantWith (const ParticleSelector &f) const
 
bool hasStableDescendantWith (const Cut &c) const
 
bool hasStableDescendantWithout (const ParticleSelector &f) const
 
bool hasStableDescendantWithout (const Cut &c) const
 
double flightLength () const
 Flight length (divide by mm or cm to get the appropriate units)
 
bool isFirstWith (const ParticleSelector &f) const
 Determine whether a particle is the first in a decay chain to meet the function requirement.
 
bool isFirstWithout (const ParticleSelector &f) const
 Determine whether a particle is the first in a decay chain not to meet the function requirement.
 
bool isLastWith (const ParticleSelector &f) const
 Determine whether a particle is the last in a decay chain to meet the function requirement.
 
bool isLastWithout (const ParticleSelector &f) const
 Determine whether a particle is the last in a decay chain not to meet the function requirement.
 
- Public Member Functions inherited from Rivet::ParticleBase
 ParticleBase ()
 Default constructor.
 
virtual ~ParticleBase ()
 Virtual destructor.
 
const FourMomentum & mom () const
 Get equivalent single momentum four-vector (const) (alias).
 
 operator const FourMomentum & () const
 Cast operator for conversion to FourMomentum.
 
double E () const
 Get the energy directly.
 
double energy () const
 Get the energy directly (alias).
 
double E2 () const
 Get the energy-squared.
 
double energy2 () const
 Get the energy-squared (alias).
 
double pt () const
 Get the $ p_T $ directly.
 
double pT () const
 Get the $ p_T $ directly (alias).
 
double perp () const
 Get the $ p_T $ directly (alias).
 
double pt2 () const
 Get the $ p_T^2 $ directly.
 
double pT2 () const
 Get the $ p_T^2 $ directly (alias).
 
double perp2 () const
 Get the $ p_T^2 $ directly (alias).
 
double Et () const
 Get the $ E_T $ directly.
 
double Et2 () const
 Get the $ E_T^2 $ 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 $ y $ directly.
 
double rap () const
 Get the $ y $ directly (alias).
 
double absrapidity () const
 Get the $ |y| $ directly.
 
double absrap () const
 Get the $ |y| $ 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 p () const
 Get the 3-momentum magnitude directly.
 
double p2 () const
 Get the 3-momentum magnitude-squared directly.
 
Vector3 ptvec () const
 Get the transverse 3-momentum directly.
 
Vector3 pTvec () const
 Get the transverse 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 px2 () const
 x component of momentum, squared.
 
double py2 () const
 y component of momentum, squared.
 
double pz2 () const
 z component of momentum, squared.
 
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)
 

Detailed Description

A charged lepton meta-particle created by clustering photons close to the bare lepton

Todo:
Remove completely – it's unnecessary and too confusing (esp. between copying & aggregating)
Deprecated:
Just use Particle.constituents() now.

Constructor & Destructor Documentation

◆ DressedLepton()

Rivet::DressedLepton::DressedLepton ( const Particle &  lepton,
const Particles &  photons,
bool  momsum = true 
)

Components constructor

Note
This is not a copy constructor, hence the explicit second argument even if empty

References Rivet::Particle::addConstituents(), and Rivet::Particle::setConstituents().

Member Function Documentation

◆ addPhoton()

void Rivet::DressedLepton::addPhoton ( const Particle &  p,
bool  momsum = true 
)

Add a photon to the dressed lepton

Todo:
Deprecate and override add/setConstituents instead?

References Rivet::Particle::addConstituent(), and Rivet::Particle::pid().

◆ constituentLepton()

const Particle& Rivet::DressedLepton::constituentLepton ( ) const
inline

Retrieve the bare lepton (alias)

Deprecated:
Prefer the more physicsy bareLepton()

References bareLepton().

◆ constituentPhotons()

const Particles Rivet::DressedLepton::constituentPhotons ( ) const
inline

Retrieve the clustered photons (alias)

Deprecated:
Prefer the shorter photons()

References photons().

The documentation for this class was generated from the following files:
Generated on Sun Feb 17 2019 21:05:06 for Rivet by   doxygen 1.8.13