FastJet 3.0.2
Public Member Functions
fastjet::GridJetPlugin Class Reference

plugin for fastjet (v3.0 upwards) that clusters particles such that all particles in a given cell of a rectangular rapidity-phi grid end up in a common "jet". More...

#include <fastjet/GridJetPlugin.hh>

Inheritance diagram for fastjet::GridJetPlugin:
Inheritance graph
[legend]
Collaboration diagram for fastjet::GridJetPlugin:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 GridJetPlugin (double ymax, double requested_grid_spacing, const JetDefinition &post_jet_def=JetDefinition())
 Main constructor for the GridJetPlugin Plugin class.
 GridJetPlugin (const GridJetPlugin &plugin)
 copy constructor
virtual std::string description () const
 return a textual description of the jet-definition implemented in this plugin
virtual void run_clustering (ClusterSequence &) const
 given a ClusterSequence that has been filled up with initial particles, the following function should fill up the rest of the ClusterSequence, using the following member functions of ClusterSequence:
virtual double R () const
 This returns the sqrt(dphi*dy/pi) -- i.e.

Detailed Description

plugin for fastjet (v3.0 upwards) that clusters particles such that all particles in a given cell of a rectangular rapidity-phi grid end up in a common "jet".

This is not intended for use as a regular jet clustering algorithm, but is rather provided for comparison purposes with the GridMedianBackgroundEstimator (which is even faster).

Definition at line 51 of file GridJetPlugin.hh.


Constructor & Destructor Documentation

fastjet::GridJetPlugin::GridJetPlugin ( double  ymax,
double  requested_grid_spacing,
const JetDefinition post_jet_def = JetDefinition() 
)

Main constructor for the GridJetPlugin Plugin class.

Parameters:
ymaxThe maximal rapidity extent of the grid
requested_grid_spacingThe requested grid spacing
post_jet_defif present, and not == JetDefinition() (which has undefined_jet_algorithm), then run the post_jet_def on the result of the grid clustering.

Definition at line 42 of file GridJetPlugin.cc.


Member Function Documentation

void fastjet::GridJetPlugin::run_clustering ( ClusterSequence ) const [virtual]

given a ClusterSequence that has been filled up with initial particles, the following function should fill up the rest of the ClusterSequence, using the following member functions of ClusterSequence:

  • plugin_do_ij_recombination(...)
  • plugin_do_iB_recombination(...)

Implements fastjet::JetDefinition::Plugin.

Definition at line 113 of file GridJetPlugin.cc.

double fastjet::GridJetPlugin::R ( ) const [virtual]

This returns the sqrt(dphi*dy/pi) -- i.e.

the radius that for a circular jet would give the same area.

Implements fastjet::JetDefinition::Plugin.

Definition at line 84 of file GridJetPlugin.cc.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends