thepeg is hosted by Hepforge, IPPP Durham
ThePEG 2.3.0
ThePEG::MECuts Class Reference

The MECuts class is (currently not at all) used to make cuts on generated phase space points for the hard interaction. More...

#include <MECuts.h>

Inheritance diagram for ThePEG::MECuts:

Public Member Functions

 MECuts ()
 Standard ctors and dtor.
 
void cut (const SubProcess &) const
 This method is called by the EventHandler with the primary SubProcess provided in its cm frame.
 
Energy mHatMin () const
 The minimum and maximum values of the invariant mass (squared) of the hard sub-process.
 
Energy mHatMax () const
 The minimum and maximum values of the invariant mass (squared) of the hard sub-process.
 
Energy sHatMin () const
 The minimum and maximum values of the invariant mass (squared) of the hard sub-process.
 
Energy sHatMax () const
 The minimum and maximum values of the invariant mass (squared) of the hard sub-process.
 
Energy pTHatMin () const
 The minimum and maximum values of the transverse momentum of the outgoing particles in the hard sub-process.
 
Energy pTHatMax () const
 The minimum and maximum values of the transverse momentum of the outgoing particles in the hard sub-process.
 
Energy pTHatSingularMin () const
 Additional cut on the transverse momenta of the hard sub-process for s-channel hard sub-processes for outgoing particles of mass less than singularMassMax().
 
Energy singularMassMax () const
 Additional cut on the transverse momenta of the hard sub-process for s-channel hard sub-processes for outgoing particles of mass less than singularMassMax().
 
double cTHMin () const
 The minimum and maximum value of cosine of the scattering angle in the restframe of a hard 2->2 scattering.
 
double cTHMax () const
 The minimum and maximum value of cosine of the scattering angle in the restframe of a hard 2->2 scattering.
 
Energy2 tHatMin () const
 The minimum and maximum value of that of a hard 2->2 scattering.
 
Energy2 tHatMax () const
 The minimum and maximum value of that of a hard 2->2 scattering.
 
Energy2 uHatMin () const
 The minimum and maximum value of uhat of a hard 2->2 scattering.
 
Energy2 uHatMax () const
 The minimum and maximum value of uhat of a hard 2->2 scattering.
 
Energy2 scaleMin () const
 The minimum and maximum value of the scale in a hard scattering as defined by the Handlers which performed the hard scattering.
 
Energy2 scaleMax () const
 The minimum and maximum value of the scale in a hard scattering as defined by the Handlers which performed the hard scattering.
 
void persistentOutput (PersistentOStream &) const
 Standard functions for writing and reading from persistent streams.
 
void persistentInput (PersistentIStream &, int)
 Standard functions for writing and reading from persistent streams.
 
- Public Member Functions inherited from ThePEG::Interfaced
virtual ~Interfaced ()
 Empty virtual destructor.
 
virtual bool defaultInit ()
 Functions which are to be used during the actual event generation, after the setup is complete.
 
PPtr getParticle (PID) const
 Create a new Particle instance given a id number.
 
PDPtr getParticleData (PID) const
 Return a pointer to the ParticleData object corresponding to the given id number.
 
bool used () const
 Returns true if this object has actally been used.
 
void useMe () const
 Should be called to indicate that this object has actually been used.
 
tEGPtr generator () const
 Return a pointer to the EventGenerator controlling the run.
 
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently.
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently.
 
- Public Member Functions inherited from ThePEG::InterfacedBase
virtual ~InterfacedBase ()
 The virtual (empty) destructor;.
 
string fullName () const
 Returns the full name of this object including its path, e.g.
 
string name () const
 Returns the name of this object, without the path.
 
string path () const
 Returns the path to this object including the trailing '/'.
 
string comment () const
 Returns a comment assigned to this object.
 
void setup (istream &is)
 Read setup info from a standard istream is.
 
void update ()
 Calls the doupdate() function with recursion prevention.
 
void init ()
 Calls the doinit() function with recursion prevention.
 
virtual bool preInitialize () const
 Return true if this object needs to be initialized before all other objects (except those for which this function also returns true).
 
void initrun ()
 Calls the doinitrun() function with recursion prevention.
 
void finish ()
 Calls the dofinish() function with recursion prevention.
 
void touch ()
 This function should be called every time something in this object has changed in a way that a sanity check with update() is needed.
 
void reset ()
 Set the state of this object to uninitialized.
 
void clear ()
 Calls reset() and unTouch().
 
InitState state () const
 Return the state of initialization of this object.
 
bool locked () const
 Return true if the BaseRepository is not allowed to change the state of this object.
 
bool touched () const
 Return true if the state of this object has been changed since the last call to update().
 
virtual IBPtr fullclone () const
 Return a full clone of this object possibly doing things to the clone to make it sane.
 
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently.
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently.
 
virtual void debugme () const
 Print out debugging information for this object on std::cerr.
 
- Public Member Functions inherited from ThePEG::Base
virtual ~Base ()
 The virtual destructor.
 
void debug () const
 Print out debugging information for this object on std::cerr.
 
virtual void debugme () const
 Print out debugging information for this object on std::cerr.
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 Return the reference count.
 
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 Constructor with name.
 
 Named (const Named &)=default
 Explicit default copy-constructor (too avoid compiler warnings)
 
const string & name () const
 Return name.
 
bool operator== (const Named &other) const
 Test for equality.
 
bool operator< (const Named &other) const
 Lexicographical comparison.
 

Static Public Member Functions

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.
 

Protected Member Functions

virtual void newcut (const SubProcess &) const
 This method is called by the corresponding cut method with the primary SubProcess provided in its cm frame.
 
virtual void doupdate ()
 Standard Interfaced virtual functions.
 
virtual IBPtr clone () const
 Standard clone method.
 
- 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 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.
 
ReferenceCountedoperator= (const ReferenceCounted &)
 Assignment.
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (const Named &other)
 Assignment.
 
const string & name (const string &newName)
 Set new name.
 

Private Member Functions

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

Private Attributes

Energy theMHatMin
 The minimum and maximum values of the invariant mass of the hard sub-process.
 
Energy theMHatMax
 The minimum and maximum values of the invariant mass of the hard sub-process.
 
Energy thePTHatMin
 The minimum and maximum values of the transverse momentum of the outgoing particles in the hard sub-process.
 
Energy thePTHatMax
 The minimum and maximum values of the transverse momentum of the outgoing particles in the hard sub-process.
 
Energy thePTHatSingularMin
 Additional cut on the transverse momenta of the hard sub-process for s-channel hard sub-processes for outgoing particles of mass less than theSingularMassMax.
 
Energy theSingularMassMax
 Additional cut on the transverse momenta of the hard sub-process for s-channel hard sub-processes for outgoing particles of mass less than theSingularMassMax.
 
double theCTHMin
 The minimum and maximum value of cosine of the scattering angle in the restframe of a hard 2->2 scattering.
 
double theCTHMax
 The minimum and maximum value of cosine of the scattering angle in the restframe of a hard 2->2 scattering.
 
Energy2 theTHatMin
 The minimum and maximum value of that of a hard 2->2 scattering.
 
Energy2 theTHatMax
 The minimum and maximum value of that of a hard 2->2 scattering.
 
Energy2 theUHatMin
 The minimum and maximum value of uhat of a hard 2->2 scattering.
 
Energy2 theUHatMax
 The minimum and maximum value of uhat of a hard 2->2 scattering.
 
Energy2 theScaleMin
 The minimum and maximum value of the scale in a hard scattering as defined by the Handlers which performed the hard scattering.
 
Energy2 theScaleMax
 The minimum and maximum value of the scale in a hard scattering as defined by the Handlers which performed the hard scattering.
 

Static Private Attributes

static ClassDescription< MECutsinitMECuts
 Describe a concrete class with persistent data.
 

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

The MECuts class is (currently not at all) used to make cuts on generated phase space points for the hard interaction.

A MECuts object is selected for each matrix element. The EventHandler has a default MECuts object, which may be overridden by the selected SubProcessHandler object, which in turn may be overridden by the selected MEBase object.

The MECuts is used in two different ways. Individual handlers may use the specific member functions which specify cuts on individual variables. In addition the cut() member functions are always called by the EventHandler to automatically check that all cuts are passed. It is possible to derive new classes from the MECuts class, in which case the virtual newcut() methods may be overridden and will be called from the cut() methods.

See also
EventHandler
SubProcessHandler
MEBase
Collision
SubProcess

Definition at line 44 of file MECuts.h.

Member Function Documentation

◆ clone()

virtual IBPtr ThePEG::MECuts::clone ( ) const
protectedvirtual

Standard clone method.

Implements ThePEG::InterfacedBase.

◆ cTHMax()

double ThePEG::MECuts::cTHMax ( ) const
inline

The minimum and maximum value of cosine of the scattering angle in the restframe of a hard 2->2 scattering.

Definition at line 121 of file MECuts.h.

References theCTHMax.

◆ cTHMin()

double ThePEG::MECuts::cTHMin ( ) const
inline

The minimum and maximum value of cosine of the scattering angle in the restframe of a hard 2->2 scattering.

Definition at line 116 of file MECuts.h.

References theCTHMin.

◆ doupdate()

virtual void ThePEG::MECuts::doupdate ( )
protectedvirtual

Standard Interfaced virtual functions.

Reimplemented from ThePEG::InterfacedBase.

◆ mHatMax()

Energy ThePEG::MECuts::mHatMax ( ) const
inline

The minimum and maximum values of the invariant mass (squared) of the hard sub-process.

Definition at line 72 of file MECuts.h.

References ThePEG::Constants::MaxEnergy, mHatMin(), and theMHatMax.

Referenced by sHatMax().

◆ mHatMin()

Energy ThePEG::MECuts::mHatMin ( ) const
inline

The minimum and maximum values of the invariant mass (squared) of the hard sub-process.

Definition at line 67 of file MECuts.h.

References theMHatMin.

Referenced by mHatMax(), and sHatMin().

◆ newcut()

virtual void ThePEG::MECuts::newcut ( const SubProcess ) const
protectedvirtual

This method is called by the corresponding cut method with the primary SubProcess provided in its cm frame.

This bas-class method does nothing.

◆ pTHatMax()

Energy ThePEG::MECuts::pTHatMax ( ) const
inline

The minimum and maximum values of the transverse momentum of the outgoing particles in the hard sub-process.

Definition at line 95 of file MECuts.h.

References ThePEG::Constants::MaxEnergy, pTHatMin(), and thePTHatMax.

◆ pTHatMin()

Energy ThePEG::MECuts::pTHatMin ( ) const
inline

The minimum and maximum values of the transverse momentum of the outgoing particles in the hard sub-process.

Definition at line 90 of file MECuts.h.

References thePTHatMin.

Referenced by pTHatMax().

◆ pTHatSingularMin()

Energy ThePEG::MECuts::pTHatSingularMin ( ) const
inline

Additional cut on the transverse momenta of the hard sub-process for s-channel hard sub-processes for outgoing particles of mass less than singularMassMax().

Definition at line 104 of file MECuts.h.

References thePTHatSingularMin.

◆ scaleMax()

Energy2 ThePEG::MECuts::scaleMax ( ) const
inline

The minimum and maximum value of the scale in a hard scattering as defined by the Handlers which performed the hard scattering.

Definition at line 154 of file MECuts.h.

References ThePEG::Constants::MaxEnergy2, scaleMin(), and theScaleMax.

◆ scaleMin()

Energy2 ThePEG::MECuts::scaleMin ( ) const
inline

The minimum and maximum value of the scale in a hard scattering as defined by the Handlers which performed the hard scattering.

Definition at line 149 of file MECuts.h.

References theScaleMin.

Referenced by scaleMax().

◆ sHatMax()

Energy ThePEG::MECuts::sHatMax ( ) const
inline

The minimum and maximum values of the invariant mass (squared) of the hard sub-process.

Definition at line 84 of file MECuts.h.

References mHatMax(), and ThePEG::sqr().

◆ sHatMin()

Energy ThePEG::MECuts::sHatMin ( ) const
inline

The minimum and maximum values of the invariant mass (squared) of the hard sub-process.

Definition at line 79 of file MECuts.h.

References mHatMin(), and ThePEG::sqr().

◆ singularMassMax()

Energy ThePEG::MECuts::singularMassMax ( ) const
inline

Additional cut on the transverse momenta of the hard sub-process for s-channel hard sub-processes for outgoing particles of mass less than singularMassMax().

Definition at line 110 of file MECuts.h.

References theSingularMassMax.

◆ tHatMax()

Energy2 ThePEG::MECuts::tHatMax ( ) const
inline

The minimum and maximum value of that of a hard 2->2 scattering.

Definition at line 130 of file MECuts.h.

References ThePEG::Constants::MaxEnergy2, tHatMin(), and theTHatMax.

◆ tHatMin()

Energy2 ThePEG::MECuts::tHatMin ( ) const
inline

The minimum and maximum value of that of a hard 2->2 scattering.

Definition at line 126 of file MECuts.h.

References theTHatMin.

Referenced by tHatMax().

◆ uHatMax()

Energy2 ThePEG::MECuts::uHatMax ( ) const
inline

The minimum and maximum value of uhat of a hard 2->2 scattering.

Definition at line 141 of file MECuts.h.

References ThePEG::Constants::MaxEnergy2, theUHatMax, and uHatMin().

◆ uHatMin()

Energy2 ThePEG::MECuts::uHatMin ( ) const
inline

The minimum and maximum value of uhat of a hard 2->2 scattering.

Definition at line 137 of file MECuts.h.

References theUHatMin.

Referenced by uHatMax().

Member Data Documentation

◆ initMECuts

ClassDescription<MECuts> ThePEG::MECuts::initMECuts
staticprivate

Describe a concrete class with persistent data.

Definition at line 277 of file MECuts.h.

◆ theCTHMax

double ThePEG::MECuts::theCTHMax
private

The minimum and maximum value of cosine of the scattering angle in the restframe of a hard 2->2 scattering.

Definition at line 241 of file MECuts.h.

Referenced by cTHMax().

◆ theCTHMin

double ThePEG::MECuts::theCTHMin
private

The minimum and maximum value of cosine of the scattering angle in the restframe of a hard 2->2 scattering.

Definition at line 236 of file MECuts.h.

Referenced by cTHMin().

◆ theMHatMax

Energy ThePEG::MECuts::theMHatMax
private

The minimum and maximum values of the invariant mass of the hard sub-process.

Definition at line 206 of file MECuts.h.

Referenced by mHatMax().

◆ theMHatMin

Energy ThePEG::MECuts::theMHatMin
private

The minimum and maximum values of the invariant mass of the hard sub-process.

Definition at line 201 of file MECuts.h.

Referenced by mHatMin().

◆ thePTHatMax

Energy ThePEG::MECuts::thePTHatMax
private

The minimum and maximum values of the transverse momentum of the outgoing particles in the hard sub-process.

Definition at line 217 of file MECuts.h.

Referenced by pTHatMax().

◆ thePTHatMin

Energy ThePEG::MECuts::thePTHatMin
private

The minimum and maximum values of the transverse momentum of the outgoing particles in the hard sub-process.

Definition at line 212 of file MECuts.h.

Referenced by pTHatMin().

◆ thePTHatSingularMin

Energy ThePEG::MECuts::thePTHatSingularMin
private

Additional cut on the transverse momenta of the hard sub-process for s-channel hard sub-processes for outgoing particles of mass less than theSingularMassMax.

Definition at line 224 of file MECuts.h.

Referenced by pTHatSingularMin().

◆ theScaleMax

Energy2 ThePEG::MECuts::theScaleMax
private

The minimum and maximum value of the scale in a hard scattering as defined by the Handlers which performed the hard scattering.

Definition at line 270 of file MECuts.h.

Referenced by scaleMax().

◆ theScaleMin

Energy2 ThePEG::MECuts::theScaleMin
private

The minimum and maximum value of the scale in a hard scattering as defined by the Handlers which performed the hard scattering.

Definition at line 265 of file MECuts.h.

Referenced by scaleMin().

◆ theSingularMassMax

Energy ThePEG::MECuts::theSingularMassMax
private

Additional cut on the transverse momenta of the hard sub-process for s-channel hard sub-processes for outgoing particles of mass less than theSingularMassMax.

Definition at line 230 of file MECuts.h.

Referenced by singularMassMax().

◆ theTHatMax

Energy2 ThePEG::MECuts::theTHatMax
private

The minimum and maximum value of that of a hard 2->2 scattering.

Definition at line 250 of file MECuts.h.

Referenced by tHatMax().

◆ theTHatMin

Energy2 ThePEG::MECuts::theTHatMin
private

The minimum and maximum value of that of a hard 2->2 scattering.

Definition at line 246 of file MECuts.h.

Referenced by tHatMin().

◆ theUHatMax

Energy2 ThePEG::MECuts::theUHatMax
private

The minimum and maximum value of uhat of a hard 2->2 scattering.

Definition at line 259 of file MECuts.h.

Referenced by uHatMax().

◆ theUHatMin

Energy2 ThePEG::MECuts::theUHatMin
private

The minimum and maximum value of uhat of a hard 2->2 scattering.

Definition at line 255 of file MECuts.h.

Referenced by uHatMin().


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