ATLAS Offline Software
Loading...
Searching...
No Matches
Functions | Variables
python.PyParticleTools Namespace Reference

Functions

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

Variables

str __docformat__ = "restructuredtext en"

Detailed Description

module to access particle objects interactively

Examples are in `PyAnalysisExamples/ParticleTest.py`_

.. _PyAnalysisExamples/ParticleTest.py: http://atlas-sw.cern.ch/cgi-bin/viewcvs-atlas.cgi/offline/PhysicsAnalysis/PyAnalysis/PyAnalysisExamples/share/ParticleTest.py?rev=HEAD&content-type=text/vnd.viewcvs-markup

:author: Tadashi Maeno
:contact: Tadashi.Maeno@cern.ch

Function Documentation

◆ getBJets()

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.

122def 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()

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.

193def 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()

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.

260def 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()

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.

17def 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
getElectrons
StatusCode getElectrons(const std::vector< std::pair< double, double > > &pt_eta, int runNumber, xAOD::TStore &store)
Definition CreateDummyEl.cxx:74

◆ getIParticles()

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.

112def 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()

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.

72def 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()

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.

132def 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()

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.

158def 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()

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.

145def 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()

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.

184def 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()

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.

171def 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()

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.

32def 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()

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.

273def 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()

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.

42def 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()

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.

52def 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()

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.

62def 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()

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.

82def 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()

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.

92def 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()

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.

231def 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()

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.

218def 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()

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.

244def 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()

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.

102def 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()

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.

205def 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__

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

Definition at line 13 of file PyParticleTools.py.

Generated on for ATLAS Offline Software by doxygen 1.14.0