fastjet::JetDefinition::Plugin Class Reference

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

#include <JetDefinition.hh>

List of all members.

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: plugin_do_ij_recombination(.
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	~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 318 of file JetDefinition.hh.

---

Constructor & Destructor Documentation

virtual fastjet::JetDefinition::Plugin::~Plugin

(

)

[inline, virtual]

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

Definition at line 347 of file JetDefinition.hh.

{};

---

Member Function Documentation

virtual std::string fastjet::JetDefinition::Plugin::description

(

)

const [pure virtual]

return a textual description of the jet-definition implemented in this plugin

Referenced by fastjet::JetDefinition::description().

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

virtual double fastjet::JetDefinition::Plugin::R

(

)

const [pure virtual]

virtual bool fastjet::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!]

Definition at line 338 of file JetDefinition.hh.

{return false;}

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)

Definition at line 186 of file JetDefinition.cc.

                                                                       {
      throw Error("set_ghost_separation_scale not supported");
}

virtual double fastjet::JetDefinition::Plugin::ghost_separation_scale

(

)

const [inline, virtual]

Definition at line 344 of file JetDefinition.hh.

{return 0.0;}

---

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

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

---