Rivet  1.8.3
Public Member Functions | Protected Member Functions | List of all members
Rivet::IdentifiedFinalState Class Reference

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

#include <IdentifiedFinalState.hh>

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

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.
 
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.
 
- Public Member Functions inherited from Rivet::FinalState
virtual const ParticleVector & particles () const
 Get the final-state particles.
 
template<typename F >
const ParticleVector & particles (F sorter) const
 Get the final-state particles, ordered by supplied sorting function object.
 
const ParticleVector & particlesByPt () const
 Get the final-state particles, ordered by decreasing $ p_T $.
 
const ParticleVector & particlesByP () const
 Get the final-state particles, ordered by decreasing $ p $.
 
const ParticleVector & particlesByE () const
 Get the final-state particles, ordered by decreasing $ E $.
 
const ParticleVector & particlesByEt () const
 Get the final-state particles, ordered by decreasing $ E_T $.
 
const ParticleVector & particlesByEta () const
 Get the final-state particles, ordered by increasing $ \eta $.
 
const ParticleVector & particlesByModEta () const
 Get the final-state particles, ordered by increasing $ |\eta| $.
 
const ParticleVector & particlesByRapidity () const
 Get the final-state particles, ordered by increasing $ y $.
 
const ParticleVector & particlesByModRapidity () 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_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< PdgIdPair > beamPairs () 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< 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 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

void project (const Event &e)
 Apply the projection on the supplied event.
 
int compare (const Projection &p) const
 Compare projections.
 
- Protected Member Functions inherited from Rivet::FinalState
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
LoggetLog () const
 
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

Produce a final state which only contains specified particle IDs.

Constructor & Destructor Documentation

◆ IdentifiedFinalState()

Rivet::IdentifiedFinalState::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 $.

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


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