FastJet 3.0.2
Classes | Public Member Functions | Static Public Attributes
fastjet::JetDefinition Class Reference

class that is intended to hold a full definition of the jet clusterer More...

#include <fastjet/JetDefinition.hh>

Collaboration diagram for fastjet::JetDefinition:
Collaboration graph
[legend]

List of all members.

Classes

class  DefaultRecombiner
 A class that will provide the recombination scheme facilities and/or allow a user to extend these facilities. More...
class  Plugin
 a class that allows a user to introduce their own "plugin" jet finder More...
class  Recombiner
 An abstract base class that will provide the recombination scheme facilities and/or allow a user to extend these facilities. More...

Public Member Functions

 JetDefinition (JetAlgorithm jet_algorithm_in, double R_in, RecombinationScheme recomb_scheme_in=E_scheme, Strategy strategy_in=Best)
 constructor with alternative ordering or arguments -- note that we have not provided a default jet finder, to avoid ambiguous JetDefinition() constructor.
 JetDefinition (JetAlgorithm jet_algorithm_in, RecombinationScheme recomb_scheme_in=E_scheme, Strategy strategy_in=Best)
 constructor for algorithms that have no free parameters (e.g.
 JetDefinition (JetAlgorithm jet_algorithm_in, double R_in, double xtra_param_in, RecombinationScheme recomb_scheme_in=E_scheme, Strategy strategy_in=Best)
 constructor for algorithms that require R + one extra parameter to be set (the gen-kt series for example)
 JetDefinition (JetAlgorithm jet_algorithm_in, double R_in, const Recombiner *recombiner_in, Strategy strategy_in=Best)
 constructor in a form that allows the user to provide a pointer to an external recombiner class (which must remain valid for the life of the JetDefinition object).
 JetDefinition (JetAlgorithm jet_algorithm_in, const Recombiner *recombiner_in, Strategy strategy_in=Best)
 constructor for case with 0 parameters (ee_kt_algorithm) and and external recombiner
 JetDefinition (JetAlgorithm jet_algorithm_in, double R_in, double xtra_param_in, const Recombiner *recombiner_in, Strategy strategy_in=Best)
 constructor allowing the extra parameter to be set and a pointer to a recombiner
 JetDefinition ()
 a default constructor which creates a jet definition that is in a well-defined internal state, but not actually usable for jet clustering.
 JetDefinition (const Plugin *plugin_in)
 constructor based on a pointer to a user's plugin; the object pointed to must remain valid for the whole duration of existence of the JetDefinition and any related ClusterSequences
 JetDefinition (JetAlgorithm jet_algorithm_in, double R_in, Strategy strategy_in, RecombinationScheme recomb_scheme_in=E_scheme, int nparameters_in=1)
 constructor to fully specify a jet-definition (together with information about how algorithically to run it).
void set_recombination_scheme (RecombinationScheme)
 set the recombination scheme to the one provided
void set_recombiner (const Recombiner *recomb)
 set the recombiner class to the one provided
void delete_recombiner_when_unused ()
 calling this tells the JetDefinition to handle the deletion of the recombiner when it is no longer used
const Pluginplugin () const
 return a pointer to the plugin
void delete_plugin_when_unused ()
 allows to let the JetDefinition handle the deletion of the plugin when it is no longer used
JetAlgorithm jet_algorithm () const
 return information about the definition...
JetAlgorithm jet_finder () const
 same as above for backward compatibility
double R () const
double extra_param () const
Strategy strategy () const
RecombinationScheme recombination_scheme () const
void set_jet_algorithm (JetAlgorithm njf)
 (re)set the jet finder
void set_jet_finder (JetAlgorithm njf)
 same as above for backward compatibility
void set_extra_param (double xtra_param)
 (re)set the general purpose extra parameter
const Recombinerrecombiner () const
 return a pointer to the currently defined recombiner.
bool has_same_recombiner (const JetDefinition &other_jd) const
 returns true if the current jet definitions shares the same recombiner as teh one passed as an argument
std::string description () const
 return a textual description of the current jet definition

Static Public Attributes

static const double max_allowable_R = 1000.0
 R values larger than max_allowable_R are not allowed.

Detailed Description

class that is intended to hold a full definition of the jet clusterer

Definition at line 173 of file JetDefinition.hh.


Constructor & Destructor Documentation

fastjet::JetDefinition::JetDefinition ( JetAlgorithm  jet_algorithm_in,
double  R_in,
RecombinationScheme  recomb_scheme_in = E_scheme,
Strategy  strategy_in = Best 
) [inline]

constructor with alternative ordering or arguments -- note that we have not provided a default jet finder, to avoid ambiguous JetDefinition() constructor.

Definition at line 190 of file JetDefinition.hh.

fastjet::JetDefinition::JetDefinition ( JetAlgorithm  jet_algorithm_in,
RecombinationScheme  recomb_scheme_in = E_scheme,
Strategy  strategy_in = Best 
) [inline]

constructor for algorithms that have no free parameters (e.g.

ee_kt_algorithm)

Definition at line 199 of file JetDefinition.hh.

fastjet::JetDefinition::JetDefinition ( JetAlgorithm  jet_algorithm_in,
double  R_in,
const Recombiner recombiner_in,
Strategy  strategy_in = Best 
) [inline]

constructor in a form that allows the user to provide a pointer to an external recombiner class (which must remain valid for the life of the JetDefinition object).

Definition at line 221 of file JetDefinition.hh.

fastjet::JetDefinition::JetDefinition ( ) [inline]

a default constructor which creates a jet definition that is in a well-defined internal state, but not actually usable for jet clustering.

Definition at line 254 of file JetDefinition.hh.

fastjet::JetDefinition::JetDefinition ( JetAlgorithm  jet_algorithm_in,
double  R_in,
Strategy  strategy_in,
RecombinationScheme  recomb_scheme_in = E_scheme,
int  nparameters_in = 1 
)

constructor to fully specify a jet-definition (together with information about how algorithically to run it).

the ordering of arguments here is old and deprecated (except as the common constructor for internal use)

Definition at line 43 of file JetDefinition.cc.


Member Function Documentation

void fastjet::JetDefinition::delete_recombiner_when_unused ( )

calling this tells the JetDefinition to handle the deletion of the recombiner when it is no longer used

allows to let the JetDefinition handle the deletion of the recombiner when it is no longer used

Definition at line 173 of file JetDefinition.cc.

const Recombiner* fastjet::JetDefinition::recombiner ( ) const [inline]

return a pointer to the currently defined recombiner.

Warning: the pointer may be to an internal recombiner (for default recombination schemes), in which case if the JetDefinition becomes invalid (e.g. is deleted), the pointer will then point to an object that no longer exists.

Note also that if you copy a JetDefinition with a default recombination scheme, then the two copies will have distinct recombiners, and return different recombiner() pointers.

Definition at line 345 of file JetDefinition.hh.


Member Data Documentation

const double fastjet::JetDefinition::max_allowable_R = 1000.0 [static]

R values larger than max_allowable_R are not allowed.

We use a value of 1000, substantially smaller than numeric_limits<double>::max(), to leave room for the convention within PseudoJet of setting unphysical (infinite) rapidities to +-(MaxRap + abs(pz())), where MaxRap is 10^5.

Definition at line 293 of file JetDefinition.hh.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends