FastJet 3.4.1
Public Member Functions | List of all members
fastjet::JetDefinition::Plugin Class Referenceabstract

a class that allows a user to introduce their own "plugin" jet finder More...

#include <fastjet/JetDefinition.hh>

Inheritance diagram for fastjet::JetDefinition::Plugin:
Inheritance graph
[legend]

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()

virtual fastjet::JetDefinition::Plugin::~Plugin ( )
inlinevirtual

a destructor to be replaced if necessary in derived classes...

Definition at line 607 of file JetDefinition.hh.

Member Function Documentation

◆ description()

virtual std::string fastjet::JetDefinition::Plugin::description ( ) const
pure virtual

◆ run_clustering()

virtual void fastjet::JetDefinition::Plugin::run_clustering ( ClusterSequence ) const
pure virtual

◆ R()

virtual double fastjet::JetDefinition::Plugin::R ( ) const
pure virtual

◆ supports_ghosted_passive_areas()

virtual bool fastjet::JetDefinition::Plugin::supports_ghosted_passive_areas ( ) const
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()

void fastjet::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 440 of file JetDefinition.cc.

◆ ghost_separation_scale()

virtual double fastjet::JetDefinition::Plugin::ghost_separation_scale ( ) const
inlinevirtual

Definition at line 593 of file JetDefinition.hh.

◆ exclusive_sequence_meaningful()

virtual bool fastjet::JetDefinition::Plugin::exclusive_sequence_meaningful ( ) const
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()

virtual bool fastjet::JetDefinition::Plugin::is_spherical ( ) const
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: