FastJet 3.4.1
Public Member Functions | List of all members
fastjet::EECambridgePlugin Class Reference

Implementation of the e+e- Cambridge algorithm (plugin for fastjet v2.4 upwards) More...

#include <fastjet/EECambridgePlugin.hh>

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

Public Member Functions

 EECambridgePlugin (double ycut_in)
 Main constructor for the EECambridge Plugin class. More...
 
 EECambridgePlugin (const EECambridgePlugin &plugin)
 copy constructor More...
 
virtual std::string description () const
 return a textual description of the jet-definition implemented in this plugin More...
 
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: More...
 
double ycut () const
 
virtual double R () const
 the plugin mechanism's standard way of accessing the jet radius. More...
 
virtual bool exclusive_sequence_meaningful () const
 avoid the warning whenever the user requests "exclusive" jets from the cluster sequence More...
 
virtual bool is_spherical () const
 returns true because this plugin is intended for spherical geometries (i.e. More...
 
- Public Member Functions inherited from fastjet::JetDefinition::Plugin
virtual std::string description () const =0
 return a textual description of the jet-definition implemented in this plugin More...
 
virtual void run_clustering (ClusterSequence &) const =0
 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: More...
 
virtual double R () const =0
 
virtual bool supports_ghosted_passive_areas () const
 return true if there is specific support for the measurement of passive areas, in the sense that areas determined from all particles below the ghost separation scale will be a passive area. More...
 
virtual void set_ghost_separation_scale (double scale) const
 set the ghost separation scale for passive area determinations in future runs (strictly speaking that makes the routine a non const, so related internal info must be stored as a mutable) More...
 
virtual double ghost_separation_scale () const
 
virtual bool exclusive_sequence_meaningful () const
 if this returns false then a warning will be given whenever the user requests "exclusive" jets from the cluster sequence More...
 
virtual bool is_spherical () const
 returns true if the plugin implements an algorithm intended for use on a spherical geometry (e.g. More...
 
virtual ~Plugin ()
 a destructor to be replaced if necessary in derived classes... More...
 

Detailed Description

Implementation of the e+e- Cambridge algorithm (plugin for fastjet v2.4 upwards)

EECambridgePlugin is a plugin for fastjet (v2.4 upwards) It implements the Cambridge algorithm, as defined in

Better jet clustering algorithms Yuri Dokshitzer, Garth Leder, Stefano Moretti, Bryan Webber JHEP 9708 (1997) 001 http://www-spires.slac.stanford.edu/spires/find/hep/www?rawcmd=FIND+j+JHEPA%2C9708%2C001

On construction one must supply a ycut value.

To get the jets at the end call ClusterSequence::inclusive_jets();

Definition at line 59 of file EECambridgePlugin.hh.

Constructor & Destructor Documentation

◆ EECambridgePlugin() [1/2]

fastjet::EECambridgePlugin::EECambridgePlugin ( double  ycut_in)
inline

Main constructor for the EECambridge Plugin class.


It takes the dimensionless parameter ycut (the Q value for normalisation of the kt-distances is taken from the sum of all particle energies).

Definition at line 64 of file EECambridgePlugin.hh.

◆ EECambridgePlugin() [2/2]

fastjet::EECambridgePlugin::EECambridgePlugin ( const EECambridgePlugin plugin)
inline

copy constructor

Definition at line 67 of file EECambridgePlugin.hh.

Member Function Documentation

◆ description()

string fastjet::EECambridgePlugin::description ( ) const
virtual

return a textual description of the jet-definition implemented in this plugin

Implements fastjet::JetDefinition::Plugin.

Definition at line 71 of file EECambridgePlugin.cc.

◆ run_clustering()

void fastjet::EECambridgePlugin::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 77 of file EECambridgePlugin.cc.

◆ ycut()

double fastjet::EECambridgePlugin::ycut ( ) const
inline

Definition at line 75 of file EECambridgePlugin.hh.

◆ R()

virtual double fastjet::EECambridgePlugin::R ( ) const
inlinevirtual

the plugin mechanism's standard way of accessing the jet radius.

This must be set to return something sensible, even if R does not make sense for this algorithm!

Implements fastjet::JetDefinition::Plugin.

Definition at line 80 of file EECambridgePlugin.hh.

◆ exclusive_sequence_meaningful()

virtual bool fastjet::EECambridgePlugin::exclusive_sequence_meaningful ( ) const
inlinevirtual

avoid the warning whenever the user requests "exclusive" jets from the cluster sequence

Reimplemented from fastjet::JetDefinition::Plugin.

Definition at line 84 of file EECambridgePlugin.hh.

◆ is_spherical()

virtual bool fastjet::EECambridgePlugin::is_spherical ( ) const
inlinevirtual

returns true because this plugin is intended for spherical geometries (i.e.

it's an e+e- algorithm).

Reimplemented from fastjet::JetDefinition::Plugin.

Definition at line 88 of file EECambridgePlugin.hh.


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