JetFinder defines an interface to jet finders to be used when cuts should actually be defined on the level of reconstructed jets such as typically encountered in higher order corrections. More...

#include <JetFinder.h>

Inheritance diagram for ThePEG::JetFinder:

[legend]

Public Member Functions
	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.

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

virtual IBPtr	fullclone () const
	Return a full clone of this object possibly doing things to the clone to make it sane.

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.

Functions used by the persistent I/O system.
Ptr< MatcherBase >::ptr	theUnresolvedMatcher
	A matcher for unresolved partons.

unsigned int	theMinOutgoing
	The minimum number of outgoing partons on which clustering should be performed.

bool	theRestrictConstituents
	True, if jets should only be constructed from matching objects inside a given rapidity interval.

pair< double, double >	theConstituentRapidityRange
	The rapidity interval within objects should be considered for clustering, if appropriate.

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.

string	doYRange (string)
	Command to insert a rapidity range.

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

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::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	doinit ()
	Initialize this object after the setup phase before saving an EventGenerator to disk.

virtual void	doinitrun ()
	Initialize this object.

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.

virtual IBPtr	clone () const =0
	Return a simple clone of this object.

	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

JetFinder defines an interface to jet finders to be used when cuts should actually be defined on the level of reconstructed jets such as typically encountered in higher order corrections.

See also: The interfaces defined for JetFinder.

Definition at line 30 of file JetFinder.h.

Member Function Documentation

◆ cluster()

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

pure 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.

Implemented in ThePEG::FastJetFinder.

◆ constituentRapidityRange() [1/2]

const pair< double, double > & ThePEG::JetFinder::constituentRapidityRange ( ) const

inline

Return the rapidity interval within objects should be considered for clustering, if appropriate.

Definition at line 83 of file JetFinder.h.

References theConstituentRapidityRange.

◆ constituentRapidityRange() [2/2]

void ThePEG::JetFinder::constituentRapidityRange ( const pair< double, double > & r )

inline

Set the rapidity interval within objects should be considered for clustering, if appropriate.

Definition at line 89 of file JetFinder.h.

References theConstituentRapidityRange.

◆ describe()

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

pure virtual

Describe this jet finder.

Implemented in ThePEG::FastJetFinder.

◆ Init()

static void ThePEG::JetFinder::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.

◆ minOutgoing() [1/2]

unsigned int ThePEG::JetFinder::minOutgoing ( ) const

inline

Return the minimum number of outgoing partons on which clustering should be performed.

Definition at line 65 of file JetFinder.h.

References theMinOutgoing.

◆ minOutgoing() [2/2]

void ThePEG::JetFinder::minOutgoing ( unsigned int n )

inline

Set the minimum number of outgoing partons on which clustering should be performed.

Definition at line 59 of file JetFinder.h.

References theMinOutgoing.

◆ operator=()

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

privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

void ThePEG::JetFinder::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::JetFinder::persistentOutput ( PersistentOStream & os ) const

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

◆ restrictConsitutents() [1/2]

bool ThePEG::JetFinder::restrictConsitutents ( ) const

inline

Return true, if jets should only be constructed from matching objects inside a given rapidity interval.

Definition at line 71 of file JetFinder.h.

References theRestrictConstituents.

◆ restrictConsitutents() [2/2]

void ThePEG::JetFinder::restrictConsitutents ( bool on )

inline

Jets should only be constructed from matching objects inside a given rapidity interval.

Definition at line 77 of file JetFinder.h.

References theRestrictConstituents.

◆ unresolvedMatcher()

Ptr< MatcherBase >::tptr ThePEG::JetFinder::unresolvedMatcher ( ) const

inline

Return the matcher for unresolved partons.

Definition at line 53 of file JetFinder.h.

References theUnresolvedMatcher.

Member Data Documentation

◆ theConstituentRapidityRange

pair<double,double> ThePEG::JetFinder::theConstituentRapidityRange

private

The rapidity interval within objects should be considered for clustering, if appropriate.

Definition at line 155 of file JetFinder.h.

Referenced by constituentRapidityRange().

◆ theMinOutgoing

unsigned int ThePEG::JetFinder::theMinOutgoing

private

The minimum number of outgoing partons on which clustering should be performed.

Definition at line 143 of file JetFinder.h.

Referenced by minOutgoing().

◆ theRestrictConstituents

bool ThePEG::JetFinder::theRestrictConstituents

private

True, if jets should only be constructed from matching objects inside a given rapidity interval.

Definition at line 149 of file JetFinder.h.

Referenced by restrictConsitutents().

◆ theUnresolvedMatcher

Ptr<MatcherBase>::ptr ThePEG::JetFinder::theUnresolvedMatcher

private

A matcher for unresolved partons.

Definition at line 137 of file JetFinder.h.

Referenced by unresolvedMatcher().

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

JetFinder.h

Public Member Functions

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ cluster()

◆ constituentRapidityRange() [1/2]

◆ constituentRapidityRange() [2/2]

◆ describe()

◆ Init()

◆ minOutgoing() [1/2]

◆ minOutgoing() [2/2]

◆ operator=()

◆ persistentInput()

◆ persistentOutput()

◆ restrictConsitutents() [1/2]

◆ restrictConsitutents() [2/2]

◆ unresolvedMatcher()

Member Data Documentation

◆ theConstituentRapidityRange

◆ theMinOutgoing

◆ theRestrictConstituents

◆ theUnresolvedMatcher