FastJet 3.0.6
D0RunIpre96ConePlugin.hh
00001 #ifndef __D0RUNIPRE96CONEPLUGIN_HH__
00002 #define __D0RUNIPRE96CONEPLUGIN_HH__
00003 
00004 //STARTHEADER
00005 // $Id: D0RunIpre96ConePlugin.hh 1778 2010-10-25 10:02:58Z soyez $
00006 //
00007 // Copyright (c) 2009-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/D0RunIBaseConePlugin.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 D0RunIpre96ConePlugin
00042 ///
00043 /// A plugin for FastJet (v3.0 or later) that provides an interface to
00044 /// the pre 1996 D0 version of Run-I cone algorithm
00045 ///
00046 /// The D0 code has been obtained from Lars Sonnenschein's web-space
00047 /// http://www-d0.fnal.gov/~sonne/D0RunIcone.tgz
00048 ///
00049 /// The version of the D0 Run I code distributed
00050 /// here has been modified by the FastJet authors, so as to provide
00051 /// access to the contents of the jets (as is necessary for the
00052 /// plugin). This does not modify the results of the clustering.
00053 ///
00054 /// The difference between this algorithm and the post-1996 version
00055 /// relates to the way the final jet momenta are calculated. Details
00056 /// are to be found in FERMILAB-PUB-97-242-E.
00057 //
00058 //----------------------------------------------------------------------
00059 class D0RunIpre96ConePlugin : public D0RunIBaseConePlugin {
00060 public:
00061   /// The D0RunIpre96ConePlugin constructor, which sets the "free" parameters of the
00062   /// algorithm:
00063   ///
00064   ///  \param CONErad is the cone radius
00065   ///
00066   ///  \param JETmne is a minimum ET requirement on every iteration
00067   ///   (jet dropped if Et < JETmne * Et_min_ratio ).
00068   ///   The value that has been used by D0 for JETmne: 8 GeV 
00069   ///   (and Et_min_ratio is 0.5)
00070   ///
00071   ///  \param SPlifr is the shared Et fraction splitting threshold, and
00072   ///   a value of 0.5 was usually used by D0
00073   ///
00074   /// The remaining parameters of the algorithm are not to be modified if the algorithm
00075   /// is to correspond to the one actually used by D0.
00076   ///
00077   ///
00078   D0RunIpre96ConePlugin (double CONErad_in, double JETmne_in , double SPLifr_in = _DEFAULT_SPLifr)
00079     : D0RunIBaseConePlugin(CONErad_in, JETmne_in , SPLifr_in){}
00080 
00081   // the things that are required by base class
00082   virtual std::string description () const;
00083 
00084   // the part that really does the clustering
00085   virtual void run_clustering(ClusterSequence &) const;
00086 
00087 private:
00088   static bool _first_time;
00089 
00090   /// print a banner for reference to the 3rd-party code
00091   void _print_banner(std::ostream *ostr) const;
00092 };
00093 
00094 
00095 FASTJET_END_NAMESPACE      // defined in fastjet/internal/base.hh
00096 
00097 #endif // __D0RUNIPRE96CONEPLUGIN_HH__
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends