FastJetFinder implements the class of longitudinally invariant kt jet clustering algorithms. More...

#include <FastJetFinder.h>

Inheritance diagram for ThePEG::FastJetFinder:

[legend]

Public Member Functions
	FastJetFinder ()
	The default constructor.

virtual bool	cluster (tcPDVector &ptype, vector< LorentzMomentum > &p, tcCutsPtr parent, tcPDPtr t1=tcPDPtr(), tcPDPtr t2=tcPDPtr()) const
	Perform jet clustering on the given outgoing particles.

virtual void	describe () const
	Describe this jet fined.

Standard Interfaced functions.
virtual void	doinit ()
	Initialize this object.

virtual void	doinitrun ()
	Initialize this object.

Public Member Functions inherited from ThePEG::JetFinder
	JetFinder ()
	The default constructor.

virtual bool	cluster (tcPDVector &ptype, vector< LorentzMomentum > &p, tcCutsPtr parent, tcPDPtr t1=tcPDPtr(), tcPDPtr t2=tcPDPtr()) const =0
	Perform jet clustering on the given outgoing particles.

Ptr< MatcherBase >::tptr	unresolvedMatcher () const
	Return the matcher for unresolved partons.

void	minOutgoing (unsigned int n)
	Set the minimum number of outgoing partons on which clustering should be performed.

unsigned int	minOutgoing () const
	Return the minimum number of outgoing partons on which clustering should be performed.

bool	restrictConsitutents () const
	Return true, if jets should only be constructed from matching objects inside a given rapidity interval.

void	restrictConsitutents (bool on)
	Jets should only be constructed from matching objects inside a given rapidity interval.

const pair< double, double > &	constituentRapidityRange () const
	Return the rapidity interval within objects should be considered for clustering, if appropriate.

void	constituentRapidityRange (const pair< double, double > &r)
	Set the rapidity interval within objects should be considered for clustering, if appropriate.

virtual void	describe () const =0
	Describe this jet finder.

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

Public Member Functions inherited from ThePEG::Interfaced
virtual	~Interfaced ()
	Empty virtual destructor.

virtual bool	defaultInit ()
	Functions which are to be used during the actual event generation, after the setup is complete.

PPtr	getParticle (PID) const
	Create a new Particle instance given a id number.

PDPtr	getParticleData (PID) const
	Return a pointer to the ParticleData object corresponding to the given id number.

bool	used () const
	Returns true if this object has actally been used.

void	useMe () const
	Should be called to indicate that this object has actually been used.

tEGPtr	generator () const
	Return a pointer to the EventGenerator controlling the run.

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

Public Member Functions inherited from ThePEG::InterfacedBase
virtual	~InterfacedBase ()
	The virtual (empty) destructor;.

string	fullName () const
	Returns the full name of this object including its path, e.g.

string	name () const
	Returns the name of this object, without the path.

string	path () const
	Returns the path to this object including the trailing '/'.

string	comment () const
	Returns a comment assigned to this object.

void	setup (istream &is)
	Read setup info from a standard istream is.

void	update ()
	Calls the doupdate() function with recursion prevention.

void	init ()
	Calls the doinit() function with recursion prevention.

virtual bool	preInitialize () const
	Return true if this object needs to be initialized before all other objects (except those for which this function also returns true).

void	initrun ()
	Calls the doinitrun() function with recursion prevention.

void	finish ()
	Calls the dofinish() function with recursion prevention.

void	touch ()
	This function should be called every time something in this object has changed in a way that a sanity check with update() is needed.

void	reset ()
	Set the state of this object to uninitialized.

void	clear ()
	Calls reset() and unTouch().

InitState	state () const
	Return the state of initialization of this object.

bool	locked () const
	Return true if the BaseRepository is not allowed to change the state of this object.

bool	touched () const
	Return true if the state of this object has been changed since the last call to update().

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

Public Member Functions inherited from ThePEG::Base
virtual	~Base ()
	The virtual destructor.

void	debug () const
	Print out debugging information for this object on std::cerr.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType	referenceCount () const
	Return the reference count.

Public Member Functions inherited from ThePEG::Named
	Named (const string &newName=string())
	Constructor with name.

	Named (const Named &)=default
	Explicit default copy-constructor (too avoid compiler warnings)

const string &	name () const
	Return name.

bool	operator== (const Named &other) const
	Test for equality.

bool	operator< (const Named &other) const
	Lexicographical comparison.

Clone Methods.
enum	variants { kt = 1 , CA = 2 , antiKt = 3 , sphericalKt = 4 , sphericalCA = 5 , sphericalAntiKt = 6 }
	The possible variants. More...

enum	modes { inclusive = 1 , exclusive = 2 }
	The possible modes. More...

enum	recombinations { recoPt = 1 , recoE = 2 }
	The possible recombination schemes. More...

Energy2	theDCut
	The resolution cut.

double	theConeRadius
	The ‘cone radius’ R.

int	theVariant
	The variant.

int	theMode
	The mode.

int	theRecombination
	The recombination scheme.

virtual IBPtr	clone () const
	Make a simple clone of this object.

virtual IBPtr	fullclone () const
	Make a clone of this object, possibly modifying the cloned object to make it sane.

FastJetFinder &	operator= (const FastJetFinder &)=delete
	The assignment operator is private and must never be called.

Functions used by the persistent I/O system.
void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

static void	Init ()
	The standard Init function used to initialize the interfaces.

Additional Inherited Members
Public Types inherited from ThePEG::InterfacedBase
enum	InitState { initializing = -1 , uninitialized = 0 , initialized = 1 , runready = 2 }
	Enumeration reflecting the state of an InterfacedBase object. More...

Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int	CounterType
	The integer type used for counting.

Static Public Member Functions inherited from ThePEG::JetFinder
static void	Init ()
	The standard Init function used to initialize the interfaces.

Static Public Member Functions inherited from ThePEG::Interfaced
static void	Init ()
	Standard Init function.

Static Public Member Functions inherited from ThePEG::InterfacedBase
static void	Init ()
	Standard Init function.

Static Public Member Functions inherited from ThePEG::Base
static void	Init ()
	The standard Init function used to initialize the interfaces.

Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long	uniqueId
	The unique ID.

Protected Member Functions inherited from ThePEG::Interfaced
void	reporeg (IBPtr object, string name) const
	Register the given object in the Repository with the given name in a subdirectory with the same name as this object.

template<typename PtrT >
bool	setDefaultReference (PtrT &ptr, string classname, string objectname)
	If the pointer, ptr, to an object is not set, create an object of class classname and register it with the Repository with the given objectname in a sib-directory with the same name as this object.

	Interfaced ()
	Protected default constructor.

	Interfaced (const string &newName)
	Protected constructor taking a name as argument.

	Interfaced (const Interfaced &i)
	Protected copy-constructor.

void	setGenerator (tEGPtr generator)
	Protected function to reset the generator pointer, required for automatic decayer generation in Herwig++ BSM models.

Protected Member Functions inherited from ThePEG::InterfacedBase
virtual void	readSetup (istream &is)
	Read setup info from a standard istream is.

virtual void	doupdate ()
	Check sanity of the object during the setup phase.

virtual void	dofinish ()
	Finalize this object.

virtual IVector	getReferences ()
	Return a vector of all pointers to Interfaced objects used in this object.

virtual void	rebind (const TranslationMap &)
	Rebind pointer to other Interfaced objects.

	InterfacedBase ()
	Protected default constructor.

	InterfacedBase (string newName)
	Protected constructor with the name given as argument.

	InterfacedBase (const InterfacedBase &i)
	Protected copy-constructor.

Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
	ReferenceCounted ()
	Default constructor.

	ReferenceCounted (const ReferenceCounted &)
	Copy-constructor.

ReferenceCounted &	operator= (const ReferenceCounted &)
	Assignment.

Protected Member Functions inherited from ThePEG::Named
const Named &	operator= (const Named &other)
	Assignment.

const string &	name (const string &newName)
	Set new name.

Static Protected Member Functions inherited from ThePEG::Interfaced
static void	registerRepository (IBPtr)
	Register an Interfaced object with the Repository.

static void	registerRepository (IBPtr, string newName)
	Register an Interfaced object with the Repository, giving it a name.

Detailed Description

FastJetFinder implements the class of longitudinally invariant kt jet clustering algorithms.

See also: The interfaces defined for FastJetFinder.

Definition at line 27 of file FastJetFinder.h.

Member Enumeration Documentation

◆ modes

enum ThePEG::FastJetFinder::modes

private

The possible modes.

Definition at line 144 of file FastJetFinder.h.

◆ recombinations

enum ThePEG::FastJetFinder::recombinations

private

The possible recombination schemes.

Definition at line 157 of file FastJetFinder.h.

◆ variants

enum ThePEG::FastJetFinder::variants

private

The possible variants.

Definition at line 127 of file FastJetFinder.h.

Member Function Documentation

◆ clone()

virtual IBPtr ThePEG::FastJetFinder::clone ( ) const

protectedvirtual

Make a simple clone of this object.

Returns: a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ cluster()

virtual bool ThePEG::FastJetFinder::cluster	(	tcPDVector &	ptype,
		vector< LorentzMomentum > &	p,
		tcCutsPtr	parent,
		tcPDPtr	t1 = `tcPDPtr()`,
		tcPDPtr	t2 = `tcPDPtr()`
	)		const

virtual

Perform jet clustering on the given outgoing particles.

Optionally, information on the incoming particles is provided. Return true, if a clustering has been performed.

Implements ThePEG::JetFinder.

◆ describe()

virtual void ThePEG::FastJetFinder::describe ( ) const

virtual

Describe this jet fined.

Implements ThePEG::JetFinder.

◆ doinit()

virtual void ThePEG::FastJetFinder::doinit ( )

virtual

Initialize this object.

Called in the read phase.

Reimplemented from ThePEG::InterfacedBase.

◆ doinitrun()

virtual void ThePEG::FastJetFinder::doinitrun ( )

virtual

Initialize this object.

Called in the run phase just before a run begins.

Reimplemented from ThePEG::InterfacedBase.

◆ fullclone()

virtual IBPtr ThePEG::FastJetFinder::fullclone ( ) const

protectedvirtual

Make a clone of this object, possibly modifying the cloned object to make it sane.

Returns: a pointer to the new object.

Reimplemented from ThePEG::InterfacedBase.

◆ Init()

static void ThePEG::FastJetFinder::Init ( )

static

The standard Init function used to initialize the interfaces.

Called exactly once for each class by the class description system before the main function starts or when this class is dynamically loaded.

◆ operator=()

FastJetFinder & ThePEG::FastJetFinder::operator= ( const FastJetFinder & )

privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

void ThePEG::FastJetFinder::persistentInput	(	PersistentIStream &	is,
		int	version
	)

Function used to read in object persistently.

Parameters

is	the persistent input stream read from.
version	the version number of the object when written.

◆ persistentOutput()

void ThePEG::FastJetFinder::persistentOutput ( PersistentOStream & os ) const

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

Member Data Documentation

◆ theConeRadius

double ThePEG::FastJetFinder::theConeRadius

private

The ‘cone radius’ R.

Definition at line 122 of file FastJetFinder.h.

◆ theDCut

Energy2 ThePEG::FastJetFinder::theDCut

private

The resolution cut.

Definition at line 117 of file FastJetFinder.h.

◆ theMode

int ThePEG::FastJetFinder::theMode

private

The mode.

Definition at line 152 of file FastJetFinder.h.

◆ theRecombination

int ThePEG::FastJetFinder::theRecombination

private

The recombination scheme.

Definition at line 165 of file FastJetFinder.h.

◆ theVariant

int ThePEG::FastJetFinder::theVariant

private

The variant.

Definition at line 139 of file FastJetFinder.h.

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

FastJetFinder.h

Public Member Functions

Clone Methods.

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ modes

◆ recombinations

◆ variants

Member Function Documentation

◆ clone()

◆ cluster()

◆ describe()

◆ doinit()

◆ doinitrun()

◆ fullclone()

◆ Init()

◆ operator=()

◆ persistentInput()

◆ persistentOutput()

Member Data Documentation

◆ theConeRadius

◆ theDCut

◆ theMode

◆ theRecombination

◆ theVariant