Rivet  1.8.0
Protected Member Functions | List of all members
Rivet::UnstableFinalState Class Reference

Project out all physical-but-decayed particles in an event. More...

#include <UnstableFinalState.hh>

Inheritance diagram for Rivet::UnstableFinalState:
Rivet::FinalState Rivet::Projection Rivet::ProjectionApplier

Public Member Functions

Standard constructors and destructors.
 UnstableFinalState (double mineta=-MAXRAPIDITY, double maxeta=MAXRAPIDITY, double minpt=0.0 *GeV)
virtual const Projectionclone () const
 Clone on the heap.
- Public Member Functions inherited from Rivet::FinalState
virtual const ParticleVectorparticles () const
 Get the final-state particles.
template<typename F >
const ParticleVectorparticles (F sorter) const
 Get the final-state particles, ordered by supplied sorting function object.
const ParticleVectorparticlesByPt () const
 Get the final-state particles, ordered by decreasing $ p_T $.
const ParticleVectorparticlesByP () const
 Get the final-state particles, ordered by decreasing $ p $.
const ParticleVectorparticlesByE () const
 Get the final-state particles, ordered by decreasing $ E $.
const ParticleVectorparticlesByEt () const
 Get the final-state particles, ordered by decreasing $ E_T $.
const ParticleVectorparticlesByEta () const
 Get the final-state particles, ordered by increasing $ \eta $.
const ParticleVectorparticlesByModEta () const
 Get the final-state particles, ordered by increasing $ |\eta| $.
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_type & entities () const
 Template-usable interface common to JetAlg.
 FinalState (double mineta=-MAXRAPIDITY, double maxeta=MAXRAPIDITY, double minpt=0.0 *GeV)
 FinalState (const vector< pair< double, double > > &etaRanges, double minpt=0.0 *GeV)
- Public Member Functions inherited from Rivet::Projection
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.
 Projection ()
 The default constructor.
virtual ~Projection ()
 The destructor.
- Public Member Functions inherited from Rivet::ProjectionApplier
 ProjectionApplier ()
 Constructor.
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
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 void project (const Event &e)
 Apply the projection to the event.
- Protected Member Functions inherited from Rivet::FinalState
virtual int compare (const Projection &p) const
 Compare projections.
bool accept (const Particle &p) const
 Decide if a particle is to be accepted or not.
- Protected Member Functions inherited from Rivet::Projection
Cmp< ProjectionmkNamedPCmp (const Projection &otherparent, const std::string &pname) const
Cmp< ProjectionmkPCmp (const Projection &otherparent, const std::string &pname) const
- Protected Member Functions inherited from Rivet::ProjectionApplier
ProjectionHandlergetProjHandler () const
 Get a reference to the ProjectionHandler for this thread.
template<typename PROJ >
const PROJ & addProjection (const PROJ &proj, const std::string &name)

Additional Inherited Members

- Public Types inherited from Rivet::FinalState
typedef Particle entity_type
typedef ParticleVector collection_type

Detailed Description

Project out all physical-but-decayed particles in an event.

The particles returned by the UFS are unique unstable particles, such as hadrons which are decayed by the generator. If, for example, you set Ks and Lambda particles stable in the generator, they will not be returned by the UFS. Also, you should be aware that all unstable particles in a decay chain are returned: if you are looking for something like the number of B hadrons in an event and there is a decay chain from e.g. B** -> B, you will count both B mesons unless you are careful to check for ancestor/descendent relations between the particles. Duplicate particles in the event record, i.e. those which differ only in bookkeeping details or photon emissions, are stripped from the returned particles collection.

Constructor & Destructor Documentation

Rivet::UnstableFinalState::UnstableFinalState ( double  mineta = -MAXRAPIDITY,
double  maxeta = MAXRAPIDITY,
double  minpt = 0.0*GeV 
)
inline

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

References Rivet::Projection::setName().

Referenced by clone().


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