FastJet  3.3.3
TrackJetPlugin.hh
1 //FJSTARTHEADER
2 // $Id: TrackJetPlugin.hh 4420 2019-11-29 09:28:20Z soyez $
3 //
4 // Copyright (c) 2007-2019, 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 __TRACKJETPLUGIN_HH__
32 #define __TRACKJETPLUGIN_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 // another forward declaration to reduce includes
40 class PseudoJet;
41 
42 //----------------------------------------------------------------------
43 
44 /// @ingroup plugins
45 /// \class TrackJetPlugin
46 /// Implementation of the TrackJet algorithm (plugin for fastjet v2.4 upwards)
47 //
49 public:
50  /// Main constructor for the TrackJet Plugin class.
51  ///
52  /// The argument is an initialised list of jet algorithms
53  /// \param _radius the distance at which point a particle is no longer
54  /// recombied into the jet
55  /// \param jet_recombination_scheme the recombination scheme used to
56  /// sum the 4-vecors inside the jet
57  /// \param track_recombination_scheme the recombination scheme used to
58  /// sum the 4-vecors when accumulating
59  /// track into a the jet
60  /// Both recombiners are defaulted to pt_scheme recomb as for the Rivet
61  /// implementation.
62  TrackJetPlugin (double radius,
63  RecombinationScheme jet_recombination_scheme=pt_scheme,
64  RecombinationScheme track_recombination_scheme=pt_scheme){
65  _radius = radius;
66  _radius2 = radius*radius;
67  _jet_recombiner = JetDefinition::DefaultRecombiner(jet_recombination_scheme);
68  _track_recombiner = JetDefinition::DefaultRecombiner(track_recombination_scheme);
69  }
70 
71  /// copy constructor
72  TrackJetPlugin (const TrackJetPlugin & plugin) {
73  *this = plugin;
74  }
75 
76  // the things that are required by base class
77  virtual std::string description () const;
78  virtual void run_clustering(ClusterSequence &) const;
79 
80  /// the plugin mechanism's standard way of accessing the jet radius
81  /// here we return the R of the last alg in the list
82  virtual double R() const {return _radius;}
83 
84 private:
85  double _radius, _radius2;
86 
87  JetDefinition::DefaultRecombiner _jet_recombiner;
88  JetDefinition::DefaultRecombiner _track_recombiner;
89 
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 FASTJET_END_NAMESPACE // defined in fastjet/internal/base.hh
97 
98 #endif // __TRACKJETPLUGIN_HH__
99 
deals with clustering
TrackJetPlugin(const TrackJetPlugin &plugin)
copy constructor
virtual double R() const
the plugin mechanism&#39;s standard way of accessing the jet radius here we return the R of the last alg ...
Implementation of the TrackJet algorithm (plugin for fastjet v2.4 upwards)
A class that will provide the recombination scheme facilities and/or allow a user to extend these fac...
RecombinationScheme
The various recombination schemes.
a class that allows a user to introduce their own "plugin" jet finder
TrackJetPlugin(double radius, RecombinationScheme jet_recombination_scheme=pt_scheme, RecombinationScheme track_recombination_scheme=pt_scheme)
Main constructor for the TrackJet Plugin class.