fastjet 2.4.5
CDFMidPointPlugin.hh
Go to the documentation of this file.
00001 //STARTHEADER
00002 // $Id: CDFMidPointPlugin.hh 1186 2008-04-04 16:15:39Z salam $
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 __CDFMIDPOINTPLUGIN_HH__
00032 #define __CDFMIDPOINTPLUGIN_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 //
00058 //
00059 //----------------------------------------------------------------------
00060 class CDFMidPointPlugin : public JetDefinition::Plugin {
00061 public:
00063   // NB: just replicates what we've added to the CDF midpoint code
00064   enum SplitMergeScale {SM_pt, SM_Et, SM_mt, SM_pttilde};
00065 
00105   CDFMidPointPlugin (
00106                      double seed_threshold     ,         
00107                      double cone_radius        ,
00108                      double cone_area_fraction ,
00109                      int    max_pair_size      ,
00110                      int    max_iterations     ,
00111                      double overlap_threshold  ,
00112                      SplitMergeScale sm_scale = SM_pt) :
00113     _seed_threshold     (seed_threshold     ),    
00114     _cone_radius        (cone_radius        ),
00115     _cone_area_fraction (cone_area_fraction ),
00116     _max_pair_size      (max_pair_size      ),
00117     _max_iterations     (max_iterations     ),
00118     _overlap_threshold  (overlap_threshold  ),
00119     _sm_scale           (sm_scale)             {}
00120 
00128   CDFMidPointPlugin (double   cone_radius, 
00129                      double   overlap_threshold,// = 0.5, 
00130                      double   seed_threshold = 1.0,          
00131                      double   cone_area_fraction = 1.0) : 
00132     _seed_threshold     (seed_threshold     ),    
00133     _cone_radius        (cone_radius        ),
00134     _cone_area_fraction (cone_area_fraction ),
00135     _max_pair_size      (2                  ),
00136     _max_iterations     (100                ),
00137     _overlap_threshold  (overlap_threshold  ),
00138     _sm_scale           (SM_pt)                {}
00139 
00140 
00141   // some functions to return info about parameters
00142   double seed_threshold     () const {return _seed_threshold     ;}
00143   double cone_radius        () const {return _cone_radius        ;}
00144   double cone_area_fraction () const {return _cone_area_fraction ;}
00145   int    max_pair_size      () const {return _max_pair_size      ;}
00146   int    max_iterations     () const {return _max_iterations     ;}
00147   double overlap_threshold  () const {return _overlap_threshold  ;}
00148 
00149 
00150   // the things that are required by base class
00151   virtual std::string description () const;
00152   virtual void run_clustering(ClusterSequence &) const;
00154   virtual double R() const {return cone_radius();}
00155 
00156 private:
00157 
00158   double _seed_threshold    ;
00159   double _cone_radius       ;
00160   double _cone_area_fraction;
00161   int    _max_pair_size     ;
00162   int    _max_iterations    ;
00163   double _overlap_threshold ;
00164   SplitMergeScale _sm_scale ;
00165 };
00166 
00167 FASTJET_END_NAMESPACE      // defined in fastjet/internal/base.hh
00168 
00169 #endif // __CDFMIDPOINTPLUGIN_HH__
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines