ATLAS Offline Software
Functions | Variables
python.PyParticleTools Namespace Reference

Functions

def getElectrons (aKey)
 
def getMuons (aKey)
 
def getNeutrinos (aKey)
 
def getParticleBases (aKey)
 
def getParticleJets (aKey)
 
def getJets (aKey)
 
def getPhotons (aKey)
 
def getTauJets (aKey)
 
def getTruthParticles (aKey)
 
def getIParticles (aKey)
 
def getBJets (aKey)
 
def getMissingET (aKey)
 
def getMissingETSig (aKey)
 
def getMissingEtCalo (aKey)
 
def getMissingEtTruth (aKey)
 
def getMissingETSigObjs (aKey)
 
def getCaloClusters (aKey)
 
def getVertices (aKey)
 
def getTrackParticleTruths (aKey)
 
def getTrackParticles (aKey)
 
def getTrackRecords (aKey)
 
def getDetStatusMap (aKey)
 
def getMuonSpShowers (key)
 

Variables

string __docformat__ = "restructuredtext en"
 

Function Documentation

◆ getBJets()

def python.PyParticleTools.getBJets (   aKey) 
Retrieve BJetContainer object from SG

:param aKey: key of the object

see `getElectrons`

Definition at line 122 of file PyParticleTools.py.

122 def getBJets (aKey):
123  """Retrieve BJetContainer object from SG
124 
125  :param aKey: key of the object
126 
127  see `getElectrons`
128 
129  """
130  return PyK.retrieve(PyK.GNS.BJetContainer,aKey)
131 

◆ getCaloClusters()

def python.PyParticleTools.getCaloClusters (   aKey) 
Retrieve CaloClusterContainer object from SG

:param aKey: key of the object

**examples**::

see `getElectrons`

Definition at line 193 of file PyParticleTools.py.

193 def getCaloClusters (aKey):
194  """Retrieve CaloClusterContainer object from SG
195 
196  :param aKey: key of the object
197 
198  **examples**::
199 
200  see `getElectrons`
201 
202  """
203  return PyK.retrieve(PyK.GNS.CaloClusterContainer,aKey)
204 

◆ getDetStatusMap()

def python.PyParticleTools.getDetStatusMap (   aKey) 
Retrieve DetStatusMap object from SG

:param aKey: key of the object

**examples**::

see `getElectrons`

Definition at line 260 of file PyParticleTools.py.

260 def getDetStatusMap (aKey):
261  """Retrieve DetStatusMap object from SG
262 
263  :param aKey: key of the object
264 
265  **examples**::
266 
267  see `getElectrons`
268 
269  """
270  return PyK.retrieve(PyK.GNS.DetStatusMap,aKey)
271 
272 

◆ getElectrons()

def python.PyParticleTools.getElectrons (   aKey) 
Retrieve ElectronContainer object from SG

:param aKey: key of the object

**examples**::

  athena> econ = PyParticleTools.getElectrons('ElectronCollection')
  athena> for e in econ:
  ...  print e.pt()  # don't forget to put an additional whitespace before 'print'
  ...                # just hit the return key

Definition at line 17 of file PyParticleTools.py.

17 def getElectrons (aKey):
18  """Retrieve ElectronContainer object from SG
19 
20  :param aKey: key of the object
21 
22  **examples**::
23 
24  athena> econ = PyParticleTools.getElectrons('ElectronCollection')
25  athena> for e in econ:
26  ... print e.pt() # don't forget to put an additional whitespace before 'print'
27  ... # just hit the return key
28 
29  """
30  return PyK.retrieve(PyK.GNS.ElectronContainer,aKey)
31 

◆ getIParticles()

def python.PyParticleTools.getIParticles (   aKey) 
Retrieve IParticleContainer object from SG

:param aKey: key of the object

see `getElectrons`

Definition at line 112 of file PyParticleTools.py.

112 def getIParticles (aKey):
113  """Retrieve IParticleContainer object from SG
114 
115  :param aKey: key of the object
116 
117  see `getElectrons`
118 
119  """
120  return PyK.retrieve(PyK.GNS.IParticleContainer,aKey)
121 

◆ getJets()

def python.PyParticleTools.getJets (   aKey) 
Retrieve JetContainer object from SG

:param aKey: key of the object

see `getElectrons`

Definition at line 72 of file PyParticleTools.py.

72 def getJets (aKey):
73  """Retrieve JetContainer object from SG
74 
75  :param aKey: key of the object
76 
77  see `getElectrons`
78 
79  """
80  return PyK.retrieve(PyK.GNS.JetCollection,aKey)
81 

◆ getMissingET()

def python.PyParticleTools.getMissingET (   aKey) 
Retrieve MissingET object from SG

:param aKey: key of the object

**examples**::

  athena> met = PyParticleTools.getMissingET('MET_Final')
  athena> print met.sumet()

Definition at line 132 of file PyParticleTools.py.

132 def getMissingET (aKey):
133  """Retrieve MissingET object from SG
134 
135  :param aKey: key of the object
136 
137  **examples**::
138 
139  athena> met = PyParticleTools.getMissingET('MET_Final')
140  athena> print met.sumet()
141 
142  """
143  return PyK.retrieve(PyK.GNS.MissingET,aKey)
144 

◆ getMissingEtCalo()

def python.PyParticleTools.getMissingEtCalo (   aKey) 
Retrieve MissingEtCalo object from SG

:param aKey: key of the object

**examples**::

  athena> met = PyParticleTools.getMissingEtCalo('MET_Base')
  athena> print met.calibType()

Definition at line 158 of file PyParticleTools.py.

158 def getMissingEtCalo (aKey):
159  """Retrieve MissingEtCalo object from SG
160 
161  :param aKey: key of the object
162 
163  **examples**::
164 
165  athena> met = PyParticleTools.getMissingEtCalo('MET_Base')
166  athena> print met.calibType()
167 
168  """
169  return PyK.retrieve(PyK.GNS.MissingEtCalo,aKey)
170 

◆ getMissingETSig()

def python.PyParticleTools.getMissingETSig (   aKey) 
Retrieve MissingETSig object from SG

:param aKey: key of the object

**examples**::

  athena> met = PyParticleTools.getMissingETSig('METSig')
  athena> print met.met()

Definition at line 145 of file PyParticleTools.py.

145 def getMissingETSig (aKey):
146  """Retrieve MissingETSig object from SG
147 
148  :param aKey: key of the object
149 
150  **examples**::
151 
152  athena> met = PyParticleTools.getMissingETSig('METSig')
153  athena> print met.met()
154 
155  """
156  return PyK.retrieve(PyK.GNS.MissingETSig,aKey)
157 

◆ getMissingETSigObjs()

def python.PyParticleTools.getMissingETSigObjs (   aKey) 
Retrieve MissingETSigObjContainer object from SG

:param aKey: key of the object

see `getElectrons`

Definition at line 184 of file PyParticleTools.py.

184 def getMissingETSigObjs (aKey):
185  """Retrieve MissingETSigObjContainer object from SG
186 
187  :param aKey: key of the object
188 
189  see `getElectrons`
190  """
191  return PyK.retrieve(PyK.GNS.MissingETSigObjContainer,aKey)
192 

◆ getMissingEtTruth()

def python.PyParticleTools.getMissingEtTruth (   aKey) 
Retrieve MissingEtTruth object from SG

:param aKey: key of the object

**examples**::

  athena> met = PyParticleTools.getMissingEtTruth('MET_Truth')
  athena> print met.sumet()

Definition at line 171 of file PyParticleTools.py.

171 def getMissingEtTruth (aKey):
172  """Retrieve MissingEtTruth object from SG
173 
174  :param aKey: key of the object
175 
176  **examples**::
177 
178  athena> met = PyParticleTools.getMissingEtTruth('MET_Truth')
179  athena> print met.sumet()
180 
181  """
182  return PyK.retrieve(PyK.GNS.MissingEtTruth,aKey)
183 

◆ getMuons()

def python.PyParticleTools.getMuons (   aKey) 
Retrieve MuonContainer object from SG

:param aKey: key of the object

see `getElectrons`

Definition at line 32 of file PyParticleTools.py.

32 def getMuons (aKey):
33  """Retrieve MuonContainer object from SG
34 
35  :param aKey: key of the object
36 
37  see `getElectrons`
38 
39  """
40  return PyK.retrieve(PyK.GNS.Analysis.MuonContainer,aKey)
41 

◆ getMuonSpShowers()

def python.PyParticleTools.getMuonSpShowers (   key) 
Retrieve Rec::MuonSpShowerContainer object from SG

:param aKey: key of the object

**examples**::

see `getElectrons`

Definition at line 273 of file PyParticleTools.py.

273 def getMuonSpShowers (key):
274  """Retrieve Rec::MuonSpShowerContainer object from SG
275 
276  :param aKey: key of the object
277 
278  **examples**::
279 
280  see `getElectrons`
281 
282  """
283  return PyK.retrieve(PyK.GNS.Rec.MuonSpShowerContainer,key)
284 
285 
286 # Workarounds for pyroot bugs.

◆ getNeutrinos()

def python.PyParticleTools.getNeutrinos (   aKey) 
Retrieve NeutrinoContainer object from SG

:param aKey: key of the object

see `getElectrons`

Definition at line 42 of file PyParticleTools.py.

42 def getNeutrinos (aKey):
43  """Retrieve NeutrinoContainer object from SG
44 
45  :param aKey: key of the object
46 
47  see `getElectrons`
48 
49  """
50  return PyK.retrieve(PyK.GNS.NeutrinoContainer,aKey)
51 

◆ getParticleBases()

def python.PyParticleTools.getParticleBases (   aKey) 
Retrieve ParticleBaseContainer object from SG

:param aKey: key of the object

see `getElectrons`

Definition at line 52 of file PyParticleTools.py.

52 def getParticleBases (aKey):
53  """Retrieve ParticleBaseContainer object from SG
54 
55  :param aKey: key of the object
56 
57  see `getElectrons`
58 
59  """
60  return PyK.retrieve(PyK.GNS.ParticleBaseContainer,aKey)
61 

◆ getParticleJets()

def python.PyParticleTools.getParticleJets (   aKey) 
Retrieve ParticleJetContainer object from SG
   OBSOLETE due to ParticleJet/Jet merger
:param aKey: key of the object

see `getElectrons`

Definition at line 62 of file PyParticleTools.py.

62 def getParticleJets (aKey):
63  """Retrieve ParticleJetContainer object from SG
64  OBSOLETE due to ParticleJet/Jet merger
65  :param aKey: key of the object
66 
67  see `getElectrons`
68 
69  """
70  return PyK.retrieve(PyK.GNS.ParticleJetContainer,aKey)
71 

◆ getPhotons()

def python.PyParticleTools.getPhotons (   aKey) 
Retrieve PhotonContainer object from SG

:param aKey: key of the object

see `getElectrons`

Definition at line 82 of file PyParticleTools.py.

82 def getPhotons (aKey):
83  """Retrieve PhotonContainer object from SG
84 
85  :param aKey: key of the object
86 
87  see `getElectrons`
88 
89  """
90  return PyK.retrieve(PyK.GNS.PhotonContainer,aKey)
91 

◆ getTauJets()

def python.PyParticleTools.getTauJets (   aKey) 
Retrieve TauJetContainer object from SG

:param aKey: key of the object

see `getElectrons`

Definition at line 92 of file PyParticleTools.py.

92 def getTauJets (aKey):
93  """Retrieve TauJetContainer object from SG
94 
95  :param aKey: key of the object
96 
97  see `getElectrons`
98 
99  """
100  return PyK.retrieve(PyK.GNS.Analysis.TauJetContainer,aKey)
101 

◆ getTrackParticles()

def python.PyParticleTools.getTrackParticles (   aKey) 
Retrieve TrackParticleContainer object from SG

:param aKey: key of the object

**examples**::

see `getElectrons`

Definition at line 231 of file PyParticleTools.py.

231 def getTrackParticles (aKey):
232  """Retrieve TrackParticleContainer object from SG
233 
234  :param aKey: key of the object
235 
236  **examples**::
237 
238  see `getElectrons`
239 
240  """
241  return PyK.retrieve(PyK.GNS.Rec.TrackParticleContainer,aKey)
242 
243 

◆ getTrackParticleTruths()

def python.PyParticleTools.getTrackParticleTruths (   aKey) 
Retrieve TrackParticleTruthCollection object from SG

:param aKey: key of the object

**examples**::

see `getElectrons`

Definition at line 218 of file PyParticleTools.py.

218 def getTrackParticleTruths (aKey):
219  """Retrieve TrackParticleTruthCollection object from SG
220 
221  :param aKey: key of the object
222 
223  **examples**::
224 
225  see `getElectrons`
226 
227  """
228  return PyK.retrieve(PyK.GNS.TrackParticleTruthCollection,aKey)
229 
230 

◆ getTrackRecords()

def python.PyParticleTools.getTrackRecords (   aKey) 
Retrieve TrackRecordCollection object from SG

:param aKey: key of the object

**examples**::

see `getElectrons`

Definition at line 244 of file PyParticleTools.py.

244 def getTrackRecords (aKey):
245  """Retrieve TrackRecordCollection object from SG
246 
247  :param aKey: key of the object
248 
249  **examples**::
250 
251  see `getElectrons`
252 
253  """
254  # nb. TrackRecordCollection is a typedef, but that was the name used
255  # in CLASS_DEF. So we have to pass that name into SG, not the name
256  # of the actual class.
257  return PyK.retrieve("TrackRecordCollection",aKey)
258 
259 

◆ getTruthParticles()

def python.PyParticleTools.getTruthParticles (   aKey) 
Retrieve TruthParticleContainer object from SG

:param aKey: key of the object

see `getElectrons`

Definition at line 102 of file PyParticleTools.py.

102 def getTruthParticles (aKey):
103  """Retrieve TruthParticleContainer object from SG
104 
105  :param aKey: key of the object
106 
107  see `getElectrons`
108 
109  """
110  return PyK.retrieve(PyK.GNS.TruthParticleContainer,aKey)
111 

◆ getVertices()

def python.PyParticleTools.getVertices (   aKey) 
Retrieve VxContainer object from SG

:param aKey: key of the object

**examples**::

see `getElectrons`

Definition at line 205 of file PyParticleTools.py.

205 def getVertices (aKey):
206  """Retrieve VxContainer object from SG
207 
208  :param aKey: key of the object
209 
210  **examples**::
211 
212  see `getElectrons`
213 
214  """
215  return PyK.retrieve(PyK.GNS.VxContainer,aKey)
216 
217 

Variable Documentation

◆ __docformat__

string python.PyParticleTools.__docformat__ = "restructuredtext en"
private

Definition at line 13 of file PyParticleTools.py.

python.PyParticleTools.getElectrons
def getElectrons(aKey)
Definition: PyParticleTools.py:17
python.PyParticleTools.getTrackRecords
def getTrackRecords(aKey)
Definition: PyParticleTools.py:244
python.PyParticleTools.getMissingEtTruth
def getMissingEtTruth(aKey)
Definition: PyParticleTools.py:171
python.PyParticleTools.getParticleBases
def getParticleBases(aKey)
Definition: PyParticleTools.py:52
python.PyParticleTools.getMissingETSig
def getMissingETSig(aKey)
Definition: PyParticleTools.py:145
python.PyParticleTools.getCaloClusters
def getCaloClusters(aKey)
Definition: PyParticleTools.py:193
python.PyParticleTools.getTruthParticles
def getTruthParticles(aKey)
Definition: PyParticleTools.py:102
python.PyParticleTools.getVertices
def getVertices(aKey)
Definition: PyParticleTools.py:205
python.PyParticleTools.getMissingEtCalo
def getMissingEtCalo(aKey)
Definition: PyParticleTools.py:158
python.PyParticleTools.getMissingET
def getMissingET(aKey)
Definition: PyParticleTools.py:132
python.PyParticleTools.getMuonSpShowers
def getMuonSpShowers(key)
Definition: PyParticleTools.py:273
python.PyParticleTools.getBJets
def getBJets(aKey)
Definition: PyParticleTools.py:122
python.PyParticleTools.getTauJets
def getTauJets(aKey)
Definition: PyParticleTools.py:92
python.PyParticleTools.getMuons
def getMuons(aKey)
Definition: PyParticleTools.py:32
python.PyParticleTools.getTrackParticles
def getTrackParticles(aKey)
Definition: PyParticleTools.py:231
python.PyParticleTools.getJets
def getJets(aKey)
Definition: PyParticleTools.py:72
python.PyParticleTools.getIParticles
def getIParticles(aKey)
Definition: PyParticleTools.py:112
python.PyParticleTools.getPhotons
def getPhotons(aKey)
Definition: PyParticleTools.py:82
python.PyParticleTools.getTrackParticleTruths
def getTrackParticleTruths(aKey)
Definition: PyParticleTools.py:218
python.PyParticleTools.getNeutrinos
def getNeutrinos(aKey)
Definition: PyParticleTools.py:42
python.PyParticleTools.getDetStatusMap
def getDetStatusMap(aKey)
Definition: PyParticleTools.py:260
python.PyParticleTools.getParticleJets
def getParticleJets(aKey)
Definition: PyParticleTools.py:62
python.PyParticleTools.getMissingETSigObjs
def getMissingETSigObjs(aKey)
Definition: PyParticleTools.py:184
Generated on Sun Dec 22 2024 22:06:51 for ATLAS Offline Software by   doxygen 1.8.18