FastJet 3.0.2
|
00001 #ifndef __JADEPLUGIN_HH__ 00002 #define __JADEPLUGIN_HH__ 00003 00004 //STARTHEADER 00005 // $Id: JadePlugin.hh 2577 2011-09-13 15:11:38Z salam $ 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 #include "fastjet/JetDefinition.hh" 00033 00034 FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh 00035 00036 // forward declaration to reduce includes 00037 class ClusterSequence; 00038 00039 //---------------------------------------------------------------------- 00040 // 00041 /// @ingroup plugins 00042 /// \class JadePlugin 00043 /// Implementation of the e+e- Jade algorithm (plugin for fastjet v2.4 upwards) 00044 /// 00045 /// JadePlugin is a plugin for fastjet (v2.4 upwards) 00046 /// It implements the JADE algorithm, which is an e+e- sequential 00047 /// recombination algorithm with interparticle distance 00048 /// 00049 /// dij = 2 E_i E_j (1 - cos theta_ij) 00050 /// 00051 /// or equivalently 00052 /// 00053 /// yij = dij/E_{vis}^2 00054 /// 00055 /// This corresponds to the distance measured used in 00056 /// 00057 /// "Experimental Investigation of the Energy Dependence of the Strong Coupling Strength." 00058 /// JADE Collaboration (S. Bethke et al.) 00059 /// Phys.Lett.B213:235,1988 00060 /// 00061 /// The JADE article carries out particle recombinations in the 00062 /// E-scheme (4-vector recombination), which is the default procedure for this 00063 /// plugin. 00064 /// 00065 /// NOTE: other widely used schemes include E0, P, P0; however they also 00066 /// involve modifications to the distance measure. Be sure of 00067 /// what you're doing before running a JADE type algorithm. 00068 /// 00069 /// To access the jets with a given ycut value (clustering stops once 00070 /// all yij > ycut), use 00071 /// 00072 /// vector<PseudoJet> jets = cluster_sequence.exclusive_jets_ycut(ycut); 00073 /// 00074 /// and related routines. 00075 class JadePlugin : public JetDefinition::Plugin { 00076 public: 00077 /// Main constructor for the Jade Plugin class. 00078 JadePlugin (){} 00079 00080 /// copy constructor 00081 JadePlugin (const JadePlugin & plugin) { 00082 *this = plugin; 00083 } 00084 00085 // the things that are required by base class 00086 virtual std::string description () const; 00087 virtual void run_clustering(ClusterSequence &) const; 00088 00089 /// the plugin mechanism's standard way of accessing the jet radius. 00090 /// This must be set to return something sensible, even if R 00091 /// does not make sense for this algorithm! 00092 virtual double R() const {return 1.0;} 00093 00094 /// avoid the warning whenever the user requests "exclusive" jets 00095 /// from the cluster sequence 00096 virtual bool exclusive_sequence_meaningful() const {return true;} 00097 00098 private: 00099 00100 }; 00101 00102 FASTJET_END_NAMESPACE // defined in fastjet/internal/base.hh 00103 00104 #endif // __JADEPLUGIN_HH__ 00105