PYTHIA8/pythia8170/xmldoc/ProgramClasses.xml

   1 <chapter name="Program Classes">
   2
   3 <h2>Program Classes</h2>
   4
   5 The complete PYTHIA 8 package contains
   6 <aloc href="ProgramFiles">a multitude of classes</aloc>.
   7 There is no reason to describe all of them, with all of their
   8 methods, since most should not be touched by a normal user.
   9 Nevertheless some of the crucial ones are described in detail,
  10 as a help not only to advanced users but also to developers.
  11 We here provide a quick reference (still incomplete) which
  12 classes you can find described where on these pages. Normally
  13 you have to scroll down to find the details, since the top of
  14 the page contains information of more general interest.
  15
  16 <p/>
  17 <table cellspacing="5">
  18
  19 <tr>
  20 <td><b>Class</b></td>
  21 <td><b>Reference</b></td>
  22 <td><b>Comment</b></td>
  23 </tr>
  24
  25 <tr>
  26 <td><code>BeamShape</code></td>
  27 <td><aloc href="BeamShape">Beam Shape</aloc></td>
  28 <td>vertex amd beam momentum spread</td>
  29 </tr>
  30
  31 <tr>
  32 <td><code>CellJet</code></td>
  33 <td><aloc href="EventAnalysis">Event Analysis</aloc></td>
  34 <td>jet cone clustering analysis, intended for hadron collider
  35 topologies</td>
  36 </tr>
  37
  38 <tr>
  39 <td><code>ClusterJet</code></td>
  40 <td><aloc href="EventAnalysis">Event Analysis</aloc></td>
  41 <td>jet clustering analysis, intended for <ei>e^+e^-</ei>
  42 collider topologies</td>
  43 </tr>
  44
  45 <tr>
  46 <td><code>CoupSM</code></td>
  47 <td><aloc href="StandardModelParameters">Standard Model Parameters</aloc></td>
  48 <td>couplings and mixing matrices</td>
  49 </tr>
  50
  51 <tr>
  52 <td><code>CoupSUSY</code></td>
  53 <td><aloc href="SUSYLesHouchesAccord">SUSY Les Houches Accord</aloc></td>
  54 <td>compute and store SUSY couplings, using input from SusyLesHouches</td>
  55 </tr>
  56
  57 <tr>
  58 <td><code>DecayChannel</code></td>
  59 <td><aloc href="ParticleDataScheme">Particle Data Scheme</aloc></td>
  60 <td>the properties of a single decay channel of  particle species</td>
  61 </tr>
  62
  63 <tr>
  64 <td><code>Event</code></td>
  65 <td><aloc href="EventRecord">Event Record</aloc></td>
  66 <td>the complete event record</td>
  67 </tr>
  68
  69 <tr>
  70 <td><code>HepMC::I_Pythia8</code></td>
  71 <td><aloc href="HepMCInterface">HepMC Interface</aloc></td>
  72 <td>convert a PYTHIA event record to the HepMC format</td>
  73 </tr>
  74
  75 <tr>
  76 <td><code>Hist</code></td>
  77 <td><aloc href="Histograms">Histograms</aloc></td>
  78 <td>a primitive built-in histogramming package</td>
  79 </tr>
  80
  81 <tr>
  82 <td><code>Info</code></td>
  83 <td><aloc href="EventInformation">Event Information</aloc></td>
  84 <td>various one-of-a-kind information on the current event</td>
  85 </tr>
  86
  87 <tr>
  88 <td><code>LHAPDFInterface</code></td>
  89 <td><aloc href="PartonDistributions">Parton Distributions</aloc></td>
  90 <td>use PDF sets from the LHAPDF library</td>
  91 </tr>
  92
  93 <tr>
  94 <td><code>LHAup</code></td>
  95 <td><aloc href="LesHouchesAccord">Les Houches Accord</aloc></td>
  96 <td>base class for Les Houches external hard-event input</td>
  97 </tr>
  98
  99 <tr>
 100 <td><code>Particle</code></td>
 101 <td><aloc href="ParticleProperties">Particle Properties</aloc></td>
 102 <td>the properties of a particle in the event record</td>
 103 </tr>
 104
 105 <tr>
 106 <td><code>ParticleData</code></td>
 107 <td><aloc href="ParticleDataScheme">Particle Data Scheme</aloc></td>
 108 <td>the database of particle species properties</td>
 109 </tr>
 110
 111 <tr>
 112 <td><code>ParticleDataEntry</code></td>
 113 <td><aloc href="ParticleDataScheme">Particle Data Scheme</aloc></td>
 114 <td>the properties of a particle species</td>
 115 </tr>
 116
 117 <tr>
 118 <td><code>PDF</code></td>
 119 <td><aloc href="PartonDistributions">Parton Distributions</aloc></td>
 120 <td>base class for all PDFs</td>
 121 </tr>
 122
 123 <tr>
 124 <td><code>Pythia</code></td>
 125 <td><aloc href="ProgramFlow">Program Flow</aloc></td>
 126 <td>the top-level class, that drives the generation process</td>
 127 </tr>
 128
 129 <tr>
 130 <td><code>ResonanceWidths</code></td>
 131 <td><aloc href="SemiInternalResonances">Semi-Internal Resonances</aloc></td>
 132 <td>base class for all resonance-width treatment</td>
 133 </tr>
 134
 135 <tr>
 136 <td><code>Rndm</code></td>
 137 <td><aloc href="RandomNumbers">RandomNumbers</aloc></td>
 138 <td>a primitive built-in histogramming package</td>
 139 </tr>
 140
 141 <tr>
 142 <td><code>RotBstMatrix</code></td>
 143 <td><aloc href="FourVectors">Four-Vectors</aloc></td>
 144 <td>rotation and boosts of four-vectors</td>
 145 </tr>
 146
 147 <tr>
 148 <td><code>Settings</code></td>
 149 <td><aloc href="SettingsScheme">Settings Scheme</aloc></td>
 150 <td>the database that regulates the behaviour of the program</td>
 151 </tr>
 152
 153 <tr>
 154 <td><code>SigmaProcess</code></td>
 155 <td><aloc href="SemiInternalProcesses">Semi-Internal Processes</aloc></td>
 156 <td>base class for all hard-process cross sections</td>
 157 </tr>
 158
 159 <tr>
 160 <td><code>SlowJet</code></td>
 161 <td><aloc href="EventAnalysis">Event Analysis</aloc></td>
 162 <td>simple jet clustering using the <ei>kT</ei>, anti-<ei>kT</ei> or
 163 Cambridge/Aachen algorithms.</td>
 164 </tr>
 165
 166 <tr>
 167 <td><code>SpaceShower</code></td>
 168 <td><aloc href="ImplementNewShowers">Implement New Showers</aloc></td>
 169 <td>spacelike, i..e. initial-state showers</td>
 170 </tr>
 171
 172 <tr>
 173 <td><code>Sphericity</code></td>
 174 <td><aloc href="EventAnalysis">Event Analysis</aloc></td>
 175 <td>sphericity analysis of events</td>
 176 </tr>
 177
 178 <tr>
 179 <td><code>SusyLesHouches</code></td>
 180 <td><aloc href="SUSYLesHouchesAccord">SUSY Les Houches Accord</aloc></td>
 181 <td>reading in of SLHA information</td>
 182 </tr>
 183
 184 <tr>
 185 <td><code>Thrust</code></td>
 186 <td><aloc href="EventAnalysis">Event Analysis</aloc></td>
 187 <td>thrust analysis of events</td>
 188 </tr>
 189
 190 <tr>
 191 <td><code>TimeShower</code></td>
 192 <td><aloc href="ImplementNewShowers">Implement New Showers</aloc></td>
 193 <td>timelike, i..e. final-state showers</td>
 194 </tr>
 195
 196 <tr>
 197 <td><code>UserHooks</code></td>
 198 <td><aloc href="UserHooks">User Hooks</aloc></td>
 199 <td>get access to some steps of the generation process</td>
 200 </tr>
 201
 202 <tr>
 203 <td><code>Vec4</code></td>
 204 <td><aloc href="FourVectors">Four-Vectors</aloc></td>
 205 <td>four-vectors</td>
 206 </tr>
 207
 208 <tr>
 209 <td><code></code></td>
 210 <td><aloc href=""></aloc></td>
 211 <td></td>
 212 </tr>
 213
 214 <tr>
 215 <td><code></code></td>
 216 <td><aloc href=""></aloc></td>
 217 <td></td>
 218 </tr>
 219
 220 </table>
 221
 222 <p/>
 223 You can also access an extensive list of the public
 224 <aloc href="ProgramMethods">methods</aloc> in these classes,
 225 which compensates for the brevity of the current page.
 226
 227 <!-- Copyright (C) 2012 Torbjorn Sjostrand -->