rivet is hosted by Hepforge, IPPP Durham
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | Friends
PromptFinalState Class Reference

Find final state particles directly connected to the hard process. More...

#include <PromptFinalState.hh>

Inheritance diagram for PromptFinalState:
Inheritance graph
[legend]
Collaboration diagram for PromptFinalState:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void acceptMuonDecays (bool acc=true)
 Accept particles from decays of prompt muons as themselves being prompt?
void acceptTauDecays (bool acc=true)
 Accept particles from decays of prompt taus as themselves being prompt?
bool isPrompt (const Particle &p) const
virtual bool accept (const Particle &p) const
 Decide if a particle is to be accepted or not.
bool before (const Projection &p) const
virtual const std::set< PdgIdPair > beamPairs () const
virtual std::string name () const
 Get the name of the projection.
Projection & addPdgIdPair (PdgId beam1, PdgId beam2)
 Add a colliding beam pair.
Log & getLog () const
 Get a Log object based on the getName() property of the calling projection object.
void setName (const std::string &name)
 Used by derived classes to set their name.
Constructors
 PromptFinalState (const FinalState &fsp)
 PromptFinalState (Cut c)
 Cut constructor.
virtual const Projection * clone () const
 Clone on the heap.
Particle accessors
virtual size_t size () const
 Access the projected final-state particles.
virtual bool empty () const
 Is this final state empty?
virtual bool isEmpty () const
virtual const Particles & particles () const
 Get the final-state particles in no particular order, with no cuts.
template<typename F >
Particles particles (Cut c, F sorter) const
 Get the final-state particles, with optional cuts.
Particles particlesByPt (Cut c=Cuts::open()) const
Particles particlesByP (Cut c=Cuts::open()) const
Particles particlesByE (Cut c=Cuts::open()) const
Particles particlesByEt (Cut c=Cuts::open()) const
Particles particlesByEta (Cut c=Cuts::open()) const
Particles particlesByModEta (Cut c=Cuts::open()) const
Particles particlesByRapidity (Cut c=Cuts::open()) const
Particles particlesByModRapidity (Cut c=Cuts::open()) const
Projection "getting" functions
std::set< ConstProjectionPtr > getProjections () const
 Get the contained projections, including recursion.
template<typename PROJ >
const PROJ & getProjection (const std::string &name) const
 Get the named projection, specifying return type via a template argument.
const Projection & getProjection (const std::string &name) const
Projection applying functions
template<typename PROJ >
const PROJ & applyProjection (const Event &evt, const PROJ &proj) const
 Apply the supplied projection on event.
template<typename PROJ >
const PROJ & applyProjection (const Event &evt, const Projection &proj) const
 Apply the supplied projection on event.
template<typename PROJ >
const PROJ & applyProjection (const Event &evt, const std::string &name) const
 Apply the named projection on event.

Protected Member Functions

void project (const Event &e)
 Apply the projection on the supplied event.
int compare (const Projection &p) const
 Compare projections.
Cmp< Projection > mkNamedPCmp (const Projection &otherparent, const std::string &pname) const
Cmp< Projection > mkPCmp (const Projection &otherparent, const std::string &pname) const
ProjectionHandler & getProjHandler () const
 Get a reference to the ProjectionHandler for this thread.
Projection registration functions
template<typename PROJ >
const PROJ & addProjection (const PROJ &proj, const std::string &name)
const Projection & _addProjection (const Projection &proj, const std::string &name)
 Untemplated function to do the work...

Protected Attributes

Cut _cuts
 The applicable cuts.
Particles _theParticles
 The final-state particles.
bool _allowProjReg
 Flag to forbid projection registration in analyses until the init phase.

Private Attributes

bool _acceptMuDecays
bool _acceptTauDecays

Friends

class Event
 Event is a friend.
class Cmp< Projection >
 The Cmp specialization for Projection is a friend.

JetAlg compatibility

Minimum- $ p_\perp $ requirement.

Todo:
Replace with cuts() accessor virtual Cut cuts() const { return _cuts; }
const collection_type & entities () const
 Template-usable interface common to JetAlg.
typedef Particle entity_type
typedef Particles collection_type

Detailed Description

Find final state particles directly connected to the hard process.

The definition of "prompt" used in Rivet is that from high-scale physics, i.e. particles directly connected to the hard process in an interaction, regardless of realistic reconstructibility of displaced vertices, etc. By construction hadrons cannot be considered prompt as they will be colour connected to other parts of the event through non-perturbative effects: this projection can return electrons, muons, photons, and exotic particles which do not have a hadron in their post-hadronization ancestor chain. Flags exist to choose whether intermediate tau or muon decays invalidate a particle's promptness.

Todo:
Decide how to treat brem photons off prompt leptons -- are they also prompt? "Decay" does not change the lepton PID...

Definition at line 22 of file PromptFinalState.hh.

Member Typedef Documentation

typedef Particles collection_type [inherited]

Definition at line 131 of file ParticleFinder.hh.

typedef Particle entity_type [inherited]

Definition at line 130 of file ParticleFinder.hh.

Constructor & Destructor Documentation

PromptFinalState ( const FinalState &  fsp)

Definition at line 7 of file PromptFinalState.cc.

References ProjectionApplier::addProjection(), and Projection::setName().

Referenced by PromptFinalState::clone().

    : _acceptMuDecays(false), _acceptTauDecays(false)
  {
    setName("PromptFinalState");
    addProjection(fsp, "FS");
  }
PromptFinalState ( Cut  c)

Cut constructor.

Definition at line 15 of file PromptFinalState.cc.

References ProjectionApplier::addProjection(), FinalState::FinalState(), and Projection::setName().

    : _acceptMuDecays(false), _acceptTauDecays(false)
  {
    setName("PromptFinalState");
    addProjection(FinalState(c), "FS");
  }

Member Function Documentation

const Projection & _addProjection ( const Projection &  proj,
const std::string &  name 
) [protected, inherited]

Untemplated function to do the work...

Definition at line 33 of file ProjectionApplier.cc.

References ProjectionApplier::_allowProjReg, ProjectionApplier::getProjHandler(), ProjectionApplier::name(), Projection::name(), and ProjectionHandler::registerProjection().

Referenced by ProjectionApplier::addProjection().

                                                                             {
    if (!_allowProjReg) {
      cerr << "Trying to register projection '"
           << proj.name() << "' before init phase in '" << this->name() << "'." << endl;
      exit(2);
    }
    const Projection& reg = getProjHandler().registerProjection(*this, proj, name);
    return reg;
  }
bool accept ( const Particle &  p) const [virtual, inherited]

Decide if a particle is to be accepted or not.

Decide if a particle is to be accepted or not.

Todo:
Rename to _accept or acceptFinal?

Definition at line 99 of file FinalState.cc.

References ParticleFinder::_cuts, and Particle::genParticle().

Referenced by InvMassFinalState::calc(), FinalState::project(), LeadingParticlesFinalState::project(), and DressedLeptons::project().

                                                 {
    // Not having s.c. == 1 should never happen!
    assert(p.genParticle() == NULL || p.genParticle()->status() == 1);

    return _cuts->accept(p);
  }
void acceptMuonDecays ( bool  acc = true) [inline]

Accept particles from decays of prompt muons as themselves being prompt?

Definition at line 40 of file PromptFinalState.hh.

References PromptFinalState::_acceptMuDecays.

{ _acceptMuDecays = acc; }
void acceptTauDecays ( bool  acc = true) [inline]

Accept particles from decays of prompt taus as themselves being prompt?

Definition at line 42 of file PromptFinalState.hh.

References PromptFinalState::_acceptTauDecays.

Referenced by ATLAS_2014_I1304688::init().

{ _acceptTauDecays = acc; }
Projection& addPdgIdPair ( PdgId  beam1,
PdgId  beam2 
) [inline, inherited]

Add a colliding beam pair.

Definition at line 107 of file Projection.hh.

References Projection::_beamPairs.

Referenced by Projection::Projection().

                                                       {
      _beamPairs.insert(PdgIdPair(beam1, beam2));
      return *this;
    }
const PROJ& addProjection ( const PROJ &  proj,
const std::string &  name 
) [inline, protected, inherited]

Register a contained projection. The type of the argument is used to instantiate a new projection internally: this new object is applied to events rather than the argument object. Hence you are advised to only use locally-scoped Projection objects in your Projection and Analysis constructors, and to avoid polymorphism (e.g. handling ConcreteProjection via a pointer or reference to type Projection) since this will screw up the internal type management.

Definition at line 116 of file ProjectionApplier.hh.

References ProjectionApplier::_addProjection().

Referenced by TauFinder::_init(), FastJets::_init1(), FastJets::_init2(), FastJets::_init3(), VetoedFinalState::addVetoOnThisFinalState(), BeamThrust::BeamThrust(), CDF_2009_S8057893::CDF_2009_S8057893::init(), CentralEtHCM::CentralEtHCM(), ChargedFinalState::ChargedFinalState(), ChargedLeptons::ChargedLeptons(), DISFinalState::DISFinalState(), DISKinematics::DISKinematics(), DISLepton::DISLepton(), DressedLeptons::DressedLeptons(), FinalState::FinalState(), FoxWolframMoments::FoxWolframMoments(), FParameter::FParameter(), HadronicFinalState::HadronicFinalState(), HeavyHadrons::HeavyHadrons(), Hemispheres::Hemispheres(), IdentifiedFinalState::IdentifiedFinalState(), ATLAS_2010_S8894728::init(), CMS_2010_S8547297::init(), CMS_2010_S8656010::init(), ALICE_2012_I1181770::init(), ATLAS_2011_S8994773::init(), CMS_2011_S8950903::init(), CMS_2012_PAS_QCD_11_010::init(), CMS_2011_S8941262::init(), CMS_2011_S8968497::init(), CMS_2011_S8973270::init(), CMS_2011_S8978280::init(), ATLAS_2014_I1298811::init(), ALICE_2011_S8909580::init(), CMS_2012_I1090423::init(), CMSTOTEM_2014_I1294140::init(), ATLAS_2010_CONF_2010_049::init(), ATLAS_2011_I894867::init(), LHCB_2013_I1208105::init(), CDF_2007_S7057202::init(), ALICE_2011_S8945144::init(), TOTEM_2012_I1115294::init(), ATLAS_2014_I1282441::init(), CMS_2011_S9086218::init(), CMS_2011_S9215166::init(), CMS_2012_I1087342::init(), CMS_2012_I1184941::init(), CMS_2012_I1193338::init(), ATLAS_2010_S8591806::init(), CMS_2013_I1265659::init(), D0_2011_I895662::init(), LHCF_2012_I1115479::init(), ATLAS_2011_I930220::init(), CMS_2011_I954992::init(), TOTEM_2012_002::init(), CMS_2011_S8957746::init(), CMS_2011_S9088458::init(), ATLAS_2011_S9002537::init(), CMS_2013_I1273574::init(), D0_2010_S8570965::init(), CDF_2012_NOTE10874::init(), STAR_2008_S7993412::init(), UA5_1987_S1640666::init(), CMS_QCD_10_024::init(), CDF_1997_S3541940::init(), ATLAS_2012_I1124167::init(), STAR_2006_S6500200::init(), ATLAS_2011_S9128077::init(), BELLE_2008_I786560::init(), CDF_1993_S2742446::init(), ARGUS_1993_S2789213::init(), CDF_2000_S4155203::init(), CDF_2005_S6080774::init(), CDF_2006_S6450792::init(), SFM_1984_S1178091::init(), BABAR_2007_S7266081::init(), CMS_2013_I1261026::init(), D0_2008_S6879055::init(), ATLAS_2012_I1091481::init(), UA5_1982_S875503::init(), CDF_2008_S7782535::init(), CDF_2008_S8093652::init(), ATLAS_2012_I1204447::init(), STAR_2006_S6870392::init(), ARGUS_1993_S2669951::init(), UA5_1989_S1926373::init(), CMS_2013_I1272853::init(), D0_2000_I499943::init(), ALEPH_1991_S2435284::init(), E735_1998_S3905616::init(), ATLAS_2012_I1183818::init(), ATLAS_2013_I1243871::init(), ATLAS_2014_I1268975::init(), CMS_2012_I1102908::init(), ATLAS_2011_S9035664::init(), ALEPH_2002_S4823664::init(), D0_1996_S3324664::init(), D0_2007_S7075677::init(), CDF_1988_S1865951::init(), CDF_1990_S2089246::init(), DELPHI_1999_S3960137::init(), ATLAS_2010_S8817804::init(), ATLAS_2011_S8924791::init(), ALEPH_1996_S3196992::init(), CDF_2005_S6217184::init(), OPAL_1995_S3198391::init(), OPAL_1996_S3257789::init(), OPAL_1997_S3608263::init(), OPAL_1998_S3702294::init(), OPAL_1998_S3749908::init(), OPAL_2000_S4418603::init(), UA5_1986_S1583476::init(), D0_2001_S4674421::init(), D0_2008_S7554427::init(), CDF_1994_S2952106::init(), H1_1995_S3167097::init(), CDF_2008_S7540469::init(), CDF_2008_S7828950::init(), ATLAS_2014_I1307756::init(), UA1_1990_S2044935::init(), ZEUS_2001_S4815815::init(), LHCB_2011_I919315::init(), ATLAS_2012_I1119557::init(), ATLAS_2012_I1188891::init(), JADE_1998_S3612880::init(), JADE_OPAL_2000_S4300807::init(), STAR_2006_S6860818::init(), OPAL_1997_S3396100::init(), ALEPH_2004_S5765862::init(), ALICE_2010_S8624100::init(), D0_1996_S3214044::init(), STAR_2009_UE_HELEN::init(), EXAMPLE::init(), CDF_2008_S8095620::init(), DELPHI_1995_S3137023::init(), ATLAS_2012_I1125575::init(), ALICE_2010_S8625980::init(), LHCB_2013_I1218996::init(), CMS_2013_I1218372::init(), ALICE_2010_S8706239::init(), CDF_2009_NOTE_9936::init(), D0_2009_S8320160::init(), CDF_2009_S8436959::init(), ATLAS_2013_I1263495::init(), CDF_1996_S3108457::init(), CDF_1998_S3618439::init(), CDF_2000_S4266730::init(), CDF_2001_S4563131::init(), ATLAS_2011_S8971293::init(), CDF_2009_S8383952::init(), DELPHI_2002_069_CONF_603::init(), ALEPH_2001_S4656318::init(), SLD_2002_S4869273::init(), D0_2010_S8566488::init(), CDF_2001_S4517016::init(), D0_2006_S6438750::init(), ATLAS_2012_I1082936::init(), CDF_1996_S3349578::init(), LHCB_2011_I917009::init(), LHCB_2012_I1119400::init(), ATLAS_2011_I921594::init(), CDF_1996_S3418421::init(), UA5_1988_S1867512::init(), SLD_1996_S3398250::init(), CDF_2006_S6653332::init(), CDF_2008_S7541902::init(), D0_2008_S7662670::init(), ATLAS_2011_S9108483::init(), TASSO_1990_S2148048::init(), ATLAS_2012_I1082009::init(), ATLAS_2012_I946427::init(), OPAL_2002_S5361494::init(), ATLAS_2012_I1199269::init(), DELPHI_2000_S4328825::init(), ATLAS_2012_I1084540::init(), CMS_2013_I1224539_DIJET::init(), CDF_2009_S8233977::init(), CDF_2010_S8591881_QCD::init(), D0_2004_S5992206::init(), ATLAS_2010_S8914702::init(), ATLAS_2010_S8918562::init(), D0_2008_S7719523::init(), ATLAS_2011_S9120807::init(), CDF_2001_S4751469::init(), ATLAS_2012_I1094568::init(), DELPHI_1996_S3430090::init(), ALEPH_1996_S3486095::init(), ALEPH_1999_S4193598::init(), ATLAS_2012_I1093738::init(), OPAL_2004_S6132243::init(), OPAL_1994_S2927284::init(), BELLE_2013_I1216515::init(), STAR_2008_S7869363::init(), ATLAS_2011_S9126244::init(), BABAR_2007_S6895344::init(), BELLE_2001_S4598261::init(), BABAR_2005_S6181155::init(), ATLAS_2011_I919017::init(), OPAL_2001_S4553896::init(), BABAR_2013_I1238276::init(), DELPHI_2003_WUD_03_11::init(), CDF_2004_S5839831::init(), BABAR_2003_I593379::init(), ATLAS_2012_I1094061::init(), ARGUS_1993_S2653028::init(), CLEO_2004_S5809304::init(), OPAL_1998_S3780481::init(), ATLAS_2012_I1093734::init(), OPAL_1993_S2692198::init(), ATLAS_2014_I1279489::init(), ATLAS_2012_I1094564::init(), SLD_2004_S5693039::init(), BELLE_2006_S6265367::init(), SLD_1999_S3743934::init(), PDG_HADRON_MULTIPLICITIES::init(), PDG_HADRON_MULTIPLICITIES_RATIOS::init(), JetAlg::JetAlg(), JetShape::JetShape(), LeadingParticlesFinalState::LeadingParticlesFinalState(), LossyFinalState< ConstRandomFilter >::LossyFinalState(), MergedFinalState::MergedFinalState(), MissingMomentum::MissingMomentum(), NeutralFinalState::NeutralFinalState(), NonHadronicFinalState::NonHadronicFinalState(), ParisiTensor::ParisiTensor(), PrimaryHadrons::PrimaryHadrons(), PromptFinalState::PromptFinalState(), Sphericity::Sphericity(), Spherocity::Spherocity(), Thrust::Thrust(), TriggerCDFRun0Run1::TriggerCDFRun0Run1(), TriggerCDFRun2::TriggerCDFRun2(), TriggerUA5::TriggerUA5(), VetoedFinalState::VetoedFinalState(), VisibleFinalState::VisibleFinalState(), WFinder::WFinder(), and ZFinder::ZFinder().

                                                                       {
      const Projection& reg = _addProjection(proj, name);
      const PROJ& rtn = dynamic_cast<const PROJ&>(reg);
      return rtn;
    }
const PROJ& applyProjection ( const Event &  evt,
const PROJ &  proj 
) const [inline, inherited]

Apply the supplied projection on event.

Definition at line 70 of file ProjectionApplier.hh.

References ProjectionApplier::_applyProjection().

Referenced by DISFinalState::project().

                                                                          {
      return pcast<PROJ>(_applyProjection(evt, proj));
    }
const PROJ& applyProjection ( const Event &  evt,
const Projection &  proj 
) const [inline, inherited]

Apply the supplied projection on event.

Definition at line 77 of file ProjectionApplier.hh.

References ProjectionApplier::_applyProjection().

                                                                                {
      return pcast<PROJ>(_applyProjection(evt, proj));
    }
const PROJ& applyProjection ( const Event &  evt,
const std::string &  name 
) const [inline, inherited]

Apply the named projection on event.

Definition at line 84 of file ProjectionApplier.hh.

References ProjectionApplier::_applyProjection().

                                                                               {
      return pcast<PROJ>(_applyProjection(evt, name));
    }
const set< PdgIdPair > beamPairs ( ) const [virtual, inherited]

Return the allowed beam pairs on which this projection can operate, not including recursion. Derived classes should ensure that all contained projections are registered in the _projections set for the beam constraint chaining to work.

Todo:
Remove the beam constraints system from projections.

Definition at line 33 of file Projection.cc.

References Projection::_beamPairs, Projection::beamPairs(), Projection::getLog(), ProjectionApplier::getProjections(), Rivet::intersection(), and Log::TRACE.

Referenced by Projection::beamPairs().

                                                   {
    set<PdgIdPair> ret = _beamPairs;
    set<ConstProjectionPtr> projs = getProjections();
    for (set<ConstProjectionPtr>::const_iterator ip = projs.begin(); ip != projs.end(); ++ip) {
      ConstProjectionPtr p = *ip;
      getLog() << Log::TRACE << "Proj addr = " << p << endl;
      if (p) ret = intersection(ret, p->beamPairs());
    }
    return ret;
  }
bool before ( const Projection &  p) const [inherited]

Determine whether this object should be ordered before the object p given as argument. If p is of a different class than this, the before() function of the corresponding type_info objects is used. Otherwise, if the objects are of the same class, the virtual compare(const Projection &) will be returned.

Definition at line 22 of file Projection.cc.

References Projection::compare().

Referenced by less< const Rivet::Projection * >::operator()().

                                                   {
    const std::type_info& thisid = typeid(*this);
    const std::type_info& otherid = typeid(p);
    if (thisid == otherid) {
      return compare(p) < 0;
    } else {
      return thisid.before(otherid);
    }
  }
virtual const Projection* clone ( ) const [inline, virtual]

Clone on the heap.

Reimplemented from FinalState.

Definition at line 34 of file PromptFinalState.hh.

References PromptFinalState::PromptFinalState().

                                            {
      return new PromptFinalState(*this);
    }
int compare ( const Projection &  p) const [protected, virtual]

Compare projections.

Reimplemented from FinalState.

Definition at line 22 of file PromptFinalState.cc.

References PromptFinalState::_acceptMuDecays, PromptFinalState::_acceptTauDecays, Rivet::cmp(), Rivet::EQUIVALENT, and Projection::mkNamedPCmp().

                                                         {
    const PCmp fscmp = mkNamedPCmp(p, "FS");
    if (fscmp != EQUIVALENT) return fscmp;
    const PromptFinalState& other = dynamic_cast<const PromptFinalState&>(p);
    return cmp(_acceptMuDecays, other._acceptMuDecays) || cmp(_acceptTauDecays, other._acceptTauDecays);
  }
virtual bool empty ( ) const [inline, virtual, inherited]

Is this final state empty?

Definition at line 37 of file ParticleFinder.hh.

References ParticleFinder::_theParticles.

Referenced by STAR_2008_S7993412::analyze(), STAR_2006_S6870392::analyze(), ATLAS_2011_I925932::analyze(), CDF_2008_S7540469::analyze(), CMS_2011_S9215166::analyze(), CMS_2013_I1272853::analyze(), MC_PHOTONINC::analyze(), MC_PHOTONKTSPLITTINGS::analyze(), CMS_2013_I1209721::analyze(), MC_PHOTONJETS::analyze(), D0_2008_S7662670::analyze(), CMS_2013_I1218372::analyze(), CMS_2013_I1261026::analyze(), CMS_2013_I1258128::makeZCut(), and WFinder::mT().

{ return _theParticles.empty(); }
const collection_type& entities ( ) const [inline, inherited]

Template-usable interface common to JetAlg.

Definition at line 134 of file ParticleFinder.hh.

References ParticleFinder::particles().

                                            {
      return particles();
    }
Log& getLog ( ) const [inline, inherited]

Get a Log object based on the getName() property of the calling projection object.

Reimplemented from ProjectionApplier.

Definition at line 114 of file Projection.hh.

References Projection::name().

Referenced by Projection::beamPairs(), InvMassFinalState::calc(), ChargedFinalState::project(), InitialQuarks::project(), UnstableFinalState::project(), PromptFinalState::project(), LossyFinalState< ConstRandomFilter >::project(), and VetoedFinalState::project().

                        {
      string logname = "Rivet.Projection." + name();
      return Log::getLog(logname);
    }
const PROJ& getProjection ( const std::string &  name) const [inline, inherited]

Get the named projection, specifying return type via a template argument.

Definition at line 52 of file ProjectionApplier.hh.

References ProjectionHandler::getProjection(), and ProjectionApplier::getProjHandler().

Referenced by ProjectionApplier::_applyProjection(), Rivet::pcmp(), and Hemispheres::project().

                                                           {
      const Projection& p = getProjHandler().getProjection(*this, name);
      return pcast<PROJ>(p);
    }
const Projection& getProjection ( const std::string &  name) const [inline, inherited]

Get the named projection (non-templated, so returns as a reference to a Projection base class).

Definition at line 60 of file ProjectionApplier.hh.

References ProjectionHandler::getProjection(), and ProjectionApplier::getProjHandler().

                                                                 {
      return getProjHandler().getProjection(*this, name);
    }
std::set<ConstProjectionPtr> getProjections ( ) const [inline, inherited]

Get the contained projections, including recursion.

Definition at line 45 of file ProjectionApplier.hh.

References ProjectionHandler::DEEP, ProjectionHandler::getChildProjections(), and ProjectionApplier::getProjHandler().

Referenced by Projection::beamPairs().

                                                      {
      return getProjHandler().getChildProjections(*this, ProjectionHandler::DEEP);
    }
ProjectionHandler& getProjHandler ( ) const [inline, protected, inherited]

Get a reference to the ProjectionHandler for this thread.

Definition at line 97 of file ProjectionApplier.hh.

References ProjectionApplier::_projhandler.

Referenced by ProjectionApplier::_addProjection(), ProjectionApplier::getProjection(), ProjectionApplier::getProjections(), and ProjectionApplier::~ProjectionApplier().

                                              {
      return _projhandler;
    }
virtual bool isEmpty ( ) const [inline, virtual, inherited]
Deprecated:
Is this final state empty?

Definition at line 39 of file ParticleFinder.hh.

References ParticleFinder::_theParticles.

{ return _theParticles.empty(); }
bool isPrompt ( const Particle &  p) const

Decide if a given particle is prompt based on set definition flags

Todo:
Move into ParticleUtils / MCUtils
Note:
This one doesn't make any judgements about final-stateness
Todo:
Shouldn't a const vertex be being returned? Ah, HepMC...
Todo:
Would be nicer to be able to write this recursively up the chain, exiting as soon as a parton or string/cluster is seen

Definition at line 30 of file PromptFinalState.cc.

References PromptFinalState::_acceptMuDecays, PromptFinalState::_acceptTauDecays, Particle::abspid(), Rivet::beams(), Particle::genParticle(), Rivet::PID::isHadron(), Rivet::PID::isParton(), Rivet::PID::MUON, Rivet::particles(), and Rivet::PID::TAU.

Referenced by PromptFinalState::project().

                                                         {
    if (p.genParticle() == NULL) return false; // no HepMC connection, give up! Throw UserError exception?
    /// @todo Shouldn't a const vertex be being returned? Ah, HepMC...
    GenVertex* prodVtx = p.genParticle()->production_vertex();
    if (prodVtx == NULL) return false; // orphaned particle, has to be assume false
    const pair<GenParticle*, GenParticle*> beams = prodVtx->parent_event()->beam_particles();

    /// @todo Would be nicer to be able to write this recursively up the chain, exiting as soon as a parton or string/cluster is seen
    foreach (const GenParticle* ancestor, Rivet::particles(prodVtx, HepMC::ancestors)) {
      const PdgId pid = ancestor->pdg_id();
      if (ancestor->status() != 2) continue; // no non-standard statuses or beams to be used in decision making
      if (ancestor == beams.first || ancestor == beams.second) continue; // PYTHIA6 uses status 2 for beams, I think... (sigh)
      if (PID::isParton(pid)) continue; // PYTHIA6 also uses status 2 for some partons, I think... (sigh)
      if (PID::isHadron(pid)) return false; // prompt particles can't be from hadron decays
      if (abs(pid) == PID::TAU && p.abspid() != PID::TAU && !_acceptTauDecays) return false; // allow or ban particles from tau decays (permitting tau copies)
      if (abs(pid) == PID::MUON && p.abspid() != PID::MUON && !_acceptMuDecays) return false; // allow or ban particles from muon decays (permitting muon copies)
    }
    return true;
  }
Cmp< Projection > mkNamedPCmp ( const Projection &  otherparent,
const std::string &  pname 
) const [protected, inherited]

Shortcut to make a named Cmp<Projection> comparison with the *this object automatically passed as one of the parent projections.

Definition at line 45 of file Projection.cc.

References Rivet::pcmp().

Referenced by ChargedFinalState::compare(), ChargedLeptons::compare(), BeamThrust::compare(), FParameter::compare(), CentralEtHCM::compare(), MergedFinalState::compare(), DISLepton::compare(), DISKinematics::compare(), NeutralFinalState::compare(), DISFinalState::compare(), VisibleFinalState::compare(), PromptFinalState::compare(), Spherocity::compare(), LeadingParticlesFinalState::compare(), ParisiTensor::compare(), FoxWolframMoments::compare(), LossyFinalState< ConstRandomFilter >::compare(), MissingMomentum::compare(), Thrust::compare(), InvMassFinalState::compare(), Sphericity::compare(), DressedLeptons::compare(), ZFinder::compare(), Hemispheres::compare(), WFinder::compare(), IdentifiedFinalState::compare(), VetoedFinalState::compare(), JetShape::compare(), and FastJets::compare().

                                                                     {
    return pcmp(*this, otherparent, pname);
  }
Cmp< Projection > mkPCmp ( const Projection &  otherparent,
const std::string &  pname 
) const [protected, inherited]

Shortcut to make a named Cmp<Projection> comparison with the *this object automatically passed as one of the parent projections.

Definition at line 51 of file Projection.cc.

References Rivet::pcmp().

                                                                {
    return pcmp(*this, otherparent, pname);
  }
virtual std::string name ( ) const [inline, virtual, inherited]

Get the name of the projection.

Implements ProjectionApplier.

Definition at line 101 of file Projection.hh.

References Projection::_name.

Referenced by ProjectionApplier::_addProjection(), ProjectionHandler::_checkDuplicate(), ProjectionHandler::_clone(), ProjectionHandler::_getEquiv(), VetoedFinalState::addVetoOnThisFinalState(), Projection::getLog(), ProjectionHandler::registerProjection(), and Projection::setName().

                                   {
      return _name;
    }
virtual const Particles& particles ( ) const [inline, virtual, inherited]

Get the final-state particles in no particular order, with no cuts.

Definition at line 42 of file ParticleFinder.hh.

References ParticleFinder::_theParticles.

Referenced by BABAR_2003_I593379::analyze(), BELLE_2001_S4598261::analyze(), CLEO_2004_S5809304::analyze(), BELLE_2006_S6265367::analyze(), BABAR_2005_S6181155::analyze(), BABAR_2007_S6895344::analyze(), BABAR_2013_I1238276::analyze(), BELLE_2013_I1216515::analyze(), ARGUS_1993_S2653028::analyze(), OPAL_1994_S2927284::analyze(), PDG_HADRON_MULTIPLICITIES::analyze(), PDG_HADRON_MULTIPLICITIES_RATIOS::analyze(), OPAL_1993_S2692198::analyze(), TOTEM_2012_002::analyze(), H1_2000_S4129130::analyze(), BELLE_2008_I786560::analyze(), SLD_2004_S5693039::analyze(), TOTEM_2012_I1115294::analyze(), CMS_2010_S8656010::analyze(), OPAL_1998_S3780481::analyze(), ATLAS_2010_S8591806::analyze(), CMS_2012_PAS_QCD_11_010::analyze(), STAR_2008_S7993412::analyze(), LHCF_2012_I1115479::analyze(), ALICE_2011_S8909580::analyze(), SLD_1999_S3743934::analyze(), ALICE_2011_S8945144::analyze(), OPAL_2000_S4418603::analyze(), CMSTOTEM_2014_I1294140::analyze(), ARGUS_1993_S2669951::analyze(), OPAL_1995_S3198391::analyze(), OPAL_1997_S3608263::analyze(), ALEPH_2002_S4823664::analyze(), DELPHI_1999_S3960137::analyze(), OPAL_1996_S3257789::analyze(), OPAL_1998_S3702294::analyze(), E735_1998_S3905616::analyze(), H1_1994_S2919893::analyze(), ATLAS_2011_S9002537::analyze(), CMS_QCD_10_024::analyze(), BABAR_2007_S7266081::analyze(), DELPHI_1995_S3137023::analyze(), UA5_1982_S875503::analyze(), CMS_2010_S8547297::analyze(), SLD_2002_S4869273::analyze(), CDF_1990_S2089246::analyze(), CDF_1988_S1865951::analyze(), ALEPH_2001_S4656318::analyze(), ATLAS_2011_S9035664::analyze(), DELPHI_2002_069_CONF_603::analyze(), ALICE_2010_S8706239::analyze(), ATLAS_2011_I925932::analyze(), SLD_1996_S3398250::analyze(), DELPHI_2000_S4328825::analyze(), CDF_2008_S7540469::analyze(), CMS_2011_S8973270::analyze(), OPAL_2002_S5361494::analyze(), CMS_2011_S9215166::analyze(), SFM_1984_S1178091::analyze(), LHCB_2011_I919315::analyze(), OPAL_1998_S3749908::analyze(), CMS_2013_I1272853::analyze(), MC_PHOTONINC::analyze(), OPAL_1997_S3396100::analyze(), ALICE_2010_S8625980::analyze(), D0_2006_S6438750::analyze(), MC_PHOTONKTSPLITTINGS::analyze(), MC_DIJET::analyze(), MC_LEADJETUE::analyze(), STAR_2006_S6500200::analyze(), UA5_1986_S1583476::analyze(), CDF_2009_S8233977::analyze(), MC_IDENTIFIED::analyze(), CMS_2011_S8978280::analyze(), MC_PHOTONJETS::analyze(), STAR_2006_S6860818::analyze(), CMS_2011_S8884919::analyze(), ATLAS_2012_I1082009::analyze(), CDF_2008_S8095620::analyze(), LHCB_2010_S8758301::analyze(), LHCB_2011_I917009::analyze(), CMS_2013_I1256943::analyze(), STAR_2009_UE_HELEN::analyze(), CDF_2006_S6653332::analyze(), LHCB_2013_I1208105::analyze(), ARGUS_1993_S2789213::analyze(), ALEPH_1999_S4193598::analyze(), UA1_1990_S2044935::analyze(), D0_2001_S4674421::analyze(), H1_1995_S3167097::analyze(), CMS_2013_I1218372::analyze(), CDF_2008_S7541902::analyze(), LHCB_2013_I1218996::analyze(), ATLAS_2012_I1183818::analyze(), JADE_1998_S3612880::analyze(), MC_PHOTONJETUE::analyze(), CDF_2010_S8591881_QCD::analyze(), CDF_2010_S8591881_DY::analyze(), TASSO_1990_S2148048::analyze(), MC_GENERIC::analyze(), LHCB_2012_I1119400::analyze(), ATLAS_2012_I1084540::analyze(), STAR_2008_S7869363::analyze(), D0_2008_S7719523::analyze(), ATLAS_2011_I926145::analyze(), ATLAS_2010_S8894728::analyze(), DELPHI_2003_WUD_03_11::analyze(), MC_SUSY::analyze(), ATLAS_2012_I1093738::analyze(), ALEPH_1996_S3486095::analyze(), ATLAS_2011_I944826::analyze(), ALEPH_2004_S5765862::analyze(), ATLAS_2012_I1094061::analyze(), DELPHI_1996_S3430090::analyze(), ATLAS_2012_I1093734::analyze(), BeamThrust::calc(), FParameter::calc(), Spherocity::calc(), Thrust::calc(), Sphericity::calc(), ParticleFinder::entities(), CMS_2013_I1261026::eventDecomp(), ATLAS_2010_S8918562::fillPtEtaNch(), CMS_2013_I1258128::makePhotonCut(), ParticleFinder::particlesByE(), ParticleFinder::particlesByEt(), ParticleFinder::particlesByEta(), ParticleFinder::particlesByModEta(), ParticleFinder::particlesByModRapidity(), ParticleFinder::particlesByP(), ParticleFinder::particlesByPt(), ParticleFinder::particlesByRapidity(), ChargedFinalState::project(), ChargedLeptons::project(), CentralEtHCM::project(), MergedFinalState::project(), FinalState::project(), DISLepton::project(), TriggerCDFRun0Run1::project(), TriggerCDFRun2::project(), NeutralFinalState::project(), HadronicFinalState::project(), PrimaryHadrons::project(), NonHadronicFinalState::project(), TauFinder::project(), VisibleFinalState::project(), PromptFinalState::project(), TriggerUA5::project(), LossyFinalState< ConstRandomFilter >::project(), LeadingParticlesFinalState::project(), FoxWolframMoments::project(), MissingMomentum::project(), InvMassFinalState::project(), DressedLeptons::project(), HeavyHadrons::project(), Hemispheres::project(), IdentifiedFinalState::project(), and VetoedFinalState::project().

{ return _theParticles; }
Particles particles ( Cut  c,
F  sorter 
) const [inline, inherited]

Get the final-state particles, with optional cuts.

Note:
Returns a copy rather than a reference, due to cuts Get the final-state particles, ordered by supplied sorting function object.
Returns a copy rather than a reference, due to cuts and sorting
Todo:
Update to use Cuts

Definition at line 52 of file ParticleFinder.hh.

References ParticleFinder::_theParticles, Rivet::Cuts::open(), and ParticleFinder::size().

                                               {
      Particles result;
      result.reserve(size());
      if ( c == Cuts::open() )
        result.assign(_theParticles.begin(), _theParticles.end());
      else 
    foreach (const Particle& p, _theParticles)
          if ( c->accept(p) ) result.push_back(p);
      std::sort(result.begin(), result.end(), sorter);
      return result;
    }
Particles particlesByE ( Cut  c = Cuts::open()) const [inline, inherited]

Get the final-state particles, ordered by decreasing $ E $.

Todo:

Update to use Cuts

Remove, since there is the templated method or sortByX methods available for these unusual cases?

Definition at line 80 of file ParticleFinder.hh.

References Rivet::cmpMomByE(), and ParticleFinder::particles().

                                                     {
      return particles(c, cmpMomByE);
    }
Particles particlesByEt ( Cut  c = Cuts::open()) const [inline, inherited]

Get the final-state particles, ordered by decreasing $ E_T $.

Todo:

Update to use Cuts

Remove, since there is the templated method or sortByX methods available for these unusual cases?

Definition at line 87 of file ParticleFinder.hh.

References Rivet::cmpMomByEt(), and ParticleFinder::particles().

                                                      {
      return particles(c, cmpMomByEt);
    }
Particles particlesByEta ( Cut  c = Cuts::open()) const [inline, inherited]

Get the final-state particles, ordered by increasing $ \eta $.

Todo:

Update to use Cuts

Remove, since there is the templated method or sortByX methods available for these unusual cases?

Definition at line 94 of file ParticleFinder.hh.

References Rivet::cmpMomByAscPseudorapidity(), and ParticleFinder::particles().

Referenced by ATLAS_2011_I894867::analyze(), CMS_2012_I1193338::analyze(), CMS_2012_I1184941::analyze(), ALICE_2012_I1181770::analyze(), ATLAS_2012_I1091481::analyze(), and ATLAS_2012_I1084540::fillMap().

                                                       {
      return particles(c, cmpMomByAscPseudorapidity);
    }
Particles particlesByModEta ( Cut  c = Cuts::open()) const [inline, inherited]

Get the final-state particles, ordered by increasing $ |\eta| $.

Todo:

Update to use Cuts

Remove, since there is the templated method or sortByX methods available for these unusual cases?

Definition at line 101 of file ParticleFinder.hh.

References Rivet::cmpMomByAscAbsPseudorapidity(), and ParticleFinder::particles().

                                                          {
      return particles(c, cmpMomByAscAbsPseudorapidity);
    }
Particles particlesByModRapidity ( Cut  c = Cuts::open()) const [inline, inherited]

Get the final-state particles, ordered by increasing $ |y| $.

Todo:

Update to use Cuts

Remove, since there is the templated method or sortByX methods available for these unusual cases?

Definition at line 115 of file ParticleFinder.hh.

References Rivet::cmpMomByAscAbsRapidity(), and ParticleFinder::particles().

                                                               {
      return particles(c, cmpMomByAscAbsRapidity);
    }
Particles particlesByP ( Cut  c = Cuts::open()) const [inline, inherited]

Get the final-state particles, ordered by decreasing $ p $.

Todo:

Update to use Cuts

Remove, since there is the templated method or sortByX methods available for these unusual cases?

Definition at line 73 of file ParticleFinder.hh.

References Rivet::cmpMomByP(), and ParticleFinder::particles().

                                                     {
      return particles(c, cmpMomByP);
    }
Particles particlesByPt ( Cut  c = Cuts::open()) const [inline, inherited]

Get the final-state particles, ordered by decreasing $ p_T $.

Todo:
Update to use Cuts

Definition at line 66 of file ParticleFinder.hh.

References Rivet::cmpMomByPt(), and ParticleFinder::particles().

Referenced by ATLAS_2011_S8994773::analyze(), CDF_2012_NOTE10874::analyze(), MC_PHOTONJETUE::analyze(), ATLAS_2012_I1124167::analyze(), ATLAS_2010_S8894728::analyze(), and ATLAS_2012_I1091481::analyze().

                                                      {
      return particles(c, cmpMomByPt);
    }
Particles particlesByRapidity ( Cut  c = Cuts::open()) const [inline, inherited]

Get the final-state particles, ordered by increasing $ y $.

Todo:

Update to use Cuts

Remove, since there is the templated method or sortByX methods available for these unusual cases?

Definition at line 108 of file ParticleFinder.hh.

References Rivet::cmpMomByAscRapidity(), and ParticleFinder::particles().

Referenced by ALICE_2012_I1181770::analyze(), and CMS_2013_I1218372::analyze().

                                                            {
      return particles(c, cmpMomByAscRapidity);
    }
void project ( const Event &  e) [protected, virtual]

Apply the projection on the supplied event.

Reimplemented from FinalState.

Definition at line 51 of file PromptFinalState.cc.

References ParticleFinder::_theParticles, Particle::charge(), Projection::getLog(), Log::isActive(), PromptFinalState::isPrompt(), MSG_DEBUG, MSG_TRACE, ParticleFinder::particles(), Particle::pid(), and Log::TRACE.

                                               {
    _theParticles.clear();

    const Particles& particles = applyProjection<FinalState>(e, "FS").particles();
    foreach (const Particle& p, particles)
      if (isPrompt(p)) _theParticles.push_back(p);
    MSG_DEBUG("Number of final state particles not from hadron decays = " << _theParticles.size());

    if (getLog().isActive(Log::TRACE)) {
      foreach (const Particle& p, _theParticles)
        MSG_TRACE("Selected: " << p.pid() << ", charge = " << p.charge());
    }
  }
void setName ( const std::string &  name) [inline, inherited]

Used by derived classes to set their name.

Definition at line 120 of file Projection.hh.

References Projection::_name, and Projection::name().

Referenced by TauFinder::_init(), FastJets::_init1(), FastJets::_init2(), FastJets::_init3(), Beam::Beam(), BeamThrust::BeamThrust(), CentralEtHCM::CentralEtHCM(), ChargedFinalState::ChargedFinalState(), ChargedLeptons::ChargedLeptons(), ConstLossyFinalState::ConstLossyFinalState(), DISFinalState::DISFinalState(), DISKinematics::DISKinematics(), DISLepton::DISLepton(), DressedLeptons::DressedLeptons(), FinalState::FinalState(), FoxWolframMoments::FoxWolframMoments(), FParameter::FParameter(), HadronicFinalState::HadronicFinalState(), HeavyHadrons::HeavyHadrons(), Hemispheres::Hemispheres(), IdentifiedFinalState::IdentifiedFinalState(), InitialQuarks::InitialQuarks(), JetAlg::JetAlg(), JetShape::JetShape(), LeadingParticlesFinalState::LeadingParticlesFinalState(), LossyFinalState< ConstRandomFilter >::LossyFinalState(), MergedFinalState::MergedFinalState(), MissingMomentum::MissingMomentum(), NeutralFinalState::NeutralFinalState(), NonHadronicFinalState::NonHadronicFinalState(), ParisiTensor::ParisiTensor(), PrimaryHadrons::PrimaryHadrons(), PromptFinalState::PromptFinalState(), Sphericity::Sphericity(), Spherocity::Spherocity(), Thrust::Thrust(), TriggerCDFRun0Run1::TriggerCDFRun0Run1(), TriggerCDFRun2::TriggerCDFRun2(), TriggerUA5::TriggerUA5(), UnstableFinalState::UnstableFinalState(), VetoedFinalState::VetoedFinalState(), VisibleFinalState::VisibleFinalState(), WFinder::WFinder(), and ZFinder::ZFinder().

                                        {
      _name = name;
    }
virtual size_t size ( ) const [inline, virtual, inherited]

Access the projected final-state particles.

Definition at line 34 of file ParticleFinder.hh.

References ParticleFinder::_theParticles.

Referenced by ATLAS_2011_I894867::analyze(), CMS_2012_I1193338::analyze(), TOTEM_2012_002::analyze(), TOTEM_2012_I1115294::analyze(), ATLAS_2010_S8591806::analyze(), CMS_2011_I954992::analyze(), ALEPH_1991_S2435284::analyze(), ALICE_2012_I1181770::analyze(), ATLAS_2011_S9002537::analyze(), UA5_1982_S875503::analyze(), ATLAS_2011_S8994773::analyze(), CDF_2009_NOTE_9936::analyze(), SLD_1996_S3398250::analyze(), CDF_2012_NOTE10874::analyze(), DELPHI_2000_S4328825::analyze(), OPAL_2002_S5361494::analyze(), ALICE_2010_S8625980::analyze(), STAR_2006_S6500200::analyze(), CDF_2009_S8233977::analyze(), UA5_1986_S1583476::analyze(), ALICE_2010_S8624100::analyze(), STAR_2006_S6860818::analyze(), UA1_1990_S2044935::analyze(), ALEPH_1999_S4193598::analyze(), CMS_2013_I1261026::analyze(), ATLAS_2012_I1183818::analyze(), MC_PHOTONJETUE::analyze(), ATLAS_2012_I1124167::analyze(), MC_GENERIC::analyze(), ATLAS_2011_I926145::analyze(), ATLAS_2010_S8894728::analyze(), OPAL_2004_S6132243::analyze(), MC_SUSY::analyze(), ATLAS_2010_S8918562::analyze(), ATLAS_2010_S8918562::fillPtEtaNch(), and ParticleFinder::particles().

{ return _theParticles.size(); }

Friends And Related Function Documentation

friend class Cmp< Projection > [friend, inherited]

The Cmp specialization for Projection is a friend.

Definition at line 35 of file Projection.hh.

friend class Event [friend, inherited]

Event is a friend.

Definition at line 32 of file Projection.hh.

Member Data Documentation

bool _acceptMuDecays [private]

Definition at line 59 of file PromptFinalState.hh.

Referenced by PromptFinalState::acceptMuonDecays(), PromptFinalState::compare(), and PromptFinalState::isPrompt().

bool _acceptTauDecays [private]

Definition at line 59 of file PromptFinalState.hh.

Referenced by PromptFinalState::acceptTauDecays(), PromptFinalState::compare(), and PromptFinalState::isPrompt().

bool _allowProjReg [protected, inherited]

Flag to forbid projection registration in analyses until the init phase.

Definition at line 143 of file ProjectionApplier.hh.

Referenced by ProjectionApplier::_addProjection(), and Analysis::Analysis().

Cut _cuts [protected, inherited]

The applicable cuts.

Definition at line 151 of file ParticleFinder.hh.

Referenced by FinalState::accept(), FinalState::compare(), ParticleFinder::compare(), FinalState::FinalState(), FinalState::project(), and UnstableFinalState::project().

Particles _theParticles [protected, inherited]

The final-state particles.

Definition at line 154 of file ParticleFinder.hh.

Referenced by InvMassFinalState::calc(), ChargedLeptons::chargedLeptons(), TauFinder::clear(), ZFinder::clear(), WFinder::clear(), ParticleFinder::empty(), ParticleFinder::isEmpty(), ParticleFinder::particles(), ChargedFinalState::project(), ChargedLeptons::project(), FinalState::project(), MergedFinalState::project(), NeutralFinalState::project(), HadronicFinalState::project(), NonHadronicFinalState::project(), DISFinalState::project(), PrimaryHadrons::project(), VisibleFinalState::project(), UnstableFinalState::project(), PromptFinalState::project(), LossyFinalState< ConstRandomFilter >::project(), LeadingParticlesFinalState::project(), DressedLeptons::project(), HeavyHadrons::project(), ZFinder::project(), WFinder::project(), IdentifiedFinalState::project(), VetoedFinalState::project(), and ParticleFinder::size().

The documentation for this class was generated from the following files:
Generated on Tue Sep 30 2014 19:46:02 for The Rivet MC analysis system by   doxygen 1.7.6.1