EECambridgePlugin.hh

00001 #ifndef __EECAMBRIDGEPLUGIN_HH__
00002 #define __EECAMBRIDGEPLUGIN_HH__
00003 
00004 //STARTHEADER
00005 // $Id: EECambridgePlugin.hh 1761 2010-09-16 10:43:18Z soyez $
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, write to the Free Software
00029 //  Foundation, Inc.:
00030 //      59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00031 //----------------------------------------------------------------------
00032 //ENDHEADER
00033 
00034 
00035 #include "fastjet/JetDefinition.hh"
00036 
00037 FASTJET_BEGIN_NAMESPACE      // defined in fastjet/internal/base.hh
00038 
00039 // forward declaration to reduce includes
00040 class ClusterSequence;
00041 
00042 //----------------------------------------------------------------------
00043 //
00059 class EECambridgePlugin : public JetDefinition::Plugin {
00060 public:
00064   EECambridgePlugin (double ycut) : _ycut(ycut) {}
00065 
00067   EECambridgePlugin (const EECambridgePlugin & plugin) {
00068     *this = plugin;
00069   }
00070 
00071   // the things that are required by base class
00072   virtual std::string description () const;
00073   virtual void run_clustering(ClusterSequence &) const;
00074 
00075   double ycut() const {return _ycut;}
00076 
00080   virtual double R() const {return 1.0;}
00081 
00084   virtual bool exclusive_sequence_meaningful() const {return true;}
00085 
00086 private:
00087   double _ycut;
00088 };
00089 
00090 FASTJET_END_NAMESPACE        // defined in fastjet/internal/base.hh
00091 
00092 #endif // __EECAMBRIDGEPLUGIN_HH__
00093