FastJet 3.0.2
|
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. | |
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). | |
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 | |
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. | |
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. | |
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: | |
Protected Member Functions | |
virtual void | reset_stored_plugin () const |
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.
fastjet::SISConePlugin::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 |
||
) | [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.
fastjet::SISConePlugin::SISConePlugin | ( | double | cone_radius_in, |
double | overlap_threshold_in, | ||
int | n_pass_max_in, | ||
bool | caching_in | ||
) | [inline] |
backwards compatible constructor for the SISCone Plugin class (avoid using this in future).
Definition at line 131 of file SISConePlugin.hh.
double fastjet::SISConePlugin::protojet_or_ghost_ptmin | ( | ) | const [inline] |
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
Definition at line 153 of file SISConePlugin.hh.
bool fastjet::SISConePlugin::split_merge_on_transverse_mass | ( | ) | const [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.
bool fastjet::SISConePlugin::split_merge_use_pt_weighted_splitting | ( | ) | const [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.
void fastjet::SISConePlugin::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:
Implements fastjet::JetDefinition::Plugin.
Definition at line 76 of file SISConePlugin.cc.