The KTRapidityCut class is a simple concrete sub-class of OneCutbase simply requiring a minimum transverse momentum of any outgoing particle. More...

#include <KTRapidityCut.h>

Inheritance diagram for ThePEG::KTRapidityCut:

[legend]

Public Member Functions
	KTRapidityCut (Energy minKT=10 *GeV)
	The default constructor.

Overwritten virtual functions defined in the base class.
virtual Energy	minKT (tcPDPtr p) const
	Return the minimum allowed value of the transverse momentum of an outgoing parton.

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

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

virtual bool	passCuts (tcCutsPtr parent, tcPDPtr ptype, LorentzMomentum p) const
	Return true if a particle with type ptype and momentum p passes the cuts.

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

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

virtual	~OneCutBase ()
	The destructor.

virtual Energy	minMaxKT (tcPDPtr p) const
	Return the minimum allowed value of the transverse momentum of the outgoing parton with the lagrest transverse momentum.

virtual double	minMaxEta (tcPDPtr p) const
	Return the minimum allowed pseudo-rapidity of the outgoing parton of the given type with the maximum pseudo-rapidity.

virtual double	maxMinEta (tcPDPtr p) const
	Return the maximum allowed pseudo-rapidity of the outgoing parton of the given type with the minimum pseudo-rapidity.

bool	passCuts (tcCutsPtr parent, tcPPtr p) const
	Return true if the given particle passes the cuts.

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.
Energy	theMinKT
	The minimum allowed value of the transverse momentum of an outgoing parton.

Energy	theMaxKT
	The maximum allowed value of the transverse momentum of an outgoing parton.

double	theMinRapidity
	The minimum allowed rapidity of an outgoing parton.

double	theMaxRapidity
	The maximum allowed rapidity of an outgoing parton.

PMPtr	theMatcher
	If non-null only particles matching this object will be affected by this cut.

static ClassDescription< KTRapidityCut >	initKTRapidityCut
	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	maxKTMin () const
	Helper function used by the interface.

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

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

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

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

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

KTRapidityCut &	operator= (const KTRapidityCut &)=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::OneCutBase
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	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.

	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

The KTRapidityCut class is a simple concrete sub-class of OneCutbase simply requiring a minimum transverse momentum of any outgoing particle.

It is also possible to require a minimum and maximum rapidity. Optionally the restrictions only apply to particles matching a specific matcher object.

See also: The interfaces defined for KTRapidityCut.; SimpleKtCut

Definition at line 23 of file KTRapidityCut.h.

Constructor & Destructor Documentation

◆ KTRapidityCut()

ThePEG::KTRapidityCut::KTRapidityCut ( Energy minKT = 10*GeV )

inline

The default constructor.

Definition at line 30 of file KTRapidityCut.h.

Member Function Documentation

◆ clone()

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

protectedvirtual

Make a simple clone of this object.

Returns: a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ describe()

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

virtual

Describe the currently active cuts in the log file.

Reimplemented from ThePEG::OneCutBase.

◆ fullclone()

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

◆ maxEta()

virtual double ThePEG::KTRapidityCut::maxEta ( tcPDPtr p ) const

virtual

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

The pseudo-rapidity is measured in the lab system.

Implements ThePEG::OneCutBase.

◆ maxRapidityMin()

virtual double ThePEG::KTRapidityCut::maxRapidityMin ( tcPDPtr p ) const

privatevirtual

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

The rapidity is measured in the lab system.

Reimplemented from ThePEG::OneCutBase.

◆ minEta()

virtual double ThePEG::KTRapidityCut::minEta ( tcPDPtr p ) const

virtual

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

The pseudo-rapidity is measured in the lab system.

Implements ThePEG::OneCutBase.

◆ minKT()

virtual Energy ThePEG::KTRapidityCut::minKT ( tcPDPtr p ) const

virtual

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

Implements ThePEG::OneCutBase.

◆ minRapidityMax()

virtual double ThePEG::KTRapidityCut::minRapidityMax ( tcPDPtr p ) const

privatevirtual

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

The rapidity is measured in the lab system.

Reimplemented from ThePEG::OneCutBase.

◆ operator=()

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

privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ passCuts()

virtual bool ThePEG::KTRapidityCut::passCuts	(	tcCutsPtr	parent,
		tcPDPtr	ptype,
		LorentzMomentum	p
	)		const

virtual

Return true if a particle with type ptype and momentum p passes the cuts.

The parent contains information about the kinematics of the hard sub-process.

Reimplemented from ThePEG::OneCutBase.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

Member Data Documentation

◆ initKTRapidityCut

ClassDescription<KTRapidityCut> ThePEG::KTRapidityCut::initKTRapidityCut

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 190 of file KTRapidityCut.h.

◆ theMatcher

PMPtr ThePEG::KTRapidityCut::theMatcher

private

If non-null only particles matching this object will be affected by this cut.

Definition at line 182 of file KTRapidityCut.h.

◆ theMaxKT

Energy ThePEG::KTRapidityCut::theMaxKT

private

The maximum allowed value of the transverse momentum of an outgoing parton.

Definition at line 164 of file KTRapidityCut.h.

◆ theMaxRapidity

double ThePEG::KTRapidityCut::theMaxRapidity

private

The maximum allowed rapidity of an outgoing parton.

The rapidity is measured in the lab system.

Definition at line 176 of file KTRapidityCut.h.

◆ theMinKT

Energy ThePEG::KTRapidityCut::theMinKT

private

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

Definition at line 158 of file KTRapidityCut.h.

◆ theMinRapidity

double ThePEG::KTRapidityCut::theMinRapidity

private

The minimum allowed rapidity of an outgoing parton.

The rapidity is measured in the lab system.

Definition at line 170 of file KTRapidityCut.h.

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

KTRapidityCut.h

Public Member Functions

Clone Methods.

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KTRapidityCut()

Member Function Documentation

◆ clone()

◆ describe()

◆ fullclone()

◆ Init()

◆ maxEta()

◆ maxRapidityMin()

◆ minEta()

◆ minKT()

◆ minRapidityMax()

◆ operator=()

◆ passCuts()

◆ persistentInput()

◆ persistentOutput()

Member Data Documentation

◆ initKTRapidityCut

◆ theMatcher

◆ theMaxKT

◆ theMaxRapidity

◆ theMinKT

◆ theMinRapidity