FastJet 3.0.2
|
00001 #ifndef __EECAMBRIDGEPLUGIN_HH__ 00002 #define __EECAMBRIDGEPLUGIN_HH__ 00003 00004 //STARTHEADER 00005 // $Id: EECambridgePlugin.hh 2692 2011-11-14 16:27:44Z soyez $ 00006 // 00007 // Copyright (c) 2009, Matteo Cacciari, Gavin Salam and Gregory Soyez 00008 // 00009 //---------------------------------------------------------------------- 00010 // This file is part of FastJet. 00011 // 00012 // FastJet is free software; you can redistribute it and/or modify 00013 // it under the terms of the GNU General Public License as published by 00014 // the Free Software Foundation; either version 2 of the License, or 00015 // (at your option) any later version. 00016 // 00017 // The algorithms that underlie FastJet have required considerable 00018 // development and are described in hep-ph/0512210. If you use 00019 // FastJet as part of work towards a scientific publication, please 00020 // include a citation to the FastJet paper. 00021 // 00022 // FastJet is distributed in the hope that it will be useful, 00023 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00024 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00025 // GNU General Public License for more details. 00026 // 00027 // You should have received a copy of the GNU General Public License 00028 // along with FastJet. If not, see <http://www.gnu.org/licenses/>. 00029 //---------------------------------------------------------------------- 00030 //ENDHEADER 00031 00032 00033 #include "fastjet/JetDefinition.hh" 00034 00035 FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh 00036 00037 // forward declaration to reduce includes 00038 class ClusterSequence; 00039 00040 //---------------------------------------------------------------------- 00041 // 00042 /// @ingroup plugins 00043 /// \class EECambridgePlugin 00044 /// Implementation of the e+e- Cambridge algorithm (plugin for fastjet v2.4 upwards) 00045 /// 00046 /// EECambridgePlugin is a plugin for fastjet (v2.4 upwards) 00047 /// It implements the Cambridge algorithm, as defined in 00048 /// 00049 /// Better jet clustering algorithms 00050 /// Yuri Dokshitzer, Garth Leder, Stefano Moretti, Bryan Webber 00051 /// JHEP 9708 (1997) 001 00052 /// http://www-spires.slac.stanford.edu/spires/find/hep/www?rawcmd=FIND+j+JHEPA%2C9708%2C001 00053 /// 00054 /// On construction one must supply a ycut value. 00055 /// 00056 /// To get the jets at the end call ClusterSequence::inclusive_jets(); 00057 class EECambridgePlugin : public JetDefinition::Plugin { 00058 public: 00059 /// Main constructor for the EECambridge Plugin class. 00060 /// It takes the dimensionless parameter ycut (the Q value for normalisation 00061 /// of the kt-distances is taken from the sum of all particle energies). 00062 EECambridgePlugin (double ycut_in) : _ycut(ycut_in) {} 00063 00064 /// copy constructor 00065 EECambridgePlugin (const EECambridgePlugin & plugin) { 00066 *this = plugin; 00067 } 00068 00069 // the things that are required by base class 00070 virtual std::string description () const; 00071 virtual void run_clustering(ClusterSequence &) const; 00072 00073 double ycut() const {return _ycut;} 00074 00075 /// the plugin mechanism's standard way of accessing the jet radius. 00076 /// This must be set to return something sensible, even if R 00077 /// does not make sense for this algorithm! 00078 virtual double R() const {return 1.0;} 00079 00080 /// avoid the warning whenever the user requests "exclusive" jets 00081 /// from the cluster sequence 00082 virtual bool exclusive_sequence_meaningful() const {return true;} 00083 00084 private: 00085 double _ycut; 00086 }; 00087 00088 FASTJET_END_NAMESPACE // defined in fastjet/internal/base.hh 00089 00090 #endif // __EECAMBRIDGEPLUGIN_HH__ 00091