fastjet::GridJetPlugin Class Reference

plugin for fastjet (v3.0 upwards) that clusters particles such that all particles in a given cell of a rectangular rapidity-phi grid end up in a common "jet". More...

#include <fastjet/GridJetPlugin.hh>

Inheritance diagram for fastjet::GridJetPlugin:

Collaboration diagram for fastjet::GridJetPlugin:

Public Member Functions
	GridJetPlugin (double ymax, double requested_grid_spacing, const JetDefinition &post_jet_def=JetDefinition())
	Basic constructor for the GridJetPlugin Plugin class. More...
	GridJetPlugin (const RectangularGrid &grid, const JetDefinition &post_jet_def=JetDefinition())
	Constructor for the GridJetPlugin Plugin class that allows full control over the underlying grid. More...
virtual std::string	description () const
	return a textual description of the jet-definition implemented in this plugin
virtual void	run_clustering (ClusterSequence &) const
	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
	This returns the sqrt(dphi*dy/pi) – i.e. More...
Public Member Functions inherited from fastjet::JetDefinition::Plugin
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...

Additional Inherited Members
Private Member Functions inherited from fastjet::RectangularGrid
	RectangularGrid (double rapmax, double cell_size)
	ctor with simple initialisation More...
	RectangularGrid (double rapmin, double rapmax, double drap, double dphi, Selector tile_selector=Selector())
	ctor with more control over initialisation More...
	RectangularGrid ()
	dummy ctor (will give an unusable grid)
virtual int	n_tiles () const
	returns the total number of tiles in the tiling; valid tile indices run from 0 ... More...
virtual int	n_good_tiles () const
	returns the number of tiles that are "good"; i.e. More...
virtual int	tile_index (const PseudoJet &p) const
	returns the index of the tile in which p is located, or -1 if p is outside the tiling region
virtual bool	tile_is_good (int itile) const
	returns whether a given tile is good
virtual double	tile_area (int) const
	returns the area of tile itile.
virtual double	mean_tile_area () const
	returns the mean area of tiles.
double	rapmin () const
	returns the minimum rapidity extent of the grid
double	rapmax () const
	returns the maxmium rapidity extent of the grid
double	drap () const
	returns the spacing of the grid in rapidity
double	dphi () const
	returns the spacing of the grid in azimuth
virtual bool	is_initialised () const
	returns true if the grid is in a suitably initialised state

Detailed Description

plugin for fastjet (v3.0 upwards) that clusters particles such that all particles in a given cell of a rectangular rapidity-phi grid end up in a common "jet".

This is not intended for use as a regular jet clustering algorithm, but is rather provided for comparison purposes with the GridMedianBackgroundEstimator (which is even faster).

Definition at line 61 of file GridJetPlugin.hh.

Constructor & Destructor Documentation

fastjet::GridJetPlugin::GridJetPlugin	(	double	ymax,
		double	requested_grid_spacing,
		const JetDefinition &	post_jet_def = JetDefinition()
	)

Basic constructor for the GridJetPlugin Plugin class.

Parameters

ymax	The maximal rapidity extent of the grid
requested_grid_spacing	The requested grid spacing
post_jet_def	if present, and not == JetDefinition() (which has undefined_jet_algorithm), then run the post_jet_def on the result of the grid clustering.

Definition at line 44 of file GridJetPlugin.cc.

fastjet::GridJetPlugin::GridJetPlugin	(	const RectangularGrid &	grid,
		const JetDefinition &	post_jet_def = JetDefinition()
	)

Constructor for the GridJetPlugin Plugin class that allows full control over the underlying grid.

New in FastJet 3.1.

Parameters

grid	The maximal rapidity extent of the grid
post_jet_def	if present, and not == JetDefinition() (which has undefined_jet_algorithm), then run the post_jet_def on the result of the grid clustering.

Definition at line 60 of file GridJetPlugin.cc.

Member Function Documentation

void fastjet::GridJetPlugin::run_clustering ( ClusterSequence &  ) const

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

Implements fastjet::JetDefinition::Plugin.

Definition at line 135 of file GridJetPlugin.cc.

double fastjet::GridJetPlugin::R ( ) const

virtual

This returns the sqrt(dphi*dy/pi) – i.e.

the radius that for a circular jet would give the same area.

Implements fastjet::JetDefinition::Plugin.

Definition at line 131 of file GridJetPlugin.cc.

---

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

• plugins/GridJet/fastjet/GridJetPlugin.hh
• plugins/GridJet/GridJetPlugin.cc