JetDefinition.hh

Go to the documentation of this file.

//STARTHEADER
// $Id: JetDefinition.hh 304 2006-08-23 21:54:34Z salam $
//
// 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 __FASTJET_JETDEFINITION_HH__
#define __FASTJET_JETDEFINITION_HH__

#include<cassert>
#include "fastjet/internal/numconsts.hh"

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

//======================================================================
enum Strategy {
  N2MinHeapTiled   = -4, 
  N2Tiled     = -3, 
  N2PoorTiled = -2, 
  N2Plain     = -1, 
  N3Dumb      =  0, 
  Best        =  1, 
  NlnN        =  2, 
  NlnN3pi     =  3, 
  NlnN4pi     =  4,
  NlnNCam4pi   = 14,
  NlnNCam2pi2R = 13,
  NlnNCam      = 12 // 2piMultD
};


//======================================================================
enum JetFinder {
  kt_algorithm=0,
  cambridge_algorithm=1
};


//======================================================================
class JetDefinition {
  
public:

  JetDefinition(JetFinder jet_finder = kt_algorithm, 
                  double R = 1.0, 
                  Strategy strategy = Best) :
    _jet_finder(jet_finder), _Rparam(R), _strategy(strategy) {
    // the largest sensible value for R
    assert(_Rparam <= 0.5*pi);
};


  // return information about the definition...
  JetFinder jet_finder  () const {return _jet_finder  ;}; 
  double      R           () const {return _Rparam      ;};
  Strategy  strategy    () const {return _strategy    ;};

private:
  JetFinder _jet_finder;
  double      _Rparam    ;
  Strategy  _strategy  ;


};


FASTJET_END_NAMESPACE

#endif // __FASTJET_JETDEFINITION_HH__

---