Rivet  1.8.0
Public Types | Public Member Functions | Protected Member Functions
Rivet::JetAlg Class Reference

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

#include <JetAlg.hh>

Inheritance diagram for Rivet::JetAlg:
Rivet::Projection Rivet::ProjectionApplier Rivet::FastJets Rivet::FastJets

List of all members.

Public Types

typedef Jet entity_type
typedef Jets collection_type

Public Member Functions

 JetAlg (const FinalState &fs)
 Constructor.
virtual const Projectionclone () 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 (double ptmin=0.0, double ptmax=MAXDOUBLE, double rapmin=-MAXDOUBLE, double rapmax=MAXDOUBLE, RapScheme rapscheme=PSEUDORAPIDITY) const
template<typename F >
Jets jets (F sorter, double ptmin, double ptmax, double rapmin, double rapmax, RapScheme rapscheme) const
Jets jetsByPt (double ptmin=0.0, double ptmax=MAXDOUBLE, double rapmin=-MAXDOUBLE, double rapmax=MAXDOUBLE, RapScheme rapscheme=PSEUDORAPIDITY) const
Jets jetsByP (double ptmin=0.0, double ptmax=MAXDOUBLE, double rapmin=-MAXDOUBLE, double rapmax=MAXDOUBLE, RapScheme rapscheme=PSEUDORAPIDITY) const
Jets jetsByE (double ptmin=0.0, double ptmax=MAXDOUBLE, double rapmin=-MAXDOUBLE, double rapmax=MAXDOUBLE, RapScheme rapscheme=PSEUDORAPIDITY) const
Jets jetsByEt (double ptmin=0.0, double ptmax=MAXDOUBLE, double rapmin=-MAXDOUBLE, double rapmax=MAXDOUBLE, RapScheme rapscheme=PSEUDORAPIDITY) const
virtual size_t size () const =0
 Number of jets.
virtual void reset ()=0
 Clear the projection.
collection_type entities () const
 Template-usable interface common to FinalState.
virtual void calc (const ParticleVector &ps)=0
 Do the calculation locally (no caching).

Protected Member Functions

virtual void project (const Event &e)=0
 Perform the projection on the Event.
virtual int compare (const Projection &p) const =0
 Compare projections.

Detailed Description

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


Member Function Documentation

virtual Jets Rivet::JetAlg::jets ( double  ptmin = 0.0,
double  ptmax = MAXDOUBLE,
double  rapmin = -MAXDOUBLE,
double  rapmax = MAXDOUBLE,
RapScheme  rapscheme = PSEUDORAPIDITY 
) const [inline, virtual]

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

Todo:
Introduce MomentumFilter objects for pT, ET, eta, y, etc. filtering, to avoid double-arg ambiguities

References Rivet::FourVector::eta(), Rivet::inRange(), Rivet::Jet::momentum(), Rivet::FourMomentum::pT(), and Rivet::FourMomentum::rapidity().

Referenced by entities(), jets(), jetsByE(), jetsByEt(), jetsByP(), and jetsByPt().

template<typename F >
Jets Rivet::JetAlg::jets ( sorter,
double  ptmin,
double  ptmax,
double  rapmin,
double  rapmax,
RapScheme  rapscheme 
) const [inline]

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

Todo:
Introduce MomentumFilter objects for pT, ET, eta, y, etc. filtering, to avoid double-arg ambiguities

References jets().

Jets Rivet::JetAlg::jetsByE ( double  ptmin = 0.0,
double  ptmax = MAXDOUBLE,
double  rapmin = -MAXDOUBLE,
double  rapmax = MAXDOUBLE,
RapScheme  rapscheme = PSEUDORAPIDITY 
) const [inline]

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

Todo:
Introduce MomentumFilter objects for pT, ET, eta, y, etc. filtering, to avoid double-arg ambiguities

References Rivet::cmpJetsByE(), and jets().

Jets Rivet::JetAlg::jetsByEt ( double  ptmin = 0.0,
double  ptmax = MAXDOUBLE,
double  rapmin = -MAXDOUBLE,
double  rapmax = MAXDOUBLE,
RapScheme  rapscheme = PSEUDORAPIDITY 
) const [inline]

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

Todo:
Introduce MomentumFilter objects for pT, ET, eta, y, etc. filtering, to avoid double-arg ambiguities

References Rivet::cmpJetsByEt(), and jets().

Jets Rivet::JetAlg::jetsByP ( double  ptmin = 0.0,
double  ptmax = MAXDOUBLE,
double  rapmin = -MAXDOUBLE,
double  rapmax = MAXDOUBLE,
RapScheme  rapscheme = PSEUDORAPIDITY 
) const [inline]

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

Todo:
Introduce MomentumFilter objects for pT, ET, eta, y, etc. filtering, to avoid double-arg ambiguities

References Rivet::cmpJetsByP(), and jets().

Jets Rivet::JetAlg::jetsByPt ( double  ptmin = 0.0,
double  ptmax = MAXDOUBLE,
double  rapmin = -MAXDOUBLE,
double  rapmax = MAXDOUBLE,
RapScheme  rapscheme = PSEUDORAPIDITY 
) const [inline]

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

Todo:
Introduce MomentumFilter objects for pT, ET, eta, y, etc. filtering, to avoid double-arg ambiguities

References Rivet::cmpJetsByPt(), and jets().

Referenced by Rivet::MC_JetAnalysis::analyze().


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