Cuts is a class for implementing kinematical cuts in ThePEG. More...

#include <Cuts.h>

Inheritance diagram for ThePEG::Cuts:

[legend]

Public Types
typedef vector< OneCutPtr >	OneCutVector
	A vector of OneCutBase pointers.

typedef vector< TwoCutPtr >	TwoCutVector
	A vector of TwoCutBase pointers.

typedef vector< MultiCutPtr >	MultiCutVector
	A vector of MultiCutBase pointers.

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.

Public Member Functions
Standard constructors and destructors.
	Cuts (Energy MhatMin=2 *GeV)
	The default constructor.

Initialization functions.
virtual void	initialize (Energy2 smax, double Y)
	Initialize this object specifying the maximum total invariant mass squared, smax, and the total rapidity, Y, of the colliding particles (for the maximum invariant mass).

virtual void	initEvent ()
	Initialize this object for a new event.

virtual bool	initSubProcess (Energy2 shat, double yhat, bool mirror=false) const
	Set information about the invariant mass squared, shat, and rapidity, yhat, of the hard sub-process.

Check functions to see if a state has passed the cuts or not.
virtual bool	passCuts (const tcPDVector &ptype, const vector< LorentzMomentum > &p, tcPDPtr t1=tcPDPtr(), tcPDPtr t2=tcPDPtr()) const
	Check if the outgoing particles, with the given types and momenta, from a sub-process passes the cuts.

bool	passCuts (const tcPVector &p, tcPDPtr t1=tcPDPtr(), tcPDPtr t2=tcPDPtr()) const
	Check if the outgoing particles from a sub-process passes the cuts.

bool	passCuts (const SubProcess &sub) const
	Check if the incoming and outgoing particles in the given sub-process passes the cuts.

bool	passCuts (const Collision &coll) const
	Check if the given collision passes the cuts.

Access to cuts of the underlying cut objects.
Energy2	minSij (tcPDPtr pi, tcPDPtr pj) const
	Return the minimum allowed squared invariant mass of two outgoing partons of type pi and pj.

Energy2	minTij (tcPDPtr pi, tcPDPtr po) const
	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.

double	minDeltaR (tcPDPtr pi, tcPDPtr pj) const
	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.

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

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

Energy	minKT (tcPDPtr p) const
	Return the minimum allowed value of the transverse momentum of an outgoing parton.

double	minEta (tcPDPtr p) const
	Return the minimum allowed pseudo-rapidity of an outgoing parton of the given type.

double	maxEta (tcPDPtr p) const
	Return the maximum allowed pseudo-rapidity of an outgoing parton of the given type.

double	minRapidityMax (tcPDPtr p) const
	Return the minimum allowed rapidity of an outgoing parton of the given type.

double	maxRapidityMin (tcPDPtr p) const
	Return the maximum allowed rapidity of an outgoing parton of the given type.

double	minYStar (tcPDPtr p) const
	Return the minimum allowed rapidity of an outgoing parton of the given type in the center-of-mass system of the hard sub-process.

double	maxYStar (tcPDPtr p) const
	Return the minimum allowed rapidity of an outgoing parton of the given type in the center-of-mass system of the hard sub-process.

Energy2	minS (const tcPDVector &pv) const
	Return the minimum allowed value of the squared invariant mass of a set of outgoing partons of the given types.

Energy2	maxS (const tcPDVector &pv) const
	Return the maximum allowed value of the squared invariant mass of a set of outgoing partons of the given types.

Direct access to underlying cut objects.
template<typename T >
vector< typename Ptr< T >::transient_const_pointer >	oneCutObjects () const
	Return a vector of pointers to objects of the given class (with base class OneCutBase).

template<typename T >
vector< typename Ptr< T >::transient_const_pointer >	twoCutObjects () const
	Return a vector of pointers to objects of the given class (with base class TwoCutBase).

template<typename T >
vector< typename Ptr< T >::transient_const_pointer >	multiCutObjects () const
	Return a vector of pointers to objects of the given class (with base class MultiCutBase).

const OneCutVector &	oneCuts () const
	Return the objects defining cuts on single outgoing partons from the hard sub-process.

const TwoCutVector &	twoCuts () const
	Return the objects defining cuts on pairs of particles in the hard sub-process.

const MultiCutVector &	multiCuts () const
	Return the objects defining cuts on sets of outgoing particles from the hard sub-process.

Ptr< JetFinder >::tptr	jetFinder () const
	Return the jet finder.

void	add (tOneCutPtr c)
	Add a OneCutBase object.

void	add (tTwoCutPtr c)
	Add a TwoCutBase object.

void	add (tMultiCutPtr c)
	Add a MultiCutBase object.

Simple access functions.
Energy2	SMax () const
	The maximum allowed total invariant mass squared allowed for events to be considered.

double	Y () const
	The total rapidity of the colliding particles corresponding to the maximum invariant mass squared, SMax().

Energy2	currentSHat () const
	The invariant mass squared of the hard sub-process of the event being considered.

double	currentYHat () const
	The total rapidity of hard sub-process (wrt.

Functions to inquire about specific cuts.
Energy2	sHatMin () const
	The minimum allowed value of \(\hat{s}\).

Energy2	sHatMax () const
	The maximum allowed value of \(\hat{s}\).

bool	sHat (Energy2 sh) const
	Check if the given \(\hat{s}\) is within the cuts.

Energy	mHatMin () const
	The minimum allowed value of \(\sqrt{\hat{s}}\).

Energy	mHatMax () const
	The maximum allowed value of \(\sqrt{\hat{s}}\).

double	yHatMin () const
	The minimum value of the rapidity of the hard sub-process (wrt.

double	yHatMax () const
	The maximum value of the rapidity of the hard sub-process (wrt.

bool	yHat (double y) const
	Check if the given \(\hat{y}\) is within the cuts.

double	x1Min () const
	The minimum value of the positive light-cone fraction of the hard sub-process.

double	x1Max () const
	The maximum value of the positive light-cone fraction of the hard sub-process.

bool	x1 (double x) const
	Check if the given \(x_1\) is within the cuts.

double	x2Min () const
	The minimum value of the negative light-cone fraction of the hard sub-process.

double	x2Max () const
	The maximum value of the negative light-cone fraction of the hard sub-process.

bool	x2 (double x) const
	Check if the given \(x_2\) is within the cuts.

Energy2	scaleMin () const
	The minimum allowed value of the scale to be used in PDF's and coupling constants.

Energy2	scaleMax () const
	The maximum allowed value of the scale to be used in PDF's and coupling constants.

bool	scale (Energy2 Q2) const
	Check if the given scale is within the cuts.

bool	subMirror () const
	Set true if a matrix element is should be using this cut and is mirrored along the z-axis .

double	cutWeight () const
	Return the overall cut weight.

void	lastCutWeight (double w) const
	Set the cut weight as appropriate from the call to the last n-cut object.

Ptr< FuzzyTheta >::tcptr	fuzzy () const
	Return the fuzziness object.

template<class CutType , class Value >
bool	isInside (const Value &v, const Value &lower, const Value &upper, double &weight) const
	Check for value inside the given bounds and update the weight.

template<class CutType , class Value >
bool	isLessThan (const Value &v, const Value &upper, double &weight) const
	Check for value inside the given bounds and update the weight.

template<class CutType , class Value >
bool	isLargerThan (const Value &v, const Value &lower, double &weight) const
	Check for value inside the given bounds and update the weight.

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

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.

Protected Member Functions
Standard Interfaced functions.
virtual void	doinitrun ()
	Initialize this object.

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

Clone Methods.
Energy2	theSMax
	The maximum allowed total invariant mass squared allowed for events to be considered.

double	theY
	The total rapidity of the colliding particles corresponding to the maximum invariant mass squared, SMax().

Energy2	theCurrentSHat
	The invariant mass squared of the hard sub-process of the event being considered.

double	theCurrentYHat
	The total rapidity of hard sub-process (wrt.

Energy	theMHatMin
	The minimum allowed value of \(\sqrt{\hat{s}}\).

Energy	theMHatMax
	The maximum allowed value of \(\sqrt{\hat{s}}\).

double	theYHatMin
	The minimum value of the rapidity of the hard sub-process (wrt.

double	theYHatMax
	The maximum value of the rapidity of the hard sub-process (wrt.

double	theX1Min
	The minimum value of the positive light-cone fraction of the hard sub-process.

double	theX1Max
	The maximum value of the positive light-cone fraction of the hard sub-process.

double	theX2Min
	The minimum value of the negative light-cone fraction of the hard sub-process.

double	theX2Max
	The maximum value of the negative light-cone fraction of the hard sub-process.

Energy2	theScaleMin
	The minimum allowed value of the scale to be used in PDF's and coupling constants.

Energy2	theScaleMax
	The maximum allowed value of the scale to be used in PDF's and coupling constants.

OneCutVector	theOneCuts
	The objects defining cuts on single outgoing partons from the hard sub-process.

TwoCutVector	theTwoCuts
	The objects defining cuts on pairs of particles in the hard sub-process.

MultiCutVector	theMultiCuts
	The objects defining cuts on sets of outgoing particles from the hard sub-process.

Ptr< JetFinder >::ptr	theJetFinder
	An optional jet finder used to define cuts on the level of reconstructed jets.

bool	theSubMirror
	Set to true if a matrix element is should be using this cut and is mirrored along the z-axis .

double	theCutWeight
	The overall cut weight.

double	theLastCutWeight
	The cut weight as appropriate from the call to the last n-cut object.

Ptr< FuzzyTheta >::ptr	theFuzzyTheta
	The fuzziness object.

static ClassDescription< Cuts >	initCuts
	The static object used to initialize the description of this class.

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.

Energy	maxMHatMin () const
	Helper function used by the interface.

Energy	minMHatMax () const
	Helper function used by the interface.

double	maxYHatMin () const
	Helper function used by the interface.

double	minYHatMax () const
	Helper function used by the interface.

double	maxX1Min () const
	Helper function used by the interface.

double	minX1Max () const
	Helper function used by the interface.

double	maxX2Min () const
	Helper function used by the interface.

double	minX2Max () const
	Helper function used by the interface.

Energy2	maxScaleMin () const
	Helper function used by the interface.

Energy2	minScaleMax () const
	Helper function used by the interface.

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

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

Cuts is a class for implementing kinematical cuts in ThePEG.

The class itself only implements cuts on the total momentum of the hard sub-process, implemented as minimum and maximum values of \(x_1\) and \(x_2\) (or \(\hat{s}=x_1x_2S_{tot}\) and \(\hat{y}=\log(x_1/x_2)/2\). Further cuts can be implemented either by inheriting from this base class, in which the virtual cut() function should be overridden, or by assigning objects of class OneCutBase, TwoCutBase and MultiCutBase defining cuts on single particles, pairs of particles and groups of particles in the hard sub-process respectively.

The Cuts object must be initialized specifying the overall laboratory frame, giving the total squared invariant mass, \(S\), and the rapidity, \(Y\), of the colliding particles in this frame. The colliding particles are thus assumed to be directed along the \(z\)-axis.

For each event, the Cuts object must also be initialized giving the squared invarint mass, \(\hat{s}\), and the total rapidity, \(\hat{y}\), of the hard sub-process in the center-of-mass frame of the colliding particles. Note that this means that the transformation between the lab frame and the rest frame of the hard sub-process is assumed to be a simple boost along the z-axis.

See also: The interfaces defined for Cuts.

Definition at line 53 of file Cuts.h.

Member Typedef Documentation

◆ MultiCutVector

typedef vector<MultiCutPtr> ThePEG::Cuts::MultiCutVector

A vector of MultiCutBase pointers.

Definition at line 70 of file Cuts.h.

◆ OneCutVector

typedef vector<OneCutPtr> ThePEG::Cuts::OneCutVector

A vector of OneCutBase pointers.

Definition at line 60 of file Cuts.h.

◆ TwoCutVector

typedef vector<TwoCutPtr> ThePEG::Cuts::TwoCutVector

A vector of TwoCutBase pointers.

Definition at line 65 of file Cuts.h.

Member Function Documentation

◆ add() [1/3]

void ThePEG::Cuts::add ( tMultiCutPtr c )

inline

Add a MultiCutBase object.

Definition at line 347 of file Cuts.h.

References theMultiCuts.

◆ add() [2/3]

void ThePEG::Cuts::add ( tOneCutPtr c )

inline

Add a OneCutBase object.

Definition at line 337 of file Cuts.h.

References theOneCuts.

◆ add() [3/3]

void ThePEG::Cuts::add ( tTwoCutPtr c )

inline

Add a TwoCutBase object.

Definition at line 342 of file Cuts.h.

References theTwoCuts.

◆ clone()

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

protectedvirtual

Make a simple clone of this object.

Returns: a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ currentSHat()

Energy2 ThePEG::Cuts::currentSHat ( ) const

inline

The invariant mass squared of the hard sub-process of the event being considered.

Definition at line 371 of file Cuts.h.

References theCurrentSHat.

◆ currentYHat()

double ThePEG::Cuts::currentYHat ( ) const

inline

The total rapidity of hard sub-process (wrt.

the rest system of the colliding particles so that currentYHat() + Y() gives the true rapidity) of the event being considered.

Definition at line 378 of file Cuts.h.

References theCurrentYHat.

◆ cutWeight()

double ThePEG::Cuts::cutWeight ( ) const

inline

Return the overall cut weight.

Definition at line 488 of file Cuts.h.

References theCutWeight.

◆ doinitrun()

virtual void ThePEG::Cuts::doinitrun ( )

protectedvirtual

Initialize this object.

Called in the run phase just before a run begins.

Reimplemented from ThePEG::InterfacedBase.

◆ fullclone()

virtual IBPtr ThePEG::Cuts::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.

◆ fuzzy()

Ptr< FuzzyTheta >::tcptr ThePEG::Cuts::fuzzy ( ) const

inline

Return the fuzziness object.

Definition at line 499 of file Cuts.h.

References theFuzzyTheta.

Referenced by isInside(), isLargerThan(), and isLessThan().

◆ Init()

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

◆ initEvent()

virtual void ThePEG::Cuts::initEvent ( )

virtual

Initialize this object for a new event.

A sub-class overriding this function must make sure the base-class function is called. This function is called before the generation of a new sub-process, before the incoming partons have been generated.

◆ initialize()

virtual void ThePEG::Cuts::initialize	(	Energy2	smax,
		double	Y
	)

virtual

Initialize this object specifying the maximum total invariant mass squared, smax, and the total rapidity, Y, of the colliding particles (for the maximum invariant mass).

A sub-class overriding this function must make sure the base-class function is called. This function should be called once in the beginning of a run.

◆ initSubProcess()

virtual bool ThePEG::Cuts::initSubProcess	(	Energy2	shat,
		double	yhat,
		bool	mirror = `false`
	)		const

virtual

Set information about the invariant mass squared, shat, and rapidity, yhat, of the hard sub-process.

The rapidity should be given wrt. the center of mass of the colliding particles. A sub-class overriding this function must make sure the base-class function is called. This function is called before the generation of a new sub-process, after the incoming partons have been generated. If mirror is true any questions regarding cuts on the sub-process in the functions minYStar(tcPDPtr), maxYStar(tcPDPtr p), passCuts(const tcPDVector &, const vector<LorentzMomentum> &, tcPDPtr, tcPDPtr) and passCuts(const tcPVector &, tcPDPtr t1, tcPDPtr) will assume that the z-axis is reversed in the sub-process rest frame. Returns false if the given values were outside of the cuts.

◆ isInside()

template<class CutType , class Value >

bool ThePEG::Cuts::isInside	(	const Value &	v,
		const Value &	lower,
		const Value &	upper,
		double &	weight
	)		const

inline

Check for value inside the given bounds and update the weight.

Definition at line 505 of file Cuts.h.

References fuzzy().

◆ isLargerThan()

template<class CutType , class Value >

bool ThePEG::Cuts::isLargerThan	(	const Value &	v,
		const Value &	lower,
		double &	weight
	)		const

inline

Check for value inside the given bounds and update the weight.

Definition at line 533 of file Cuts.h.

References fuzzy().

◆ isLessThan()

template<class CutType , class Value >

bool ThePEG::Cuts::isLessThan	(	const Value &	v,
		const Value &	upper,
		double &	weight
	)		const

inline

Check for value inside the given bounds and update the weight.

Definition at line 519 of file Cuts.h.

References fuzzy().

◆ jetFinder()

Ptr< JetFinder >::tptr ThePEG::Cuts::jetFinder ( ) const

inline

Return the jet finder.

Definition at line 332 of file Cuts.h.

References theJetFinder.

◆ lastCutWeight()

void ThePEG::Cuts::lastCutWeight ( double w ) const

inline

Set the cut weight as appropriate from the call to the last n-cut object.

Definition at line 494 of file Cuts.h.

References theLastCutWeight.

◆ maxEta()

double ThePEG::Cuts::maxEta ( tcPDPtr p ) const

Return the maximum allowed pseudo-rapidity of an outgoing parton of the given type.

The pseudo-rapidity is measured in the lab system. Simply returns the minimum of the results from calling the corresponding function in the OneCutBase objects.

◆ maxRapidityMin()

double ThePEG::Cuts::maxRapidityMin ( tcPDPtr p ) const

Return the maximum allowed rapidity of an outgoing parton of the given type.

The rapidity is measured in the lab system. Simply returns the minimum of the results from calling the corresponding function in the OneCutBase objects.

◆ maxS()

Energy2 ThePEG::Cuts::maxS ( const tcPDVector & pv ) const

Return the maximum allowed value of the squared invariant mass of a set of outgoing partons of the given types.

Typically used to cut off the tails of the mass of a resonance for efficiency. Simply returns the minimum of the results from calling the corresponding function in the MultiCutBase objects.

◆ maxYStar()

double ThePEG::Cuts::maxYStar ( tcPDPtr p ) const

Return the minimum allowed rapidity of an outgoing parton of the given type in the center-of-mass system of the hard sub-process.

Only available after initSubProcess() has been called.

◆ mHatMax()

Energy ThePEG::Cuts::mHatMax ( ) const

inline

The maximum allowed value of \(\sqrt{\hat{s}}\).

Definition at line 409 of file Cuts.h.

References SMax(), theMHatMax, theX1Max, and theX2Max.

◆ mHatMin()

Energy ThePEG::Cuts::mHatMin ( ) const

inline

The minimum allowed value of \(\sqrt{\hat{s}}\).

Definition at line 404 of file Cuts.h.

References SMax(), theMHatMin, theX1Min, and theX2Min.

◆ minDeltaR()

double ThePEG::Cuts::minDeltaR	(	tcPDPtr	pi,
		tcPDPtr	pj
	)		const

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.

Simply returns the maximum of the results from calling the corresponding function in the TwoCutBase objects.

◆ minDurham()

double ThePEG::Cuts::minDurham	(	tcPDPtr	pi,
		tcPDPtr	pj
	)		const

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. Simply returns the maximum of the results from calling the corresponding function in the TwoCutBase objects.

◆ minEta()

double ThePEG::Cuts::minEta ( tcPDPtr p ) const

Return the minimum allowed pseudo-rapidity of an outgoing parton of the given type.

The pseudo-rapidity is measured in the lab system. Simply returns the maximum of the results from calling the corresponding function in the OneCutBase objects.

◆ minKT()

Energy ThePEG::Cuts::minKT ( tcPDPtr p ) const

Return the minimum allowed value of the transverse momentum of an outgoing parton.

This function first determines the minimum from the corresponding function from in OneCutBase objects. If no minimum was found, one is derived from minKTClus(), if possible.

◆ minKTClus()

Energy ThePEG::Cuts::minKTClus	(	tcPDPtr	pi,
		tcPDPtr	pj
	)		const

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. Simply returns the maximum of the results from calling the corresponding function in the TwoCutBase objects.

◆ minRapidityMax()

double ThePEG::Cuts::minRapidityMax ( tcPDPtr p ) const

Return the minimum allowed rapidity of an outgoing parton of the given type.

The rapidity is measured in the lab system. Simply returns the maximum of the results from calling the corresponding function in the OneCutBase objects.

◆ minS()

Energy2 ThePEG::Cuts::minS ( const tcPDVector & pv ) const

Return the minimum allowed value of the squared invariant mass of a set of outgoing partons of the given types.

Typically used to cut off the tails of the mass of a resonance for efficiency. Simply returns the maximum of the results from calling the corresponding function in the MultiCutBase objects.

◆ minSij()

Energy2 ThePEG::Cuts::minSij	(	tcPDPtr	pi,
		tcPDPtr	pj
	)		const

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

This function first determines the minimum from the corresponding function from in TwoCutBase objects. If no minimum was found, one is derived from minKTClus(), minDurham(), minKT() and minDeltaR(), if possible.

◆ minTij()

Energy2 ThePEG::Cuts::minTij	(	tcPDPtr	pi,
		tcPDPtr	po
	)		const

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.

This function first determines the minimum from the corresponding function from in TwoCutBase objects. If no minimum was found, one is derived from minKT(), if possible.

◆ minYStar()

double ThePEG::Cuts::minYStar ( tcPDPtr p ) const

Return the minimum allowed rapidity of an outgoing parton of the given type in the center-of-mass system of the hard sub-process.

Only available after initSubProcess() has been called.

◆ multiCuts()

const MultiCutVector & ThePEG::Cuts::multiCuts ( ) const

inline

Return the objects defining cuts on sets of outgoing particles from the hard sub-process.

Definition at line 327 of file Cuts.h.

References theMultiCuts.

◆ oneCuts()

const OneCutVector & ThePEG::Cuts::oneCuts ( ) const

inline

Return the objects defining cuts on single outgoing partons from the hard sub-process.

Definition at line 315 of file Cuts.h.

References theOneCuts.

◆ operator=()

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

privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ passCuts() [1/4]

bool ThePEG::Cuts::passCuts ( const Collision & coll ) const

Check if the given collision passes the cuts.

The collision must be given in its rest frame.

◆ passCuts() [2/4]

bool ThePEG::Cuts::passCuts ( const SubProcess & sub ) const

Check if the incoming and outgoing particles in the given sub-process passes the cuts.

The sub-process must be given in its rest frame, and the initSubProcess must have been called before.

◆ passCuts() [3/4]

virtual bool ThePEG::Cuts::passCuts	(	const tcPDVector &	ptype,
		const vector< LorentzMomentum > &	p,
		tcPDPtr	t1 = `tcPDPtr()`,
		tcPDPtr	t2 = `tcPDPtr()`
	)		const

virtual

Check if the outgoing particles, with the given types and momenta, from a sub-process passes the cuts.

The particles must be given in the rest frame of tha hard sub-process, and the initSubProcess must have been called before. Also the types of the incoming partons, t1 and t2, may be given if availible.

◆ passCuts() [4/4]

bool ThePEG::Cuts::passCuts	(	const tcPVector &	p,
		tcPDPtr	t1 = `tcPDPtr()`,
		tcPDPtr	t2 = `tcPDPtr()`
	)		const

Check if the outgoing particles from a sub-process passes the cuts.

The particles must be given in the rest frame of tha hard sub-process, and the initSubProcess must have been called before. Also the types of the incoming partons, t1 and t2, may be given if availible.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

◆ scale()

bool ThePEG::Cuts::scale ( Energy2 Q2 ) const

inline

Check if the given scale is within the cuts.

Definition at line 477 of file Cuts.h.

References scaleMax(), and scaleMin().

◆ scaleMax()

Energy2 ThePEG::Cuts::scaleMax ( ) const

inline

The maximum allowed value of the scale to be used in PDF's and coupling constants.

Definition at line 472 of file Cuts.h.

References theScaleMax.

Referenced by scale().

◆ scaleMin()

Energy2 ThePEG::Cuts::scaleMin ( ) const

inline

The minimum allowed value of the scale to be used in PDF's and coupling constants.

Definition at line 466 of file Cuts.h.

References theScaleMin.

Referenced by scale().

◆ sHat()

bool ThePEG::Cuts::sHat ( Energy2 sh ) const

inline

Check if the given \(\hat{s}\) is within the cuts.

Definition at line 397 of file Cuts.h.

References ThePEG::Constants::epsilon, sHatMax(), and sHatMin().

◆ sHatMax()

Energy2 ThePEG::Cuts::sHatMax ( ) const

inline

The maximum allowed value of \(\hat{s}\).

Definition at line 392 of file Cuts.h.

References SMax(), ThePEG::sqr(), theMHatMax, theX1Max, and theX2Max.

Referenced by sHat().

◆ sHatMin()

Energy2 ThePEG::Cuts::sHatMin ( ) const

inline

The minimum allowed value of \(\hat{s}\).

Definition at line 387 of file Cuts.h.

References SMax(), ThePEG::sqr(), theMHatMin, theX1Min, and theX2Min.

Referenced by sHat().

◆ SMax()

Energy2 ThePEG::Cuts::SMax ( ) const

inline

The maximum allowed total invariant mass squared allowed for events to be considered.

Definition at line 358 of file Cuts.h.

References theSMax.

Referenced by mHatMax(), mHatMin(), sHatMax(), and sHatMin().

◆ subMirror()

bool ThePEG::Cuts::subMirror ( ) const

inline

Set true if a matrix element is should be using this cut and is mirrored along the z-axis .

Definition at line 483 of file Cuts.h.

References theSubMirror.

◆ twoCuts()

const TwoCutVector & ThePEG::Cuts::twoCuts ( ) const

inline

Return the objects defining cuts on pairs of particles in the hard sub-process.

Definition at line 321 of file Cuts.h.

References theTwoCuts.

◆ Y()

double ThePEG::Cuts::Y ( ) const

inline

The total rapidity of the colliding particles corresponding to the maximum invariant mass squared, SMax().

Definition at line 365 of file Cuts.h.

References theY.

◆ yHatMax()

double ThePEG::Cuts::yHatMax ( ) const

The maximum value of the rapidity of the hard sub-process (wrt.

the rest system of the colliding particles).

◆ yHatMin()

double ThePEG::Cuts::yHatMin ( ) const

The minimum value of the rapidity of the hard sub-process (wrt.

the rest system of the colliding particles).

Member Data Documentation

◆ initCuts

ClassDescription<Cuts> ThePEG::Cuts::initCuts

staticprivate

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

Indicates that this is a concrete class with persistent data.

Definition at line 794 of file Cuts.h.

◆ theCurrentSHat

Energy2 ThePEG::Cuts::theCurrentSHat

mutableprivate

The invariant mass squared of the hard sub-process of the event being considered.

Definition at line 675 of file Cuts.h.

Referenced by currentSHat().

◆ theCurrentYHat

double ThePEG::Cuts::theCurrentYHat

mutableprivate

The total rapidity of hard sub-process (wrt.

the rest system of the colliding particles so that currentYHat() + Y() gives the true rapidity) of the event being considered.

Definition at line 682 of file Cuts.h.

Referenced by currentYHat().

◆ theCutWeight

double ThePEG::Cuts::theCutWeight

mutableprivate

The overall cut weight.

Definition at line 775 of file Cuts.h.

Referenced by cutWeight().

◆ theFuzzyTheta

Ptr<FuzzyTheta>::ptr ThePEG::Cuts::theFuzzyTheta

private

The fuzziness object.

Definition at line 786 of file Cuts.h.

Referenced by fuzzy().

◆ theJetFinder

Ptr<JetFinder>::ptr ThePEG::Cuts::theJetFinder

private

An optional jet finder used to define cuts on the level of reconstructed jets.

Definition at line 764 of file Cuts.h.

Referenced by jetFinder().

◆ theLastCutWeight

double ThePEG::Cuts::theLastCutWeight

mutableprivate

The cut weight as appropriate from the call to the last n-cut object.

Definition at line 781 of file Cuts.h.

Referenced by lastCutWeight().

◆ theMHatMax

Energy ThePEG::Cuts::theMHatMax

private

The maximum allowed value of \(\sqrt{\hat{s}}\).

Definition at line 692 of file Cuts.h.

Referenced by mHatMax(), and sHatMax().

◆ theMHatMin

Energy ThePEG::Cuts::theMHatMin

private

The minimum allowed value of \(\sqrt{\hat{s}}\).

Definition at line 687 of file Cuts.h.

Referenced by mHatMin(), and sHatMin().

◆ theMultiCuts

MultiCutVector ThePEG::Cuts::theMultiCuts

private

The objects defining cuts on sets of outgoing particles from the hard sub-process.

Definition at line 758 of file Cuts.h.

Referenced by add(), and multiCuts().

◆ theOneCuts

OneCutVector ThePEG::Cuts::theOneCuts

private

The objects defining cuts on single outgoing partons from the hard sub-process.

Definition at line 746 of file Cuts.h.

Referenced by add(), and oneCuts().

◆ theScaleMax

Energy2 ThePEG::Cuts::theScaleMax

private

The maximum allowed value of the scale to be used in PDF's and coupling constants.

Definition at line 740 of file Cuts.h.

Referenced by scaleMax().

◆ theScaleMin

Energy2 ThePEG::Cuts::theScaleMin

private

The minimum allowed value of the scale to be used in PDF's and coupling constants.

Definition at line 734 of file Cuts.h.

Referenced by scaleMin().

◆ theSMax

Energy2 ThePEG::Cuts::theSMax

private

The maximum allowed total invariant mass squared allowed for events to be considered.

Definition at line 663 of file Cuts.h.

Referenced by SMax().

◆ theSubMirror

bool ThePEG::Cuts::theSubMirror

mutableprivate

Set to true if a matrix element is should be using this cut and is mirrored along the z-axis .

Definition at line 770 of file Cuts.h.

Referenced by subMirror().

◆ theTwoCuts

TwoCutVector ThePEG::Cuts::theTwoCuts

private

The objects defining cuts on pairs of particles in the hard sub-process.

Definition at line 752 of file Cuts.h.

Referenced by add(), and twoCuts().

◆ theX1Max

double ThePEG::Cuts::theX1Max

private

The maximum value of the positive light-cone fraction of the hard sub-process.

Definition at line 716 of file Cuts.h.

Referenced by mHatMax(), and sHatMax().

◆ theX1Min

double ThePEG::Cuts::theX1Min

private

The minimum value of the positive light-cone fraction of the hard sub-process.

Definition at line 710 of file Cuts.h.

Referenced by mHatMin(), and sHatMin().

◆ theX2Max

double ThePEG::Cuts::theX2Max

private

The maximum value of the negative light-cone fraction of the hard sub-process.

Definition at line 728 of file Cuts.h.

Referenced by mHatMax(), and sHatMax().

◆ theX2Min

double ThePEG::Cuts::theX2Min

private

The minimum value of the negative light-cone fraction of the hard sub-process.

Definition at line 722 of file Cuts.h.

Referenced by mHatMin(), and sHatMin().

◆ theY

double ThePEG::Cuts::theY

private

The total rapidity of the colliding particles corresponding to the maximum invariant mass squared, SMax().

Definition at line 669 of file Cuts.h.

Referenced by Y().

◆ theYHatMax

double ThePEG::Cuts::theYHatMax

private

The maximum value of the rapidity of the hard sub-process (wrt.

the rest system of the colliding particles).

Definition at line 704 of file Cuts.h.

◆ theYHatMin

double ThePEG::Cuts::theYHatMin

private

The minimum value of the rapidity of the hard sub-process (wrt.

the rest system of the colliding particles).

Definition at line 698 of file Cuts.h.

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

Cuts.h

Public Types

Public Member Functions

Protected Member Functions

Clone Methods.

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ MultiCutVector

◆ OneCutVector

◆ TwoCutVector

Member Function Documentation

◆ add() [1/3]

◆ add() [2/3]

◆ add() [3/3]

◆ clone()

◆ currentSHat()

◆ currentYHat()

◆ cutWeight()

◆ doinitrun()

◆ fullclone()

◆ fuzzy()

◆ Init()

◆ initEvent()

◆ initialize()

◆ initSubProcess()

◆ isInside()

◆ isLargerThan()

◆ isLessThan()

◆ jetFinder()

◆ lastCutWeight()

◆ maxEta()

◆ maxRapidityMin()

◆ maxS()

◆ maxYStar()

◆ mHatMax()

◆ mHatMin()

◆ minDeltaR()

◆ minDurham()

◆ minEta()

◆ minKT()

◆ minKTClus()

◆ minRapidityMax()

◆ minS()

◆ minSij()

◆ minTij()

◆ minYStar()

◆ multiCuts()

◆ oneCuts()

◆ operator=()

◆ passCuts() [1/4]

◆ passCuts() [2/4]

◆ passCuts() [3/4]

◆ passCuts() [4/4]

◆ persistentInput()

◆ persistentOutput()

◆ scale()

◆ scaleMax()

◆ scaleMin()

◆ sHat()

◆ sHatMax()

◆ sHatMin()

◆ SMax()

◆ subMirror()

◆ twoCuts()

◆ Y()

◆ yHatMax()

◆ yHatMin()

Member Data Documentation

◆ initCuts

◆ theCurrentSHat

◆ theCurrentYHat

◆ theCutWeight

◆ theFuzzyTheta

◆ theJetFinder

◆ theLastCutWeight

◆ theMHatMax

◆ theMHatMin

◆ theMultiCuts

◆ theOneCuts