CDFMidPointPlugin.hh

//STARTHEADER
// $Id: CDFMidPointPlugin.hh 1761 2010-09-16 10:43:18Z soyez $
//
// Copyright (c) 2005-2006, Matteo Cacciari and Gavin Salam
//
//----------------------------------------------------------------------
// This file is part of FastJet.
//
//  FastJet is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  The algorithms that underlie FastJet have required considerable
//  development and are described in hep-ph/0512210. If you use
//  FastJet as part of work towards a scientific publication, please
//  include a citation to the FastJet paper.
//
//  FastJet is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with FastJet; if not, write to the Free Software
//  Foundation, Inc.:
//      59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//----------------------------------------------------------------------
//ENDHEADER

#ifndef __CDFMIDPOINTPLUGIN_HH__
#define __CDFMIDPOINTPLUGIN_HH__

#include "fastjet/JetDefinition.hh"

// questionable whether this should be in fastjet namespace or not...

FASTJET_BEGIN_NAMESPACE      // defined in fastjet/internal/base.hh

//----------------------------------------------------------------------
//
//
//----------------------------------------------------------------------
class CDFMidPointPlugin : public JetDefinition::Plugin {
public:
  // NB: just replicates what we've added to the CDF midpoint code
  enum SplitMergeScale {SM_pt, SM_Et, SM_mt, SM_pttilde};

  CDFMidPointPlugin (
                     double seed_threshold     ,         
                     double cone_radius        ,
                     double cone_area_fraction ,
                     int    max_pair_size      ,
                     int    max_iterations     ,
                     double overlap_threshold  ,
                     SplitMergeScale sm_scale = SM_pt) :
    _seed_threshold     (seed_threshold     ),    
    _cone_radius        (cone_radius        ),
    _cone_area_fraction (cone_area_fraction ),
    _max_pair_size      (max_pair_size      ),
    _max_iterations     (max_iterations     ),
    _overlap_threshold  (overlap_threshold  ),
    _sm_scale           (sm_scale)             {}

  CDFMidPointPlugin (double   cone_radius, 
                     double   overlap_threshold,// = 0.5, 
                     double   seed_threshold = 1.0,          
                     double   cone_area_fraction = 1.0) : 
    _seed_threshold     (seed_threshold     ),    
    _cone_radius        (cone_radius        ),
    _cone_area_fraction (cone_area_fraction ),
    _max_pair_size      (2                  ),
    _max_iterations     (100                ),
    _overlap_threshold  (overlap_threshold  ),
    _sm_scale           (SM_pt)                {}


  // some functions to return info about parameters
  double seed_threshold     () const {return _seed_threshold     ;}
  double cone_radius        () const {return _cone_radius        ;}
  double cone_area_fraction () const {return _cone_area_fraction ;}
  int    max_pair_size      () const {return _max_pair_size      ;}
  int    max_iterations     () const {return _max_iterations     ;}
  double overlap_threshold  () const {return _overlap_threshold  ;}


  // the things that are required by base class
  virtual std::string description () const;
  virtual void run_clustering(ClusterSequence &) const;
  virtual double R() const {return cone_radius();}

private:

  double _seed_threshold    ;
  double _cone_radius       ;
  double _cone_area_fraction;
  int    _max_pair_size     ;
  int    _max_iterations    ;
  double _overlap_threshold ;
  SplitMergeScale _sm_scale ;
};

FASTJET_END_NAMESPACE      // defined in fastjet/internal/base.hh

#endif // __CDFMIDPOINTPLUGIN_HH__