fastjet 2.4.5
Public Member Functions | Protected Member Functions | Protected Attributes
fastjet::SISConeBasePlugin Class Reference

SISConeBasePlugin is a plugin for fastjet (v2.1 upwards) that provides a base interface to SISCone-type cone jet finder by Gregory Soyez and Gavin Salam. More...

#include <SISConeBasePlugin.hh>

Inheritance diagram for fastjet::SISConeBasePlugin:
Inheritance graph
[legend]
Collaboration diagram for fastjet::SISConeBasePlugin:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 SISConeBasePlugin ()
 default ctor
 SISConeBasePlugin (const SISConeBasePlugin &plugin)
 copy constructor
double cone_radius () const
 the cone radius
double overlap_threshold () const
 Fraction of overlap energy in a jet above which jets are merged and below which jets are split.
int n_pass_max () const
 the maximum number of passes of stable-cone searching (<=0 is same as infinity).
void set_split_merge_stopping_scale (double scale)
 set the "split_merge_stopping_scale": if the scale variable for all protojets is below this, then stop the split-merge procedure and keep only those jets found so far.
double split_merge_stopping_scale ()
 return the value of the split_merge_stopping_scale (see set_split_merge_stopping_scale(...) for description)
void set_use_jet_def_recombiner (bool choice)
 allow the user to decide if one uses the jet_def's own recombination scheme
bool use_jet_def_recombiner () const
 indicate if the jet_def's recombination scheme is being used
bool caching () const
 indicates whether caching is turned on or not.
virtual double R () const
 the plugin mechanism's standard way of accessing the jet radius
virtual bool supports_ghosted_passive_areas () const
 return true since there is specific support for the measurement of passive areas, in the sense that areas determined from all particles below the ghost separation scale will be a passive area.
virtual void set_ghost_separation_scale (double scale) const
 set the ghost separation scale for passive area determinations _just_ in the next run (strictly speaking that makes the routine a non const, so related internal info must be stored as a mutable)
virtual double ghost_separation_scale () const
virtual std::string description () const =0
 plugin description
virtual void run_clustering (ClusterSequence &) const =0
 really do the clustering work

Protected Member Functions

virtual void reset_stored_plugin () const =0
 call the re-clustering itself

Protected Attributes

double _cone_radius
double _overlap_threshold
int _n_pass_max
bool _caching
double _split_merge_stopping_scale
bool _use_jet_def_recombiner
double _ghost_sep_scale

Detailed Description

SISConeBasePlugin is a plugin for fastjet (v2.1 upwards) that provides a base interface to SISCone-type cone jet finder by Gregory Soyez and Gavin Salam.

This is a purely virtual class that needs to be overloaded for the specific implementations of SISCone (i.e. regular or spherical as of July 16th 2008).

any derived plugin MUST overload the following methods: description() run_siscone_clustering() reset_stored_plugin()

For further details, see the derived plugins or http://projects.hepforge.com/siscone

Definition at line 33 of file SISConeBasePlugin.hh.


Constructor & Destructor Documentation

fastjet::SISConeBasePlugin::SISConeBasePlugin ( ) [inline]

default ctor

Definition at line 36 of file SISConeBasePlugin.hh.

fastjet::SISConeBasePlugin::SISConeBasePlugin ( const SISConeBasePlugin plugin) [inline]

copy constructor

Definition at line 41 of file SISConeBasePlugin.hh.

                                                       {
    *this = plugin;
  }

Member Function Documentation

bool fastjet::SISConeBasePlugin::caching ( ) const [inline]

indicates whether caching is turned on or not.

Definition at line 76 of file SISConeBasePlugin.hh.

{return _caching ;}
double fastjet::SISConeBasePlugin::cone_radius ( ) const [inline]

the cone radius

Definition at line 46 of file SISConeBasePlugin.hh.

{return _cone_radius        ;}
virtual std::string fastjet::SISConeBasePlugin::description ( ) const [pure virtual]

plugin description

Implements fastjet::JetDefinition::Plugin.

Implemented in fastjet::SISConePlugin, and fastjet::SISConeSphericalPlugin.

virtual double fastjet::SISConeBasePlugin::ghost_separation_scale ( ) const [inline, virtual]

Reimplemented from fastjet::JetDefinition::Plugin.

Definition at line 96 of file SISConeBasePlugin.hh.

                                                {
    return _ghost_sep_scale;
  }
int fastjet::SISConeBasePlugin::n_pass_max ( ) const [inline]

the maximum number of passes of stable-cone searching (<=0 is same as infinity).

Definition at line 54 of file SISConeBasePlugin.hh.

{return _n_pass_max  ;}
double fastjet::SISConeBasePlugin::overlap_threshold ( ) const [inline]

Fraction of overlap energy in a jet above which jets are merged and below which jets are split.

Definition at line 50 of file SISConeBasePlugin.hh.

{return _overlap_threshold  ;}
virtual double fastjet::SISConeBasePlugin::R ( ) const [inline, virtual]

the plugin mechanism's standard way of accessing the jet radius

Implements fastjet::JetDefinition::Plugin.

Definition at line 79 of file SISConeBasePlugin.hh.

{return cone_radius();}
virtual void fastjet::SISConeBasePlugin::reset_stored_plugin ( ) const [protected, pure virtual]

call the re-clustering itself

Implemented in fastjet::SISConePlugin, and fastjet::SISConeSphericalPlugin.

virtual void fastjet::SISConeBasePlugin::run_clustering ( ClusterSequence ) const [pure virtual]

really do the clustering work

Implements fastjet::JetDefinition::Plugin.

Implemented in fastjet::SISConePlugin, and fastjet::SISConeSphericalPlugin.

virtual void fastjet::SISConeBasePlugin::set_ghost_separation_scale ( double  scale) const [inline, virtual]

set the ghost separation scale for passive area determinations _just_ in the next run (strictly speaking that makes the routine a non const, so related internal info must be stored as a mutable)

Reimplemented from fastjet::JetDefinition::Plugin.

Definition at line 92 of file SISConeBasePlugin.hh.

Referenced by main().

                                                              {
    _ghost_sep_scale = scale;
  }
void fastjet::SISConeBasePlugin::set_split_merge_stopping_scale ( double  scale) [inline]

set the "split_merge_stopping_scale": if the scale variable for all protojets is below this, then stop the split-merge procedure and keep only those jets found so far.

This is useful in determination of areas of hard jets because it can be used to avoid running the split-merging on the pure ghost-part of the event.

Definition at line 62 of file SISConeBasePlugin.hh.

void fastjet::SISConeBasePlugin::set_use_jet_def_recombiner ( bool  choice) [inline]

allow the user to decide if one uses the jet_def's own recombination scheme

Definition at line 70 of file SISConeBasePlugin.hh.

double fastjet::SISConeBasePlugin::split_merge_stopping_scale ( ) [inline]

return the value of the split_merge_stopping_scale (see set_split_merge_stopping_scale(...) for description)

Definition at line 67 of file SISConeBasePlugin.hh.

virtual bool fastjet::SISConeBasePlugin::supports_ghosted_passive_areas ( ) const [inline, virtual]

return true since there is specific support for the measurement of passive areas, in the sense that areas determined from all particles below the ghost separation scale will be a passive area.

Reimplemented from fastjet::JetDefinition::Plugin.

Reimplemented in fastjet::SISConeSphericalPlugin.

Definition at line 85 of file SISConeBasePlugin.hh.

                                                      {
    return true;
  }
bool fastjet::SISConeBasePlugin::use_jet_def_recombiner ( ) const [inline]

indicate if the jet_def's recombination scheme is being used

Definition at line 73 of file SISConeBasePlugin.hh.


Member Data Documentation

Definition at line 112 of file SISConeBasePlugin.hh.

Definition at line 110 of file SISConeBasePlugin.hh.

double fastjet::SISConeBasePlugin::_ghost_sep_scale [mutable, protected]

Definition at line 116 of file SISConeBasePlugin.hh.

Definition at line 111 of file SISConeBasePlugin.hh.

Definition at line 110 of file SISConeBasePlugin.hh.

Definition at line 113 of file SISConeBasePlugin.hh.

Definition at line 114 of file SISConeBasePlugin.hh.


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