FastJet
3.1.0-beta.1
|
Implementation of the SISCone algorithm (plugin for fastjet v2.1 upwards) More...
#include <fastjet/SISConePlugin.hh>
Inherits fastjet::SISConeBasePlugin.
Public Types | |
enum | SplitMergeScale { SM_pt, SM_Et, SM_mt, SM_pttilde } |
enum for the different split-merge scale choices; Note that order must be the same as in siscone More... | |
Public Member Functions | |
SISConePlugin (double cone_radius_in, double overlap_threshold_in, int n_pass_max_in=0, double protojet_ptmin_in=0.0, bool caching_in=false, SplitMergeScale split_merge_scale_in=SM_pttilde, double split_merge_stopping_scale_in=0.0) | |
Main constructor for the SISCone Plugin class. More... | |
SISConePlugin (double cone_radius_in, double overlap_threshold_in, int n_pass_max_in, double protojet_ptmin_in, bool caching_in, bool split_merge_on_transverse_mass_in) | |
Backwards compatible constructor for the SISCone Plugin class. | |
SISConePlugin (double cone_radius_in, double overlap_threshold_in, int n_pass_max_in, bool caching_in) | |
backwards compatible constructor for the SISCone Plugin class (avoid using this in future). More... | |
double | protojet_ptmin () const |
minimum pt for a protojet to be considered in the split-merge step of the algorithm | |
double | protojet_or_ghost_ptmin () const |
return the scale to be passed to SISCone as the protojet_ptmin – 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_on_transverse_mass () const |
indicates whether the split-merge orders on transverse mass or not. More... | |
void | set_split_merge_on_transverse_mass (bool val) |
bool | split_merge_use_pt_weighted_splitting () const |
indicates whether the split-merge orders on transverse mass or not. More... | |
void | set_split_merge_use_pt_weighted_splitting (bool val) |
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... | |
Public Member Functions inherited from fastjet::SISConeBasePlugin | |
SISConeBasePlugin () | |
default ctor | |
SISConeBasePlugin (const SISConeBasePlugin &plugin) | |
copy constructor | |
double | cone_radius () const |
the cone radius | |
double | overlap_threshold () const |
Fraction of overlap energy in a jet above which jets are merged and below which jets are split. More... | |
int | n_pass_max () const |
the maximum number of passes of stable-cone searching (<=0 is same as infinity). More... | |
void | set_split_merge_stopping_scale (double scale) |
set the "split_merge_stopping_scale": if the scale variable for all protojets is below this, then stop the split-merge procedure and keep only those jets found so far. More... | |
double | split_merge_stopping_scale () |
return the value of the split_merge_stopping_scale (see set_split_merge_stopping_scale(...) for description) | |
void | set_use_jet_def_recombiner (bool choice) |
allow the user to decide if one uses the jet_def's own recombination scheme | |
bool | use_jet_def_recombiner () const |
indicate if the jet_def's recombination scheme is being used | |
bool | caching () const |
indicates whether caching is turned on or not. | |
virtual double | R () const |
the plugin mechanism's standard way of accessing the jet radius | |
virtual bool | supports_ghosted_passive_areas () const |
return true since 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 just in the next run (strictly speaking that makes the routine a non const, so related internal info must be stored as a mutable) | |
virtual double | ghost_separation_scale () const |
virtual std::string | description () const =0 |
plugin description | |
virtual void | run_clustering (ClusterSequence &) const =0 |
really do the clustering work | |
Public Member Functions inherited from fastjet::JetDefinition::Plugin | |
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) | |
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 | |
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... | |
Protected Member Functions | |
virtual void | reset_stored_plugin () const |
Protected Member Functions inherited from fastjet::SISConeBasePlugin | |
virtual void | reset_stored_plugin () const =0 |
call the re-clustering itself | |
Additional Inherited Members | |
Protected Attributes inherited from fastjet::SISConeBasePlugin | |
double | _cone_radius |
double | _overlap_threshold |
int | _n_pass_max |
bool | _caching |
double | _split_merge_stopping_scale |
bool | _use_jet_def_recombiner |
double | _ghost_sep_scale |
Implementation of the SISCone algorithm (plugin for fastjet v2.1 upwards)
SISConePlugin 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.
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 71 of file SISConePlugin.hh.
enum for the different split-merge scale choices; Note that order must be the same as in siscone
Definition at line 76 of file SISConePlugin.hh.
|
inline |
Main constructor for the SISCone Plugin class.
Note: wrt version prior to 2.4 this constructor differs in that a the default value has been removed for overlap_threshold. The former has been removed because the old default of 0.5 was found to be unsuitable in high-noise environments; so the user should now explicitly think about the value for this – we recommend 0.75.
Definition at line 95 of file SISConePlugin.hh.
|
inline |
backwards compatible constructor for the SISCone Plugin class (avoid using this in future).
Definition at line 131 of file SISConePlugin.hh.
|
inline |
indicates whether the split-merge orders on transverse mass or not.
retained for backwards compatibility with 2.1.0b3
Definition at line 163 of file SISConePlugin.hh.
|
inline |
indicates whether the split-merge orders on transverse mass or not.
retained for backwards compatibility with 2.1.0b3
Definition at line 169 of file SISConePlugin.hh.
|
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:
Implements fastjet::JetDefinition::Plugin.
Definition at line 76 of file SISConePlugin.cc.