herwig is hosted by Hepforge, IPPP Durham
Herwig++  2.7.0
Analysis2::JetFinder Class Reference

A general interface to a jet finder which may be used by an Analysis2 handler. More...

#include <JetFinder.h>

Inheritance diagram for Analysis2::JetFinder:

List of all members.

Classes

struct  GreaterInEnergy
 Sort in energy. More...
struct  GreaterInEt
 Sort in transverse energy. More...
struct  GreaterInEta
 Sort in eta. More...
struct  GreaterInPt
 Sort in pt. More...
struct  GreaterInY
 Sort in y. More...

Public Member Functions

virtual void use (const vector< Lorentz5Momentum > &, bool inclusive=false)
 Set the event to be analysed.
const vector< Lorentz5Momentum > & lastEvent () const
 Get the event to be analysed.
const vector< Lorentz5Momentum > & jets () const
 Return the jets resolved.
Standard constructors and destructors.
 JetFinder ()
 The default constructor.
virtual ~JetFinder ()
 The destructor.
Resolution parameters
Energy dCut () const
 Get the resolution scale.
double yCut () const
 Get the dimensionless resolution parameter.
double R () const
 Get the optional cone radius.
Jet finding
virtual void findJets ()=0
 Do inclusive jet finding.
virtual void findJetsN (unsigned int nJets)=0
 Do exclusive jet-finding for nJets jets.
virtual void findJetsD ()=0
 Do jet-finding up to the resolution scale.
virtual void findJetsY (double y=-1.)=0
 Do exclusive jet-finding up to dimensionless resolution.
unsigned int getNJets () const
 Get the number of final state jets.
virtual Energy getDMerge (unsigned int nJets) const =0
 Resolution scale where n+1 jets merged to n.
virtual double getYMerge (unsigned int nJets) const =0
 Dimensionless scale where n+1 jets merged to n.
Jet sorting
virtual void sortEnergy ()
 Sort the jets in decreasing energy.
virtual void sortEt ()
 Sort the jets in decreasing transverse energy.
virtual void sortPt ()
 Sort the jets in decreasing transverse momentum.
virtual void sortY ()
 Sort the jets in decreasing rapidity.
virtual void sortEta ()
 Sort the jets in decreasing pseudorapidity.
Functions used by the persistent I/O system.
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently.
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently.

Static Public Member Functions

static void Init ()
 The standard Init function used to initialize the interfaces.

Protected Member Functions

void jets (const vector< Lorentz5Momentum > &)
 Set the result from jet finding.

Private Member Functions

JetFinderoperator= (const JetFinder &)
 The assignment operator is private and must never be called.

Private Attributes

Energy _dCut
 The dimensionful resolution parameter.
double _yCut
 The dimensionless resolution parameter.
double _R
 The optional cone radius.
vector< Lorentz5Momentum > _lastEvent
 The event to be analysed.
vector< Lorentz5Momentum > _jets
 The jets resolved.

Static Private Attributes

static
AbstractClassDescription
< JetFinder
initJetFinder
 The static object used to initialize the description of this class.

Detailed Description

A general interface to a jet finder which may be used by an Analysis2 handler.

Author:
Simon Plaetzer
See also:
The interfaces defined for JetFinder.

Definition at line 31 of file JetFinder.h.


Member Function Documentation

static void Analysis2::JetFinder::Init ( ) [static]

The standard Init function used to initialize the interfaces.

Called exactly once for each class by the class description system before the main function starts or when this class is dynamically loaded.

Reimplemented from ThePEG::Interfaced.

JetFinder& Analysis2::JetFinder::operator= ( const JetFinder ) [private]

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

void Analysis2::JetFinder::persistentInput ( PersistentIStream is,
int  version 
)

Function used to read in object persistently.

Parameters:
isthe persistent input stream read from.
versionthe version number of the object when written.

Reimplemented from ThePEG::Interfaced.

Function used to write out object persistently.

Parameters:
osthe persistent output stream written to.

Reimplemented from ThePEG::Interfaced.

virtual void Analysis2::JetFinder::use ( const vector< Lorentz5Momentum > &  ,
bool  inclusive = false 
) [inline, virtual]

Set the event to be analysed.

The implementation of this method may also do some conversion.


Member Data Documentation

AbstractClassDescription<JetFinder> Analysis2::JetFinder::initJetFinder [static, private]

The static object used to initialize the description of this class.

Indicates that this is an abstract class with persistent data.

Definition at line 299 of file JetFinder.h.


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