a class that allows a user to introduce their own "plugin" jet finder More...
#include <fastjet/JetDefinition.hh>
Public Member Functions | |
| virtual std::string | description () const =0 |
| return a textual description of the jet-definition implemented in this plugin More... | |
| virtual void | run_clustering (ClusterSequence &) const =0 |
| given a ClusterSequence that has been filled up with initial particles, the following function should fill up the rest of the ClusterSequence, using the following member functions of ClusterSequence: More... | |
| virtual double | R () const =0 |
| virtual bool | supports_ghosted_passive_areas () const |
| return true if 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. More... | |
| virtual void | set_ghost_separation_scale (double scale) const |
| set the ghost separation scale for passive area determinations in future runs (strictly speaking that makes the routine a non const, so related internal info must be stored as a mutable) More... | |
| virtual double | ghost_separation_scale () const |
| virtual bool | exclusive_sequence_meaningful () const |
| if this returns false then a warning will be given whenever the user requests "exclusive" jets from the cluster sequence More... | |
| virtual bool | is_spherical () const |
| returns true if the plugin implements an algorithm intended for use on a spherical geometry (e.g. More... | |
| virtual | ~Plugin () |
| a destructor to be replaced if necessary in derived classes... More... | |
Detailed Description
a class that allows a user to introduce their own "plugin" jet finder
Note that all the plugins provided with FastJet are derived from this class
Definition at line 567 of file JetDefinition.hh.
Constructor & Destructor Documentation
◆ ~Plugin()
|
inlinevirtual |
a destructor to be replaced if necessary in derived classes...
Definition at line 607 of file JetDefinition.hh.
Member Function Documentation
◆ description()
|
pure virtual |
return a textual description of the jet-definition implemented in this plugin
Implemented in fastjet::ATLASConePlugin, fastjet::CDFJetCluPlugin, fastjet::CDFMidPointPlugin, fastjet::CMSIterativeConePlugin, fastjet::D0RunIConePlugin, fastjet::D0RunIpre96ConePlugin, fastjet::D0RunIIConePlugin, fastjet::EECambridgePlugin, fastjet::GridJetPlugin, fastjet::JadePlugin, fastjet::NestedDefsPlugin, fastjet::PxConePlugin, fastjet::SISConePlugin, fastjet::SISConeSphericalPlugin, fastjet::TrackJetPlugin, fastjet::PruningPlugin, fastjet::D0RunIBaseConePlugin, and fastjet::SISConeBasePlugin.
◆ run_clustering()
|
pure virtual |
given a ClusterSequence that has been filled up with initial particles, the following function should fill up the rest of the ClusterSequence, using the following member functions of ClusterSequence:
- plugin_do_ij_recombination(...)
- plugin_do_iB_recombination(...)
Implemented in fastjet::ATLASConePlugin, fastjet::CDFJetCluPlugin, fastjet::CDFMidPointPlugin, fastjet::CMSIterativeConePlugin, fastjet::D0RunIConePlugin, fastjet::D0RunIpre96ConePlugin, fastjet::D0RunIIConePlugin, fastjet::EECambridgePlugin, fastjet::GridJetPlugin, fastjet::JadePlugin, fastjet::NestedDefsPlugin, fastjet::PxConePlugin, fastjet::SISConePlugin, fastjet::SISConeSphericalPlugin, fastjet::TrackJetPlugin, fastjet::D0RunIBaseConePlugin, fastjet::SISConeBasePlugin, and fastjet::PruningPlugin.
◆ R()
|
pure virtual |
Implemented in fastjet::ATLASConePlugin, fastjet::CDFJetCluPlugin, fastjet::CDFMidPointPlugin, fastjet::CMSIterativeConePlugin, fastjet::D0RunIBaseConePlugin, fastjet::D0RunIIConePlugin, fastjet::EECambridgePlugin, fastjet::GridJetPlugin, fastjet::JadePlugin, fastjet::NestedDefsPlugin, fastjet::PxConePlugin, fastjet::SISConeBasePlugin, fastjet::TrackJetPlugin, and fastjet::PruningPlugin.
◆ supports_ghosted_passive_areas()
|
inlinevirtual |
return true if 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.
[If you don't understand this, ignore it!]
Reimplemented in fastjet::SISConeBasePlugin, and fastjet::SISConeSphericalPlugin.
Definition at line 587 of file JetDefinition.hh.
◆ set_ghost_separation_scale()
|
virtual |
set the ghost separation scale for passive area determinations in future runs (strictly speaking that makes the routine a non const, so related internal info must be stored as a mutable)
Reimplemented in fastjet::SISConeBasePlugin.
Definition at line 440 of file JetDefinition.cc.
◆ ghost_separation_scale()
|
inlinevirtual |
Definition at line 593 of file JetDefinition.hh.
◆ exclusive_sequence_meaningful()
|
inlinevirtual |
if this returns false then a warning will be given whenever the user requests "exclusive" jets from the cluster sequence
Reimplemented in fastjet::EECambridgePlugin, and fastjet::JadePlugin.
Definition at line 598 of file JetDefinition.hh.
◆ is_spherical()
|
inlinevirtual |
returns true if the plugin implements an algorithm intended for use on a spherical geometry (e.g.
e+e- algorithms, as opposed to most pp algorithms, which use a cylindrical, rapidity-phi geometry).
Reimplemented in fastjet::EECambridgePlugin, and fastjet::SISConeSphericalPlugin.
Definition at line 604 of file JetDefinition.hh.
The documentation for this class was generated from the following files:
- include/fastjet/JetDefinition.hh
- src/JetDefinition.cc
