This class corresponds to a kinematical cut to be made on a pair of particles in a hard sub-process. More...

#include <TwoCutBase.h>

Inheritance diagram for ThePEG::TwoCutBase:

[legend]

Public Member Functions
	TwoCutBase ()
	The default constructor.

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.

Virtual functions to be overridden by sub-classes.
static AbstractNoPIOClassDescription< TwoCutBase >	initTwoCutBase
	The static object used to initialize the description of this class.

virtual Energy2	minSij (tcPDPtr pi, tcPDPtr pj) const =0
	Return the minimum allowed squared invariant mass of two outgoing partons of type pi and pj.

virtual Energy2	minTij (tcPDPtr pi, tcPDPtr po) const =0
	Return the minimum allowed value of the negative of the squared invariant mass of an incoming parton of type pi and an outgoing parton of type po.

virtual double	minDeltaR (tcPDPtr pi, tcPDPtr pj) const =0
	Return the minimum allowed value of \(\Delta R_{ij}=\sqrt{\Delta\eta_{ij}^2+\Delta\phi_{ij}^2}\) of two outgoing partons of type pi and pj.

virtual Energy	minKTClus (tcPDPtr pi, tcPDPtr pj) const =0
	Return the minimum allowed value of the longitudinally invariant \(k_\perp\)-algorithms distance measure.

virtual double	minDurham (tcPDPtr pi, tcPDPtr pj) const =0
	Return the minimum allowed value of the Durham \(k_\perp\)-algorithms distance measure.

virtual bool	passCuts (tcCutsPtr parent, tcPDPtr pitype, tcPDPtr pjtype, LorentzMomentum pi, LorentzMomentum pj, bool inci=false, bool incj=false) const
	Return true if a pair of particles with type pitype and pjtype and momenta pi and pj respectively passes the cuts.

bool	passCuts (tcCutsPtr parent, tcPPtr pi, tcPPtr pj, bool inci=false, bool incj=false) const
	Return true if the given pair of particles passes the cuts.

virtual void	describe () const
	Describe the currently active cuts in the log file.

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

TwoCutBase &	operator= (const TwoCutBase &)=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

This class corresponds to a kinematical cut to be made on a pair of particles in a hard sub-process.

There are six main virtual functions to be overridden by concrete sub-classes. minsSij(), minTij(), minDeltaR(), minKTClus() and minDurham() returns the minimum allowed values of pre defined kinematical variable. In addition the passCut() function should return true if a pair of particle with a given types and given momenta will pass the cuts.

See also: The interfaces defined for TwoCutBase.

Definition at line 35 of file TwoCutBase.h.

Constructor & Destructor Documentation

◆ TwoCutBase()

ThePEG::TwoCutBase::TwoCutBase ( )

inline

The default constructor.

Definition at line 42 of file TwoCutBase.h.

Member Function Documentation

◆ describe()

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

virtual

Describe the currently active cuts in the log file.

Reimplemented in ThePEG::DeltaMeasureCuts, ThePEG::KTClus, and ThePEG::SimpleDISCut.

◆ Init()

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

◆ minDeltaR()

virtual double ThePEG::TwoCutBase::minDeltaR	(	tcPDPtr	pi,
		tcPDPtr	pj
	)		const

pure virtual

Return the minimum allowed value of \(\Delta R_{ij}=\sqrt{\Delta\eta_{ij}^2+\Delta\phi_{ij}^2}\) of two outgoing partons of type pi and pj.

Implemented in ThePEG::DeltaMeasureCuts, ThePEG::KTClus, ThePEG::SimpleDISCut, and ThePEG::MadGraphTwoCut.

◆ minDurham()

virtual double ThePEG::TwoCutBase::minDurham	(	tcPDPtr	pi,
		tcPDPtr	pj
	)		const

pure virtual

Return the minimum allowed value of the Durham \(k_\perp\)-algorithms distance measure.

This is defined as \(2\min(E_j^2, E_j^2)(1-\cos\theta_{ij})/\hat{s}\) for two outgoing partons.

Implemented in ThePEG::DeltaMeasureCuts, ThePEG::KTClus, ThePEG::SimpleDISCut, and ThePEG::MadGraphTwoCut.

◆ minKTClus()

virtual Energy ThePEG::TwoCutBase::minKTClus	(	tcPDPtr	pi,
		tcPDPtr	pj
	)		const

pure virtual

Return the minimum allowed value of the longitudinally invariant \(k_\perp\)-algorithms distance measure.

This is defined as \(\min(p_{\perp i}, p_{\perp j})\sqrt{\Delta\eta_{ij}^2+\Delta\phi_{ij}^2}\) for two outgoing partons, or simply \(p_{\perp i}\) or \(p_{\perp j}\) for a single outgoing parton. Returns 0 if both partons are incoming. A null pointer indicates an incoming parton, hence the type of the incoming parton is irrelevant.

Implemented in ThePEG::DeltaMeasureCuts, ThePEG::KTClus, ThePEG::SimpleDISCut, and ThePEG::MadGraphTwoCut.

◆ minSij()

virtual Energy2 ThePEG::TwoCutBase::minSij	(	tcPDPtr	pi,
		tcPDPtr	pj
	)		const

pure virtual

Return the minimum allowed squared invariant mass of two outgoing partons of type pi and pj.

Implemented in ThePEG::DeltaMeasureCuts, ThePEG::KTClus, ThePEG::SimpleDISCut, and ThePEG::MadGraphTwoCut.

◆ minTij()

virtual Energy2 ThePEG::TwoCutBase::minTij	(	tcPDPtr	pi,
		tcPDPtr	po
	)		const

pure virtual

Return the minimum allowed value of the negative of the squared invariant mass of an incoming parton of type pi and an outgoing parton of type po.

Implemented in ThePEG::DeltaMeasureCuts, ThePEG::KTClus, ThePEG::SimpleDISCut, and ThePEG::MadGraphTwoCut.

◆ operator=()

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

privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ passCuts() [1/2]

virtual bool ThePEG::TwoCutBase::passCuts	(	tcCutsPtr	parent,
		tcPDPtr	pitype,
		tcPDPtr	pjtype,
		LorentzMomentum	pi,
		LorentzMomentum	pj,
		bool	inci = `false`,
		bool	incj = `false`
	)		const

virtual

Return true if a pair of particles with type pitype and pjtype and momenta pi and pj respectively passes the cuts.

inci and inj indicates if the corresponding particles are incoming.

Reimplemented in ThePEG::DeltaMeasureCuts, ThePEG::KTClus, ThePEG::SimpleDISCut, and ThePEG::MadGraphTwoCut.

◆ passCuts() [2/2]

bool ThePEG::TwoCutBase::passCuts	(	tcCutsPtr	parent,
		tcPPtr	pi,
		tcPPtr	pj,
		bool	inci = `false`,
		bool	incj = `false`
	)		const

Return true if the given pair of particles passes the cuts.

inci and inj indicates if the corresponding particles are incoming.

Member Data Documentation

◆ initTwoCutBase

AbstractNoPIOClassDescription<TwoCutBase> ThePEG::TwoCutBase::initTwoCutBase

staticprivate

The static object used to initialize the description of this class.

Indicates that this is an abstract class with persistent data.

Definition at line 128 of file TwoCutBase.h.

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

TwoCutBase.h

Public Member Functions

Virtual functions to be overridden by sub-classes.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TwoCutBase()

Member Function Documentation

◆ describe()

◆ Init()

◆ minDeltaR()

◆ minDurham()

◆ minKTClus()

◆ minSij()

◆ minTij()

◆ operator=()

◆ passCuts() [1/2]

◆ passCuts() [2/2]

Member Data Documentation

◆ initTwoCutBase