[u/mrichter/AliRoot.git] / PYTHIA8 / pythia8170 / phpdoc / ProgramClasses.php

<html>
<head>
<title>Program Classes</title>
<link rel="stylesheet" type="text/css" href="pythia.css"/>
<link rel="shortcut icon" href="pythia32.gif"/>
</head>
<body>

<script language=javascript type=text/javascript>
function stopRKey(evt) {
var evt = (evt) ? evt : ((event) ? event : null);
var node = (evt.target) ? evt.target :((evt.srcElement) ? evt.srcElement : null);
if ((evt.keyCode == 13) && (node.type=="text"))
{return false;}
}

document.onkeypress = stopRKey;
</script>
<?php
if($_POST['saved'] == 1) {
if($_POST['filepath'] != "files/") {
echo "<font color='red'>SETTINGS SAVED TO FILE</font><br/><br/>"; }
else {
echo "<font color='red'>NO FILE SELECTED YET.. PLEASE DO SO </font><a href='SaveSettings.php'>HERE</a><br/><br/>"; }
}
?>

<form method='post' action='ProgramClasses.php'>

<h2>Program Classes</h2>

The complete PYTHIA 8 package contains 
<?php $filepath = $_GET["filepath"];
echo "<a href='ProgramFiles.php?filepath=".$filepath."' target='page'>";?>a multitude of classes</a>.
There is no reason to describe all of them, with all of their
methods, since most should not be touched by a normal user.
Nevertheless some of the crucial ones are described in detail,
as a help not only to advanced users but also to developers. 
We here provide a quick reference (still incomplete) which 
classes you can find described where on these pages. Normally
you have to scroll down to find the details, since the top of
the page contains information of more general interest.

<p/>
<table cellspacing="5">

<tr> 
<td><b>Class</b></td> 
<td><b>Reference</b></td> 
<td><b>Comment</b></td> 
</tr>

<tr> 
<td><code>BeamShape</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='BeamShape.php?filepath=".$filepath."' target='page'>";?>Beam Shape</a></td> 
<td>vertex amd beam momentum spread</td> 
</tr>

<tr> 
<td><code>CellJet</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='EventAnalysis.php?filepath=".$filepath."' target='page'>";?>Event Analysis</a></td> 
<td>jet cone clustering analysis, intended for hadron collider 
topologies</td> 
</tr>

<tr> 
<td><code>ClusterJet</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='EventAnalysis.php?filepath=".$filepath."' target='page'>";?>Event Analysis</a></td> 
<td>jet clustering analysis, intended for <i>e^+e^-</i> 
collider topologies</td> 
</tr>

<tr> 
<td><code>CoupSM</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='StandardModelParameters.php?filepath=".$filepath."' target='page'>";?>Standard Model Parameters</a></td> 
<td>couplings and mixing matrices</td> 
</tr>

<tr> 
<td><code>CoupSUSY</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='SUSYLesHouchesAccord.php?filepath=".$filepath."' target='page'>";?>SUSY Les Houches Accord</a></td> 
<td>compute and store SUSY couplings, using input from SusyLesHouches</td> 
</tr>

<tr> 
<td><code>DecayChannel</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='ParticleDataScheme.php?filepath=".$filepath."' target='page'>";?>Particle Data Scheme</a></td> 
<td>the properties of a single decay channel of  particle species</td> 
</tr>

<tr> 
<td><code>Event</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='EventRecord.php?filepath=".$filepath."' target='page'>";?>Event Record</a></td> 
<td>the complete event record</td> 
</tr>

<tr> 
<td><code>HepMC::I_Pythia8</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='HepMCInterface.php?filepath=".$filepath."' target='page'>";?>HepMC Interface</a></td> 
<td>convert a PYTHIA event record to the HepMC format</td> 
</tr>

<tr> 
<td><code>Hist</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='Histograms.php?filepath=".$filepath."' target='page'>";?>Histograms</a></td> 
<td>a primitive built-in histogramming package</td> 
</tr>

<tr> 
<td><code>Info</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='EventInformation.php?filepath=".$filepath."' target='page'>";?>Event Information</a></td> 
<td>various one-of-a-kind information on the current event</td> 
</tr>

<tr> 
<td><code>LHAPDFInterface</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='PartonDistributions.php?filepath=".$filepath."' target='page'>";?>Parton Distributions</a></td> 
<td>use PDF sets from the LHAPDF library</td> 
</tr>

<tr> 
<td><code>LHAup</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='LesHouchesAccord.php?filepath=".$filepath."' target='page'>";?>Les Houches Accord</a></td> 
<td>base class for Les Houches external hard-event input</td> 
</tr>

<tr> 
<td><code>Particle</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='ParticleProperties.php?filepath=".$filepath."' target='page'>";?>Particle Properties</a></td> 
<td>the properties of a particle in the event record</td> 
</tr>

<tr> 
<td><code>ParticleData</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='ParticleDataScheme.php?filepath=".$filepath."' target='page'>";?>Particle Data Scheme</a></td> 
<td>the database of particle species properties</td> 
</tr>

<tr> 
<td><code>ParticleDataEntry</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='ParticleDataScheme.php?filepath=".$filepath."' target='page'>";?>Particle Data Scheme</a></td> 
<td>the properties of a particle species</td> 
</tr>

<tr> 
<td><code>PDF</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='PartonDistributions.php?filepath=".$filepath."' target='page'>";?>Parton Distributions</a></td> 
<td>base class for all PDFs</td> 
</tr>

<tr> 
<td><code>Pythia</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='ProgramFlow.php?filepath=".$filepath."' target='page'>";?>Program Flow</a></td> 
<td>the top-level class, that drives the generation process</td> 
</tr>

<tr> 
<td><code>ResonanceWidths</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='SemiInternalResonances.php?filepath=".$filepath."' target='page'>";?>Semi-Internal Resonances</a></td> 
<td>base class for all resonance-width treatment</td> 
</tr>

<tr> 
<td><code>Rndm</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='RandomNumbers.php?filepath=".$filepath."' target='page'>";?>RandomNumbers</a></td> 
<td>a primitive built-in histogramming package</td> 
</tr>

<tr> 
<td><code>RotBstMatrix</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='FourVectors.php?filepath=".$filepath."' target='page'>";?>Four-Vectors</a></td> 
<td>rotation and boosts of four-vectors</td> 
</tr>

<tr> 
<td><code>Settings</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='SettingsScheme.php?filepath=".$filepath."' target='page'>";?>Settings Scheme</a></td> 
<td>the database that regulates the behaviour of the program</td> 
</tr>

<tr> 
<td><code>SigmaProcess</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='SemiInternalProcesses.php?filepath=".$filepath."' target='page'>";?>Semi-Internal Processes</a></td> 
<td>base class for all hard-process cross sections</td> 
</tr>

<tr> 
<td><code>SlowJet</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='EventAnalysis.php?filepath=".$filepath."' target='page'>";?>Event Analysis</a></td> 
<td>simple jet clustering using the <i>kT</i>, anti-<i>kT</i> or
Cambridge/Aachen algorithms.</td> 
</tr>

<tr> 
<td><code>SpaceShower</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='ImplementNewShowers.php?filepath=".$filepath."' target='page'>";?>Implement New Showers</a></td> 
<td>spacelike, i..e. initial-state showers</td> 
</tr>

<tr> 
<td><code>Sphericity</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='EventAnalysis.php?filepath=".$filepath."' target='page'>";?>Event Analysis</a></td> 
<td>sphericity analysis of events</td> 
</tr>

<tr> 
<td><code>SusyLesHouches</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='SUSYLesHouchesAccord.php?filepath=".$filepath."' target='page'>";?>SUSY Les Houches Accord</a></td> 
<td>reading in of SLHA information</td> 
</tr>

<tr> 
<td><code>Thrust</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='EventAnalysis.php?filepath=".$filepath."' target='page'>";?>Event Analysis</a></td> 
<td>thrust analysis of events</td> 
</tr>

<tr> 
<td><code>TimeShower</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='ImplementNewShowers.php?filepath=".$filepath."' target='page'>";?>Implement New Showers</a></td> 
<td>timelike, i..e. final-state showers</td> 
</tr>

<tr> 
<td><code>UserHooks</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='UserHooks.php?filepath=".$filepath."' target='page'>";?>User Hooks</a></td> 
<td>get access to some steps of the generation process</td> 
</tr>

<tr> 
<td><code>Vec4</code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='FourVectors.php?filepath=".$filepath."' target='page'>";?>Four-Vectors</a></td> 
<td>four-vectors</td> 
</tr>

<tr> 
<td><code></code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='.php?filepath=".$filepath."' target='page'>";?></a></td> 
<td></td> 
</tr>

<tr> 
<td><code></code></td> 
<td><?php $filepath = $_GET["filepath"];
echo "<a href='.php?filepath=".$filepath."' target='page'>";?></a></td> 
<td></td> 
</tr>

</table>

<p/>
You can also access an extensive list of the public 
<?php $filepath = $_GET["filepath"];
echo "<a href='ProgramMethods.php?filepath=".$filepath."' target='page'>";?>methods</a> in these classes, 
which compensates for the brevity of the current page. 

<!-- Copyright (C) 2012 Torbjorn Sjostrand -->
Commit	Line	Data
63ba5337	1	<html>
	2	<head>
	3	<title>Program Classes</title>
	4	<link rel="stylesheet" type="text/css" href="pythia.css"/>
	5	<link rel="shortcut icon" href="pythia32.gif"/>
	6	</head>
	7	<body>
	8
	9	<script language=javascript type=text/javascript>
	10	function stopRKey(evt) {
	11	var evt = (evt) ? evt : ((event) ? event : null);
	12	var node = (evt.target) ? evt.target :((evt.srcElement) ? evt.srcElement : null);
	13	if ((evt.keyCode == 13) && (node.type=="text"))
	14	{return false;}
	15	}
	16
	17	document.onkeypress = stopRKey;
	18	</script>
	19	<?php
	20	if($_POST['saved'] == 1) {
	21	if($_POST['filepath'] != "files/") {
	22	echo "<font color='red'>SETTINGS SAVED TO FILE</font><br/><br/>"; }
	23	else {
	24	echo "<font color='red'>NO FILE SELECTED YET.. PLEASE DO SO </font><a href='SaveSettings.php'>HERE</a><br/><br/>"; }
	25	}
	26	?>
	27
	28	<form method='post' action='ProgramClasses.php'>
	29
	30	<h2>Program Classes</h2>
	31
	32	The complete PYTHIA 8 package contains
	33	<?php $filepath = $_GET["filepath"];
	34	echo "<a href='ProgramFiles.php?filepath=".$filepath."' target='page'>";?>a multitude of classes</a>.
	35	There is no reason to describe all of them, with all of their
	36	methods, since most should not be touched by a normal user.
	37	Nevertheless some of the crucial ones are described in detail,
	38	as a help not only to advanced users but also to developers.
	39	We here provide a quick reference (still incomplete) which
	40	classes you can find described where on these pages. Normally
	41	you have to scroll down to find the details, since the top of
	42	the page contains information of more general interest.
	43
	44	<p/>
	45	<table cellspacing="5">
	46
	47	<tr>
	48	<td><b>Class</b></td>
	49	<td><b>Reference</b></td>
	50	<td><b>Comment</b></td>
	51	</tr>
	52
	53	<tr>
	54	<td><code>BeamShape</code></td>
	55	<td><?php $filepath = $_GET["filepath"];
	56	echo "<a href='BeamShape.php?filepath=".$filepath."' target='page'>";?>Beam Shape</a></td>
	57	<td>vertex amd beam momentum spread</td>
	58	</tr>
	59
	60	<tr>
	61	<td><code>CellJet</code></td>
	62	<td><?php $filepath = $_GET["filepath"];
	63	echo "<a href='EventAnalysis.php?filepath=".$filepath."' target='page'>";?>Event Analysis</a></td>
	64	<td>jet cone clustering analysis, intended for hadron collider
65	topologies</td>
66	</tr>
67
68	<tr>
69	<td><code>ClusterJet</code></td>
70	<td><?php $filepath = $_GET["filepath"];
71	echo "<a href='EventAnalysis.php?filepath=".$filepath."' target='page'>";?>Event Analysis</a></td>
72	<td>jet clustering analysis, intended for <i>e^+e^-</i>
73	collider topologies</td>
74	</tr>
75
76	<tr>
77	<td><code>CoupSM</code></td>
78	<td><?php $filepath = $_GET["filepath"];
79	echo "<a href='StandardModelParameters.php?filepath=".$filepath."' target='page'>";?>Standard Model Parameters</a></td>
80	<td>couplings and mixing matrices</td>
81	</tr>
82
83	<tr>
84	<td><code>CoupSUSY</code></td>
85	<td><?php $filepath = $_GET["filepath"];
86	echo "<a href='SUSYLesHouchesAccord.php?filepath=".$filepath."' target='page'>";?>SUSY Les Houches Accord</a></td>
87	<td>compute and store SUSY couplings, using input from SusyLesHouches</td>
88	</tr>
89
90	<tr>
91	<td><code>DecayChannel</code></td>
92	<td><?php $filepath = $_GET["filepath"];
93	echo "<a href='ParticleDataScheme.php?filepath=".$filepath."' target='page'>";?>Particle Data Scheme</a></td>
94	<td>the properties of a single decay channel of particle species</td>
95	</tr>
96
97	<tr>
98	<td><code>Event</code></td>
99	<td><?php $filepath = $_GET["filepath"];
100	echo "<a href='EventRecord.php?filepath=".$filepath."' target='page'>";?>Event Record</a></td>
101	<td>the complete event record</td>
102	</tr>
103
104	<tr>
105	<td><code>HepMC::I_Pythia8</code></td>
106	<td><?php $filepath = $_GET["filepath"];
107	echo "<a href='HepMCInterface.php?filepath=".$filepath."' target='page'>";?>HepMC Interface</a></td>
108	<td>convert a PYTHIA event record to the HepMC format</td>
109	</tr>
110
111	<tr>
112	<td><code>Hist</code></td>
113	<td><?php $filepath = $_GET["filepath"];
114	echo "<a href='Histograms.php?filepath=".$filepath."' target='page'>";?>Histograms</a></td>
115	<td>a primitive built-in histogramming package</td>
116	</tr>
117
118	<tr>
119	<td><code>Info</code></td>
120	<td><?php $filepath = $_GET["filepath"];
121	echo "<a href='EventInformation.php?filepath=".$filepath."' target='page'>";?>Event Information</a></td>
122	<td>various one-of-a-kind information on the current event</td>
123	</tr>
124
125	<tr>
126	<td><code>LHAPDFInterface</code></td>
127	<td><?php $filepath = $_GET["filepath"];
128	echo "<a href='PartonDistributions.php?filepath=".$filepath."' target='page'>";?>Parton Distributions</a></td>
129	<td>use PDF sets from the LHAPDF library</td>
130	</tr>
131
132	<tr>
133	<td><code>LHAup</code></td>
134	<td><?php $filepath = $_GET["filepath"];
135	echo "<a href='LesHouchesAccord.php?filepath=".$filepath."' target='page'>";?>Les Houches Accord</a></td>
136	<td>base class for Les Houches external hard-event input</td>
137	</tr>
138
139	<tr>
140	<td><code>Particle</code></td>
141	<td><?php $filepath = $_GET["filepath"];
142	echo "<a href='ParticleProperties.php?filepath=".$filepath."' target='page'>";?>Particle Properties</a></td>
143	<td>the properties of a particle in the event record</td>
144	</tr>
145
146	<tr>
147	<td><code>ParticleData</code></td>
148	<td><?php $filepath = $_GET["filepath"];
149	echo "<a href='ParticleDataScheme.php?filepath=".$filepath."' target='page'>";?>Particle Data Scheme</a></td>
150	<td>the database of particle species properties</td>
151	</tr>
152
153	<tr>
154	<td><code>ParticleDataEntry</code></td>
155	<td><?php $filepath = $_GET["filepath"];
156	echo "<a href='ParticleDataScheme.php?filepath=".$filepath."' target='page'>";?>Particle Data Scheme</a></td>
157	<td>the properties of a particle species</td>
158	</tr>
159
160	<tr>
161	<td><code>PDF</code></td>
162	<td><?php $filepath = $_GET["filepath"];
163	echo "<a href='PartonDistributions.php?filepath=".$filepath."' target='page'>";?>Parton Distributions</a></td>
164	<td>base class for all PDFs</td>
165	</tr>
166
167	<tr>
168	<td><code>Pythia</code></td>
169	<td><?php $filepath = $_GET["filepath"];
170	echo "<a href='ProgramFlow.php?filepath=".$filepath."' target='page'>";?>Program Flow</a></td>
171	<td>the top-level class, that drives the generation process</td>
172	</tr>
173
174	<tr>
175	<td><code>ResonanceWidths</code></td>
176	<td><?php $filepath = $_GET["filepath"];
177	echo "<a href='SemiInternalResonances.php?filepath=".$filepath."' target='page'>";?>Semi-Internal Resonances</a></td>
178	<td>base class for all resonance-width treatment</td>
179	</tr>
180
181	<tr>
182	<td><code>Rndm</code></td>
183	<td><?php $filepath = $_GET["filepath"];
184	echo "<a href='RandomNumbers.php?filepath=".$filepath."' target='page'>";?>RandomNumbers</a></td>
185	<td>a primitive built-in histogramming package</td>
186	</tr>
187
188	<tr>
189	<td><code>RotBstMatrix</code></td>
190	<td><?php $filepath = $_GET["filepath"];
191	echo "<a href='FourVectors.php?filepath=".$filepath."' target='page'>";?>Four-Vectors</a></td>
192	<td>rotation and boosts of four-vectors</td>
193	</tr>
194
195	<tr>
196	<td><code>Settings</code></td>
197	<td><?php $filepath = $_GET["filepath"];
198	echo "<a href='SettingsScheme.php?filepath=".$filepath."' target='page'>";?>Settings Scheme</a></td>
199	<td>the database that regulates the behaviour of the program</td>
200	</tr>
201
202	<tr>
203	<td><code>SigmaProcess</code></td>
204	<td><?php $filepath = $_GET["filepath"];
205	echo "<a href='SemiInternalProcesses.php?filepath=".$filepath."' target='page'>";?>Semi-Internal Processes</a></td>
206	<td>base class for all hard-process cross sections</td>
207	</tr>
208
209	<tr>
210	<td><code>SlowJet</code></td>
211	<td><?php $filepath = $_GET["filepath"];
212	echo "<a href='EventAnalysis.php?filepath=".$filepath."' target='page'>";?>Event Analysis</a></td>
213	<td>simple jet clustering using the <i>kT</i>, anti-<i>kT</i> or
214	Cambridge/Aachen algorithms.</td>
215	</tr>
216
217	<tr>
218	<td><code>SpaceShower</code></td>
219	<td><?php $filepath = $_GET["filepath"];
220	echo "<a href='ImplementNewShowers.php?filepath=".$filepath."' target='page'>";?>Implement New Showers</a></td>
221	<td>spacelike, i..e. initial-state showers</td>
222	</tr>
223
224	<tr>
225	<td><code>Sphericity</code></td>
226	<td><?php $filepath = $_GET["filepath"];
227	echo "<a href='EventAnalysis.php?filepath=".$filepath."' target='page'>";?>Event Analysis</a></td>
228	<td>sphericity analysis of events</td>
229	</tr>
230
231	<tr>
232	<td><code>SusyLesHouches</code></td>
233	<td><?php $filepath = $_GET["filepath"];
234	echo "<a href='SUSYLesHouchesAccord.php?filepath=".$filepath."' target='page'>";?>SUSY Les Houches Accord</a></td>
235	<td>reading in of SLHA information</td>
236	</tr>
237
238	<tr>
239	<td><code>Thrust</code></td>
240	<td><?php $filepath = $_GET["filepath"];
241	echo "<a href='EventAnalysis.php?filepath=".$filepath."' target='page'>";?>Event Analysis</a></td>
242	<td>thrust analysis of events</td>
243	</tr>
244
245	<tr>
246	<td><code>TimeShower</code></td>
247	<td><?php $filepath = $_GET["filepath"];
248	echo "<a href='ImplementNewShowers.php?filepath=".$filepath."' target='page'>";?>Implement New Showers</a></td>
249	<td>timelike, i..e. final-state showers</td>
250	</tr>
251
252	<tr>
253	<td><code>UserHooks</code></td>
254	<td><?php $filepath = $_GET["filepath"];
255	echo "<a href='UserHooks.php?filepath=".$filepath."' target='page'>";?>User Hooks</a></td>
256	<td>get access to some steps of the generation process</td>
257	</tr>
258
259	<tr>
260	<td><code>Vec4</code></td>
261	<td><?php $filepath = $_GET["filepath"];
262	echo "<a href='FourVectors.php?filepath=".$filepath."' target='page'>";?>Four-Vectors</a></td>
263	<td>four-vectors</td>
264	</tr>
265
266	<tr>
267	<td><code></code></td>
268	<td><?php $filepath = $_GET["filepath"];
269	echo "<a href='.php?filepath=".$filepath."' target='page'>";?></a></td>
270	<td></td>
271	</tr>
272
273	<tr>
274	<td><code></code></td>
275	<td><?php $filepath = $_GET["filepath"];
276	echo "<a href='.php?filepath=".$filepath."' target='page'>";?></a></td>
277	<td></td>
278	</tr>
279
280	</table>
281
282	<p/>
283	You can also access an extensive list of the public
284	<?php $filepath = $_GET["filepath"];
285	echo "<a href='ProgramMethods.php?filepath=".$filepath."' target='page'>";?>methods</a> in these classes,
286	which compensates for the brevity of the current page.
287
288	<!-- Copyright (C) 2012 Torbjorn Sjostrand -->