Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members

fastjet Namespace Reference


Classes

class  ActiveAreaSpec
 Class that defines the parameters that go into the measurement of active jet areas. More...
class  ClusterSequence
 deals with clustering More...
class  ClusterSequenceActiveArea
 Class that behaves essentially like ClusterSequence except that it also provides access to the area of a jet (which will be a random quantity. More...
class  ClusterSequenceActiveAreaExplicitGhosts
 Class that behaves essentially like ClusterSequence except that it also provides access to the area of a jet (which will be a random quantity. More...
class  ClusterSequenceWithArea
 base class that sets interface for extensions of ClusterSequence that provide information about the area of each jet; More...
class  Error
 class corresponding to errors that will be thrown by fastjet More...
class  BasicRandom
class  BasicRandom< int >
class  BasicRandom< double >
 template specialization (double) for the BasicRandom template class. More...
class  ClosestPair2D
 concrete implementation for finding closest pairs in 2D -- will use Chan's (hopefully efficient) shuffle based structures More...
class  Coord2D
 class for representing 2d coordinates and carrying out some basic operations on them More...
class  ClosestPair2DBase
 abstract base class for finding closest pairs in 2D More...
class  Dnn2piCylinder
 class derived from DynamicNearestNeighbours that provides an implementation for the surface of cylinder (using one DnnPlane object spanning 0--2pi). More...
class  Dnn3piCylinder
 class derived from DynamicNearestNeighbours that provides an implementation for the surface of cylinder (using one DnnPlane object spanning 0--3pi). More...
class  Dnn4piCylinder
 class derived from DynamicNearestNeighbours that provides an implementation for the surface of cylinder (using two copies of DnnPlane, one running from 0--2pi, the other from pi--3pi). More...
class  DnnPlane
 class derived from DynamicNearestNeighbours that provides an implementation for the Euclidean plane More...
class  EtaPhi
 use a class instead of a pair so that phi can be sanitized and put into proper range on initialization. More...
class  DnnError
 class corresponding to errors that will be thrown by Dynamic Nearest Neighbours code More...
class  DynamicNearestNeighbours
 Abstract base class for quick location of nearest neighbours in a set of points, with facilities for adding and removing points from the set after initialisation. More...
class  MinHeap
 A class which provides a "heap"-like structure that allows access to a the minimal value of a dynamically changing set of numbers. More...
class  SearchTree
 This is the class for a search tree designed to be especially efficient when looking for successors and predecessors (to be used in Chan's CP algorithm). More...
struct  K
 the basic geometrical kernel that lies at the base of all CGAL operations More...
class  InitialisedInt
 A class to provide an "int" with an initial value. More...
class  JetDefinition
 class that is intended to hold a full definition of the jet clusterer More...
class  PseudoJet
 Class to contain pseudojets, including minimal information of use to to jet-clustering routines. More...
class  IndexedSortHelper
 a class that helps us carry out indexed sorting. More...

Namespaces

namespace  Private

Typedefs

typedef ClusterSequenceActiveAreaExplicitGhosts ClustSeqActAreaEG
typedef CGAL::Triangulation_vertex_base_with_info_2<
InitialisedInt, K > 		Vbb
typedef CGAL::Triangulation_hierarchy_vertex_base_2<
Vbb > 		Vb
typedef CGAL::Triangulation_face_base_2<
K > 		Fb
typedef CGAL::Triangulation_data_structure_2<
Vb, Fb > 		Tds
typedef CGAL::Delaunay_triangulation_2<
K, Tds > 		Dt
typedef CGAL::Triangulation_hierarchy_2<
Dt > 		Triangulation
typedef Triangulation::Vertex_handle Vertex_handle
typedef Triangulation::Point Point
typedef Triangulation::Vertex_circulator Vertex_circulator
 CGAL Point structure.
typedef Triangulation::Face_circulator Face_circulator
typedef Triangulation::Face_handle Face_handle

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
}
 the various options for the algorithmic strategy to adopt in clustering events with kt and cambridge style algorithms. More...
enum  JetFinder { kt_algorithm = 0, cambridge_algorithm = 1 }
 the various families of jet-clustering algorithm More...

Functions

int __default_random_generator (int *__iseed)
PseudoJet operator+ (const PseudoJet &jet1, const PseudoJet &jet2)
PseudoJet operator- (const PseudoJet &jet1, const PseudoJet &jet2)
PseudoJet operator * (double coeff, const PseudoJet &jet)
PseudoJet operator * (const PseudoJet &jet, double coeff)
PseudoJet operator/ (const PseudoJet &jet, double coeff)
void sort_indices (vector< int > &indices, const vector< double > &values)
template<class T>
vector< T > objects_sorted_by_values (const vector< T > &objects, const vector< double > &values)
 given a vector of values with a one-to-one correspondence with the vector of objects, sort objects into an order such that the associated values would be in increasing order
vector< PseudoJet > sorted_by_pt (const vector< PseudoJet > &jets)
 return a vector of jets sorted into decreasing kt2
vector< PseudoJet > sorted_by_rapidity (const vector< PseudoJet > &jets)
 return a vector of jets sorted into increasing rapidity
vector< PseudoJet > sorted_by_E (const vector< PseudoJet > &jets)
 return a vector of jets sorted into decreasing energy
bool floor_ln2_less (unsigned x, unsigned y)
 returns true if floor(ln_base2(x)) < floor(ln_base2(y)), using Chan's neat trick.
std::vector< PseudoJet > sorted_by_pt (const std::vector< PseudoJet > &jets)
 return a vector of jets sorted into decreasing transverse momentum
std::vector< PseudoJet > sorted_by_rapidity (const std::vector< PseudoJet > &jets)
 return a vector of jets sorted into increasing rapidity
std::vector< PseudoJet > sorted_by_E (const std::vector< PseudoJet > &jets)
 return a vector of jets sorted into decreasing energy
void sort_indices (std::vector< int > &indices, const std::vector< double > &values)
 sort the indices so that values[indices[0->n-1]] is sorted into increasing order
template<class T>
std::vector< T > objects_sorted_by_values (const std::vector< T > &objects, const std::vector< double > &values)
 given a vector of values with a one-to-one correspondence with the vector of objects, sort objects into an order such that the associated values would be in increasing order (but don't actually touch the values vector in the process).

Variables

BasicRandom< int > _G_random_int
BasicRandom< double > _G_random_double
const unsigned int huge_unsigned = 4294967295U
const unsigned int twopow31 = 2147483648U
const double pi = 3.141592653589793238462643383279502884197
const double twopi = 6.283185307179586476925286766559005768394
const double pisq = 9.869604401089358618834490999876151135314
const double zeta2 = 1.644934066848226436472415166646025189219
const double zeta3 = 1.202056903159594285399738161511449990765
const double eulergamma = 0.577215664901532860606512090082402431042
const double ln2 = 0.693147180559945309417232121458176568076
const int INFINITE_VERTEX = -1
const int NEW_VERTEX = -2
const double HUGE_DOUBLE = 1e300
const double MaxRap = 1e5
 Used to protect against parton-level events where pt can be zero for some partons, giving rapidity=infinity.

Typedef Documentation

typedef ClusterSequenceActiveAreaExplicitGhosts fastjet::ClustSeqActAreaEG
 

Definition at line 38 of file ClusterSequenceActiveAreaExplicitGhosts.cc.

typedef CGAL::Delaunay_triangulation_2<K,Tds> fastjet::Dt
 

Definition at line 85 of file Triangulation.hh.

typedef Triangulation::Face_circulator fastjet::Face_circulator
 

Definition at line 92 of file Triangulation.hh.

typedef Triangulation::Face_handle fastjet::Face_handle
 

Definition at line 93 of file Triangulation.hh.

typedef CGAL::Triangulation_face_base_2<K> fastjet::Fb
 

Definition at line 83 of file Triangulation.hh.

typedef Triangulation::Point fastjet::Point
 

Definition at line 90 of file Triangulation.hh.

typedef CGAL::Triangulation_data_structure_2<Vb,Fb> fastjet::Tds
 

Definition at line 84 of file Triangulation.hh.

typedef CGAL::Triangulation_hierarchy_2<Dt> fastjet::Triangulation
 

Definition at line 86 of file Triangulation.hh.

typedef CGAL::Triangulation_hierarchy_vertex_base_2<Vbb> fastjet::Vb
 

Definition at line 82 of file Triangulation.hh.

typedef CGAL::Triangulation_vertex_base_with_info_2<InitialisedInt,K> fastjet::Vbb
 

Definition at line 81 of file Triangulation.hh.

typedef Triangulation::Vertex_circulator fastjet::Vertex_circulator
 

CGAL Point structure.

Definition at line 91 of file Triangulation.hh.

typedef Triangulation::Vertex_handle fastjet::Vertex_handle
 

Definition at line 89 of file Triangulation.hh.

Enumeration Type Documentation

enum fastjet::JetFinder
 

the various families of jet-clustering algorithm

Enumeration values:
kt_algorithm  the longitudinally invariant kt algorithm
cambridge_algorithm  the longitudinally invariant variant of the cambridge algorithm (aka Aachen algoithm).

Definition at line 71 of file JetDefinition.hh.

00071                {
00073   kt_algorithm=0,
00076   cambridge_algorithm=1
00077 };

enum fastjet::Strategy
 

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

Enumeration values:
N2MinHeapTiled  experimental ...
N2Tiled  fastest from about 50..10^4
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 

Definition at line 42 of file JetDefinition.hh.

00042               {
00044   N2MinHeapTiled   = -4, 
00046   N2Tiled     = -3, 
00048   N2PoorTiled = -2, 
00050   N2Plain     = -1, 
00052   N3Dumb      =  0, 
00054   Best        =  1, 
00056   NlnN        =  2, 
00058   NlnN3pi     =  3, 
00060   NlnN4pi     =  4,
00063   NlnNCam4pi   = 14,
00064   NlnNCam2pi2R = 13,
00065   NlnNCam      = 12 // 2piMultD
00066 };

Function Documentation

int fastjet::__default_random_generator (  int *  __iseed  ) 
 

Definition at line 31 of file BasicRandom.cc.

Referenced by fastjet::BasicRandom< double >::operator()(), and fastjet::BasicRandom< int >::operator()().

00032 {
00033   int __k = __iseed[0]/53668;
00034   __iseed[0] = (__iseed[0] - __k*53668)*40014 - __k*12211;
00035   if(__iseed[0] < 0) __iseed[0] += 2147483563;
00036   
00037   __k = __iseed[1]/52774;
00038   __iseed[1] = (__iseed[1] - __k*52774)*40692 - __k*3791;
00039   if(__iseed[1] < 0) __iseed[1] += 2147483399;
00040   
00041   int __iz = __iseed[0] - __iseed[1];
00042   if(__iz < 1) __iz += 2147483562;
00043   
00044   return __iz;
00045 }

bool fastjet::floor_ln2_less (  unsigned  x,
unsigned  y
)  [inline]
 

returns true if floor(ln_base2(x)) < floor(ln_base2(y)), using Chan's neat trick.

..

Definition at line 212 of file ClosestPair2D.hh.

Referenced by fastjet::ClosestPair2D::Shuffle::operator<().

00212                                                    {
00213   if (x>y) return false;
00214   return (x < (x^y)); // beware of operator precedence...
00215 }

template<class T>
std::vector<T> fastjet::objects_sorted_by_values (  const std::vector< T > &  objects,
const std::vector< double > &  values
) 
 

given a vector of values with a one-to-one correspondence with the vector of objects, sort objects into an order such that the associated values would be in increasing order (but don't actually touch the values vector in the process).

template<class T>
vector<T> fastjet::objects_sorted_by_values (  const vector< T > &  objects,
const vector< double > &  values
) 
 

given a vector of values with a one-to-one correspondence with the vector of objects, sort objects into an order such that the associated values would be in increasing order

Definition at line 246 of file PseudoJet.cc.

References sort_indices().

Referenced by sorted_by_E(), sorted_by_pt(), and sorted_by_rapidity().

00248                                                       {
00249 
00250   assert(objects.size() == values.size());
00251 
00252   // get a vector of indices
00253   vector<int> indices(values.size());
00254   for (size_t i = 0; i < indices.size(); i++) {indices[i] = i;}
00255   
00256   // sort the indices
00257   sort_indices(indices, values);
00258   
00259   // copy the objects 
00260   vector<T> objects_sorted(objects.size());
00261   
00262   // place the objects in the correct order
00263   for (size_t i = 0; i < indices.size(); i++) {
00264     objects_sorted[i] = objects[indices[i]];
00265   }
00266 
00267   return objects_sorted;
00268 }

PseudoJet fastjet::operator * (  const PseudoJet &  jet,
double  coeff
) 
 

Definition at line 161 of file PseudoJet.cc.

00161                                                           {
00162   return coeff*jet;
00163 }

PseudoJet fastjet::operator * (  double  coeff,
const PseudoJet &  jet
) 
 

Definition at line 151 of file PseudoJet.cc.

00151                                                           {
00152   //return PseudoJet(coeff*jet.four_mom());
00153   // the following code is hopefully more efficient
00154   PseudoJet coeff_times_jet(jet);
00155   coeff_times_jet *= coeff;
00156   return coeff_times_jet;
00157 }

PseudoJet fastjet::operator+ (  const PseudoJet &  jet1,
const PseudoJet &  jet2
) 
 

Definition at line 131 of file PseudoJet.cc.

References fastjet::PseudoJet::E(), fastjet::PseudoJet::px(), fastjet::PseudoJet::py(), and fastjet::PseudoJet::pz().

00131                                                                      {
00132   //return PseudoJet(jet1.four_mom()+jet2.four_mom());
00133   return PseudoJet(jet1.px()+jet2.px(),
00134                    jet1.py()+jet2.py(),
00135                    jet1.pz()+jet2.pz(),
00136                    jet1.E() +jet2.E()  );
00137 }

PseudoJet fastjet::operator- (  const PseudoJet &  jet1,
const PseudoJet &  jet2
) 
 

Definition at line 141 of file PseudoJet.cc.

References fastjet::PseudoJet::E(), fastjet::PseudoJet::px(), fastjet::PseudoJet::py(), and fastjet::PseudoJet::pz().

00141                                                                      {
00142   //return PseudoJet(jet1.four_mom()-jet2.four_mom());
00143   return PseudoJet(jet1.px()-jet2.px(),
00144                    jet1.py()-jet2.py(),
00145                    jet1.pz()-jet2.pz(),
00146                    jet1.E() -jet2.E()  );
00147 }

PseudoJet fastjet::operator/ (  const PseudoJet &  jet,
double  coeff
) 
 

Definition at line 167 of file PseudoJet.cc.

00167                                                           {
00168   return (1.0/coeff)*jet;
00169 }

void fastjet::sort_indices (  std::vector< int > &  indices,
const std::vector< double > &  values
) 
 

sort the indices so that values[indices[0->n-1]] is sorted into increasing order

void fastjet::sort_indices (  vector< int > &  indices,
const vector< double > &  values
) 
 

Definition at line 236 of file PseudoJet.cc.

Referenced by objects_sorted_by_values().

00237                                                         {
00238   IndexedSortHelper index_sort_helper(&values);
00239   sort(indices.begin(), indices.end(), index_sort_helper);
00240 }

std::vector<PseudoJet> fastjet::sorted_by_E (  const std::vector< PseudoJet > &  jets  ) 
 

return a vector of jets sorted into decreasing energy

vector<PseudoJet> fastjet::sorted_by_E (  const vector< PseudoJet > &  jets  ) 
 

return a vector of jets sorted into decreasing energy

Definition at line 288 of file PseudoJet.cc.

References objects_sorted_by_values().

Referenced by main().

00288                                                               {
00289   vector<double> energies(jets.size());
00290   for (size_t i = 0; i < jets.size(); i++) {energies[i] = -jets[i].E();}
00291   return objects_sorted_by_values(jets, energies);
00292 }

std::vector<PseudoJet> fastjet::sorted_by_pt (  const std::vector< PseudoJet > &  jets  ) 
 

return a vector of jets sorted into decreasing transverse momentum

vector<PseudoJet> fastjet::sorted_by_pt (  const vector< PseudoJet > &  jets  ) 
 

return a vector of jets sorted into decreasing kt2

Definition at line 272 of file PseudoJet.cc.

References objects_sorted_by_values().

Referenced by main(), and print_jets().

00272                                                                {
00273   vector<double> minus_kt2(jets.size());
00274   for (size_t i = 0; i < jets.size(); i++) {minus_kt2[i] = -jets[i].kt2();}
00275   return objects_sorted_by_values(jets, minus_kt2);
00276 }

std::vector<PseudoJet> fastjet::sorted_by_rapidity (  const std::vector< PseudoJet > &  jets  ) 
 

return a vector of jets sorted into increasing rapidity

vector<PseudoJet> fastjet::sorted_by_rapidity (  const vector< PseudoJet > &  jets  ) 
 

return a vector of jets sorted into increasing rapidity

Definition at line 280 of file PseudoJet.cc.

References objects_sorted_by_values().

00280                                                                      {
00281   vector<double> rapidities(jets.size());
00282   for (size_t i = 0; i < jets.size(); i++) {rapidities[i] = jets[i].rap();}
00283   return objects_sorted_by_values(jets, rapidities);
00284 }

Variable Documentation

BasicRandom< double > fastjet::_G_random_double
 

Definition at line 49 of file BasicRandom.cc.

BasicRandom< int > fastjet::_G_random_int
 

Definition at line 48 of file BasicRandom.cc.

const double fastjet::eulergamma = 0.577215664901532860606512090082402431042
 

Definition at line 47 of file numconsts.hh.

const double fastjet::HUGE_DOUBLE = 1e300
 

Definition at line 56 of file Triangulation.hh.

Referenced by fastjet::DnnPlane::_SetAndUpdateNearest(), and fastjet::DnnPlane::_SetNearest().

const unsigned int fastjet::huge_unsigned = 4294967295U
 

Definition at line 39 of file ClosestPair2D.cc.

const int fastjet::INFINITE_VERTEX = -1
 

Definition at line 54 of file Triangulation.hh.

Referenced by fastjet::DnnPlane::_SetAndUpdateNearest(), fastjet::DnnPlane::_SetNearest(), fastjet::DnnPlane::DnnPlane(), and fastjet::DnnPlane::RemoveAndAddPoints().

const double fastjet::ln2 = 0.693147180559945309417232121458176568076
 

Definition at line 48 of file numconsts.hh.

const double fastjet::MaxRap = 1e5
 

Used to protect against parton-level events where pt can be zero for some partons, giving rapidity=infinity.

KtJet fails in those cases.

Definition at line 49 of file PseudoJet.hh.

Referenced by fastjet::PseudoJet::_finish_init().

const int fastjet::NEW_VERTEX = -2
 

Definition at line 55 of file Triangulation.hh.

Referenced by fastjet::DnnPlane::_CrashIfVertexPresent(), and fastjet::InitialisedInt::InitialisedInt().

const double fastjet::pi = 3.141592653589793238462643383279502884197
 

Definition at line 42 of file numconsts.hh.

Referenced by fastjet::ClusterSequence::_bj_dist(), fastjet::ClusterSequence::_CP2DChan_limited_cluster(), fastjet::Dnn3piCylinder::_RegisterCylinderPoint(), fastjet::Dnn2piCylinder::_RegisterCylinderPoint(), fastjet::Dnn4piCylinder::_remap_phi(), fastjet::Dnn3piCylinder::_remap_phi(), fastjet::Dnn2piCylinder::_remap_phi(), fastjet::Dnn4piCylinder::Dnn4piCylinder(), fastjet::JetDefinition::JetDefinition(), fastjet::PseudoJet::kt_distance(), fastjet::PseudoJet::phi_std(), and fastjet::PseudoJet::plain_distance().

const double fastjet::pisq = 9.869604401089358618834490999876151135314
 

Definition at line 44 of file numconsts.hh.

const double fastjet::twopi = 6.283185307179586476925286766559005768394
 

Definition at line 43 of file numconsts.hh.

Referenced by fastjet::ClusterSequence::_bj_dist(), fastjet::ClusterSequence::_CP2DChan_cluster(), fastjet::Dnn2piCylinder::_CreateNecessaryMirrorPoints(), fastjet::ClusterSequence::_delaunay_cluster(), fastjet::PseudoJet::_finish_init(), fastjet::ClusterSequence::_initialise_tiles(), fastjet::ActiveAreaSpec::_initialize(), fastjet::Dnn4piCylinder::_remap_phi(), fastjet::Dnn3piCylinder::_remap_phi(), fastjet::Dnn2piCylinder::_remap_phi(), fastjet::ClusterSequence::_tile_index(), fastjet::PseudoJet::kt_distance(), main(), fastjet::Private::make_mirror(), fastjet::PseudoJet::phi_std(), fastjet::PseudoJet::plain_distance(), and fastjet::EtaPhi::sanitize().

const unsigned int fastjet::twopow31 = 2147483648U
 

Definition at line 40 of file ClosestPair2D.cc.

Referenced by fastjet::ClosestPair2D::_initialize(), and fastjet::ClosestPair2D::_point2shuffle().

const double fastjet::zeta2 = 1.644934066848226436472415166646025189219
 

Definition at line 45 of file numconsts.hh.

const double fastjet::zeta3 = 1.202056903159594285399738161511449990765
 

Definition at line 46 of file numconsts.hh.

Generated on Thu Oct 12 17:36:35 2006 for fastjet by  doxygen 1.4.2