FastJet  3.1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
CMSIterativeConePlugin.hh
1 //FJSTARTHEADER
2 // $Id: CMSIterativeConePlugin.hh 1508 2009-04-10 22:46:49Z soyez $
3 //
4 // Copyright (c) 2007-2014, Matteo Cacciari, Gavin P. Salam and Gregory Soyez
5 //
6 //----------------------------------------------------------------------
7 // This file is part of FastJet.
8 //
9 // FastJet is free software; you can redistribute it and/or modify
10 // it under the terms of the GNU General Public License as published by
11 // the Free Software Foundation; either version 2 of the License, or
12 // (at your option) any later version.
13 //
14 // The algorithms that underlie FastJet have required considerable
15 // development. They are described in the original FastJet paper,
16 // hep-ph/0512210 and in the manual, arXiv:1111.6097. If you use
17 // FastJet as part of work towards a scientific publication, please
18 // quote the version you use and include a citation to the manual and
19 // optionally also to hep-ph/0512210.
20 //
21 // FastJet is distributed in the hope that it will be useful,
22 // but WITHOUT ANY WARRANTY; without even the implied warranty of
23 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 // GNU General Public License for more details.
25 //
26 // You should have received a copy of the GNU General Public License
27 // along with FastJet. If not, see <http://www.gnu.org/licenses/>.
28 //----------------------------------------------------------------------
29 //FJENDHEADER
30 
31 #ifndef __CMSITERATIVECONEPLUGIN_HH__
32 #define __CMSITERATIVECONEPLUGIN_HH__
33 
34 #include "fastjet/JetDefinition.hh"
35 
36 // questionable whether this should be in fastjet namespace or not...
37 FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
38 
39 // forward declaration to reduce includes
40 class PseudoJet;
41 
42 //----------------------------------------------------------------------
43 //
44 
45 /// @ingroup plugins
46 /// \class CMSIterativeConePlugin
47 /// Implementation of the CMS Iterative Cone (plugin for fastjet v2.4 upwards)
49 public:
50  /// Main constructor for the CMSIterativeCone Plugin class.
51  ///
52  /// The arguments are
53  /// ConeRadius the radius of the cone
54  /// SeedThreshold a threshold for the seeds to iterate from
55  ///
56  /// NOTE: to be more coherent with all other fastjet plugins,
57  /// we've put the radius before the seed threshold.
58  /// CMS does the opposite.
59  /// In this way, we also put a default value of 0 for the
60  /// seed threshold.
61  CMSIterativeConePlugin (double ConeRadius, double SeedThreshold=1.0) :
62  theConeRadius(ConeRadius), theSeedThreshold(SeedThreshold){}
63 
64  /// copy constructor
66  *this = plugin;
67  }
68 
69  // the things that are required by base class
70  virtual std::string description () const;
71  virtual void run_clustering(ClusterSequence &) const;
72 
73  /// the plugin mechanism's standard way of accessing the jet radius
74  /// here we return the R of the last alg in the list
75  virtual double R() const {return theConeRadius;}
76 
77  /// get the seed threshold
78  virtual double seed_threshold() const {return theSeedThreshold;}
79 
80 private:
81  double theConeRadius; ///< cone radius
82  double theSeedThreshold; ///< seed threshold
83 
84  static bool _first_time;
85 
86  /// print a banner for reference to the 3rd-party code
87  void _print_banner(std::ostream *ostr) const;
88 };
89 
90 FASTJET_END_NAMESPACE // defined in fastjet/internal/base.hh
91 
92 #endif // __CMSITERATIVECONEPLUGIN_HH__
93 
deals with clustering
CMSIterativeConePlugin(const CMSIterativeConePlugin &plugin)
copy constructor
virtual double seed_threshold() const
get the seed threshold
virtual double R() const
the plugin mechanism's standard way of accessing the jet radius here we return the R of the last alg ...
CMSIterativeConePlugin(double ConeRadius, double SeedThreshold=1.0)
Main constructor for the CMSIterativeCone Plugin class.
Implementation of the CMS Iterative Cone (plugin for fastjet v2.4 upwards)
a class that allows a user to introduce their own "plugin" jet finder