final class: gather everything to compute the jet contents. More...
#include <siscone.h>
Public Member Functions | |
| CSphsiscone () | |
| default ctor | |
| ~CSphsiscone () | |
| default dtor | |
| int | compute_jets (std::vector< CSphmomentum > &_particles, double _radius, double _f, int _n_pass_max=0, double _Emin=0.0, Esplit_merge_scale _split_merge_scale=SM_Etilde) |
| compute the jets from a given particle set. | |
| int | recompute_jets (double _f, double _Emin=0.0, Esplit_merge_scale _split_merge_scale=SM_Etilde) |
| recompute the jets with a different overlap parameter. | |
Static Public Member Functions | |
| static void | set_banner_stream (std::ostream *ostr) |
| A call to this function modifies the stream used to print banners (by default cout). | |
| static std::ostream * | banner_stream () |
| returns a pointer to the stream to be used to print banners (cout by default) | |
Public Attributes | |
|
std::vector< std::vector < CSphmomentum > > | protocones_list |
| list of protocones found pass-by-pass | |
Static Public Attributes | |
| static bool | init_done = false |
| check random generator initialisation | |
Detailed Description
final class: gather everything to compute the jet contents.
This is the class user should use. It computes the jet contents of a list of particles given a cone radius and a threshold for splitting/merging.
After the call to 'perform', the vector jets is filled with the jets found. the 'contents' field of each jets contains the indices of the particles included in that jet.
Member Function Documentation
| int siscone_spherical::CSphsiscone::compute_jets | ( | std::vector< CSphmomentum > & | _particles, |
| double | _radius, | ||
| double | _f, | ||
| int | _n_pass_max = 0, |
||
| double | _Emin = 0.0, |
||
| Esplit_merge_scale | _split_merge_scale = SM_Etilde |
||
| ) |
compute the jets from a given particle set.
We are doing multiple passes such pass n_pass looks for jets among all particles not put into jets during previous passes. By default the number of passes is infinite (0).
- Parameters:
-
_particles list of particles _radius cone radius _f shared energy threshold for splitting&merging _n_pass_max maximum number of passes (0=full search) _Emin minimum energy of the protojets _split_merge_scale the scale choice for the split-merge procedure NOTE: SM_Etilde is always IR safe SM_E is IR unsafe for events with mom. conservation
- Returns:
- the number of jets found.
Definition at line 88 of file siscone.cpp.
References siscone_spherical::CSphstable_cones::init().
| int siscone_spherical::CSphsiscone::recompute_jets | ( | double | _f, |
| double | _Emin = 0.0, |
||
| Esplit_merge_scale | _split_merge_scale = SM_Etilde |
||
| ) |
recompute the jets with a different overlap parameter.
we use the same particles and R as in the preceeding call.
- Parameters:
-
_f shared energy threshold for splitting&merging _Emin minimum energy of the protojets _split_merge_scale the scale choice for the split-merge procedure split--merge variable NOTE: using pt leads to IR unsafety for some events with momentum conservation. So we strongly advise not to change the default value.
- Returns:
- the number of jets found, -1 if recomputation not allowed.
Definition at line 189 of file siscone.cpp.
| static void siscone_spherical::CSphsiscone::set_banner_stream | ( | std::ostream * | ostr | ) | [inline, static] |
A call to this function modifies the stream used to print banners (by default cout).
Please note that if you distribute 3rd party code that links with SISCone, that 3rd party code must not use this call turn off the printing of thw banner by default. This requirement reflects the spirit of clause 2c of the GNU Public License (v2), under which SISCone is distributed.
The documentation for this class was generated from the following files:
- siscone/spherical/siscone.h
- siscone/spherical/siscone.cpp