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