rivet is hosted by Hepforge, IPPP Durham

Produce a final state which only contains specified particle IDs. More...

#include <IdentifiedFinalState.hh>

Inheritance diagram for IdentifiedFinalState:
Collaboration diagram for IdentifiedFinalState:

List of all members.

Public Types

typedef Particle entity_type
typedef Particles collection_type

Public Member Functions

const set< PdgId > & acceptedIds () const
 Get the list of particle IDs to accept.
IdentifiedFinalStateacceptId (PdgId pid)
 Add an accepted particle ID.
IdentifiedFinalStateacceptIds (const vector< PdgId > &pids)
 Add a set of accepted particle IDs.
IdentifiedFinalStateacceptIdPair (PdgId pid)
 Add an accepted particle ID and its antiparticle.
IdentifiedFinalStateacceptIdPairs (const vector< PdgId > &pids)
 Add a set of accepted particle IDs and their antiparticles.
IdentifiedFinalStateacceptNeutrinos ()
 Accept all neutrinos (convenience method).
IdentifiedFinalStateacceptChLeptons ()
 Accept all charged leptons (convenience method).
void reset ()
 Reset the list of particle IDs to accept.
virtual const Particlesparticles () const
 Get the final-state particles.
template<typename F >
const Particlesparticles (F sorter) const
 Get the final-state particles, ordered by supplied sorting function object.
const ParticlesparticlesByPt () const
 Get the final-state particles, ordered by decreasing $ p_T $.
const ParticlesparticlesByP () const
 Get the final-state particles, ordered by decreasing $ p $.
const ParticlesparticlesByE () const
 Get the final-state particles, ordered by decreasing $ E $.
const ParticlesparticlesByEt () const
 Get the final-state particles, ordered by decreasing $ E_T $.
const ParticlesparticlesByEta () const
 Get the final-state particles, ordered by increasing $ \eta $.
const ParticlesparticlesByModEta () const
 Get the final-state particles, ordered by increasing $ |\eta| $.
const ParticlesparticlesByRapidity () const
 Get the final-state particles, ordered by increasing $ y $.
const ParticlesparticlesByModRapidity () const
 Get the final-state particles, ordered by increasing $ |y| $.
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 double ptMin () const
 Minimum- $ p_\perp $ requirement.
const collection_typeentities () const
 Template-usable interface common to JetAlg.
bool before (const Projection &p) const
virtual const std::set< PdgIdPairbeamPairs () const
virtual std::string name () const
 Get the name of the projection.
ProjectionaddPdgIdPair (PdgId beam1, PdgId beam2)
 Add a colliding beam pair.
LoggetLog () 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
 IdentifiedFinalState (const FinalState &fsp)
 Constructor with specific FinalState.
 IdentifiedFinalState (double etamin=-MAXRAPIDITY, double etamax=MAXRAPIDITY, double ptMin=0.0 *GeV)
 Constructor with a single eta range argument.
 IdentifiedFinalState (const vector< pair< double, double > > &etaRanges, double ptMin=0.0 *GeV)
virtual const Projectionclone () const
 Clone on the heap.
Projection "getting" functions
std::set< ConstProjectionPtrgetProjections () 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 ProjectiongetProjection (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.
bool accept (const Particle &p) const
 Decide if a particle is to be accepted or not.
Cmp< ProjectionmkNamedPCmp (const Projection &otherparent, const std::string &pname) const
Cmp< ProjectionmkPCmp (const Projection &otherparent, const std::string &pname) const
ProjectionHandlergetProjHandler () 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

vector< pair< double, double > > _etaRanges
 The ranges allowed for pseudorapidity.
double _ptmin
 The minimum allowed transverse momentum.
Particles _theParticles
 The final-state particles.
bool _allowProjReg
 Flag to forbid projection registration in analyses until the init phase.

Private Attributes

set< PdgId_pids
 The final-state particles.

Friends

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

Detailed Description

Produce a final state which only contains specified particle IDs.

Definition at line 16 of file IdentifiedFinalState.hh.


Member Typedef Documentation

typedef Particles collection_type [inherited]

Definition at line 103 of file FinalState.hh.

typedef Particle entity_type [inherited]

Definition at line 102 of file FinalState.hh.


Constructor & Destructor Documentation

IdentifiedFinalState ( const FinalState fsp)

Constructor with specific FinalState.

Definition at line 7 of file IdentifiedFinalState.cc.

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

Referenced by IdentifiedFinalState::clone().

                                                                  {
    setName("IdentifiedFinalState");
    addProjection(fsp, "FS");
  }
IdentifiedFinalState ( double  etamin = -MAXRAPIDITY,
double  etamax = MAXRAPIDITY,
double  ptMin = 0.0*GeV 
)

Constructor with a single eta range argument.

Definition at line 13 of file IdentifiedFinalState.cc.

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

    : FinalState(etamin, etamax, ptMin)
  {
    setName("IdentifiedFinalState");
    addProjection(FinalState(etamin, etamax, ptMin), "FS");
  }
IdentifiedFinalState ( const vector< pair< double, double > > &  etaRanges,
double  ptMin = 0.0*GeV 
)

Constructor which allows to specify multiple eta ranges and the min $ p_T $.

Definition at line 21 of file IdentifiedFinalState.cc.

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

    : FinalState(etaRanges, ptMin)
  {
    setName("IdentifiedFinalState");
    addProjection(FinalState(etaRanges, ptMin), "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 [protected, inherited]

Decide if a particle is to be accepted or not.

Definition at line 93 of file FinalState.cc.

References FinalState::_etaRanges, FinalState::_ptmin, ParticleBase::eta(), Particle::genParticle(), Rivet::inRange(), and ParticleBase::pT().

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

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

    // Check pT cut
    if (_ptmin > 0.0) {
      if (p.pT() < _ptmin) return false;
    }

    // Check eta cuts
    if (!_etaRanges.empty()) {
      bool eta_pass = false;
      typedef pair<double,double> EtaPair;
      foreach (const EtaPair& etacuts, _etaRanges) {
        if (inRange(p.eta(), etacuts.first, etacuts.second)) {
          eta_pass = true;
          break;
        }
      }
      if (!eta_pass) return false;
    }

    return true;
  }

Accept all charged leptons (convenience method).

Definition at line 88 of file IdentifiedFinalState.hh.

References IdentifiedFinalState::acceptIdPair(), Rivet::PID::ELECTRON, Rivet::PID::MUON, and Rivet::PID::TAU.

Referenced by MC_PHOTONS::init().

const set<PdgId>& acceptedIds ( ) const [inline]

Get the list of particle IDs to accept.

Definition at line 45 of file IdentifiedFinalState.hh.

References IdentifiedFinalState::_pids.

Referenced by IdentifiedFinalState::project().

                                          {
      return _pids;
    }
IdentifiedFinalState& acceptIdPairs ( const vector< PdgId > &  pids) [inline]

Add a set of accepted particle IDs and their antiparticles.

Definition at line 71 of file IdentifiedFinalState.hh.

References IdentifiedFinalState::_pids.

                                                                   {
      foreach (const PdgId pid, pids) {
        _pids.insert(pid);
        _pids.insert(-pid);
      }
      return *this;
    }
IdentifiedFinalState& acceptIds ( const vector< PdgId > &  pids) [inline]

Add a set of accepted particle IDs.

Definition at line 56 of file IdentifiedFinalState.hh.

References IdentifiedFinalState::_pids.

                                                               {
      foreach (const PdgId pid, pids) {
        _pids.insert(pid);
      }
      return *this;
    }
Projection& addPdgIdPair ( PdgId  beam1,
PdgId  beam2 
) [inline, inherited]

Add a colliding beam pair.

Definition at line 109 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 ZFinder::_init(), WFinder::_init(), VetoedFinalState::addVetoOnThisFinalState(), BeamThrust::BeamThrust(), CDF_2009_S8057893::CDF_2009_S8057893::init(), CentralEtHCM::CentralEtHCM(), ChargedFinalState::ChargedFinalState(), ChargedLeptons::ChargedLeptons(), ClusteredPhotons::ClusteredPhotons(), DISFinalState::DISFinalState(), DISKinematics::DISKinematics(), DISLepton::DISLepton(), 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(), CMS_2012_PAS_QCD_11_010::init(), ATLAS_2011_S8994773::init(), CMS_2011_S8950903::init(), ATLAS_2010_CONF_2010_049::init(), ALICE_2011_S8909580::init(), ATLAS_2011_I894867::init(), CMS_2011_S8941262::init(), CMS_2011_S8973270::init(), CMS_2011_S8978280::init(), CMS_2011_S8968497::init(), CMS_2011_S9086218::init(), TOTEM_2012_I1115294::init(), CMS_2011_S9215166::init(), CMS_2012_I1087342::init(), CMS_2012_I1193338::init(), CMS_2012_I1184941::init(), CDF_2007_S7057202::init(), ALICE_2011_S8945144::init(), CMS_2011_S8957746::init(), TOTEM_2012_002::init(), CMS_2011_S9088458::init(), CMS_2012_I1107658::init(), ATLAS_2010_S8591806::init(), ATLAS_2011_S9002537::init(), D0_2011_I895662::init(), LHCF_2012_I1115479::init(), CMS_2011_I954992::init(), D0_2010_S8570965::init(), MC_JETS::init(), MC_KTSPLITTINGS::init(), CDF_2012_NOTE10874::init(), STAR_2006_S6500200::init(), STAR_2008_S7993412::init(), UA5_1987_S1640666::init(), CMS_QCD_10_024::init(), CDF_1997_S3541940::init(), CDF_2005_S6080774::init(), CDF_2006_S6450792::init(), MC_WINC::init(), MC_ZINC::init(), MC_ZZINC::init(), SFM_1984_S1178091::init(), ARGUS_1993_S2789213::init(), BABAR_2007_S7266081::init(), CDF_1993_S2742446::init(), ATLAS_2011_S9128077::init(), CDF_2000_S4155203::init(), MC_DIJET::init(), MC_DIPHOTON::init(), MC_HINC::init(), STAR_2006_S6870392::init(), UA5_1989_S1926373::init(), D0_2008_S6879055::init(), UA5_1982_S875503::init(), MC_HJETS::init(), MC_HKTSPLITTINGS::init(), MC_PHOTONINC::init(), CDF_2008_S7782535::init(), MC_WKTSPLITTINGS::init(), MC_WWINC::init(), CDF_2008_S8093652::init(), MC_ZJETS::init(), MC_ZKTSPLITTINGS::init(), MC_ZZJETS::init(), MC_ZZKTSPLITTINGS::init(), ARGUS_1993_S2669951::init(), ATLAS_2012_I1091481::init(), ALEPH_1991_S2435284::init(), CMS_2012_I1102908::init(), ATLAS_2012_I1183818::init(), ATLAS_2011_S9035664::init(), MC_WWKTSPLITTINGS::init(), E735_1998_S3905616::init(), MC_PHOTONJETS::init(), MC_PHOTONKTSPLITTINGS::init(), MC_WJETS::init(), MC_WWJETS::init(), ATLAS_2011_I944826::init(), ATLAS_2011_S8924791::init(), D0_1996_S3324664::init(), OPAL_1998_S3702294::init(), ATLAS_2010_S8817804::init(), ALEPH_1996_S3196992::init(), DELPHI_1999_S3960137::init(), CDF_1990_S2089246::init(), CDF_1988_S1865951::init(), UA5_1986_S1583476::init(), MC_GENERIC::init(), CDF_2005_S6217184::init(), MC_IDENTIFIED::init(), MC_LEADJETUE::init(), MC_PHOTONJETUE::init(), ALEPH_2002_S4823664::init(), MC_TTBAR::init(), OPAL_1995_S3198391::init(), OPAL_1996_S3257789::init(), OPAL_1997_S3608263::init(), OPAL_1998_S3749908::init(), OPAL_2000_S4418603::init(), D0_2001_S4674421::init(), CDF_1994_S2952106::init(), ATLAS_2011_I954993::init(), H1_1995_S3167097::init(), MC_QCD_PARTONS::init(), ATLAS_2012_I1119557::init(), ZEUS_2001_S4815815::init(), ATLAS_2012_I1188891::init(), D0_2007_S7075677::init(), D0_2008_S7837160::init(), CDF_2008_S7540469::init(), ATLAS_2011_S9131140::init(), UA1_1990_S2044935::init(), LHCB_2011_I919315::init(), CDF_2008_S7828950::init(), ATLAS_2011_I925932::init(), D0_1996_S3214044::init(), D0_2008_S7554427::init(), D0_2008_S7863608::init(), D0_2010_S8671338::init(), DELPHI_1995_S3137023::init(), EXAMPLE::init(), JADE_1998_S3612880::init(), JADE_OPAL_2000_S4300807::init(), CDF_2008_S8095620::init(), MC_SUSY::init(), OPAL_1997_S3396100::init(), ALICE_2010_S8624100::init(), STAR_2006_S6860818::init(), MC_PHOTONS::init(), ALEPH_2004_S5765862::init(), STAR_2009_UE_HELEN::init(), CDF_2009_NOTE_9936::init(), CMS_2012_PAS_FWD_11_003::init(), ALICE_2010_S8625980::init(), D0_2000_S4480767::init(), ALICE_2010_S8706239::init(), D0_2009_S8202443::init(), D0_2009_S8349509::init(), ATLAS_2011_I926145::init(), ATLAS_2012_I1125575::init(), D0_2009_S8320160::init(), CDF_1996_S3108457::init(), CDF_1998_S3618439::init(), CDF_2009_S8436959::init(), ATLAS_2011_S8971293::init(), CDF_2000_S4266730::init(), CDF_2001_S4563131::init(), CDF_2009_S8383952::init(), D0_2006_S6438750::init(), D0_2010_S8821313::init(), DELPHI_2002_069_CONF_603::init(), D0_2010_S8566488::init(), CDF_2001_S4517016::init(), MC_WPOL::init(), ALEPH_2001_S4656318::init(), SLD_2002_S4869273::init(), ATLAS_2012_I1082936::init(), CDF_1996_S3349578::init(), CDF_1996_S3418421::init(), SLD_1996_S3398250::init(), CDF_2006_S6653332::init(), D0_2008_S7662670::init(), ATLAS_2011_S9108483::init(), UA5_1988_S1867512::init(), ATLAS_2010_S8919674::init(), CDF_2008_S7541902::init(), ATLAS_2012_I1083318::init(), ATLAS_2012_I1125961::init(), ATLAS_2012_I1095236::init(), ATLAS_2011_S9212183::init(), ATLAS_2012_CONF_2012_109::init(), ATLAS_2013_I1217867::init(), ATLAS_2012_CONF_2012_105::init(), ATLAS_2012_I1190891::init(), DELPHI_2000_S4328825::init(), ATLAS_2011_S8983313::init(), ATLAS_2011_S9019561::init(), ATLAS_2012_I1180197::init(), ATLAS_2012_CONF_2012_001::init(), ATLAS_2012_I943401::init(), ATLAS_2011_S9212353::init(), ATLAS_2012_I946427::init(), ATLAS_2012_I1112263::init(), ATLAS_2012_I1117704::init(), ATLAS_2011_S9225137::init(), ATLAS_2011_CONF_2011_090::init(), ATLAS_2012_CONF_2012_104::init(), TASSO_1990_S2148048::init(), ATLAS_2012_CONF_2012_103::init(), OPAL_2002_S5361494::init(), ATLAS_2012_I1186556::init(), ATLAS_2012_I1126136::init(), ATLAS_2012_I1084540::init(), ATLAS_2012_I1082009::init(), ATLAS_2011_CONF_2011_098::init(), CDF_2009_S8233977::init(), CDF_2010_S8591881_DY::init(), ATLAS_2012_CONF_2012_153::init(), CDF_2010_S8591881_QCD::init(), ATLAS_2011_I945498::init(), D0_2004_S5992206::init(), ATLAS_2010_S8914702::init(), LHCB_2011_I917009::init(), CDF_2001_S4751469::init(), ATLAS_2010_S8918562::init(), D0_2008_S7719523::init(), ATLAS_2011_S9120807::init(), LHCB_2012_I1119400::init(), ATLAS_2012_I1094568::init(), ATLAS_2011_S9041966::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(), 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(), DELPHI_2003_WUD_03_11::init(), CDF_2004_S5839831::init(), BABAR_2003_I593379::init(), ARGUS_1993_S2653028::init(), CLEO_2004_S5809304::init(), OPAL_1998_S3780481::init(), OPAL_1993_S2692198::init(), H1_1994_S2919893::init(), H1_2000_S4129130::init(), SLD_2004_S5693039::init(), BELLE_2006_S6265367::init(), SLD_1999_S3743934::init(), PDG_HADRON_MULTIPLICITIES::init(), PDG_HADRON_MULTIPLICITIES_RATIOS::init(), IsolationProjection< PROJ1, PROJ2, EST >::IsolationProjection(), JetAlg::JetAlg(), JetShape::JetShape(), LeadingParticlesFinalState::LeadingParticlesFinalState(), LeptonClusters::LeptonClusters(), LossyFinalState< ConstRandomFilter >::LossyFinalState(), MergedFinalState::MergedFinalState(), MissingMomentum::MissingMomentum(), NeutralFinalState::NeutralFinalState(), NonHadronicFinalState::NonHadronicFinalState(), ParisiTensor::ParisiTensor(), PrimaryHadrons::PrimaryHadrons(), Sphericity::Sphericity(), Spherocity::Spherocity(), Thrust::Thrust(), TriggerCDFRun0Run1::TriggerCDFRun0Run1(), TriggerCDFRun2::TriggerCDFRun2(), TriggerUA5::TriggerUA5(), VetoedFinalState::VetoedFinalState(), and VisibleFinalState::VisibleFinalState().

                                                                       {
      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 36 of file IdentifiedFinalState.hh.

References IdentifiedFinalState::IdentifiedFinalState().

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

Compare projections.

Reimplemented from FinalState.

Definition at line 30 of file IdentifiedFinalState.cc.

References IdentifiedFinalState::_pids, Rivet::cmp(), Rivet::EQUIVALENT, and Projection::mkNamedPCmp().

                                                             {
    const PCmp fscmp = mkNamedPCmp(p, "FS");
    if (fscmp != EQUIVALENT) return fscmp;

    const IdentifiedFinalState& other = dynamic_cast<const IdentifiedFinalState&>(p);
    int pidssize = cmp(_pids.size(), other._pids.size());
    if (pidssize != EQUIVALENT) return pidssize;
    return cmp(_pids, other._pids);
  }
const collection_type& entities ( ) const [inline, inherited]

Template-usable interface common to JetAlg.

Definition at line 106 of file FinalState.hh.

References FinalState::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 116 of file Projection.hh.

References Projection::name().

Referenced by Projection::beamPairs(), InvMassFinalState::calc(), ChargedFinalState::project(), InitialQuarks::project(), UnstableFinalState::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().

virtual bool isEmpty ( ) const [inline, virtual, inherited]
Deprecated:
Is this final state empty?

Definition at line 94 of file FinalState.hh.

References FinalState::_theParticles.

{ return _theParticles.empty(); }
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 const Particles& particles ( ) const [inline, virtual, inherited]

Get the final-state particles.

Definition at line 39 of file FinalState.hh.

References FinalState::_theParticles.

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

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

Get the final-state particles, ordered by supplied sorting function object.

Definition at line 43 of file FinalState.hh.

References FinalState::_theParticles.

                                               {
      std::sort(_theParticles.begin(), _theParticles.end(), sorter);
      return _theParticles;
    }
const Particles& particlesByE ( ) const [inline, inherited]

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

Definition at line 59 of file FinalState.hh.

References Rivet::cmpParticleByE(), and FinalState::particles().

                                          {
      return particles(cmpParticleByE);
    }
const Particles& particlesByEt ( ) const [inline, inherited]

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

Definition at line 64 of file FinalState.hh.

References Rivet::cmpParticleByEt(), and FinalState::particles().

                                           {
      return particles(cmpParticleByEt);
    }
const Particles& particlesByModEta ( ) const [inline, inherited]

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

Definition at line 74 of file FinalState.hh.

References Rivet::cmpParticleByAscAbsPseudorapidity(), and FinalState::particles().

const Particles& particlesByModRapidity ( ) const [inline, inherited]

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

Definition at line 84 of file FinalState.hh.

References Rivet::cmpParticleByAscAbsRapidity(), and FinalState::particles().

const Particles& particlesByP ( ) const [inline, inherited]

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

Definition at line 54 of file FinalState.hh.

References Rivet::cmpParticleByP(), and FinalState::particles().

                                          {
      return particles(cmpParticleByP);
    }
const Particles& particlesByPt ( ) const [inline, inherited]
const Particles& particlesByRapidity ( ) const [inline, inherited]

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

Definition at line 79 of file FinalState.hh.

References Rivet::cmpParticleByAscRapidity(), and FinalState::particles().

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

void project ( const Event e) [protected, virtual]

Apply the projection on the supplied event.

Reimplemented from FinalState.

Definition at line 41 of file IdentifiedFinalState.cc.

References FinalState::_theParticles, IdentifiedFinalState::acceptedIds(), FinalState::particles(), and Particle::pdgId().

                                                   {
    const FinalState& fs = applyProjection<FinalState>(e, "FS");
    _theParticles.clear();
    _theParticles.reserve(fs.particles().size());
    foreach (const Particle& p, fs.particles()) {
      if (acceptedIds().find(p.pdgId()) != acceptedIds().end()) {
        _theParticles.push_back(p);
      }
    }
  }
virtual double ptMin ( ) const [inline, virtual, inherited]

Minimum- $ p_\perp $ requirement.

Definition at line 97 of file FinalState.hh.

References FinalState::_ptmin.

{ return _ptmin; }
void reset ( ) [inline]

Reset the list of particle IDs to accept.

Definition at line 96 of file IdentifiedFinalState.hh.

References IdentifiedFinalState::_pids.

                 {
      _pids.clear();
    }
void setName ( const std::string &  name) [inline, inherited]

Used by derived classes to set their name.

Definition at line 122 of file Projection.hh.

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

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

                                        {
      _name = name;
    }

Friends And Related Function Documentation

friend class Cmp< Projection > [friend, inherited]

The Cmp specialization for Projection is a friend.

Definition at line 37 of file Projection.hh.

friend class Event [friend, inherited]

Event is a friend.

Definition at line 34 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().

vector<pair<double,double> > _etaRanges [protected, inherited]

The ranges allowed for pseudorapidity.

Definition at line 126 of file FinalState.hh.

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

double _ptmin [protected, inherited]

The minimum allowed transverse momentum.

Definition at line 129 of file FinalState.hh.

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


The documentation for this class was generated from the following files: