The StandardEventHandler class is the main class for generating simple events without overlayed collisions. More...

#include <StandardEventHandler.h>

Inheritance diagram for ThePEG::StandardEventHandler:

[legend]

Public Types
typedef vector< SubHdlPtr >	SubHandlerList
	A vector of `SubProcessHandler`s.

typedef Selector< StdXCombPtr >	XSelector
	A weighted list of pointers to StandardXComb objects.

typedef vector< StdXCombPtr >	XVector
	A vector of pointers to StandardXComb objects.

typedef vector< CrossSection >	XSVector
	A vector of cross sections.

typedef map< tMEPtr, XVector >	MEXMap
	Map of pointers to StandardXComb objects indexed by pointers to the corresponding MEBase object.

Public Types inherited from ThePEG::EventHandler
enum	ConsistencyLevel { clNoCheck , clCollision , clStep , clPrintCollision , clPrintStep }
	Enumerate the different levels of consistency checking. More...

typedef vector< HandlerGroupBase * >	GroupVector
	A vector of `HandlerGroup`s.

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 Types inherited from ThePEG::LastXCombInfo< XC >
typedef ThePEG::Ptr< XC >::pointer	XCPtr
	Alias for a reference counted pointer to XC .

typedef ThePEG::Ptr< XC >::const_pointer	cXCPtr
	Alias for a reference counted pointer to a const XC .

typedef ThePEG::Ptr< XC >::transient_pointer	tXCPtr
	Alias for a transient pointer to XC .

typedef ThePEG::Ptr< XC >::transient_const_pointer	tcXCPtr
	Alias for a transient pointer to a const XC .

Public Member Functions
Standard constructors and destructors.
	StandardEventHandler ()
	Default constructor.

virtual	~StandardEventHandler ()
	Destructor.

virtual void	initialize ()
	Initialize this event handler and all related objects needed to generate events.

virtual void	statistics (ostream &) const
	Write out accumulated statistics about intergrated cross sections and stuff.

tSamplerPtr	sampler ()
	Return the sampler assigned to this event handler.

tcSamplerPtr	sampler () const
	Return the sampler assigned to this event handler.

virtual CrossSection	histogramScale () const
	Histogram scale.

virtual CrossSection	integratedXSec () const
	The estimated total integrated cross section of the processes generated in this run.

virtual CrossSection	integratedXSecErr () const
	The estimated error int total integrated cross section of the processes generated in this run.

virtual CrossSection	integratedXSecNoReweight () const
	The estimated total integrated cross section of the processes generated in this run, excluding reweighting.

virtual CrossSection	integratedXSecErrNoReweight () const
	The estimated error int total integrated cross section of the processes generated in this run, excluding reweighting.

Functions used for the actual generation
virtual CrossSection	dSigDR (const vector< double > &r)
	Return the cross section for the chosen phase space point.

virtual EventPtr	generateEvent ()
	Generate an event.

virtual EventPtr	continueEvent ()
	Continue generating an event if the generation has been stopped before finishing.

void	reweight (double factor) const
	Reweight a partially generated event.

const XVector &	xCombs () const
	Return the vector of StandardXComb objects.

virtual void	select (tXCombPtr newXComb)
	Change the XComb object.

const LorentzRotation &	currentEventBoost () const
	Return the boost needed to transform the current event from the CMS system to the lab system.

Standard Interfaced functions.
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.

Public Member Functions inherited from ThePEG::EventHandler
	EventHandler (bool warnincomplete=true)
	Default constructor.

	EventHandler (const EventHandler &)
	Copy-constructor.

virtual	~EventHandler ()
	Destructor.

tEventPtr	generateEvent (tEventPtr e)
	Generate an Event, where the initial state is supplied from the outside.

tEventPtr	generateEvent (tStepPtr s)
	Generate an Event, where the initial state is supplied as a single step from the outside.

tCollPtr	continueCollision ()
	Continue the generation of a Collision.

void	clearEvent ()
	Clear all step handlers, making the handler ready for a new event.

virtual bool	empty () const
	Returns true if there are no step handlers left to apply to the current event;.

long	maxLoop () const
	Return the maximum number attemts allowed to select a sub-process for each event.

const cPDPair &	incoming () const
	The pair of incoming particle types.

const LuminosityFunction &	lumiFn () const
	Access the luminosity function.

tcLumiFnPtr	lumiFnPtr () const
	Access the luminosity function.

tLumiFnPtr	lumiFnPtr ()
	Access to the luminosity function.

tCutsPtr	cuts () const
	The kinematical cuts to used by subclasses which do not provide their own.

tPExtrPtr	partonExtractor () const
	A PartonExtractor object to be used by sub classes which do not provide their own.

tCascHdlPtr	cascadeHandler () const
	Return a pointer (possibly null) to the assigned main CascadeHandler.

tCascHdlPtr	CKKWHandler () const
	Return a pointer (possibly null) to the assigned main CascadeHandler to be used as CKKW-reweighter.

tEventPtr	currentEvent () const
	Gget current event.

tCollPtr	currentCollision () const
	Get current collision.

tStepPtr	currentStep () const
	Get current step.

bool	weighted () const
	Return true if this event handler should produce weightes events.

int	statLevel () const
	The level of statistics.

ConsistencyLevel	consistencyLevel () const
	Determines how often the event handler should check for charge and energy-momentum conservation.

double	consistencyEpsilon () const
	The maximum fraction of the total invariant mass of a collision that any of the components of the summed momentum is allowed to change during the generation.

void	performStep (tStepHdlPtr handler, tHintPtr hint)
	Perform a given step using a handler and a hint.

void	addStep (Group::Level, Group::Handler, tStepHdlPtr=tStepHdlPtr(), tHintPtr=tHintPtr())
	In the curresnt list of step handlers to go through, add another step handler and/or hint.

tStepPtr	newStep (tcStepHdlPtr sh)
	Create a new step and make it current.

void	popStep ()
	Remove the last step.

void	currentEvent (tEventPtr e)
	Set current event.

void	currentCollision (tCollPtr c)
	Set current collision.

void	currentStep (tStepPtr s)
	Set current step.

tStepHdlPtr	currentStepHandler () const
	Get current StepHandler.

void	currentStepHandler (tStepHdlPtr sh)
	Set current StepHandler.

void	throwCurrent ()
	Throw away the current event/collision.

virtual void	checkConsistency () const
	Check that the charge and energy-momentum in the last step of the current collision is consistent with the incoming particles.

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::HandlerBaseT< UseRandom >
virtual	~HandlerBaseT ()
	Destructor.

double	rnd () const
	Return a simple flat random number in the range ]0,1[.

double	rnd (double xu) const
	Return a simple flat random number in the range ]0,xu[.

double	rnd (double xl, double xu) const
	Return a simple flat random number in the range ]xl,xu[.

bool	rndbool () const
	Return true with 50% probability.

bool	rndbool (double p) const
	Return a true with probability p.

bool	rndbool (double p1, double p2) const
	Return a true with probability p1/(p1+p2).

int	rndsign (double p1, double p2, double p3) const
	Return -1, 0, or 1 with relative probabilities p1, p2, p3.

int	rnd2 (double p0, double p1) const
	Return an integer \(i\) with probability p \(i\)/(p0+p1).

int	rnd3 (double p0, double p1, double p2) const
	Return an integer \(i\) with probability p \(i\)/(p0+p1+p2).

int	rnd4 (double p0, double p1, double p2, double p3) const
	Return an integer/ \(i\) with probability p \(i\)(p0+p1+p2+p3).

long	irnd (long xu=2) const
	Return a simple flat random integrer number in the range [0,xu[.

long	irnd (long xl, long xu) const
	Return a simple flat random integrer number in the range [xl,xu[.

const StandardModelBase &	SM () const
	Return a reference to the object containing the standard model parameters for this run.

tSMPtr	standardModel () const
	Return a pointer to the object containing the standard model parameters for this run.

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.

Public Member Functions inherited from ThePEG::LastXCombInfo< XC >
const XC &	lastXComb () const
	Return a reference to the last selected XComb.

tXCPtr	lastXCombPtr () const
	Return a pointer to the last selected XComb.

const XC &	lastHeadXComb () const
	If the last selected XComb object belongs to a group of XComb's return a reference to the head XComb object for this group.

tXCPtr	lastHeadXCombPtr () const
	If the last selected XComb object belongs to a group of XComb's return a pointer to the head XComb object for this group.

const EventHandler &	lastEventHandler () const
	Return a reference to the currently used EventHandler.

tPExtrPtr	lastExtractor () const
	A pointer to the currently used parton extractor.

template<typename PDFT >
PDFT	pdf (tcPPtr parton) const
	Return the parton density used to extract the given parton.

const Cuts &	lastCuts () const
	A reference to the currently used kinematical cuts.

tCutsPtr	lastCutsPtr () const
	A pointer to the currently used kinematical cuts.

const PPair &	lastParticles () const
	Return the pair of incoming parton instances.

Energy2	lastS () const
	The last generated total energy squared of the incoming particles.

const PPair &	lastPartons () const
	Return the pair of incoming parton instances.

Energy2	lastSHat () const
	The last used interval in total parton-parton energy squared.

double	lastTau () const
	Return lastSHat()/lastS().

double	lastY () const
	The generated rapidity of the hard scattering sub-system.

double	lastP1 () const
	Log of one over the momentum fraction of the first incoming particle w.r.t.

double	lastP2 () const
	Log of one over the momentum fraction of the second incoming particle w.r.t.

double	lastL1 () const
	Log of one over the first incoming parton momentum fraction w.r.t.

double	lastL2 () const
	Log of one over the second incoming parton momentum fraction w.r.t.

double	lastX1 () const
	The first incoming parton momentum fraction w.r.t.

double	lastX2 () const
	The second incoming parton momentum fraction w.r.t.

double	lastE1 () const
	Return 1-lastX1() to highest possible precision for x \(\rightarrow\) 1.

double	lastE2 () const
	Return 1-lastX2() to highest possible precision for x \(\rightarrow\) 1.

double	lastFL1L2 () const
	The product of the parton density functions at the last generated phase-space point.

Energy2	lastScale () const
	The chosen scale of the hard scattering.

double	lastAlphaS () const
	Get the \(\alpha_S\) used in the hard scattering.

double	lastAlphaEM () const
	Get the \(\alpha_{EM}\) used in the hard scattering.

const vector< Lorentz5Momentum > &	meMomenta () const
	Return the momenta of the incoming and outgoing partons to be used by the matrix element object, in the order specified by the TreeDiagram objects given by the matrix element.

double	lastME2 () const
	Return the matrix element squared as calculated for the last phase space point.

double	lastPreweight () const
	Return the last preweight factor.

double	jacobian () const
	Get the last jacobian obtained when generating the kinematics for the call to dSigHatDR.

CrossSection	lastMECrossSection () const
	Return the partonic cross section as calculated for the last phase space point.

double	lastMEPDFWeight () const
	Return the PDF weight as calculated for the last phase space point, if the matrix element does supply PDF weights.

double	lastMECouplings () const
	Return the coupling weight as calculated for the last phase space point.

tSubProPtr	subProcess () const
	Return the SubProcess object corresponding to the last generated sub-process.

const cPDVector &	mePartonData () const
	Return the incoming and outgoing parton types to be used by the matrix element object, in the order specified by the TreeDiagram objects given by the matrix element.

Clone Methods.
PDPtr	theIncomingA
	The first of the incoming particle types.

PDPtr	theIncomingB
	The second of the incoming particle types.

SubHandlerList	theSubProcesses
	The list of `SubProcessHandler`s.

CutsPtr	theCuts
	The kinematical cuts used for this collision handler.

bool	collisionCuts
	True if cuts on collision objects should be performed.

XVector	theXCombs
	The StandardXComb objects.

vector< int >	theMaxDims
	The number of degrees of freedom needed to generate the phase space for the different bins.

LorentzRotation	theCurrentEventBoost
	The boost needed to transform the current collision from the CMS system to the lab system.

SamplerPtr	theSampler
	The phase space sampler responsible for generating phase space points according to the cross section given by this event handler.

int	theLumiDim
	The number of phase space dimensions used by the luminosity function.

XSecStat	xSecStats
	The overall cross section statistics.

static ClassDescription< StandardEventHandler >	initStandardEventHandler
	Standard Initialization object.

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.

void	reject (double weight)
	Reject a (partially) generated event.

void	setIncomingA (PDPtr)
	Helper function for the interface.

void	setIncomingB (PDPtr)
	Helper function for the interface.

const StandardEventHandler &	operator= (const StandardEventHandler &)=delete
	Private and non-existent assignment operator.

Simple access functions
tCutsPtr	cuts () const
	Return a reference to the Cuts of this EventHandler.

int	nBins () const
	Return the number of separate bins of StandardXComb objects to sample.

int	maxDim (int bin) const
	Return the number of phase space dimensions needed for the sampling of indicated bin of StandardXComb objects.

int	lumiDim () const
	The number of phase space dimensions used by the luminosity function.

int	nDim (int bin) const
	The number of dimensions of the basic phase space to generate sub-processes in for a given bin of StandardXComb objects.

virtual CrossSection	dSigDR (const pair< double, double > ll, Energy2 maxS, int ibin, int nr, const double *r)
	Generate a phase space point and return the corresponding cross section.

tStdXCombPtr	select (int bin, double &weight)
	Select an StandardXComb.

void	addME (Energy maxEnergy, tSubHdlPtr sub, tPExtrPtr extractor, tCutsPtr cuts, tCascHdlPtr ckkw, tMEPtr me, const PBPair &pBins, const PartonPairVec &allPBins)
	Create and add `StandardXComb` objects.

tCollPtr	performCollision ()
	For the sub-procss and phase-space point selected in the previous call to dSigDR, produce the first step of an actual Collision.

virtual void	initGroups ()
	Initialize groups of `StepHandler`s.

LorentzRotation &	currentEventBoost ()
	Return the boost needed to transform the current collision from the CMS system to the lab system.

void	setScale (Energy2)
	Set information about the current sub-process.

XVector &	xCombs ()
	Return the vector of StandardXComb objects.

virtual void	clean ()
	Throw away the last generated event before generating a new one.

const SubHandlerList &	subProcesses () const
	Access the list of sub-process handlers.

SubHandlerList &	subProcesses ()
	Access the list of sub-process handlers.

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 ()
	Standard Init function used to initialize the interface.

Additional Inherited Members
Static Public Member Functions inherited from ThePEG::EventHandler
static void	Init ()
	Standard Init function used to initialize the interface.

Static Public Member Functions inherited from ThePEG::HandlerBase
static void	Init ()
	Standard Init function used to initialize the interface.

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::EventHandler
virtual void	rebind (const TranslationMap &trans)
	Rebind pointer to other Interfaced objects.

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

LuminosityFunction &	lumiFn ()
	Access to the luminosity function.

void	setupGroups ()
	Setup the step handler groups.

GroupVector &	groups ()
	Access the step handler groups.

const GroupVector &	groups () const
	Access the step handler groups.

void	lumiFn (LumiFnPtr)
	Set the luminosity function.

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.

	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.

Protected Attributes inherited from ThePEG::EventHandler
HandlerGroup< SubProcessHandler >	optSubprocessGroup
	Utility object to facilitate default selection of step handlers.

HandlerGroup< CascadeHandler >	optCascadeGroup
	Utility object to facilitate default selection of step handlers.

HandlerGroup< MultipleInteractionHandler >	optMultiGroup
	Utility object to facilitate default selection of step handlers.

HandlerGroup< HadronizationHandler >	optHadronizationGroup
	Utility object to facilitate default selection of step handlers.

HandlerGroup< DecayHandler >	optDecayGroup
	Utility object to facilitate default selection of step handlers.

GroupVector	optGroups
	Utility object to facilitate default selection of step handlers.

bool	warnIncomplete
	Emit warning that this EventHandler is incomplete.

cPDPair	theIncoming
	The pair of incoming particle types.

Protected Attributes inherited from ThePEG::LastXCombInfo< XC >
XCPtr	theLastXComb
	The pointer to the last selected XComb.

Detailed Description

The StandardEventHandler class is the main class for generating simple events without overlayed collisions.

It is derived from the basic EventHandler class.

Besides the standard doinit() method, the StandardEventHandler needs to be separately initialized with the initialize() method. In the dofinish() method statistics is written out to the EventGenerators default output file.

See also: The interfaces defined for StandardEventHandler.; EventHandler; EventGenerator; Event

Definition at line 44 of file StandardEventHandler.h.

Member Typedef Documentation

◆ MEXMap

typedef map<tMEPtr,XVector> ThePEG::StandardEventHandler::MEXMap

Map of pointers to StandardXComb objects indexed by pointers to the corresponding MEBase object.

Definition at line 62 of file StandardEventHandler.h.

◆ SubHandlerList

typedef vector<SubHdlPtr> ThePEG::StandardEventHandler::SubHandlerList

A vector of SubProcessHandlers.

Definition at line 49 of file StandardEventHandler.h.

◆ XSelector

typedef Selector<StdXCombPtr> ThePEG::StandardEventHandler::XSelector

A weighted list of pointers to StandardXComb objects.

Definition at line 52 of file StandardEventHandler.h.

◆ XSVector

typedef vector<CrossSection> ThePEG::StandardEventHandler::XSVector

A vector of cross sections.

Definition at line 58 of file StandardEventHandler.h.

◆ XVector

typedef vector<StdXCombPtr> ThePEG::StandardEventHandler::XVector

A vector of pointers to StandardXComb objects.

Definition at line 55 of file StandardEventHandler.h.

Member Function Documentation

◆ addME()

void ThePEG::StandardEventHandler::addME	(	Energy	maxEnergy,
		tSubHdlPtr	sub,
		tPExtrPtr	extractor,
		tCutsPtr	cuts,
		tCascHdlPtr	ckkw,
		tMEPtr	me,
		const PBPair &	pBins,
		const PartonPairVec &	allPBins
	)

protected

Create and add StandardXComb objects.

Parameters

maxEnergy	the maximum CMS energy of the incoming particles.
sub	a pointer to the SubProcessHandler object.
extractor	a pointer to the PartonExtractor object.
cuts	a pointer to the Cuts object.
ckkw	a pointer to a CascadeHandler to be used for CKKW reweighting.
me	a pointer to the MEBase object.
pBins	a pair of `PartonBin`s describing the partons extracted from the particles
allPBins	all available parton bins at the given energy

◆ clean()

virtual void ThePEG::StandardEventHandler::clean ( )

protectedvirtual

Throw away the last generated event before generating a new one.

Reimplemented from ThePEG::EventHandler.

◆ clone()

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

protectedvirtual

Make a simple clone of this object.

Returns: a pointer to the new object.

Reimplemented from ThePEG::EventHandler.

◆ continueEvent()

virtual EventPtr ThePEG::StandardEventHandler::continueEvent ( )

virtual

Continue generating an event if the generation has been stopped before finishing.

Reimplemented from ThePEG::EventHandler.

◆ currentEventBoost() [1/2]

LorentzRotation & ThePEG::StandardEventHandler::currentEventBoost ( )

inlineprotected

Return the boost needed to transform the current collision from the CMS system to the lab system.

By default this is the unit transformation, but an EventHandler derived from this class may override it.

Definition at line 277 of file StandardEventHandler.h.

References theCurrentEventBoost.

◆ currentEventBoost() [2/2]

const LorentzRotation & ThePEG::StandardEventHandler::currentEventBoost ( ) const

inline

Return the boost needed to transform the current event from the CMS system to the lab system.

Definition at line 177 of file StandardEventHandler.h.

References theCurrentEventBoost.

◆ cuts()

tCutsPtr ThePEG::StandardEventHandler::cuts ( ) const

inline

Return a reference to the Cuts of this EventHandler.

Note that these cuts may be overridden by the SubProcess chosen.

Definition at line 187 of file StandardEventHandler.h.

References theCuts.

◆ dofinish()

virtual void ThePEG::StandardEventHandler::dofinish ( )

virtual

Finalize this object.

Called in the run phase just after a run has ended. Writes out statistics on the generation.

Reimplemented from ThePEG::EventHandler.

◆ doinit()

virtual void ThePEG::StandardEventHandler::doinit ( )

virtual

Initialize this object after the setup phase before saving an EventGenerator to disk.

Exceptions

InitException if object could not be initialized properly.

Reimplemented from ThePEG::InterfacedBase.

◆ doinitrun()

virtual void ThePEG::StandardEventHandler::doinitrun ( )

virtual

Initialize this object.

Called in the run phase just before a run begins.

Reimplemented from ThePEG::InterfacedBase.

◆ doupdate()

virtual void ThePEG::StandardEventHandler::doupdate ( )

virtual

Check sanity of the object during the setup phase.

Reimplemented from ThePEG::InterfacedBase.

◆ dSigDR() [1/2]

virtual CrossSection ThePEG::StandardEventHandler::dSigDR	(	const pair< double, double >	ll,
		Energy2	maxS,
		int	ibin,
		int	nr,
		const double *	r
	)

protectedvirtual

Generate a phase space point and return the corresponding cross section.

Is called from sSigDR(const vector<double> &).

Parameters

ll	a pair of doubles giving the logarithms of the (inverse energy fractions of the maximum CMS energy of the incoming particles.
maxS	the maximum squared CMS energy of the incoming particles.
ibin	the preselected bin of StandardXComb objects to choose sub-process from
nr	the number of random numbers availiable in r.
r	an array of random numbers to be used to generate a phase-space point.

◆ dSigDR() [2/2]

virtual CrossSection ThePEG::StandardEventHandler::dSigDR ( const vector< double > & r )

virtual

Return the cross section for the chosen phase space point.

Parameters

r	a vector of random numbers to be used in the generation of a phase space point.

◆ fullclone()

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

◆ generateEvent()

virtual EventPtr ThePEG::StandardEventHandler::generateEvent ( )

virtual

Generate an event.

Reimplemented from ThePEG::EventHandler.

◆ histogramScale()

virtual CrossSection ThePEG::StandardEventHandler::histogramScale ( ) const

virtual

Histogram scale.

A histogram bin which has been filled with the weights associated with the Event objects should be scaled by this factor to give the correct cross section.

Reimplemented from ThePEG::EventHandler.

◆ initGroups()

virtual void ThePEG::StandardEventHandler::initGroups ( )

protectedvirtual

Initialize groups of StepHandlers.

This overrides the method in the EventHandler, and the StepHandlers given in the currently selected SubProcess take precedence over the ones specified in the EventHandler sub class.

Reimplemented from ThePEG::EventHandler.

◆ initialize()

virtual void ThePEG::StandardEventHandler::initialize ( )

virtual

Initialize this event handler and all related objects needed to generate events.

Reimplemented from ThePEG::EventHandler.

◆ integratedXSec()

virtual CrossSection ThePEG::StandardEventHandler::integratedXSec ( ) const

virtual

The estimated total integrated cross section of the processes generated in this run.

Returns: 0 if no integrated cross section could be estimated.

Reimplemented from ThePEG::EventHandler.

◆ integratedXSecErr()

virtual CrossSection ThePEG::StandardEventHandler::integratedXSecErr ( ) const

virtual

The estimated error int total integrated cross section of the processes generated in this run.

Returns: 0 if no integrated cross section error could be estimated.

Reimplemented from ThePEG::EventHandler.

◆ integratedXSecErrNoReweight()

virtual CrossSection ThePEG::StandardEventHandler::integratedXSecErrNoReweight ( ) const

virtual

The estimated error int total integrated cross section of the processes generated in this run, excluding reweighting.

Returns: 0 if no integrated cross section error could be estimated.

◆ integratedXSecNoReweight()

virtual CrossSection ThePEG::StandardEventHandler::integratedXSecNoReweight ( ) const

virtual

The estimated total integrated cross section of the processes generated in this run, excluding reweighting.

Returns: 0 if no integrated cross section could be estimated.

◆ lumiDim()

int ThePEG::StandardEventHandler::lumiDim ( ) const

inline

The number of phase space dimensions used by the luminosity function.

Definition at line 205 of file StandardEventHandler.h.

References theLumiDim.

Referenced by nDim().

◆ maxDim()

int ThePEG::StandardEventHandler::maxDim ( int bin ) const

inline

Return the number of phase space dimensions needed for the sampling of indicated bin of StandardXComb objects.

Definition at line 199 of file StandardEventHandler.h.

References theMaxDims.

Referenced by nDim().

◆ nDim()

int ThePEG::StandardEventHandler::nDim ( int bin ) const

inline

The number of dimensions of the basic phase space to generate sub-processes in for a given bin of StandardXComb objects.

Definition at line 211 of file StandardEventHandler.h.

References lumiDim(), and maxDim().

◆ persistentInput()

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

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

◆ reject()

void ThePEG::StandardEventHandler::reject ( double weight )

protected

Reject a (partially) generated event.

Parameters

weight the weight given for the event.

◆ sampler() [1/2]

tSamplerPtr ThePEG::StandardEventHandler::sampler ( )

inline

Return the sampler assigned to this event handler.

Definition at line 96 of file StandardEventHandler.h.

References theSampler.

◆ sampler() [2/2]

tcSamplerPtr ThePEG::StandardEventHandler::sampler ( ) const

inline

Return the sampler assigned to this event handler.

Definition at line 101 of file StandardEventHandler.h.

References theSampler.

◆ select() [1/2]

tStdXCombPtr ThePEG::StandardEventHandler::select	(	int	bin,
		double &	weight
	)

protected

Select an StandardXComb.

Given a preselected bin, ibin of StandardXComb objects pick one to generate the corresponding sub-process with the given weight.

◆ select() [2/2]

virtual void ThePEG::StandardEventHandler::select ( tXCombPtr newXComb )

virtual

Change the XComb object.

Reimplemented from ThePEG::EventHandler.

◆ statistics()

virtual void ThePEG::StandardEventHandler::statistics ( ostream & ) const

virtual

Write out accumulated statistics about intergrated cross sections and stuff.

Reimplemented from ThePEG::EventHandler.

◆ subProcesses() [1/2]

SubHandlerList & ThePEG::StandardEventHandler::subProcesses ( )

inlineprivate

Access the list of sub-process handlers.

Definition at line 304 of file StandardEventHandler.h.

References theSubProcesses.

◆ subProcesses() [2/2]

const SubHandlerList & ThePEG::StandardEventHandler::subProcesses ( ) const

inlineprivate

Access the list of sub-process handlers.

Definition at line 299 of file StandardEventHandler.h.

References theSubProcesses.

◆ xCombs() [1/2]

XVector & ThePEG::StandardEventHandler::xCombs ( )

inlineprotected

Return the vector of StandardXComb objects.

Definition at line 287 of file StandardEventHandler.h.

References theXCombs.

◆ xCombs() [2/2]

const XVector & ThePEG::StandardEventHandler::xCombs ( ) const

inline

Return the vector of StandardXComb objects.

Definition at line 166 of file StandardEventHandler.h.

References theXCombs.

Member Data Documentation

◆ collisionCuts

bool ThePEG::StandardEventHandler::collisionCuts

private

True if cuts on collision objects should be performed.

Definition at line 405 of file StandardEventHandler.h.

◆ initStandardEventHandler

ClassDescription<StandardEventHandler> ThePEG::StandardEventHandler::initStandardEventHandler

staticprivate

Standard Initialization object.

Definition at line 445 of file StandardEventHandler.h.

◆ theCurrentEventBoost

LorentzRotation ThePEG::StandardEventHandler::theCurrentEventBoost

private

The boost needed to transform the current collision from the CMS system to the lab system.

Definition at line 422 of file StandardEventHandler.h.

Referenced by currentEventBoost().

◆ theCuts

CutsPtr ThePEG::StandardEventHandler::theCuts

private

The kinematical cuts used for this collision handler.

Definition at line 400 of file StandardEventHandler.h.

Referenced by cuts().

◆ theIncomingA

PDPtr ThePEG::StandardEventHandler::theIncomingA

private

The first of the incoming particle types.

Definition at line 385 of file StandardEventHandler.h.

◆ theIncomingB

PDPtr ThePEG::StandardEventHandler::theIncomingB

private

The second of the incoming particle types.

Definition at line 390 of file StandardEventHandler.h.

◆ theLumiDim

int ThePEG::StandardEventHandler::theLumiDim

private

The number of phase space dimensions used by the luminosity function.

Definition at line 435 of file StandardEventHandler.h.

Referenced by lumiDim().

◆ theMaxDims

vector<int> ThePEG::StandardEventHandler::theMaxDims

private

The number of degrees of freedom needed to generate the phase space for the different bins.

Definition at line 416 of file StandardEventHandler.h.

Referenced by maxDim().

◆ theSampler

SamplerPtr ThePEG::StandardEventHandler::theSampler

private

The phase space sampler responsible for generating phase space points according to the cross section given by this event handler.

Definition at line 429 of file StandardEventHandler.h.

Referenced by sampler().

◆ theSubProcesses

SubHandlerList ThePEG::StandardEventHandler::theSubProcesses

private

The list of SubProcessHandlers.

Definition at line 395 of file StandardEventHandler.h.

Referenced by subProcesses().

◆ theXCombs

XVector ThePEG::StandardEventHandler::theXCombs

private

The StandardXComb objects.

Definition at line 410 of file StandardEventHandler.h.

Referenced by xCombs().

◆ xSecStats

XSecStat ThePEG::StandardEventHandler::xSecStats

mutableprivate

The overall cross section statistics.

Definition at line 440 of file StandardEventHandler.h.

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

StandardEventHandler.h

Public Types

Public Member Functions

Clone Methods.

Simple access functions

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ MEXMap

◆ SubHandlerList

◆ XSelector

◆ XSVector

◆ XVector

Member Function Documentation

◆ addME()

◆ clean()

◆ clone()

◆ continueEvent()

◆ currentEventBoost() [1/2]

◆ currentEventBoost() [2/2]

◆ cuts()

◆ dofinish()

◆ doinit()

◆ doinitrun()

◆ doupdate()

◆ dSigDR() [1/2]

◆ dSigDR() [2/2]

◆ fullclone()

◆ generateEvent()

◆ histogramScale()

◆ initGroups()

◆ initialize()

◆ integratedXSec()

◆ integratedXSecErr()

◆ integratedXSecErrNoReweight()

◆ integratedXSecNoReweight()

◆ lumiDim()

◆ maxDim()

◆ nDim()

◆ persistentInput()

◆ persistentOutput()

◆ reject()

◆ sampler() [1/2]

◆ sampler() [2/2]

◆ select() [1/2]

◆ select() [2/2]

◆ statistics()

◆ subProcesses() [1/2]

◆ subProcesses() [2/2]

◆ xCombs() [1/2]

◆ xCombs() [2/2]

Member Data Documentation

◆ collisionCuts

◆ initStandardEventHandler

◆ theCurrentEventBoost

◆ theCuts

◆ theIncomingA

◆ theIncomingB

◆ theLumiDim

◆ theMaxDims

◆ theSampler

◆ theSubProcesses

◆ theXCombs

◆ xSecStats