SISCone  2.0.6
siscone.h
1 // -*- C++ -*-
3 // File: siscone.h //
4 // Description: header file for the main SISCone class //
5 // This file is part of the SISCone project. //
6 // WARNING: this is not the main SISCone trunk but //
7 // an adaptation to spherical coordinates //
8 // For more details, see http://projects.hepforge.org/siscone //
9 // //
10 // Copyright (c) 2006-2008 Gavin Salam and Gregory Soyez //
11 // //
12 // This program is free software; you can redistribute it and/or modify //
13 // it under the terms of the GNU General Public License as published by //
14 // the Free Software Foundation; either version 2 of the License, or //
15 // (at your option) any later version. //
16 // //
17 // This program is distributed in the hope that it will be useful, //
18 // but WITHOUT ANY WARRANTY; without even the implied warranty of //
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
20 // GNU General Public License for more details. //
21 // //
22 // You should have received a copy of the GNU General Public License //
23 // along with this program; if not, write to the Free Software //
24 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA //
25 // //
26 // $Revision:: 325 $//
27 // $Date:: 2011-11-25 12:41:17 +0100 (Fri, 25 Nov 2011) $//
29 
30 #ifndef __SPH_SISCONE_H__
31 #define __SPH_SISCONE_H__
32 
33 #include "protocones.h"
34 #include "split_merge.h"
35 
36 namespace siscone_spherical{
37 
51  public:
53  CSphsiscone();
54 
56  ~CSphsiscone();
57 
76  int compute_jets(std::vector<CSphmomentum> &_particles, double _radius, double _f,
77  int _n_pass_max=0, double _Emin=0.0,
78  Esplit_merge_scale _split_merge_scale=SM_Etilde);
79 
92  int recompute_jets(double _f, double _Emin = 0.0,
93  Esplit_merge_scale _split_merge_scale=SM_Etilde);
94 
96  std::vector<std::vector<CSphmomentum> > protocones_list;
97 
98  // random number initialisation
99  static bool init_done;
100 
101 #ifdef DEBUG_STABLE_CONES
102  int nb_hash_cones_total, nb_hash_occupied_total;
103 #endif
104 
116  static void set_banner_stream(std::ostream * ostr) {_banner_ostr = ostr;}
117 
122  static std::ostream * banner_stream() {return _banner_ostr;}
123 
124  private:
125  bool rerun_allowed;
126  static std::ostream * _banner_ostr;
127 };
128 
129 
130 // finally, a bunch of functions to access to
131 // basic information (package name, version)
132 //---------------------------------------------
133 
141 std::string siscone_package_name();
142 
148 std::string siscone_version();
149 
150 }
151 #endif
Computes the list of stable comes from a particle list.
Definition: protocones.h:89
Class used to split and merge jets.
Definition: split_merge.h:170
static std::ostream * banner_stream()
returns a pointer to the stream to be used to print banners (cout by default)
Definition: siscone.h:122
static bool init_done
check random generator initialisation
Definition: siscone.h:99
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.
Definition: siscone.cpp:88
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.
Definition: siscone.cpp:189
final class: gather everything to compute the jet contents.
Definition: siscone.h:50
~CSphsiscone()
default dtor
Definition: siscone.cpp:66
std::vector< std::vector< CSphmomentum > > protocones_list
list of protocones found pass-by-pass
Definition: siscone.h:96
static void set_banner_stream(std::ostream *ostr)
A call to this function modifies the stream used to print banners (by default cout).
Definition: siscone.h:116
CSphsiscone()
default ctor
Definition: siscone.cpp:60
The SISCone project has been developed by Gavin Salam and Gregory Soyez
Documentation generated for SISCone by  Doxygen 1.8.13