JetDefinition::Plugin Class Reference
a class that allows a user to introduce their own "plugin" jet finder More...
#include <JetDefinition.hh>
Public Member Functions | |
| virtual std::string | description () const =0 |
| return a textual description of the jet-definition implemented in this plugin | |
| 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:
| |
| 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. | |
| 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) | |
| 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 | |
| virtual | ~Plugin () |
| a destructor to be replaced if necessary in derived classes... | |
Detailed Description
a class that allows a user to introduce their own "plugin" jet finder
Definition at line 381 of file JetDefinition.hh.
Constructor & Destructor Documentation
| virtual JetDefinition::Plugin::~Plugin | ( | ) | [inline, virtual] |
a destructor to be replaced if necessary in derived classes...
Definition at line 415 of file JetDefinition.hh.
Member Function Documentation
| virtual std::string JetDefinition::Plugin::description | ( | ) | const [pure virtual] |
return a textual description of the jet-definition implemented in this plugin
Implemented in fastjet::ATLASConePlugin, fastjet::CMSIterativeConePlugin, fastjet::CDFJetCluPlugin, fastjet::CDFMidPointPlugin, fastjet::D0RunIIConePlugin, fastjet::EECambridgePlugin, fastjet::JadePlugin, fastjet::NestedDefsPlugin, fastjet::SISConeBasePlugin, fastjet::SISConePlugin, fastjet::SISConeSphericalPlugin, fastjet::PxConePlugin, and fastjet::TrackJetPlugin.
Referenced by JetDefinition::description().
| virtual bool JetDefinition::Plugin::exclusive_sequence_meaningful | ( | ) | const [inline, virtual] |
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 412 of file JetDefinition.hh.
| virtual double JetDefinition::Plugin::ghost_separation_scale | ( | ) | const [inline, virtual] |
Reimplemented in fastjet::SISConeBasePlugin.
Definition at line 407 of file JetDefinition.hh.
| virtual double JetDefinition::Plugin::R | ( | ) | const [pure virtual] |
Implemented in fastjet::ATLASConePlugin, fastjet::CMSIterativeConePlugin, fastjet::CDFJetCluPlugin, fastjet::CDFMidPointPlugin, fastjet::D0RunIIConePlugin, fastjet::EECambridgePlugin, fastjet::JadePlugin, fastjet::NestedDefsPlugin, fastjet::SISConeBasePlugin, fastjet::PxConePlugin, and fastjet::TrackJetPlugin.
Referenced by JetDefinition::JetDefinition().
| virtual void JetDefinition::Plugin::run_clustering | ( | ClusterSequence & | ) | const [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::CMSIterativeConePlugin, fastjet::CDFJetCluPlugin, fastjet::CDFMidPointPlugin, fastjet::D0RunIIConePlugin, fastjet::EECambridgePlugin, fastjet::JadePlugin, fastjet::NestedDefsPlugin, fastjet::SISConeBasePlugin, fastjet::SISConePlugin, fastjet::SISConeSphericalPlugin, fastjet::PxConePlugin, and fastjet::TrackJetPlugin.
| void JetDefinition::Plugin::set_ghost_separation_scale | ( | double | scale | ) | const [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 248 of file JetDefinition.cc.
00248 { 00249 throw Error("set_ghost_separation_scale not supported"); 00250 }
| virtual bool JetDefinition::Plugin::supports_ghosted_passive_areas | ( | ) | const [inline, virtual] |
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 401 of file JetDefinition.hh.
The documentation for this class was generated from the following files:
- include/fastjet/JetDefinition.hh
- src/JetDefinition.cc
