FastJet 3.0.2
NestedDefsPlugin.hh
00001 //STARTHEADER
00002 // $Id: NestedDefsPlugin.hh 2577 2011-09-13 15:11:38Z salam $
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 __NESTEDALGSPLUGIN_HH__
00030 #define __NESTEDALGSPLUGIN_HH__
00031 
00032 #include "fastjet/JetDefinition.hh"
00033 #include <list>
00034 #include <memory>
00035 #include <cmath>
00036 
00037 // questionable whether this should be in fastjet namespace or not...
00038 FASTJET_BEGIN_NAMESPACE      // defined in fastjet/internal/base.hh
00039 
00040 // another forward declaration to reduce includes
00041 class PseudoJet;
00042 
00043 //----------------------------------------------------------------------
00044 //
00045 /// @ingroup plugins
00046 /// \class NestedDefsPlugin
00047 /// Plugin to run multiple jet definitions successively (plugin for fastjet v2.4 upwards)
00048 ///
00049 /// NestedAglsPlugin is a plugin for fastjet (v2.4 upwards) that, given
00050 /// a list of jet definitions, performs the clustering by feeding the 
00051 /// particles to the first algorithm and then, successively feeding the 
00052 /// output to the next algorithm in the list.
00053 //
00054 class NestedDefsPlugin : public JetDefinition::Plugin {
00055 public:
00056   /// Main constructor for the NestedDefs Plugin class.  
00057   ///
00058   /// The argument is an initialised list of jet algorithms
00059   NestedDefsPlugin (std::list<JetDefinition> &defs) :
00060     _defs(defs){}
00061 
00062   /// copy constructor
00063   NestedDefsPlugin (const NestedDefsPlugin & 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   /// the plugin mechanism's standard way of accessing the jet radius
00071   /// here we return the R of the last alg in the list
00072   virtual double R() const {return _defs.rbegin()->R();}
00073 
00074 private:
00075   std::list<JetDefinition> _defs;
00076 };
00077 
00078 FASTJET_END_NAMESPACE        // defined in fastjet/internal/base.hh
00079 
00080 #endif // __SISCONEPLUGIN_HH__
00081 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends