thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.1.5
ThePEG::MadGraphOneCut Class Reference

Objects of the MadGraphOneCut class can be created automatically by the MadGraphReader class when scanning event files for information about cuts. More...

#include <MadGraphOneCut.h>

Inheritance diagram for ThePEG::MadGraphOneCut:

Public Types

enum  Cut { Cut::PT, Cut::ETA, Cut::XPT }
 Enumerate the different kinds of cuts made by MadGraph. More...
 
enum  P { P::JET, P::LEP, P::PHO, P::BOT }
 Enumerate the types of particles the cut is made on. More...
 
- 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.
 MadGraphOneCut ()
 The default constructor.
 
 MadGraphOneCut (Cut t, P p, double c)
 The constructor used by the MadGraphReader. More...
 
Virtual functions mandated by 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. More...
 
virtual double maxEta (tcPDPtr p) const
 Return the maximum allowed pseudo-rapidity of an outgoing parton of the given type. More...
 
virtual Energy minMaxKT (tcPDPtr p) const
 Return the minimum allowed value of the transverse momentum of the outgoing parton with the lagrest transverse momentum. More...
 
virtual bool passCuts (tcCutsPtr parent, tcPDPtr ptype, LorentzMomentum p) const
 Return true if a particle with type ptype and momentum p passes the cuts. More...
 
Functions used by the persistent I/O system.
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- Public Member Functions inherited from ThePEG::OneCutBase
virtual void describe () const
 Describe the currently active cuts in the log file.
 
 OneCutBase ()
 The default constructor.
 
virtual ~OneCutBase ()
 The destructor.
 
virtual double minRapidityMax (tcPDPtr p) const
 Return the minimum allowed rapidity of an outgoing parton of the given type. More...
 
virtual double maxRapidityMin (tcPDPtr p) const
 Return the maximum allowed rapidity of an outgoing parton of the given type. More...
 
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. More...
 
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. More...
 
bool passCuts (tcCutsPtr parent, tcPPtr p) const
 Return true if the given particle passes the cuts. More...
 
- 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. More...
 
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. More...
 
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- 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. More...
 
string name () const
 Returns the name of this object, without the path.
 
string path () const
 Returns the path to this object including the trailing '/'. More...
 
string comment () const
 Returns a comment assigned to this object.
 
void setup (istream &is)
 Read setup info from a standard istream is. More...
 
virtual void debugme () const
 Print out debugging information for this object on std::cerr. More...
 
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). More...
 
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. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- 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. More...
 
- 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 ()
 The standard Init function used to initialize the interfaces. More...
 
- Static Public Member Functions inherited from ThePEG::OneCutBase
static void Init ()
 The standard Init function used to initialize the interfaces. More...
 
- 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. More...
 

Protected Member Functions

bool checkType (tcPDPtr p) const
 Returns true if cut should be applied to a particle of type p.
 
Clone Methods.
virtual IBPtr clone () const
 Make a simple clone of this object. More...
 
virtual IBPtr fullclone () const
 Make a clone of this object, possibly modifying the cloned object to make it sane. More...
 
- 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. More...
 
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
 InterfacedBase ()
 Protected default constructor.
 
 InterfacedBase (string newName)
 Protected constructor with the name given as argument.
 
 InterfacedBase (const InterfacedBase &i)
 Protected copy-constructor.
 
virtual void readSetup (istream &is)
 Read setup info from a standard istream is. More...
 
virtual void doupdate ()
 Check sanity of the object during the setup phase. More...
 
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk. More...
 
virtual void doinitrun ()
 Initialize this object. More...
 
virtual void dofinish ()
 Finalize this object. More...
 
virtual IVector getReferences ()
 Return a vector of all pointers to Interfaced objects used in this object. More...
 
virtual void rebind (const TranslationMap &)
 Rebind pointer to other Interfaced objects. More...
 
- 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

MadGraphOneCutoperator= (const MadGraphOneCut &)=delete
 The assignment operator is private and must never be called. More...
 

Private Attributes

Cut cutType
 The type of this cut.
 
P particleType
 The type of particles this cut applies to.
 
double theCut
 The value of the cut to be applied.
 

Static Private Attributes

static ClassDescription< MadGraphOneCutinitMadGraphOneCut
 The static object used to initialize the description of this class. More...
 

Additional Inherited Members

- Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long uniqueId
 The unique ID. More...
 
- 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

Objects of the MadGraphOneCut class can be created automatically by the MadGraphReader class when scanning event files for information about cuts.

It is also possible to create objects by hand and use it as any other OneCutBase object.

See also
The interfaces defined for MadGraphOneCut.

Definition at line 28 of file MadGraphOneCut.h.

Member Enumeration Documentation

◆ Cut

Enumerate the different kinds of cuts made by MadGraph.

Enumerator
PT 

The minimum transverse momentum of a particle.

ETA 

The maximum (absolute value of) pseudo-rapidity of a particle.

XPT 

The minimum transverse momentum of the particle with largest transverse momentum.

Definition at line 35 of file MadGraphOneCut.h.

◆ P

Enumerate the types of particles the cut is made on.

Enumerator
JET 

The cut applies only to coloured particles.

LEP 

The cut applies only to leptons.

PHO 

The cut applies only to photons.

BOT 

The cut applies only to bottom quarks.

Definition at line 45 of file MadGraphOneCut.h.

Constructor & Destructor Documentation

◆ MadGraphOneCut()

ThePEG::MadGraphOneCut::MadGraphOneCut ( Cut  t,
P  p,
double  c 
)
inline

The constructor used by the MadGraphReader.

Parameters
tis the type of the cut.
pis the type of particles the cut is applied to.
cis the value of the cut (in units of GeV where applicable).

Definition at line 67 of file MadGraphOneCut.h.

References checkType(), clone(), fullclone(), Init(), maxEta(), minEta(), minKT(), minMaxKT(), passCuts(), persistentInput(), and persistentOutput().

Member Function Documentation

◆ clone()

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

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

Referenced by MadGraphOneCut().

◆ fullclone()

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

Referenced by MadGraphOneCut().

◆ Init()

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

Referenced by MadGraphOneCut().

◆ maxEta()

virtual double ThePEG::MadGraphOneCut::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.

Referenced by MadGraphOneCut().

◆ minEta()

virtual double ThePEG::MadGraphOneCut::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.

Referenced by MadGraphOneCut().

◆ minMaxKT()

virtual Energy ThePEG::MadGraphOneCut::minMaxKT ( tcPDPtr  p) const
virtual

Return the minimum allowed value of the transverse momentum of the outgoing parton with the lagrest transverse momentum.

This version simply returns minKt().

Reimplemented from ThePEG::OneCutBase.

Referenced by MadGraphOneCut().

◆ operator=()

MadGraphOneCut& ThePEG::MadGraphOneCut::operator= ( const MadGraphOneCut )
privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ passCuts()

virtual bool ThePEG::MadGraphOneCut::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.

Referenced by MadGraphOneCut().

◆ persistentInput()

void ThePEG::MadGraphOneCut::persistentInput ( PersistentIStream is,
int  version 
)

Function used to read in object persistently.

Parameters
isthe persistent input stream read from.
versionthe version number of the object when written.

Referenced by MadGraphOneCut().

◆ persistentOutput()

void ThePEG::MadGraphOneCut::persistentOutput ( PersistentOStream os) const

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

Referenced by MadGraphOneCut().

Member Data Documentation

◆ initMadGraphOneCut

ClassDescription<MadGraphOneCut> ThePEG::MadGraphOneCut::initMadGraphOneCut
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 184 of file MadGraphOneCut.h.


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