FastJet  3.0.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
D0RunIConePlugin.hh
1 #ifndef __D0RUNICONEPLUGIN_HH__
2 #define __D0RUNICONEPLUGIN_HH__
3 
4 //STARTHEADER
5 // $Id: D0RunIConePlugin.hh 1778 2010-10-25 10:02:58Z soyez $
6 //
7 // Copyright (c) 2009-2011, Matteo Cacciari, Gavin P. Salam and Gregory Soyez
8 //
9 //----------------------------------------------------------------------
10 // This file is part of FastJet.
11 //
12 // FastJet 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 // The algorithms that underlie FastJet have required considerable
18 // development and are described in hep-ph/0512210. If you use
19 // FastJet as part of work towards a scientific publication, please
20 // include a citation to the FastJet paper.
21 //
22 // FastJet is distributed in the hope that it will be useful,
23 // but WITHOUT ANY WARRANTY; without even the implied warranty of
24 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 // GNU General Public License for more details.
26 //
27 // You should have received a copy of the GNU General Public License
28 // along with FastJet. If not, see <http://www.gnu.org/licenses/>.
29 //----------------------------------------------------------------------
30 //ENDHEADER
31 
32 #include "fastjet/D0RunIBaseConePlugin.hh"
33 
34 // questionable whether this should be in fastjet namespace or not...
35 
36 FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
37 
38 //----------------------------------------------------------------------
39 //
40 /// @ingroup plugins
41 /// \class D0RunIConePlugin
42 ///
43 /// A plugin for FastJet (v3.0 or later) that provides an interface to
44 /// the D0 version of Run-I cone algorithm
45 ///
46 /// The D0 code has been obtained from Lars Sonnenschein's web-space
47 /// http://www-d0.fnal.gov/~sonne/D0RunIcone.tgz
48 ///
49 /// The version of the D0 Run I code distributed
50 /// here has been modified by the FastJet authors, so as to provide
51 /// access to the contents of the jets (as is necessary for the
52 /// plugin). This does not modify the results of the clustering.
53 ///
54 /// The difference between this algorithm and the post-1996 version
55 /// relates to the way the final jet momenta are calculated. Details
56 /// are to be found in FERMILAB-PUB-97-242-E.
57 //
58 //----------------------------------------------------------------------
59 class D0RunIConePlugin : public D0RunIBaseConePlugin {
60 public:
61  /// The D0RunIConePlugin constructor, which sets the "free" parameters of the
62  /// algorithm:
63  ///
64  /// \param CONErad is the cone radius
65  ///
66  /// \param JETmne is a minimum ET requirement on every iteration
67  /// (jet dropped if Et < JETmne * Et_min_ratio ).
68  /// The value that has been used by D0 for JETmne: 8 GeV
69  /// (and Et_min_ratio is 0.5)
70  ///
71  /// \param SPlifr is the shared Et fraction splitting threshold, and
72  /// a value of 0.5 was usually used by D0
73  ///
74  /// The remaining parameters of the algorithm are not to be modified if the algorithm
75  /// is to correspond to the one actually used by D0.
76  ///
77  D0RunIConePlugin (double CONErad_in, double JETmne_in , double SPLifr_in = _DEFAULT_SPLifr)
78  : D0RunIBaseConePlugin(CONErad_in, JETmne_in , SPLifr_in){}
79 
80  // the things that are required by base class
81  virtual std::string description () const;
82 
83  // the part that really does the clustering
84  virtual void run_clustering(ClusterSequence &) const;
85 
86 private:
87  static bool _first_time;
88 
89  /// print a banner for reference to the 3rd-party code
90  void _print_banner(std::ostream *ostr) const;
91 };
92 
93 
94 
95 FASTJET_END_NAMESPACE // defined in fastjet/internal/base.hh
96 
97 #endif // __D0RUNICONEPLUGIN_HH__
D0RunIConePlugin(double CONErad_in, double JETmne_in, double SPLifr_in=_DEFAULT_SPLifr)
The D0RunIConePlugin constructor, which sets the &quot;free&quot; parameters of the algorithm: ...
A plugin for FastJet (v3.0 or later) that provides an interface to the D0 version of Run-I cone algor...