Page MenuHomeHEPForge

refParticle.html
No OneTemporary

refParticle.html

<!--
//==============================================================================
// refParticle.html
//
// Copyright (C) 2010-2013 Tobias Toll and Thomas Ullrich
//
// This file is part of Sartre version: 1.1
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation.
// This program is distributed in the hope that it will be useful,
// but without any warranty; without even the implied warranty of
// merchantability or fitness for a particular purpose. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
// Author: Thomas Ullrich
// Last update:
// $Date: 2013-05-29 21:25:21 +0100 (Wed, 29 May 2013) $
// $Author: thomas.ullrich@bnl.gov $
//==============================================================================
-->
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<title>Sartre - Particle Class Reference</title>
<meta http-equiv="Content-type" content="text/html; charset=UTF-8" /> <link href="sartre.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="120" align="left" valign="top"><img src="images/sartreLogo.png" alt="" border="0" align="right" /></td>
<td width="10">&nbsp;&nbsp;</td>
<td align="left" valign="middle" class="postheader"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot;
<a href="overview.html"><font color="#004faf">Overview</font></a>&nbsp;&middot;
<a href="usersGuide.html"><font color="#004faf">Users Guide</font></a>&nbsp;&middot;
<a href="referenceGuide.html"><font color="#004faf">Reference Guide</font> </a></td></tr>
</table>
<h1 class="title">Particle Class Reference</h1>
<p>The Particle class holds information of any particle used in Sartre<a href="#details">.
More...</a></p>
<pre><span class="preprocessor"> #include</span> "Event.h"</pre>
<hr>
<h2>Public Data Member</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tbody><tr><td class="memItemLeft" align="right" valign="top">int</td>
<td class="memItemRight" valign="bottom"><a href="#index">index</a></td></tr>
<tr>
<td class="memItemLeft" align="right" valign="top">int</td>
<td class="memItemRight" valign="bottom"><a href="#pdgId">pdgId</a></td></tr>
<tr>
<td class="memItemLeft" align="right" valign="top">int</td>
<td class="memItemRight" valign="top"><a href="#status">status</a></td></tr>
<tr>
<td class="memItemLeft" align="right" valign="top">TLorentzVector</td>
<td class="memItemRight" valign="top"><a href="#p">p</a></td></tr>
<tr>
<td class="memItemLeft" align="right" valign="top">vector&lt;int&gt;</td>
<td class="memItemRight" valign="top"><a href="#parents">parents</a></td></tr>
<tr>
<td class="memItemLeft" align="right" valign="top">vector&lt;int&gt;</td>
<td class="memItemRight" valign="top"><a href="#daughters">daughters</a></td></tr>
</tbody></table>
<hr>
<h2><a name="details" id="details"></a>Detailed Description</h2>
<p>The Particle class contains all information needed to
describe any particle used in Sar<em>t</em>e.
The particles are stored in an internal list in the <a href="refEvent.html"> Event</a> class.
It is a lightweight class without any member functions and all data members
are public. The data members hold information on the particle's status
(stable/decayed), 4-momentum, parent particle(s), daughter particle(s).
Each particle is uniquely identified by an index number.</p>
<p>Note that moment and energy (TLorentzVector p) for nuclei are always
expressed
as <em>per-nucleon</em>.</p>
<hr>
<h2>Data Member Documentation</h2>
<h3 class="fn"><a name="index" id="index"></a>int index</h3>
<p>Index of the particle. The index starts at 0. index=0 is typically
the incoming electron and index=1 the incoming hadron. The index
identifies a particle unambiguously in the event.</p>
<h3 class="fn"><a name="pdgId" id="pdgId"></a>int pdgId</h3>
<p>The ID of the particle following the PDG scheme. Note that it also
holds nuclei and heavy fragments. The PDG for nuclei is coded
as 10LZZZAAAI, where L = number of strange quark (for hypernuclei),
I = isomer level, with I = 0 corresponding to the ground state and
I &gt; 0 to excitations. For example
the Au ion is decoded as <span class="code">1000791970</span>.</p>
<h3 class="fn"><a name="status" id="status"></a>int status<span class="memItemRight"></span></h3>
<p> We follow HepMC conventions (February 2009). <br />
0 : an empty entry, with no meaningful information (not used in Sar<em>t</em>re)<br />
1 : a final-state particle, i.e. a particle that is not decayed further by the
generator (may also include unstable particles that are to be decayed later) <br />
2 : a decayed hadron or tau or mu lepton, or an intermediate virtual particle. <br />
3 : a documentation entry (not used in Sar<em>t</em>re) <br />
4 : an incoming beam particle; <br />
11 - 200 : an intermediate (decayed/branched/...) particle that does
not fulfill the criteria of status code 2 (not used in Sar<em>t</em>re)<br />
At the moment Sartre only supports status codes 1,2, and 4.</p>
<h3 class="fn"><a name="p" id="p"></a>TLorentzVector p<span class="memItemRight"></span></h3>
<p>Four momentum vector of the particle. See <a href="http://root.cern.ch/root/html/TLorentzVector.html">ROOT
documentation</a> for details. The vector is defined with respect to
the beam axis. The beam electron comes from the right, with a negative
p<sub>z</sub>, the hadron beam is coming from the left and has a
positive p<sub>z</sub>. Note that momenta and energy (TLorentzVector
p) for nuclei are always expressed
as <em>per-nucleon</em>.</p>
<h3 class="fn"><a name="parents" id="parents"></a>vector&lt;int&gt; parents<span class="memItemRight"></span></h3>
<p>Vector holding the <a href="#index">index</a> of each parent. In Sar<em>t</em>re there are currently
at most 2 parents.</p>
<h3 class="fn"><a name="daughters" id="daughters"></a>vector&lt;int&gt; daughters<span class="memItemRight"></span></h3>
<p>Vector holding the <a href="#index">index</a> of the daughter(s) of
the particle. </p>
<address><div align="center">
<table border="0" cellspacing="0" width="100%"><tbody><tr class="address">
<td align="left" width="40%">&nbsp;</td>
<td align="center" width="20%">&nbsp;</td>
<td align="right" width="40%"><div align="right"><br>Last Update:
<!-- #BeginDate format:Am1 -->January 8, 2013<!-- #EndDate -->
</div></td>
</tr></tbody></table></div></address>
</body></html>

File Metadata

Mime Type
text/html
Expires
Sat, Dec 21, 1:07 PM (1 d, 7 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3999837
Default Alt Text
refParticle.html (7 KB)

Event Timeline