fastjet 2.4.5
PxConePlugin.hh
Go to the documentation of this file.
00001 //STARTHEADER
00002 // $Id: PxConePlugin.hh 917 2007-11-05 20:09:08Z soyez $
00003 //
00004 // Copyright (c) 2005-2006, Matteo Cacciari and Gavin Salam
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, write to the Free Software
00026 //  Foundation, Inc.:
00027 //      59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00028 //----------------------------------------------------------------------
00029 //ENDHEADER
00030 
00031 #ifndef __PXCONEPLUGIN_HH__
00032 #define __PXCONEPLUGIN_HH__
00033 
00034 #include "fastjet/JetDefinition.hh"
00035 
00036 // questionable whether this should be in fastjet namespace or not...
00037 
00038 FASTJET_BEGIN_NAMESPACE      // defined in fastjet/internal/base.hh
00039 
00040 //----------------------------------------------------------------------
00041 //
00063 //
00064 //----------------------------------------------------------------------
00065 class PxConePlugin : public JetDefinition::Plugin {
00066 public:
00067 
00089   PxConePlugin (double  cone_radius      , 
00090                 double  min_jet_energy = 5.0  , 
00091                 double  overlap_threshold = 0.5,
00092                 bool    E_scheme_jets = false) : 
00093     _cone_radius        (cone_radius        ),
00094     _min_jet_energy     (min_jet_energy     ),
00095     _overlap_threshold  (overlap_threshold  ),
00096     _E_scheme_jets      (E_scheme_jets      ) {}
00097 
00098 
00099   // some functions to return info about parameters ----------------
00100 
00102   double cone_radius        () const {return _cone_radius        ;}
00103 
00106   double min_jet_energy     () const {return _min_jet_energy     ;}
00107 
00109   double overlap_threshold  () const {return _overlap_threshold  ;}
00110 
00116   bool E_scheme_jets()         const {return _E_scheme_jets      ;}
00117 
00118 
00119   // the things that are required by base class
00120   virtual std::string description () const;
00121   virtual void run_clustering(ClusterSequence &) const;
00123   virtual double R() const {return cone_radius();}
00124 
00125 private:
00126 
00127   double _cone_radius       ;
00128   double _min_jet_energy    ;
00129   double _overlap_threshold ;
00130 
00131   bool _E_scheme_jets;
00132 };
00133 
00134 FASTJET_END_NAMESPACE      // defined in fastjet/internal/base.hh
00135 
00136 #endif // __PXCONEPLUGIN_HH__
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines