FastJet 3.0.2
CMSIterativeConePlugin.hh
00001 //STARTHEADER
00002 // $Id: CMSIterativeConePlugin.hh 1508 2009-04-10 22:46:49Z soyez $
00003 //
00004 // Copyright (c) 2007-2011, Matteo Cacciari, Gavin P. Salam and Gregory Soyez
00005 //
00006 //----------------------------------------------------------------------
00007 // This file is part of FastJet.
00008 //
00009 //  FastJet is free software; you can redistribute it and/or modify
00010 //  it under the terms of the GNU General Public License as published by
00011 //  the Free Software Foundation; either version 2 of the License, or
00012 //  (at your option) any later version.
00013 //
00014 //  The algorithms that underlie FastJet have required considerable
00015 //  development and are described in hep-ph/0512210. If you use
00016 //  FastJet as part of work towards a scientific publication, please
00017 //  include a citation to the FastJet paper.
00018 //
00019 //  FastJet is distributed in the hope that it will be useful,
00020 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
00021 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00022 //  GNU General Public License for more details.
00023 //
00024 //  You should have received a copy of the GNU General Public License
00025 //  along with FastJet. If not, see <http://www.gnu.org/licenses/>.
00026 //----------------------------------------------------------------------
00027 //ENDHEADER
00028 
00029 #ifndef __CMSITERATIVECONEPLUGIN_HH__
00030 #define __CMSITERATIVECONEPLUGIN_HH__
00031 
00032 #include "fastjet/JetDefinition.hh"
00033 
00034 // questionable whether this should be in fastjet namespace or not...
00035 FASTJET_BEGIN_NAMESPACE      // defined in fastjet/internal/base.hh
00036 
00037 // forward declaration to reduce includes
00038 class PseudoJet;
00039 
00040 //----------------------------------------------------------------------
00041 //
00042 
00043 /// @ingroup plugins
00044 /// \class CMSIterativeConePlugin
00045 /// Implementation of the CMS Iterative Cone (plugin for fastjet v2.4 upwards)
00046 class CMSIterativeConePlugin : public JetDefinition::Plugin {
00047 public:
00048   /// Main constructor for the CMSIterativeCone Plugin class.  
00049   ///
00050   /// The arguments are
00051   ///   ConeRadius      the radius of the cone
00052   ///   SeedThreshold   a threshold for the seeds to iterate from
00053   ///
00054   /// NOTE: to be more coherent with all other fastjet plugins,
00055   ///       we've put the radius before the seed threshold. 
00056   ///       CMS does the opposite.
00057   ///       In this way, we also put a default value of 0 for the 
00058   ///       seed threshold.
00059   CMSIterativeConePlugin (double ConeRadius, double SeedThreshold=1.0) :
00060     theConeRadius(ConeRadius), theSeedThreshold(SeedThreshold){}
00061 
00062   /// copy constructor
00063   CMSIterativeConePlugin (const CMSIterativeConePlugin & plugin) {
00064     *this = plugin;
00065   }
00066 
00067   // the things that are required by base class
00068   virtual std::string description () const;
00069   virtual void run_clustering(ClusterSequence &) const;
00070 
00071   /// the plugin mechanism's standard way of accessing the jet radius
00072   /// here we return the R of the last alg in the list
00073   virtual double R() const {return theConeRadius;}
00074 
00075   /// get the seed threshold
00076   virtual double seed_threshold() const {return theSeedThreshold;}
00077 
00078 private:
00079   double theConeRadius;     ///< cone radius
00080   double theSeedThreshold;  ///< seed threshold
00081 
00082   static bool _first_time;
00083 
00084   /// print a banner for reference to the 3rd-party code
00085   void _print_banner(std::ostream *ostr) const;
00086 };
00087 
00088 FASTJET_END_NAMESPACE        // defined in fastjet/internal/base.hh
00089 
00090 #endif // __CMSITERATIVECONEPLUGIN_HH__
00091 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends