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

Abstract base class for projections which can return a set of Jets. More...

#include <JetAlg.hh>

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

List of all members.

Public Types

typedef Jet entity_type
typedef Jets collection_type

Public Member Functions

 JetAlg (const FinalState &fs)
 Constructor.
 JetAlg ()
virtual const Projection * clone () const =0
 Clone on the heap.
virtual ~JetAlg ()
 Destructor.
void useInvisibles (bool useinvis=true)
 Include invisible particles in jet construction. The default behaviour is that jets are only constructed from visible (i.e. charged under an SM gauge group) particles. Some jet studies, including those from ATLAS, use a definition in which neutrinos from hadron decays are included (via MC correction) in the experimental jet definition. Setting this flag to true avoids the automatic restriction to a VisibleFinalState.
virtual Jets jets (const Cut &c=Cuts::open()) const
template<typename F >
Jets jets (F sorter, const Cut &c=Cuts::open()) const
template<typename F >
Jets jets (const Cut &c, F sorter) const
Jets jetsByPt (const Cut &c=Cuts::open()) const
virtual size_t size () const =0
 Number of jets.
bool empty () const
 Determine if the jet collection is empty.
virtual void reset ()=0
 Clear the projection.
collection_type entities () const
 Template-usable interface common to FinalState.
virtual void calc (const Particles &constituents, const Particles &tagparticles=Particles())=0
 Do the calculation locally (no caching).
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.
Old sorted jet accessors
Deprecated:
Use the versions with sorter function arguments
Jets jetsByP (const Cut &c=Cuts::open()) const
Jets jetsByE (const Cut &c=Cuts::open()) const
Jets jetsByEt (const Cut &c=Cuts::open()) const
Old jet accessors
Deprecated:
Use the versions with Cut arguments
Jets jets (double ptmin, double ptmax=MAXDOUBLE, double rapmin=-MAXDOUBLE, double rapmax=MAXDOUBLE, RapScheme rapscheme=PSEUDORAPIDITY) const
Jets jetsByPt (double ptmin) 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

virtual Jets _jets (double ptmin=0) const =0
 Internal pure virtual method for getting jets in no guaranteed order. An optional cut on min $ p_\perp $ is applied in this function, since that is directly supported by FastJet and it seems a shame to not make use of that. But all other jet cuts are applied at the ::jets() function level.
virtual void project (const Event &e)=0
 Perform the projection on the Event.
virtual int compare (const Projection &p) const =0
 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

bool _useInvisibles
 Flag to determine whether or not the VFS wrapper is to be used.
bool _allowProjReg
 Flag to forbid projection registration in analyses until the init phase.

Friends

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

Detailed Description

Abstract base class for projections which can return a set of Jets.

Definition at line 15 of file JetAlg.hh.

Member Typedef Documentation

typedef Jets collection_type

Definition at line 169 of file JetAlg.hh.

typedef Jet entity_type

Definition at line 168 of file JetAlg.hh.

Constructor & Destructor Documentation

JetAlg ( const FinalState &  fs)

Constructor.

Definition at line 7 of file JetAlg.cc.

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

    : _useInvisibles(false)
  {
    setName("JetAlg");
    addProjection(fs, "FS");
    VisibleFinalState vfs(fs);
    MSG_DEBUG("Making visible final state from provided FS");
    addProjection(vfs, "VFS");
  }
JetAlg ( ) [inline]

Definition at line 21 of file JetAlg.hh.

{};
virtual ~JetAlg ( ) [inline, virtual]

Destructor.

Definition at line 27 of file JetAlg.hh.

{ }

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;
  }
virtual Jets _jets ( double  ptmin = 0) const [protected, pure virtual]

Internal pure virtual method for getting jets in no guaranteed order. An optional cut on min $ p_\perp $ is applied in this function, since that is directly supported by FastJet and it seems a shame to not make use of that. But all other jet cuts are applied at the ::jets() function level.

Todo:
Remove the ptmin cut

Implemented in FastJets.

Referenced by JetAlg::jets().

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 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(), CMS_2010_S8547297::init(), CMS_2010_S8656010::init(), ATLAS_2010_S8894728::init(), ALICE_2012_I1181770::init(), ATLAS_2011_S8994773::init(), CMS_2011_S8950903::init(), CMS_2012_PAS_QCD_11_010::init(), CMS_2011_S8968497::init(), CMS_2012_I1193338::init(), CMS_2012_I1184941::init(), CMSTOTEM_2014_I1294140::init(), ATLAS_2014_I1298811::init(), ATLAS_2011_I894867::init(), ALICE_2011_S8909580::init(), LHCB_2013_I1208105::init(), CMS_2011_S8941262::init(), CMS_2011_S8973270::init(), CMS_2012_I1090423::init(), ATLAS_2010_CONF_2010_049::init(), CDF_2007_S7057202::init(), CMS_2011_S9086218::init(), TOTEM_2012_I1115294::init(), CMS_2011_S9215166::init(), CMS_2012_I1087342::init(), ATLAS_2014_I1282441::init(), ALICE_2011_S8945144::init(), ATLAS_2012_I1091481::init(), MC_MUONS::init(), MC_TAUS::init(), ATLAS_2010_S8591806::init(), ATLAS_2011_S9002537::init(), CMS_2011_I954992::init(), CMS_2011_S8957746::init(), CMS_2011_S8978280::init(), TOTEM_2012_002::init(), CMS_2011_S9088458::init(), CMS_2013_I1265659::init(), D0_2011_I895662::init(), ATLAS_2011_I930220::init(), LHCF_2012_I1115479::init(), MC_ELECTRONS::init(), CDF_2012_NOTE10874::init(), CMS_2013_I1273574::init(), D0_2010_S8570965::init(), ATLAS_2011_I925932::init(), MC_JETTAGS::init(), ATLAS_2012_I1124167::init(), STAR_2006_S6500200::init(), STAR_2008_S7993412::init(), CMS_2013_I1256943::init(), CMS_QCD_10_024::init(), UA5_1987_S1640666::init(), CDF_1997_S3541940::init(), MC_HINC::init(), MC_JETS::init(), MC_KTSPLITTINGS::init(), CDF_2005_S6080774::init(), CDF_2006_S6450792::init(), SFM_1984_S1178091::init(), ARGUS_1993_S2789213::init(), ATLAS_2011_S9128077::init(), CMS_2013_I1261026::init(), CMS_2013_I1258128::init(), CMS_2014_I1298810::init(), D0_2000_S4480767::init(), BABAR_2007_S7266081::init(), BELLE_2008_I786560::init(), CDF_1993_S2742446::init(), CDF_2000_S4155203::init(), MC_WWINC::init(), CDF_2008_S7782535::init(), MC_ZJETS::init(), CDF_2008_S8093652::init(), MC_ZZINC::init(), STAR_2006_S6870392::init(), UA5_1982_S875503::init(), UA5_1989_S1926373::init(), ATLAS_2013_I1190187::init(), CMS_2013_I1209721::init(), D0_2008_S6879055::init(), ATLAS_2012_I1204447::init(), ARGUS_1993_S2669951::init(), LHCB_2012_I1208102::init(), ATLAS_2011_I944826::init(), MC_ZINC::init(), ALEPH_1991_S2435284::init(), MC_WINC::init(), MC_WJETS::init(), MC_WWKTSPLITTINGS::init(), MC_ZZJETS::init(), ATLAS_2012_I1183818::init(), ATLAS_2011_S9035664::init(), ATLAS_2012_I1204784::init(), CMS_2012_I1102908::init(), ATLAS_2013_I1219109::init(), CMS_2013_I1272853::init(), ATLAS_2013_I1243871::init(), ATLAS_2014_I1268975::init(), D0_2000_I499943::init(), ATLAS_2014_I1325553::init(), E735_1998_S3905616::init(), MC_ZZKTSPLITTINGS::init(), MC_DIJET::init(), MC_DIPHOTON::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(), ATLAS_2010_S8817804::init(), PDG_TAUS::init(), D0_1996_S3324664::init(), D0_2007_S7075677::init(), D0_2009_S8202443::init(), D0_2010_S8821313::init(), ALEPH_2002_S4823664::init(), DELPHI_1999_S3960137::init(), ALEPH_1996_S3196992::init(), UA5_1986_S1583476::init(), EXAMPLE_CUTS::init(), CDF_1990_S2089246::init(), CDF_1988_S1865951::init(), MC_ZKTSPLITTINGS::init(), MC_HJETS::init(), MC_HKTSPLITTINGS::init(), CDF_2005_S6217184::init(), MC_PHOTONINC::init(), MC_WKTSPLITTINGS::init(), ATLAS_2011_S8924791::init(), ATLAS_2011_I945498::init(), MC_PHOTONKTSPLITTINGS::init(), MC_PHOTONJETS::init(), MC_WWJETS::init(), CMS_2012_I1107658::init(), D0_2008_S7554427::init(), D0_2008_S7863608::init(), D0_2010_S8671338::init(), MC_IDENTIFIED::init(), H1_1995_S3167097::init(), CDF_1994_S2952106::init(), ATLAS_2011_I954993::init(), ATLAS_2012_CONF_2012_104::init(), ATLAS_2012_CONF_2012_105::init(), UA1_1990_S2044935::init(), ZEUS_2001_S4815815::init(), LHCB_2011_I919315::init(), ATLAS_2012_I1119557::init(), MC_GENERIC::init(), ATLAS_2012_I1180197::init(), MC_LEADJETUE::init(), MC_PHOTONJETUE::init(), MC_TTBAR::init(), ATLAS_2012_I1188891::init(), CDF_2008_S7828950::init(), CDF_2008_S7540469::init(), D0_2001_S4674421::init(), ATLAS_2014_I1300647::init(), D0_2008_S7837160::init(), ATLAS_2011_S9131140::init(), ATLAS_2011_S9212353::init(), ATLAS_2014_I1306615::init(), ATLAS_2014_I1307756::init(), CDF_2008_S8095620::init(), ATLAS_2013_I1217863_W::init(), CMS_2012_I941555::init(), ATLAS_2012_I1126136::init(), EXAMPLE::init(), ATLAS_2013_I1217863_Z::init(), CMS_2014_I1303894::init(), D0_1996_S3214044::init(), ALICE_2010_S8624100::init(), ATLAS_2011_CONF_2011_098::init(), DELPHI_1995_S3137023::init(), ATLAS_2012_CONF_2012_109::init(), ATLAS_2012_I1095236::init(), STAR_2009_UE_HELEN::init(), OPAL_1997_S3396100::init(), ATLAS_2012_CONF_2012_103::init(), JADE_1998_S3612880::init(), ATLAS_2011_S8983313::init(), JADE_OPAL_2000_S4300807::init(), STAR_2006_S6860818::init(), CDF_1996_S3108457::init(), ATLAS_2011_I926145::init(), MC_QCD_PARTONS::init(), ATLAS_2012_I1186556::init(), ALEPH_2004_S5765862::init(), ATLAS_2012_I1125961::init(), ATLAS_2011_S9212183::init(), LHCB_2013_I1218996::init(), ATLAS_2012_CONF_2012_001::init(), ALICE_2010_S8706239::init(), MC_HFJETS::init(), ATLAS_2014_I1288706::init(), ATLAS_2012_I1112263::init(), ATLAS_2012_I1190891::init(), CMS_2013_I1218372::init(), ATLAS_2012_I1125575::init(), ALICE_2010_S8625980::init(), CDF_2009_NOTE_9936::init(), CDF_1996_S3349578::init(), MC_SUSY::init(), ATLAS_2011_S8971293::init(), CDF_2009_S8383952::init(), CDF_2009_S8436959::init(), CDF_1998_S3618439::init(), ATLAS_2013_I1263495::init(), D0_2009_S8320160::init(), CDF_2000_S4266730::init(), D0_2009_S8349509::init(), CDF_2001_S4563131::init(), CDF_2001_S4517016::init(), D0_2006_S6438750::init(), ALEPH_2001_S4656318::init(), SLD_2002_S4869273::init(), ATLAS_2010_S8919674::init(), ATLAS_2012_I1082936::init(), D0_2010_S8566488::init(), DELPHI_2002_069_CONF_603::init(), MC_PHOTONS::init(), CDF_1996_S3418421::init(), LHCB_2011_I917009::init(), LHCB_2014_I1281685::init(), UA5_1988_S1867512::init(), SLD_1996_S3398250::init(), ATLAS_2011_I921594::init(), LHCB_2012_I1119400::init(), ATLAS_2011_S9108483::init(), MC_WPOL::init(), CDF_2006_S6653332::init(), CDF_2008_S7541902::init(), ATLAS_2014_I1306294::init(), ATLAS_2014_I1304688::init(), D0_2008_S7662670::init(), ATLAS_2013_I1230812::init(), ATLAS_2012_I1199269::init(), ATLAS_2014_I1307243::init(), DELPHI_2000_S4328825::init(), ATLAS_2012_I943401::init(), OPAL_2002_S5361494::init(), TASSO_1990_S2148048::init(), ATLAS_2012_I946427::init(), ATLAS_2012_I1117704::init(), ATLAS_2011_S9019561::init(), ATLAS_2011_CONF_2011_090::init(), ATLAS_2011_S9225137::init(), ATLAS_2012_I1082009::init(), ATLAS_2012_I1084540::init(), CMS_2013_I1224539_WJET::init(), CMS_2013_I1224539_DIJET::init(), ATLAS_2012_I1083318::init(), ATLAS_2012_CONF_2012_153::init(), CDF_2009_S8233977::init(), ATLAS_2013_I1217867::init(), CMS_2013_I1224539_ZJET::init(), CDF_2010_S8591881_DY::init(), CDF_2010_S8591881_QCD::init(), D0_2004_S5992206::init(), ATLAS_2010_S8914702::init(), ATLAS_2014_I1312627::init(), ATLAS_2010_S8918562::init(), ATLAS_2011_S9120807::init(), CDF_2001_S4751469::init(), D0_2008_S7719523::init(), ATLAS_2011_S9041966::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(), MC_VH2BB::init(), BABAR_2005_S6181155::init(), BELLE_2001_S4598261::init(), ATLAS_2011_I919017::init(), OPAL_2001_S4553896::init(), BABAR_2013_I1238276::init(), DELPHI_2003_WUD_03_11::init(), ATLAS_2012_I1203852::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(), H1_1994_S2919893::init(), H1_2000_S4129130::init(), SLD_2004_S5693039::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(), TauFinder::TauFinder(), 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 void calc ( const Particles &  constituents,
const Particles &  tagparticles = Particles() 
) [pure virtual]

Do the calculation locally (no caching).

Implemented in FastJets.

virtual const Projection* clone ( ) const [pure virtual]

Clone on the heap.

Implements Projection.

Implemented in FastJets.

virtual int compare ( const Projection &  p) const [protected, pure virtual]

Compare projections.

Implements Projection.

Implemented in FastJets.

bool empty ( ) const [inline]

Determine if the jet collection is empty.

Definition at line 163 of file JetAlg.hh.

References JetAlg::size().

{ return size() != 0; }
collection_type entities ( ) const [inline]

Template-usable interface common to FinalState.

Definition at line 172 of file JetAlg.hh.

References JetAlg::jets().

{ return jets(); }
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(), PromptFinalState::project(), LossyFinalState< ConstRandomFilter >::project(), UnstableFinalState::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 Jets jets ( const Cut &  c = Cuts::open()) const [inline, virtual]

Get jets in no guaranteed order, with optional cuts on $ p_\perp $ and rapidity.

Note:
Returns a copy rather than a reference, due to cuts
Todo:
Can't this be a const Cut& arg?

Definition at line 43 of file JetAlg.hh.

References JetAlg::_jets(), Rivet::Cuts::open(), and JetAlg::size().

Referenced by CMS_2012_I1087342::analyze(), CMS_2011_S9086218::analyze(), CMS_2012_I1102908::analyze(), ZEUS_2001_S4815815::analyze(), CDF_2008_S7540469::analyze(), CDF_2008_S7782535::analyze(), D0_2008_S7662670::analyze(), CDF_2008_S7541902::analyze(), ATLAS_2013_I1217863_Z::analyze(), ATLAS_2013_I1217863_W::analyze(), JetAlg::entities(), JetAlg::jets(), JetAlg::jetsByE(), JetAlg::jetsByEt(), JetAlg::jetsByP(), and JetAlg::jetsByPt().

                                                        {
      const Jets rawjets = _jets(0.0); // arg means no pT cut
      // Just return a copy of rawjets if the cut is open
      if (c == Cuts::open()) return rawjets;
      // If there is a non-trivial cut...
      Jets rtn;
      rtn.reserve(size());
      foreach (const Jet& j, rawjets)
        if (c->accept(j)) rtn.push_back(j);
      return rtn;
    }
Jets jets ( F  sorter,
const Cut &  c = Cuts::open() 
) const [inline]

Get the jets, ordered by supplied sorting function object, with optional cuts on $ p_\perp $ and rapidity.

Note:
Returns a copy rather than a reference, due to cuts and sorting
Todo:
Will the vector be efficiently std::move'd by value through this function chain?

Definition at line 58 of file JetAlg.hh.

References JetAlg::jets(), and Rivet::sortBy().

                                                          {
      /// @todo Will the vector be efficiently std::move'd by value through this function chain?
      return sortBy(jets(c), sorter);
    }
Jets jets ( const Cut &  c,
F  sorter 
) const [inline]

Get the jets, ordered by supplied sorting function object, with optional cuts on $ p_\perp $ and rapidity.

Note:
Returns a copy rather than a reference, due to cuts and sorting
Todo:
Will the vector be efficiently std::move'd by value through this function chain?

Definition at line 66 of file JetAlg.hh.

References JetAlg::jets(), and Rivet::sortBy().

                                               {
      /// @todo Will the vector be efficiently std::move'd by value through this function chain?
      return sortBy(jets(c), sorter);
    }
Jets jets ( double  ptmin,
double  ptmax = MAXDOUBLE,
double  rapmin = -MAXDOUBLE,
double  rapmax = MAXDOUBLE,
RapScheme  rapscheme = PSEUDORAPIDITY 
) const [inline]

Get jets in no guaranteed order, with optional cuts on $ p_\perp $ and rapidity.

Deprecated:
Use the version with a Cut argument
Note:
Returns a copy rather than a reference, due to cuts

Definition at line 123 of file JetAlg.hh.

References Rivet::Cuts::etaIn(), JetAlg::jets(), Rivet::Cuts::pT, Rivet::RAPIDITY, and Rivet::Cuts::rapIn().

                                                        {
      if (rapscheme == PSEUDORAPIDITY) {
        return jets((Cuts::pT >= ptmin) & (Cuts::pT < ptmax) & (Cuts::rapIn(rapmin, rapmax)));
      } else if (rapscheme == RAPIDITY) {
        return jets((Cuts::pT >= ptmin) & (Cuts::pT < ptmax) & (Cuts::etaIn(rapmin, rapmax)));
      }
      throw LogicError("Unknown rapidity scheme. This shouldn't be possible!");
    }
Jets jetsByE ( const Cut &  c = Cuts::open()) const [inline]

Get the jets, ordered by $ E $, with optional cuts on $ p_\perp $ and rapidity.

Note:
Returns a copy rather than a reference, due to cuts and sorting
Deprecated:
Use the version with a sorter function argument.

Definition at line 99 of file JetAlg.hh.

References Rivet::cmpMomByE(), and JetAlg::jets().

                                                   {
      return jets(c, cmpMomByE);
    }
Jets jetsByEt ( const Cut &  c = Cuts::open()) const [inline]

Get the jets, ordered by $ E_T $, with optional cuts on $ p_\perp $ and rapidity.

Note:
Returns a copy rather than a reference, due to cuts and sorting
Deprecated:
Use the version with a sorter function argument.

Definition at line 107 of file JetAlg.hh.

References Rivet::cmpMomByEt(), and JetAlg::jets().

                                                    {
      return jets(c, cmpMomByEt);
    }
Jets jetsByP ( const Cut &  c = Cuts::open()) const [inline]

Get the jets, ordered by $ |p| $, with optional cuts on $ p_\perp $ and rapidity.

Note:
Returns a copy rather than a reference, due to cuts and sorting
Deprecated:
Use the version with a sorter function argument.

Definition at line 91 of file JetAlg.hh.

References Rivet::cmpMomByP(), and JetAlg::jets().

                                                   {
      return jets(c, cmpMomByP);
    }
Jets jetsByPt ( const Cut &  c = Cuts::open()) const [inline]

Get the jets, ordered by $ p_T $, with optional cuts.

Note:
Returns a copy rather than a reference, due to cuts and sorting

This is a very common use-case, so is available as syntatic sugar for jets(c, cmpMomByPt).

Todo:
The other sorted accessors should be removed in a cleanup.

Definition at line 78 of file JetAlg.hh.

References Rivet::cmpMomByPt(), and JetAlg::jets().

Referenced by CDF_2008_S8093652::analyze(), STAR_2006_S6870392::analyze(), ATLAS_2010_CONF_2010_049::analyze(), CMS_2011_S9215166::analyze(), CMS_2013_I1272853::analyze(), MC_DIJET::analyze(), MC_LEADJETUE::analyze(), D0_2008_S7863608::analyze(), CMS_2013_I1209721::analyze(), D0_2004_S5992206::analyze(), CMS_2013_I1218372::analyze(), ATLAS_2012_I1183818::analyze(), CMS_2013_I1261026::analyze(), MC_TTBAR::analyze(), CDF_2001_S4751469::analyze(), ATLAS_2012_I1083318::analyze(), ATLAS_2014_I1312627::analyze(), MC_SUSY::analyze(), CDF_2009_S8057893::CDF_2009_S8057893::analyze(), CMS_2013_I1261026::eventDecomp(), CMS_2013_I1258128::makePhotonCut(), CMS_2013_I1258128::makeZCut(), and ATLAS_2011_I945498::selectJets().

                                                    {
      return jets(c, cmpMomByPt);
    }
Jets jetsByPt ( double  ptmin) const [inline]

Get the jets, ordered by $ p_T $, with a cut on $ p_\perp $.

Deprecated:
Use the version with a Cut argument
Note:
Returns a copy rather than a reference, due to cuts and sorting

This is a very common use-case, so is available as syntatic sugar for jets(Cuts::pT >= ptmin, cmpMomByPt).

Todo:
The other sorted accessors should be removed in a cleanup.

Definition at line 141 of file JetAlg.hh.

References Rivet::cmpMomByPt(), JetAlg::jets(), and Rivet::Cuts::pT.

                                      {
      return jets(Cuts::pT >= ptmin, cmpMomByPt);
    }
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 BeamThrust::compare(), ChargedLeptons::compare(), FParameter::compare(), CentralEtHCM::compare(), MergedFinalState::compare(), ChargedFinalState::compare(), DISLepton::compare(), DISKinematics::compare(), DISFinalState::compare(), VisibleFinalState::compare(), TauFinder::compare(), PromptFinalState::compare(), NeutralFinalState::compare(), Spherocity::compare(), ParisiTensor::compare(), LeadingParticlesFinalState::compare(), FoxWolframMoments::compare(), MissingMomentum::compare(), LossyFinalState< ConstRandomFilter >::compare(), Thrust::compare(), InvMassFinalState::compare(), Sphericity::compare(), HeavyHadrons::compare(), ZFinder::compare(), Hemispheres::compare(), DressedLeptons::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 void project ( const Event &  e) [protected, pure virtual]

Perform the projection on the Event.

Implements Projection.

Implemented in FastJets.

virtual void reset ( ) [pure virtual]

Clear the projection.

Implemented in FastJets.

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 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(), TauFinder::TauFinder(), 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 [pure virtual]

Number of jets.

Implemented in FastJets.

Referenced by ZEUS_2001_S4815815::analyze(), D0_2004_S5992206::analyze(), JetAlg::empty(), and JetAlg::jets().

void useInvisibles ( bool  useinvis = true) [inline]

Include invisible particles in jet construction. The default behaviour is that jets are only constructed from visible (i.e. charged under an SM gauge group) particles. Some jet studies, including those from ATLAS, use a definition in which neutrinos from hadron decays are included (via MC correction) in the experimental jet definition. Setting this flag to true avoids the automatic restriction to a VisibleFinalState.

Definition at line 35 of file JetAlg.hh.

References JetAlg::_useInvisibles.

Referenced by CMS_2011_S8973270::init(), ATLAS_2011_I930220::init(), D0_2011_I895662::init(), ATLAS_2011_S9128077::init(), CDF_2008_S7782535::init(), D0_2000_I499943::init(), ATLAS_2014_I1268975::init(), ATLAS_2014_I1325553::init(), ATLAS_2013_I1219109::init(), ATLAS_2011_S8924791::init(), CDF_2005_S6217184::init(), ATLAS_2011_I945498::init(), CMS_2014_I1303894::init(), ATLAS_2013_I1217863_Z::init(), JADE_OPAL_2000_S4300807::init(), ALEPH_2004_S5765862::init(), ATLAS_2013_I1217863_W::init(), MC_HFJETS::init(), ATLAS_2012_I1082936::init(), ATLAS_2014_I1304688::init(), ATLAS_2014_I1306294::init(), ATLAS_2013_I1230812::init(), ATLAS_2014_I1307243::init(), ATLAS_2012_I1083318::init(), ATLAS_2013_I1217867::init(), ATLAS_2014_I1312627::init(), and ATLAS_2012_I1093738::init().

                                           {
      _useInvisibles = useinvis;
    }

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 _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().

bool _useInvisibles [protected]

Flag to determine whether or not the VFS wrapper is to be used.

Definition at line 190 of file JetAlg.hh.

Referenced by FastJets::compare(), FastJets::project(), and JetAlg::useInvisibles().

The documentation for this class was generated from the following files:
Generated on Tue Mar 24 2015 17:35:44 for The Rivet MC analysis system by   doxygen 1.7.6.1