Logo ROOT   6.12/07
Reference Guide
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | List of all members
TPythia8 Class Reference

TPythia8 is an interface class to C++ version of Pythia 8.1 event generators, written by T.Sjostrand.

The user is assumed to be familiar with the Pythia package. This class includes only a basic interface to Pythia8. Because Pythia8 is also written in C++, its functions/classes can be called directly from a compiled C++ script.

To call Pythia functions not available in this interface a dictionary must be generated.

See $ROOTSYS/tutorials/pythia/pythia8.C for an example of use from CINT.

Author: Andreas Morsch 27/10/2007

*------------------------------------------------------------------------------------*
 |                                                                                    |
 |  *------------------------------------------------------------------------------*  |
 |  |                                                                              |  |
 |  |                                                                              |  |
 |  |   PPP   Y   Y  TTTTT  H   H  III    A      Welcome to the Lund Monte Carlo!  |  |
 |  |   P  P   Y Y     T    H   H   I    A A     This is PYTHIA version 8.100      |  |
 |  |   PPP     Y      T    HHHHH   I   AAAAA    Last date of change: 20 Oct 2007  |  |
 |  |   P       Y      T    H   H   I   A   A                                      |  |
 |  |   P       Y      T    H   H  III  A   A    Now is 27 Oct 2007 at 18:26:53    |  |
 |  |                                                                              |  |
 |  |   Main author: Torbjorn Sjostrand; CERN/PH, CH-1211 Geneva, Switzerland,     |  |
 |  |     and Department of Theoretical Physics, Lund University, Lund, Sweden;    |  |
 |  |     phone: + 41 - 22 - 767 82 27; e-mail: torbjorn@thep.lu.se                |  |
 |  |   Author: Stephen Mrenna; Computing Division, Simulations Group,             |  |
 |  |     Fermi National Accelerator Laboratory, MS 234, Batavia, IL 60510, USA;   |  |
 |  |     phone: + 1 - 630 - 840 - 2556; e-mail: mrenna@fnal.gov                   |  |
 |  |   Author: Peter Skands; CERN/PH, CH-1211 Geneva, Switzerland,                |  |
 |  |     and Theoretical Physics Department,                                      |  |
 |  |     Fermi National Accelerator Laboratory, MS 106, Batavia, IL 60510, USA;   |  |
 |  |     phone: + 41 - 22 - 767 24 59; e-mail: skands@fnal.gov                    |  |
 |  |                                                                              |  |
 |  |   The main program reference is the 'Brief Introduction to PYTHIA 8.1',      |  |
 |  |   T. Sjostrand, S. Mrenna and P. Skands, arXiv:0710.3820                     |  |
 |  |                                                                              |  |
 |  |   The main physics reference is the 'PYTHIA 6.4 Physics and Manual',         |  |
 |  |   T. Sjostrand, S. Mrenna and P. Skands, JHEP05 (2006) 026 [hep-ph/0603175]. |  |
 |  |                                                                              |  |
 |  |   An archive of program versions and documentation is found on the web:      |  |
 |  |   http://www.thep.lu.se/~torbjorn/Pythia.html                                |  |
 |  |                                                                              |  |
 |  |   This program is released under the GNU General Public Licence version 2.   |  |
 |  |   Please respect the MCnet Guidelines for Event Generator Authors and Users. |  |
 |  |                                                                              |  |
 |  |   Disclaimer: this program comes without any guarantees.                     |  |
 |  |   Beware of errors and use common sense when interpreting results.           |  |
 |  |                                                                              |  |
 |  |   Copyright (C) 2007 Torbjorn Sjostrand                                      |  |
 |  |                                                                              |  |
 |  |                                                                              |  |
 |  *------------------------------------------------------------------------------*  |
 |                                                                                    |
 *------------------------------------------------------------------------------------*

Definition at line 76 of file TPythia8.h.

Public Member Functions

 TPythia8 ()
 Number of particles. More...
 
 TPythia8 (const char *xmlDir)
 Constructor with an xmlDir (eg "../xmldoc". More...
 
virtual ~TPythia8 ()
 Destructor. More...
 
void EventListing () const
 Event listing. More...
 
virtual void GenerateEvent ()
 Generate the next event. More...
 
Int_t GetN () const
 Initialization. More...
 
virtual Int_t ImportParticles (TClonesArray *particles, Option_t *option="")
 Import particles from Pythia stack. More...
 
virtual TObjArrayImportParticles (Option_t *option="")
 Import particles from Pythia stack. More...
 
Bool_t Initialize (Int_t idAin, Int_t idBin, Double_t ecms)
 Initialization. More...
 
Bool_t Initialize (Int_t idAin, Int_t idBin, Double_t eAin, Double_t eBin)
 Initialization. More...
 
void ListAll () const
 Event listing. More...
 
void ListChanged () const
 Event listing. More...
 
void Plist (Int_t id) const
 Event listing. More...
 
void PlistAll () const
 Event listing. More...
 
void PlistChanged () const
 Event listing. More...
 
void PrintStatistics () const
 Print end of run statistics. More...
 
Pythia8::Pythia * Pythia8 ()
 
void ReadConfigFile (const char *string) const
 Configuration. More...
 
void ReadString (const char *string) const
 Configuration. More...
 
- Public Member Functions inherited from TGenerator
 TGenerator ()
 
 TGenerator (const char *name, const char *title="Generator class")
 Event generator default constructor. More...
 
virtual ~TGenerator ()
 Event generator default destructor. More...
 
virtual void Browse (TBrowser *b)
 browse generator More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Compute distance from point px,py to objects in event. More...
 
virtual void Draw (Option_t *option="")
 Insert one event in the pad list. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to one event. More...
 
virtual TObjArrayGetListOfParticles () const
 
Int_t GetNumberOfParticles () const
 Return the number of particles in the stack. More...
 
virtual Double_t GetParameter (const char *) const
 
virtual TParticleGetParticle (Int_t i) const
 Returns pointer to primary number i;. More...
 
virtual TObjArrayGetPrimaries (Option_t *option="")
 
Float_t GetPtCut () const
 
virtual void Paint (Option_t *option="")
 Paint one event. More...
 
virtual void SetParameter (const char *, Double_t)
 
virtual void SetPtCut (Float_t ptcut=0)
 Set Pt threshold below which primaries are not drawn. More...
 
virtual void SetViewRadius (Float_t rbox=1000)
 Set lower and upper values of the view range. More...
 
virtual void SetViewRange (Float_t xmin=-10000, Float_t ymin=-10000, Float_t zmin=-10000, Float_t xmax=10000, Float_t ymax=10000, Float_t zmax=10000)
 Set lower and upper values of the view range. More...
 
virtual void ShowNeutrons (Bool_t show=1)
 Set flag to display or not neutrons. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
ULong_t CheckedHash ()
 Checked and record whether for this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Static Public Member Functions

static TPythia8Instance ()
 Return an instance of TPythia8. More...
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

Protected Attributes

Int_t fNumberOfParticles
 The pythia8 instance. More...
 
Pythia8::Pythia * fPythia
 singleton instance More...
 
- Protected Attributes inherited from TGenerator
TObjArrayfParticles
 display neutrons if true More...
 
Float_t fPtCut
 
Bool_t fShowNeutrons
 Pt cut. Do not show primaries below. More...
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Static Protected Attributes

static TPythia8fgInstance = 0
 

Private Member Functions

void AddParticlesToPdgDataBase ()
 Add some pythia specific particle code to the data base. More...
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Protected Member Functions inherited from TGenerator
 TGenerator (const TGenerator &tg)
 
TGeneratoroperator= (const TGenerator &tg)
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

#include <TPythia8.h>

Inheritance diagram for TPythia8:
[legend]

Constructor & Destructor Documentation

◆ TPythia8() [1/2]

TPythia8::TPythia8 ( )

Number of particles.

Constructor.

Definition at line 91 of file TPythia8.cxx.

◆ TPythia8() [2/2]

TPythia8::TPythia8 ( const char *  xmlDir)

Constructor with an xmlDir (eg "../xmldoc".

Definition at line 108 of file TPythia8.cxx.

◆ ~TPythia8()

TPythia8::~TPythia8 ( )
virtual

Destructor.

Definition at line 125 of file TPythia8.cxx.

Member Function Documentation

◆ AddParticlesToPdgDataBase()

void TPythia8::AddParticlesToPdgDataBase ( )
private

Add some pythia specific particle code to the data base.

Definition at line 371 of file TPythia8.cxx.

◆ EventListing()

void TPythia8::EventListing ( ) const

Event listing.

Definition at line 363 of file TPythia8.cxx.

◆ GenerateEvent()

void TPythia8::GenerateEvent ( )
virtual

Generate the next event.

Reimplemented from TGenerator.

Definition at line 184 of file TPythia8.cxx.

◆ GetN()

Int_t TPythia8::GetN ( ) const

Initialization.

Definition at line 291 of file TPythia8.cxx.

◆ ImportParticles() [1/2]

Int_t TPythia8::ImportParticles ( TClonesArray particles,
Option_t option = "" 
)
virtual

Import particles from Pythia stack.

Reimplemented from TGenerator.

Definition at line 193 of file TPythia8.cxx.

◆ ImportParticles() [2/2]

TObjArray * TPythia8::ImportParticles ( Option_t option = "")
virtual

Import particles from Pythia stack.

Reimplemented from TGenerator.

Definition at line 256 of file TPythia8.cxx.

◆ Initialize() [1/2]

Bool_t TPythia8::Initialize ( Int_t  idAin,
Int_t  idBin,
Double_t  ecms 
)

Initialization.

Definition at line 146 of file TPythia8.cxx.

◆ Initialize() [2/2]

Bool_t TPythia8::Initialize ( Int_t  idAin,
Int_t  idBin,
Double_t  eAin,
Double_t  eBin 
)

Initialization.

Definition at line 164 of file TPythia8.cxx.

◆ Instance()

TPythia8 * TPythia8::Instance ( )
static

Return an instance of TPythia8.

Definition at line 138 of file TPythia8.cxx.

◆ ListAll()

void TPythia8::ListAll ( ) const

Event listing.

Definition at line 315 of file TPythia8.cxx.

◆ ListChanged()

void TPythia8::ListChanged ( ) const

Event listing.

Definition at line 323 of file TPythia8.cxx.

◆ Plist()

void TPythia8::Plist ( Int_t  id) const

Event listing.

Definition at line 331 of file TPythia8.cxx.

◆ PlistAll()

void TPythia8::PlistAll ( ) const

Event listing.

Definition at line 339 of file TPythia8.cxx.

◆ PlistChanged()

void TPythia8::PlistChanged ( ) const

Event listing.

Definition at line 347 of file TPythia8.cxx.

◆ PrintStatistics()

void TPythia8::PrintStatistics ( ) const

Print end of run statistics.

Definition at line 355 of file TPythia8.cxx.

◆ Pythia8()

Pythia8::Pythia* TPythia8::Pythia8 ( )
inline

Definition at line 89 of file TPythia8.h.

◆ ReadConfigFile()

void TPythia8::ReadConfigFile ( const char *  string) const

Configuration.

Definition at line 307 of file TPythia8.cxx.

◆ ReadString()

void TPythia8::ReadString ( const char *  string) const

Configuration.

Definition at line 299 of file TPythia8.cxx.

Member Data Documentation

◆ fgInstance

TPythia8 * TPythia8::fgInstance = 0
staticprotected

Definition at line 81 of file TPythia8.h.

◆ fNumberOfParticles

Int_t TPythia8::fNumberOfParticles
protected

The pythia8 instance.

Definition at line 83 of file TPythia8.h.

◆ fPythia

Pythia8::Pythia* TPythia8::fPythia
protected

singleton instance

Definition at line 82 of file TPythia8.h.

Libraries for TPythia8:
[legend]

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