fastjet::JetDefinition::Plugin Class Reference

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

#include <fastjet/JetDefinition.hh>

Inheritance diagram for fastjet::JetDefinition::Plugin:

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: 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)
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 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...

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 547 of file JetDefinition.hh.

Member Function Documentation

virtual void fastjet::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::SISConePlugin, fastjet::CDFMidPointPlugin, fastjet::SISConeSphericalPlugin, fastjet::PxConePlugin, fastjet::D0RunIIConePlugin, fastjet::D0RunIBaseConePlugin, fastjet::GridJetPlugin, fastjet::JadePlugin, fastjet::D0RunIpre96ConePlugin, fastjet::D0RunIConePlugin, fastjet::CDFJetCluPlugin, fastjet::TrackJetPlugin, fastjet::ATLASConePlugin, fastjet::EECambridgePlugin, fastjet::CMSIterativeConePlugin, and fastjet::NestedDefsPlugin.

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::SISConeSphericalPlugin.

Definition at line 567 of file JetDefinition.hh.

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::SISConeSphericalPlugin, and fastjet::EECambridgePlugin.

Definition at line 584 of file JetDefinition.hh.

---

The documentation for this class was generated from the following files:

• include/fastjet/JetDefinition.hh
• src/JetDefinition.cc