Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

FinalState Class Reference

#include <FinalState.hh>

Inheritance diagram for FinalState:

Inheritance graph
[legend]
Collaboration diagram for FinalState:

Collaboration graph
[legend]
List of all members.

Detailed Description

Project out all final-state particles in an event.

Definition at line 13 of file FinalState.hh.


Standard constructors and destructors.

 FinalState (double mineta=-MaxRapidity, double maxeta=MaxRapidity, double minpt=0.0)
string getName () const
 Return the name of the projection.
const ParticleVectorparticles () const
 Access the projected final-state particles.
void project (const Event &e)
 Apply the projection to the event.
int compare (const Projection &p) const
 Compare projections.
ParticleVector _theParticles
 The final-state particles.

Public Member Functions

bool before (const Projection &p) const
virtual const Cuts getCuts () const
virtual const set< BeamPairgetBeamPairs () const
set< Projection * > getProjections () const
 Get the contained projections, including recursion.

Protected Member Functions

ProjectionaddProjection (Projection &proj)
 Add a projection dependency to the projection list.
ProjectionaddBeamPair (const ParticleName &beam1, const ParticleName &beam2)
 Add a colliding beam pair.
ProjectionaddCut (const string &quantity, const Comparison &comparison, const double value)
 Add a cut.
LoggetLog ()
 Get a Log object based on the getName() property of the calling projection object.

Protected Attributes

Cuts _cuts
 Parameter constraints.
set< BeamPair_beamPairs
 Beam-type constraint.
set< Projection * > _projections
 Collection of pointers to projections, for automatically combining constraints.

Friends

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

Constructor & Destructor Documentation

FinalState double  mineta = -MaxRapidity,
double  maxeta = MaxRapidity,
double  minpt = 0.0
[inline]
 

The default constructor. May specify the minimum and maximum pseudorapidity $ \eta $ and the min $ p_T $ (in GeV).

Definition at line 21 of file FinalState.hh.

References Rivet::LESS_EQ, and Rivet::MORE_EQ.


Member Function Documentation

Projection& addBeamPair const ParticleName beam1,
const ParticleName beam2
[inline, protected, inherited]
 

Add a colliding beam pair.

Definition at line 145 of file Projection.hh.

References Rivet::BeamPair.

Projection& addCut const string &  quantity,
const Comparison comparison,
const double  value
[inline, protected, inherited]
 

Add a cut.

Definition at line 151 of file Projection.hh.

Projection& addProjection Projection proj  )  [inline, protected, inherited]
 

Add a projection dependency to the projection list.

Definition at line 139 of file Projection.hh.

bool before const Projection p  )  const [inline, 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 88 of file Projection.hh.

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

int compare const Projection p  )  const [protected, virtual]
 

Compare projections.

Implements Projection.

Reimplemented in ChargedFinalState, FinalStateHCM, and VetoedFinalState.

Definition at line 9 of file FinalState.cc.

References FinalState::_etamax, FinalState::_etamin, FinalState::_ptmin, and Rivet::cmp().

virtual const set<BeamPair> getBeamPairs  )  const [inline, virtual, inherited]
 

Return the BeamConstraints for this projection. Derived classes should ensure that all contained projections are registered in the _projections set for the beam constraint chaining to work.

Definition at line 114 of file Projection.hh.

References Cuts::end(), and Rivet::intersection().

virtual const Cuts getCuts  )  const [inline, virtual, inherited]
 

Return the Cuts objects for this projection. Derived classes should ensure that all contained projections are registered in the _projections set for the cut chaining to work.

Definition at line 102 of file Projection.hh.

References Cuts::addCuts().

Log & getLog  )  [protected, inherited]
 

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

Definition at line 7 of file Projection.cc.

References Log::getLog(), and Projection::getName().

Referenced by VetoedFinalState::project(), TrackJet::project(), TotalVisibleMomentum::project(), Sphericity::project(), Multiplicity::project(), ChargedLeptons::project(), ChargedFinalState::project(), and Beam::project().

string getName  )  const [inline, virtual]
 

Return the name of the projection.

Reimplemented from Projection.

Reimplemented in ChargedFinalState, FinalStateHCM, and VetoedFinalState.

Definition at line 32 of file FinalState.hh.

set<Projection*> getProjections  )  const [inline, inherited]
 

Get the contained projections, including recursion.

Definition at line 128 of file Projection.hh.

References Cuts::end().

const ParticleVector& particles  )  const [inline]
 

Access the projected final-state particles.

Definition at line 37 of file FinalState.hh.

References Rivet::ParticleVector.

Referenced by ZPhys73C11::analyze(), HepEx9506012::analyze(), VetoedFinalState::project(), TrackJet::project(), TotalVisibleMomentum::project(), Sphericity::project(), Multiplicity::project(), KtJets::project(), FinalStateHCM::project(), FastJets::project(), DISLepton::project(), D0ILConeJets::project(), ChargedLeptons::project(), ChargedFinalState::project(), and CentralEtHCM::project().

void project const Event e  )  [protected, virtual]
 

Apply the projection to the event.

Implements Projection.

Reimplemented in ChargedFinalState, FinalStateHCM, and VetoedFinalState.

Definition at line 15 of file FinalState.cc.

References FinalState::_theParticles, and Event::genEvent().


Friends And Related Function Documentation

friend class Cmp<Projection> [friend, inherited]
 

The Cmp specialization for Projection is a friend.

Definition at line 31 of file Projection.hh.

friend class Event [friend, inherited]
 

Event is a friend.

Definition at line 28 of file Projection.hh.


Member Data Documentation

set<BeamPair> _beamPairs [protected, inherited]
 

Beam-type constraint.

Definition at line 164 of file Projection.hh.

Cuts _cuts [protected, inherited]
 

Parameter constraints.

Definition at line 161 of file Projection.hh.

set<Projection*> _projections [protected, inherited]
 

Collection of pointers to projections, for automatically combining constraints.

Definition at line 167 of file Projection.hh.

ParticleVector _theParticles [protected]
 

The final-state particles.

Definition at line 63 of file FinalState.hh.

Referenced by FinalState::project().


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