siscone::Csiscone Class Reference

final class: gather everything to compute the jet contents. More...

#include <siscone.h>

Inheritance diagram for siscone::Csiscone:

Inheritance graph
[legend]
Collaboration diagram for siscone::Csiscone:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 Csiscone ()
 default ctor
 ~Csiscone ()
 default dtor
int compute_jets (std::vector< Cmomentum > &_particles, double _radius, double _f, int _n_pass_max=0, double _ptmin=0.0, Esplit_merge_scale _split_merge_scale=SM_pttilde)
 compute the jets from a given particle set.
int recompute_jets (double _f, double _ptmin=0.0, Esplit_merge_scale _split_merge_scale=SM_pttilde)
 recompute the jets with a different overlap parameter.

Public Attributes

std::vector< std::vector
< Cmomentum > > 
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.

Definition at line 48 of file siscone.h.


Member Function Documentation

int siscone::Csiscone::compute_jets ( std::vector< Cmomentum > &  _particles,
double  _radius,
double  _f,
int  _n_pass_max = 0,
double  _ptmin = 0.0,
Esplit_merge_scale  _split_merge_scale = SM_pttilde 
)

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)
_ptmin minimum pT of the protojets
_split_merge_scale the scale choice for the split-merge procedure NOTE: SM_pt leads to IR unsafety for some events with momentum conservation. SM_Et is IR safe but not boost invariant and not implemented(!) SM_mt is IR safe for hadronic events, but not for decays of two back-to-back particles of identical mass SM_pttilde is always IR safe, and also boost invariant (default)
Returns:
the number of jets found.

int siscone::Csiscone::recompute_jets ( double  _f,
double  _ptmin = 0.0,
Esplit_merge_scale  _split_merge_scale = SM_pttilde 
)

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
_ptmin minimum pT 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 164 of file siscone.cpp.

References siscone::Csplit_merge::add_protocones(), siscone::Csplit_merge::init_pleft(), siscone::Csplit_merge::partial_clear(), siscone::Csplit_merge::perform(), protocones_list, siscone::Csplit_merge::ptcomparison, and siscone::Cstable_cones::R2.


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

The SISCone project has been developed by Gavin Salam and Gregory Soyez
Documentation generated on Thu Apr 3 10:22:52 2008 for SISCone by  Doxygen 1.5.5