FastJet  3.4.0
Public Types | Public Member Functions | Protected Member Functions | List of all members
fastjet::SISConeSphericalPlugin Class Reference

Implementation of the spherical version of the SISCone algorithm (plugin for fastjet v2.1 upwards) More...

#include <fastjet/SISConeSphericalPlugin.hh>

Inherits fastjet::SISConeBasePlugin.

Public Types

enum  SplitMergeScale { SM_E , SM_Etilde }
 enum for the different split-merge scale choices; Note that order must be the same as in siscone More...
 

Public Member Functions

 SISConeSphericalPlugin (double cone_radius_in, double overlap_threshold_in, int n_pass_max_in=0, double protojet_Emin_in=0.0, bool caching_in=false, SplitMergeScale split_merge_scale_in=SM_Etilde, double split_merge_stopping_scale_in=0.0)
 Main constructor for the SISConeSpherical Plugin class. More...
 
double protojet_Emin () const
 minimum energy for a protojet to be considered in the split-merge step of the algorithm
 
double protojet_or_ghost_Emin () const
 return the scale to be passed to SISCone as the protojet_Emin – if we have a ghost separation scale that is above the protojet_ptmin, then the ghost_separation_scale becomes the relevant one to use here
 
SplitMergeScale split_merge_scale () const
 indicates scale used in split-merge
 
void set_split_merge_scale (SplitMergeScale sms)
 sets scale used in split-merge
 
bool split_merge_use_E_weighted_splitting () const
 indicate if the splittings are done using the anti-kt distance
 
void set_split_merge_use_E_weighted_splitting (bool val)
 
virtual bool supports_ghosted_passive_areas () const
 overload the default as we don't provide support for passive areas.
 
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: More...
 
virtual bool is_spherical () const
 returns true because this plugin is intended for spherical geometries (i.e. More...
 

Protected Member Functions

virtual void reset_stored_plugin () const
 

Detailed Description

Implementation of the spherical version of the SISCone algorithm (plugin for fastjet v2.1 upwards)

SISConeSphericalPlugin is a plugin for fastjet (v2.1 upwards) that provides an interface to the seedless infrared safe cone jet finder by Gregory Soyez and Gavin Salam.

This is the version of SISCone using spherical coordinates. Compared to the original cylindrical version:

SISCone uses geometrical techniques to exhaustively consider all possible distinct cones. It then finds out which ones are stable and sends the result to the Tevatron Run-II type split-merge procedure for overlapping cones.

Four parameters govern the "physics" of the algorithm:

One parameter governs some internal algorithmic shortcuts:

The final jets can be accessed by requestion the inclusive_jets(...) from the ClusterSequence object. Note that these PseudoJets have their user_index() set to the index of the pass in which they were found (first pass = 0). NB: This does not currently work for jets that consist of a single particle.

For further information on the details of the algorithm see the SISCone paper, arXiv:0704.0292 [JHEP 0705:086,2007].

For documentation about the implementation, see the siscone/doc/html/index.html file.

Definition at line 94 of file SISConeSphericalPlugin.hh.

Member Enumeration Documentation

◆ SplitMergeScale

enum for the different split-merge scale choices; Note that order must be the same as in siscone

Enumerator
SM_E 

Energy (IR unsafe with momentum conservation)

SM_Etilde 

sum_{i \in jet} E_i [1+sin^2(theta_iJ)]

Definition at line 99 of file SISConeSphericalPlugin.hh.

Constructor & Destructor Documentation

◆ SISConeSphericalPlugin()

fastjet::SISConeSphericalPlugin::SISConeSphericalPlugin ( double  cone_radius_in,
double  overlap_threshold_in,
int  n_pass_max_in = 0,
double  protojet_Emin_in = 0.0,
bool  caching_in = false,
SplitMergeScale  split_merge_scale_in = SM_Etilde,
double  split_merge_stopping_scale_in = 0.0 
)
inline

Main constructor for the SISConeSpherical Plugin class.


Definition at line 107 of file SISConeSphericalPlugin.hh.

Member Function Documentation

◆ run_clustering()

void fastjet::SISConeSphericalPlugin::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 140 of file SISConeSphericalPlugin.cc.

◆ is_spherical()

virtual bool fastjet::SISConeSphericalPlugin::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 156 of file SISConeSphericalPlugin.hh.


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