rivet is hosted by Hepforge, IPPP Durham
Classes | Public Member Functions
ParticleBase Class Reference

Base class for particle-like things like Particle and Jet. More...

#include <ParticleBase.hh>

Inheritance diagram for ParticleBase:
Inheritance graph
[legend]

List of all members.

Classes

struct  byEAscending
 Struct for sorting by increasing energy. More...
struct  byEDescending
 Struct for sorting by decreasing energy. More...
struct  byETAscending
 Struct for sorting by increasing transverse energy. More...
struct  byETDescending
 Struct for sorting by decreasing transverse energy. More...
struct  byPTAscending
 Struct for sorting by increasing transverse momentum in STL set, sort, etc. More...
struct  byPTDescending
 Struct for sorting by decreasing transverse momentum in STL set, sort etc. More...

Public Member Functions

 ParticleBase ()
 Default constructor.
virtual ~ParticleBase ()
 Virtual destructor.
Effective momentum accessors
virtual const FourMomentum & momentum () const =0
 Get equivalent single momentum four-vector.
 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 $ p_T $ directly.
double pT () const
 Get the $ p_T $ directly (alias).
double perp () const
 Get the $ p_T $ directly (alias).
double Et () const
 Get the $ E_T $ 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 phi () const
 Get the $ \phi $ directly.

Detailed Description

Base class for particle-like things like Particle and Jet.

Definition at line 11 of file ParticleBase.hh.

Constructor & Destructor Documentation

ParticleBase ( ) [inline]

Default constructor.

Definition at line 15 of file ParticleBase.hh.

{ }
virtual ~ParticleBase ( ) [inline, virtual]

Virtual destructor.

Definition at line 18 of file ParticleBase.hh.

{ }

Member Function Documentation

double abseta ( ) const [inline]

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(); }
double abspseudorapidity ( ) const [inline]

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]

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]

Get the $ |y| $ directly.

Definition at line 75 of file ParticleBase.hh.

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

{ return momentum().absrapidity(); }
double E ( ) const [inline]

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]

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]

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]

Get the $ \eta $ directly (alias).

Definition at line 64 of file ParticleBase.hh.

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

Referenced by ATLAS_2012_I1118269::analyze(), ATLAS_2011_I894867::analyze(), LHCB_2010_I867355::analyze(), CMS_2012_I1193338::analyze(), TOTEM_2012_002::analyze(), CMS_2012_I1087342::analyze(), CMS_2012_I1184941::analyze(), TOTEM_2012_I1115294::analyze(), CMS_2010_S8656010::analyze(), ATLAS_2010_S8591806::analyze(), CMS_2011_S9088458::analyze(), STAR_2008_S7993412::analyze(), ALICE_2012_I1181770::analyze(), CMS_2011_S8957746::analyze(), STAR_2006_S6870392::analyze(), MC_DIPHOTON::analyze(), MC_HINC::analyze(), CDF_2005_S6080774::analyze(), CMS_2010_S8547297::analyze(), ATLAS_2011_S8994773::analyze(), D0_1996_S3324664::analyze(), CDF_2001_S4563131::analyze(), MC_ZINC::analyze(), ATLAS_2010_CONF_2010_049::analyze(), D0_2008_S6879055::analyze(), CDF_1993_S2742446::analyze(), CDF_2009_S8436959::analyze(), CMS_2011_S8973270::analyze(), CMS_2011_S9215166::analyze(), D0_2010_S8570965::analyze(), MC_WINC::analyze(), MC_IDENTIFIED::analyze(), ATLAS_2012_I1119557::analyze(), CDF_1997_S3541940::analyze(), CMS_2011_S8884919::analyze(), ATLAS_2012_I1082009::analyze(), D0_2009_S8202443::analyze(), CMS_2011_S9120041::analyze(), ATLAS_2012_I946427::analyze(), STAR_2009_UE_HELEN::analyze(), UA1_1990_S2044935::analyze(), ATLAS_2010_S8919674::analyze(), CMS_2013_I1218372::analyze(), ATLAS_2012_I1183818::analyze(), D0_1996_S3214044::analyze(), ATLAS_2012_CONF_2012_104::analyze(), MC_GENERIC::analyze(), ATLAS_2012_I1126136::analyze(), ATLAS_2012_I1190891::analyze(), ATLAS_2012_I1186556::analyze(), ATLAS_2011_S9212183::analyze(), ATLAS_2012_CONF_2012_105::analyze(), ATLAS_2011_S9120807::analyze(), ATLAS_2011_S9128077::analyze(), ATLAS_2011_CONF_2011_098::analyze(), ATLAS_2012_I1112263::analyze(), ATLAS_2012_CONF_2012_103::analyze(), ATLAS_2012_I1117704::analyze(), ATLAS_2010_S8914702::analyze(), ATLAS_2012_I1125961::analyze(), ATLAS_2012_I1095236::analyze(), ATLAS_2012_CONF_2012_001::analyze(), ATLAS_2012_CONF_2012_109::analyze(), ATLAS_2012_I1180197::analyze(), ATLAS_2011_S8983313::analyze(), ATLAS_2011_CONF_2011_090::analyze(), ATLAS_2011_S9019561::analyze(), ATLAS_2010_S8894728::analyze(), ATLAS_2012_CONF_2012_153::analyze(), ATLAS_2011_S9212353::analyze(), ATLAS_2012_I943401::analyze(), ATLAS_2012_I1093738::analyze(), ATLAS_2011_S9225137::analyze(), ATLAS_2011_S9041966::analyze(), MC_VH2BB::analyze(), CDF_2004_S5839831::analyze(), ATLAS_2012_I1084540::fillMap(), ATLAS_2010_S8918562::fillPtEtaNch(), ATLAS_2012_I1091481::getSeta(), TriggerCDFRun0Run1::project(), TriggerCDFRun2::project(), NeutralFinalState::project(), TriggerUA5::project(), and FinalState::project().

{ return momentum().eta(); }
double mass ( ) const [inline]

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]

Get the mass**2 directly.

Definition at line 59 of file ParticleBase.hh.

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

{ return momentum().mass2(); }
virtual const FourMomentum& momentum ( ) const [pure virtual]

Get equivalent single momentum four-vector.

Get equivalent single momentum four-vector (const).

Implemented in Jet, and Particle.

Referenced by ParticleBase::abseta(), ParticleBase::abspseudorapidity(), ParticleBase::absrap(), ParticleBase::absrapidity(), ParticleBase::E(), ParticleBase::energy(), ParticleBase::Et(), ParticleBase::eta(), ParticleBase::mass(), ParticleBase::mass2(), ParticleBase::operator const FourMomentum &(), ParticleBase::byPTAscending::operator()(), ParticleBase::byETAscending::operator()(), ParticleBase::byEAscending::operator()(), ParticleBase::phi(), ParticleBase::pseudorapidity(), ParticleBase::pt(), ParticleBase::rap(), and ParticleBase::rapidity().

operator const FourMomentum & ( ) const [inline]

Cast operator for conversion to FourMomentum.

Definition at line 31 of file ParticleBase.hh.

References ParticleBase::momentum().

{ return momentum(); }
double perp ( ) const [inline]

Get the $ p_T $ directly (alias).

Definition at line 51 of file ParticleBase.hh.

References ParticleBase::pt().

{ return pt(); }
double phi ( ) const [inline]

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(); }
double pseudorapidity ( ) const [inline]

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]

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]

Get the $ p_T $ directly (alias).

Definition at line 49 of file ParticleBase.hh.

References ParticleBase::pt().

Referenced by ATLAS_2012_I1118269::analyze(), MC_JetAnalysis::analyze(), TOTEM_2012_002::analyze(), CMS_2012_I1087342::analyze(), CMS_2010_S8656010::analyze(), ATLAS_2010_S8591806::analyze(), CDF_2006_S6450792::analyze(), CMS_2011_S9088458::analyze(), CMS_2012_PAS_QCD_11_010::analyze(), LHCF_2012_I1115479::analyze(), STAR_2008_S7993412::analyze(), ALICE_2011_S8909580::analyze(), ALICE_2011_S8945144::analyze(), CMS_2011_S9086218::analyze(), CDF_2007_S7057202::analyze(), MC_HINC::analyze(), CMS_2010_S8547297::analyze(), ATLAS_2011_S8994773::analyze(), MC_ZINC::analyze(), CDF_1988_S1865951::analyze(), ATLAS_2010_CONF_2010_049::analyze(), CDF_2008_S7828950::analyze(), ZEUS_2001_S4815815::analyze(), ALICE_2010_S8706239::analyze(), ATLAS_2012_I1188891::analyze(), CDF_2008_S7540469::analyze(), ATLAS_2011_I930220::analyze(), CDF_2012_NOTE10874::analyze(), CMS_2011_S8973270::analyze(), MC_WINC::analyze(), MC_DIJET::analyze(), MC_LEADJETUE::analyze(), CDF_1996_S3108457::analyze(), STAR_2006_S6500200::analyze(), CDF_2009_S8233977::analyze(), CMS_2011_S8978280::analyze(), MC_PHOTONS::analyze(), STAR_2006_S6860818::analyze(), CMS_2011_S8884919::analyze(), ATLAS_2010_S8817804::analyze(), D0_2008_S7662670::analyze(), MC_WWJETS::analyze(), MC_ZZJETS::analyze(), CMS_2011_S9120041::analyze(), STAR_2009_UE_HELEN::analyze(), CMS_2012_I1107658::analyze(), UA1_1990_S2044935::analyze(), LHCB_2013_I1218996::analyze(), ATLAS_2012_I1082936::analyze(), MC_PHOTONJETUE::analyze(), CDF_2010_S8591881_QCD::analyze(), ATLAS_2012_CONF_2012_104::analyze(), ATLAS_2012_I1190891::analyze(), MC_GENERIC::analyze(), ATLAS_2012_I1186556::analyze(), ATLAS_2011_S9212183::analyze(), ATLAS_2012_CONF_2012_105::analyze(), STAR_2008_S7869363::analyze(), MC_TTBAR::analyze(), ATLAS_2012_I1112263::analyze(), ATLAS_2012_CONF_2012_103::analyze(), ATLAS_2012_I1117704::analyze(), CDF_2001_S4751469::analyze(), ATLAS_2012_I1125961::analyze(), ATLAS_2012_I1095236::analyze(), ATLAS_2011_I926145::analyze(), ATLAS_2012_CONF_2012_001::analyze(), ATLAS_2012_CONF_2012_109::analyze(), ATLAS_2011_S8983313::analyze(), ATLAS_2012_I1180197::analyze(), ATLAS_2011_S9019561::analyze(), ATLAS_2011_CONF_2011_090::analyze(), ATLAS_2012_I1083318::analyze(), ATLAS_2010_S8894728::analyze(), ATLAS_2012_CONF_2012_153::analyze(), ATLAS_2012_I1125575::analyze(), MC_SUSY::analyze(), ATLAS_2011_S9212353::analyze(), ATLAS_2012_I943401::analyze(), ATLAS_2011_S9225137::analyze(), MC_VH2BB::analyze(), ATLAS_2011_S9041966::analyze(), ATLAS_2012_I1094568::analyze(), ATLAS_2011_I944826::analyze(), ATLAS_2011_I919017::analyze(), JetShape::calc(), ATLAS_2012_I1084540::fillMap(), ATLAS_2010_S8918562::fillPtEtaNch(), STARRandomFilter::operator()(), LeadingParticlesFinalState::project(), FinalState::project(), and VetoedFinalState::project().

{ return pt(); }
double rap ( ) const [inline]

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]

Get the $ y $ directly.

Definition at line 71 of file ParticleBase.hh.

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

Referenced by CDF_2006_S6450792::analyze(), LHCF_2012_I1115479::analyze(), ALICE_2011_S8909580::analyze(), ALICE_2011_S8945144::analyze(), CMS_2011_S9086218::analyze(), ALICE_2012_I1181770::analyze(), CDF_2007_S7057202::analyze(), ATLAS_2011_S9035664::analyze(), CDF_2008_S7828950::analyze(), ATLAS_2012_I1188891::analyze(), LHCB_2011_I919315::analyze(), ATLAS_2011_S8971293::analyze(), STAR_2006_S6500200::analyze(), CMS_2011_S8978280::analyze(), STAR_2006_S6860818::analyze(), ATLAS_2010_S8817804::analyze(), D0_2008_S7662670::analyze(), CDF_2008_S8095620::analyze(), CDF_2006_S6653332::analyze(), ATLAS_2012_I1082936::analyze(), MC_GENERIC::analyze(), STAR_2008_S7869363::analyze(), ATLAS_2012_I1112263::analyze(), ATLAS_2012_I1095236::analyze(), ATLAS_2012_CONF_2012_001::analyze(), ATLAS_2012_I1083318::analyze(), ATLAS_2012_I943401::analyze(), ATLAS_2012_I1094568::analyze(), ATLAS_2011_I944826::analyze(), ATLAS_2011_S9126244::analyze(), ATLAS_2011_I919017::analyze(), and CentralEtHCM::project().

{ return momentum().rapidity(); }
The documentation for this class was generated from the following file:
Generated on Thu Feb 6 2014 17:38:58 for The Rivet MC analysis system by   doxygen 1.7.6.1