FastJet 3.0.2
D0RunIIConePlugin.hh
00001 #ifndef __D0RUNIICONEPLUGIN_HH__
00002 #define __D0RUNIICONEPLUGIN_HH__
00003 
00004 //STARTHEADER
00005 // $Id: D0RunIIConePlugin.hh 2761 2011-11-24 13:54:05Z soyez $
00006 //
00007 // Copyright (c) 2005-2011, Matteo Cacciari, Gavin P. 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 // questionable whether this should be in fastjet namespace or not...
00035 
00036 FASTJET_BEGIN_NAMESPACE      // defined in fastjet/internal/base.hh
00037 
00038 //----------------------------------------------------------------------
00039 //
00040 /// @ingroup plugins
00041 /// \class D0RunIIConePlugin
00042 /// Implementation of the D0 Run II Cone (plugin for fastjet v2.1 upwards)
00043 /// 
00044 /// D0RunIIConePlugin is a plugin for fastjet (v2.1 upwards) that
00045 /// provides an interface to the D0 version of Run-II iterative cone
00046 /// algorithm with midpoint seeds (also known as the Iterative Legacy
00047 /// Cone Algorithm, ILCA).
00048 ///
00049 /// The D0 code has been taken from Lars Sonnenschein's web-space
00050 /// http://www-d0.fnal.gov/~sonne/D0RunIIcone.tgz
00051 ///
00052 /// The version of the D0 Run II code distributed
00053 /// here has been modified by the FastJet authors, so as to provide
00054 /// access to the contents of the jets (as is necessary for the
00055 /// plugin). This does not modify the results of the clustering.
00056 //
00057 //----------------------------------------------------------------------
00058 class D0RunIIConePlugin : public JetDefinition::Plugin {
00059 public:
00060 
00061   //
00062   /// A D0RunIIConePlugin constructor which sets the "free" parameters of the
00063   /// algorithm:
00064   ///
00065   ///  - the cone_radius has the usual meaning
00066   ///
00067   ///  - the min_jet_Et causes cones to be discarded at if at any
00068   ///    iteration they have pt < Et_min_ratio * min_jet_Et. Two
00069   ///    values have been used by D0 for min_jet_Et: 8 GeV in earlier
00070   ///    Run II publicatinos, 6 GeV in later publications
00071   ///
00072   ///  - split_ratio is equivalent to the overlap threshold during the split/merge step. 
00073   ///    Default: 0.5.
00074   ///
00075   /// The remaining parameters of the algorithm are not to be modified if the algorithm
00076   /// is to correspond to the one actually used by D0.
00077   //
00078   D0RunIIConePlugin (double cone_radius_in, 
00079                      double min_jet_Et_in , 
00080                      double split_ratio_in = _DEFAULT_split_ratio) :
00081     _cone_radius            (cone_radius_in                  ),
00082     _min_jet_Et             (min_jet_Et_in                   ),
00083     _split_ratio            (split_ratio_in                  ),
00084     _far_ratio              (_DEFAULT_far_ratio              ),
00085     _Et_min_ratio           (_DEFAULT_Et_min_ratio           ),
00086     _kill_duplicate         (_DEFAULT_kill_duplicate         ),
00087     _duplicate_dR           (_DEFAULT_duplicate_dR           ),
00088     _duplicate_dPT          (_DEFAULT_duplicate_dPT          ),
00089     _search_factor          (_DEFAULT_search_factor          ),
00090     _pT_min_leading_protojet(_DEFAULT_pT_min_leading_protojet),
00091     _pT_min_second_protojet (_DEFAULT_pT_min_second_protojet ),
00092     _merge_max              (_DEFAULT_merge_max              ),
00093     _pT_min_nomerge         (_DEFAULT_pT_min_nomerge         )
00094   {
00095     // nothing to be done here!
00096   }
00097 
00098   // some functions to return info about parameters
00099   inline double cone_radius            () const { return _cone_radius            ;} //= 0.5;
00100   inline double min_jet_Et             () const { return _min_jet_Et             ;} //= 8.0;
00101   inline double split_ratio            () const { return _split_ratio            ;} //= 0.5;
00102   inline double far_ratio              () const { return _far_ratio              ;} // =0.5;
00103   inline double Et_min_ratio           () const { return _Et_min_ratio           ;} // =0.5;
00104   inline bool   kill_duplicate         () const { return _kill_duplicate         ;} // =true;
00105   inline double duplicate_dR           () const { return _duplicate_dR           ;} // =0.005; 
00106   inline double duplicate_dPT          () const { return _duplicate_dPT          ;} // =0.01; 
00107   inline double search_factor          () const { return _search_factor          ;} // =1.0; 
00108   inline double pT_min_leading_protojet() const { return _pT_min_leading_protojet;} // =0.; 
00109   inline double pT_min_second_protojet () const { return _pT_min_second_protojet ;} // =0.;
00110   inline int    merge_max              () const { return _merge_max              ;} // =10000; 
00111   inline double pT_min_nomerge         () const { return _pT_min_nomerge         ;} // =0.;
00112 
00113 
00114   /// access the split_ratio() also by the name overlap_threshold()
00115   inline double overlap_threshold() const {return split_ratio();}
00116 
00117   // the things that are required by base class
00118   virtual std::string description () const;
00119   virtual void run_clustering(ClusterSequence &) const;
00120   /// the plugin mechanism's standard way of accessing the jet radius
00121   virtual double R() const {return cone_radius();}
00122   
00123 
00124 private:
00125 
00126   double _cone_radius ;//= 0.5;
00127   double _min_jet_Et  ;//= 8.0;
00128   double _split_ratio ;//= 0.5; // overlap threshold
00129         
00130   //the parameters below have been found to be set to the values given below 
00131   //in the original implementation, shouldn't be altered
00132   double _far_ratio              ; // =0.5;
00133   double _Et_min_ratio           ; // =0.5;
00134   bool   _kill_duplicate         ; // =true;
00135   double _duplicate_dR           ; // =0.005; 
00136   double _duplicate_dPT          ; // =0.01; 
00137   double _search_factor          ; // =1.0; 
00138   double _pT_min_leading_protojet; // =0.; 
00139   double _pT_min_second_protojet ; // =0.;
00140   int    _merge_max              ; // =10000; 
00141   double _pT_min_nomerge         ; // =0.;
00142 
00143   // here are the variables for the default parameters of the D0 Run II Cone algorithm.
00144   // They are set in the .cc file 
00145   const static double _DEFAULT_split_ratio             ;// = 0.5  ; // overlap threshold
00146   const static double _DEFAULT_far_ratio               ;// = 0.5  ;
00147   const static double _DEFAULT_Et_min_ratio            ;// = 0.5  ;
00148   const static bool   _DEFAULT_kill_duplicate          ;// = true ;
00149   const static double _DEFAULT_duplicate_dR            ;// = 0.005; 
00150   const static double _DEFAULT_duplicate_dPT           ;// = 0.01 ; 
00151   const static double _DEFAULT_search_factor           ;// = 1.0  ; 
00152   const static double _DEFAULT_pT_min_leading_protojet ;// = 0.   ; 
00153   const static double _DEFAULT_pT_min_second_protojet  ;// = 0.   ;
00154   const static int    _DEFAULT_merge_max               ;// = 10000; 
00155   const static double _DEFAULT_pT_min_nomerge          ;// = 0.   ;
00156 
00157   static bool _first_time;
00158 
00159   /// print a banner for reference to the 3rd-party code
00160   void _print_banner(std::ostream *ostr) const;
00161 };
00162 
00163 FASTJET_END_NAMESPACE      // defined in fastjet/internal/base.hh
00164 
00165 #endif // __D0RUNIICONEPLUGIN_HH__
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends