JetDefinition.hh File Reference

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

Include dependency graph for JetDefinition.hh:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	JetDefinition
	class that is intended to hold a full definition of the jet clusterer More...
class	JetDefinition::Recombiner
	An abstract base class that will provide the recombination scheme facilities and/or allow a user to extend these facilities. More...
class	JetDefinition::DefaultRecombiner
	A class that will provide the recombination scheme facilities and/or allow a user to extend these facilities. More...
class	JetDefinition::Plugin
	a class that allows a user to introduce their own "plugin" jet finder More...
Typedefs
typedef JetAlgorithm	JetFinder
	make standard Les Houches nomenclature JetAlgorithm (algorithm is general recipe without the parameters) backward-compatible with old JetFinder
Enumerations
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,   plugin_strategy = 999 }
	the various options for the algorithmic strategy to adopt in clustering events with kt and cambridge style algorithms. More...
enum	JetAlgorithm {   kt_algorithm = 0, cambridge_algorithm = 1, antikt_algorithm = 2, genkt_algorithm = 3,   cambridge_for_passive_algorithm = 11, genkt_for_passive_algorithm = 13, ee_kt_algorithm = 50, ee_genkt_algorithm = 53,   plugin_algorithm = 99 }
	the various families of jet-clustering algorithm More...
enum	RecombinationScheme {   E_scheme = 0, pt_scheme = 1, pt2_scheme = 2, Et_scheme = 3,   Et2_scheme = 4, BIpt_scheme = 5, BIpt2_scheme = 6, external_scheme = 99 }
	the various recombination schemes More...
Functions
FASTJET_BEGIN_NAMESPACE std::string	fastjet_version_string ()
	return a string containing information about the release
Variables
const JetAlgorithm	aachen_algorithm = cambridge_algorithm
	provide other possible names for the Cambridge/Aachen algorithm?
const JetAlgorithm	cambridge_aachen_algorithm = cambridge_algorithm

---

Typedef Documentation

typedef JetAlgorithm JetFinder

make standard Les Houches nomenclature JetAlgorithm (algorithm is general recipe without the parameters) backward-compatible with old JetFinder

Definition at line 114 of file JetDefinition.hh.

---

Enumeration Type Documentation

enum JetAlgorithm

the various families of jet-clustering algorithm

Enumerator:

kt_algorithm	the longitudinally invariant kt algorithm
cambridge_algorithm	the longitudinally invariant variant of the cambridge algorithm (aka Aachen algoithm).
antikt_algorithm	like the k_t but with distance measures dij = min(1/kti^2,1/ktj^2) Delta R_{ij}^2 / R^2 diB = 1/kti^2
genkt_algorithm	like the k_t but with distance measures dij = min(kti^{2p},ktj^{2p}) Delta R_{ij}^2 / R^2 diB = 1/kti^{2p} where p = extra_param()
cambridge_for_passive_algorithm	a version of cambridge with a special distance measure for particles whose pt is < extra_param()
genkt_for_passive_algorithm	a version of genkt with a special distance measure for particles whose pt is < extra_param() [relevant for passive areas when p<=0]
ee_kt_algorithm	the e+e- kt algorithm
ee_genkt_algorithm	the e+e- genkt algorithm (R > 2 and p=1 gives ee_kt)
plugin_algorithm	any plugin algorithm supplied by the user

Definition at line 81 of file JetDefinition.hh.

                  {
  kt_algorithm=0,
  cambridge_algorithm=1,
  antikt_algorithm=2, 
  genkt_algorithm=3, 
  cambridge_for_passive_algorithm=11,
  genkt_for_passive_algorithm=13, 
  //.................................................................
  ee_kt_algorithm=50,
  ee_genkt_algorithm=53,
  //.................................................................
  plugin_algorithm = 99
};

enum RecombinationScheme

the various recombination schemes

Enumerator:

E_scheme	summing the 4-momenta
pt_scheme	pt weighted recombination of y,phi (and summing of pt's) with preprocessing to make things massless by rescaling E=| p|
pt2_scheme	pt^2 weighted recombination of y,phi (and summing of pt's) with preprocessing to make things massless by rescaling E=| p|
Et_scheme	pt weighted recombination of y,phi (and summing of pt's) with preprocessing to make things massless by rescaling | p|->=E
Et2_scheme	pt^2 weighted recombination of y,phi (and summing of pt's) with preprocessing to make things massless by rescaling | p|->=E
BIpt_scheme	pt weighted recombination of y,phi (and summing of pt's), with no preprocessing
BIpt2_scheme	pt^2 weighted recombination of y,phi (and summing of pt's) no preprocessing
external_scheme	for the user's external scheme

Definition at line 122 of file JetDefinition.hh.

                         {
  E_scheme=0,
  pt_scheme=1,
  pt2_scheme=2,
  Et_scheme=3,
  Et2_scheme=4,
  BIpt_scheme=5,
  BIpt2_scheme=6,
  external_scheme = 99
};

enum Strategy

the various options for the algorithmic strategy to adopt in clustering events with kt and cambridge style algorithms.

Enumerator:

N2MinHeapTiled	fastest form about 500..10^4
N2Tiled	fastest from about 50..500
N2PoorTiled	legacy
N2Plain	fastest below 50
N3Dumb	worse even than the usual N^3 algorithms
Best	automatic selection of the best (based on N)
NlnN	best of the NlnN variants -- best overall for N>10^4
NlnN3pi	legacy N ln N using 3pi coverage of cylinder
NlnN4pi	legacy N ln N using 4pi coverage of cylinder
NlnNCam4pi	Chan's closest pair method (in a variant with 4pi coverage), for use exclusively with the Cambridge algorithm.
NlnNCam2pi2R
NlnNCam
plugin_strategy	the plugin has been used...

Definition at line 50 of file JetDefinition.hh.

              {
  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
  plugin_strategy = 999
};

---

Function Documentation

FASTJET_BEGIN_NAMESPACE std::string fastjet_version_string

(

)

return a string containing information about the release

Definition at line 190 of file ClusterSequence.cc.

References fastjet_version.

Referenced by main().

                                {
  return "FastJet version "+string(fastjet_version);
}

---

Variable Documentation

const JetAlgorithm aachen_algorithm = cambridge_algorithm

provide other possible names for the Cambridge/Aachen algorithm?

Definition at line 117 of file JetDefinition.hh.

const JetAlgorithm cambridge_aachen_algorithm = cambridge_algorithm

Definition at line 118 of file JetDefinition.hh.