ATLAS Offline Software
Loading...
Searching...
No Matches
ParticleJetToolsConfig.py
Go to the documentation of this file.
1# Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
2
3
10
11from AthenaCommon import Logging
12jrtlog = Logging.logging.getLogger('ParticleJetToolsConfig')
13
14from AthenaConfiguration.ComponentFactory import CompFactory
15# workaround for missing JetRecConfig in AthAnalysis
16try:
17 from JetRecConfig.JetRecConfig import isAnalysisRelease
18except ModuleNotFoundError:
20 return True
21
22# Putting MCTruthClassifier here as we needn't stick jet configs in really foreign packages
24 # Assume mc15 value
25 truthclassif = CompFactory.MCTruthClassifier(
26 "JetMCTruthClassifier"
27 )
28 if not isAnalysisRelease() :
29 truthclassif.xAODTruthLinkVector= ""
30 # Config neessary only for Athena releases
31 import os
32 if "AtlasProject" in os.environ.keys():
33 if os.environ["AtlasProject"] in ["Athena","AthDerivation"]:
34 truthclassif.ParticleCaloExtensionTool=""
35 return truthclassif
36
37# Generates truth particle containers for truth labeling
38truthpartoptions = {
39 "Partons":{"ToolType":CompFactory.CopyTruthPartons,"ptmin":5000},
40 "BosonTop":{"ToolType":CompFactory.CopyBosonTopLabelTruthParticles,"ptmin":100000},
41 "FlavourLabel":{"ToolType":CompFactory.CopyFlavorLabelTruthParticles,"ptmin":5000},
42}
44 toolProperties = {}
45 if truthtype == "Partons":
46 truthcategory = "Partons"
47 elif truthtype in ["WBosons", "ZBosons", "HBosons", "TQuarksFinal"]:
48 truthcategory = "BosonTop"
49 toolProperties['ParticleType'] = truthtype
50 else:
51 truthcategory = "FlavourLabel"
52 toolProperties['ParticleType'] = truthtype
53
54 tooltype = truthpartoptions[truthcategory]["ToolType"]
55 toolProperties.update( PtMin = truthpartoptions[truthcategory]["ptmin"],
56 OutputName = "TruthLabel"+truthtype)
57 ctp = tooltype("truthpartcopy_"+truthtype,
58 **toolProperties
59 )
60 return ctp
61
62# Generates input truth particle containers for truth jets
63def getCopyTruthJetParticles(modspec, cflags):
64 truthclassif = getMCTruthClassifier()
65
66 truthpartcopy = CompFactory.CopyTruthJetParticles(
67 "truthpartcopy"+modspec,
68 OutputName="JetInputTruthParticles"+modspec,
69 MCTruthClassifier=truthclassif)
70 if modspec=="NoWZ":
71 truthpartcopy.IncludePromptLeptons=False
72 truthpartcopy.IncludePromptPhotons=False
73 truthpartcopy.IncludeMuons=True
74 truthpartcopy.IncludeNeutrinos=True
75 if modspec=="DressedWZ":
76 truthpartcopy.IncludePromptLeptons=False
77 truthpartcopy.IncludePromptPhotons=True
78 truthpartcopy.IncludeMuons=True
79 truthpartcopy.IncludeNeutrinos=True
80 truthpartcopy.DressingDecorationNames=['TruthParticles.dressedPhoton_e','TruthParticles.dressedPhoton_mu']
81
82 truthpartcopy.ExtraInputs = {( 'xAOD::TruthParticleContainer' , 'StoreGateSvc+TruthParticles.dressedPhoton_e' ),
83 ( 'xAOD::TruthParticleContainer' , 'StoreGateSvc+TruthParticles.dressedPhoton_mu' )}
84 if modspec=="Charged":
85 truthpartcopy.ChargedParticlesOnly=True
86 return truthpartcopy
87
88
89def getCopyTruthJetParticlesGEN(modspec, cflags):
90 """ Build truth constituents as in EVTGEN jobs in the r21 config.
91 IMPORTANT : this is expected to be temporary, only to reproduce the EVTGEN r21 config with the new config. The definitions should be harmonized with reco-level at some point and this function removed.
92 The source for r21 EVTGEN config was in GeneratorFilters/share/common/GenerateTruthJets.py
93 """
94 truthclassif = getMCTruthClassifier()
95
96 if modspec == "":
97 return CompFactory.CopyTruthJetParticles("truthpartcopy",
98 OutputName="JetInputTruthParticlesGEN",
99 MCTruthClassifier=truthclassif)
100 elif modspec=="NoWZ":
101 return CompFactory.CopyTruthJetParticles("truthpartcopywz",
102 OutputName="JetInputTruthParticlesGENNoWZ",
103 MCTruthClassifier=truthclassif,
104 IncludePromptLeptons=False)
105
106
108 """Internal unlity to name labels
109
110 Returns a dictionary to configure labeling tools. Takes one
111 argument which is prefixed to each label.
112 """
113 return dict(
114 LabelName=f"{prefix}TruthLabelID",
115 DoubleLabelName=f"{prefix}ExtendedTruthLabelID",
116 LabelPtName=f"{prefix}TruthLabelPt",
117 LabelLxyName=f"{prefix}TruthLabelLxy",
118 LabelDRName=f"{prefix}TruthLabelDR",
119 LabelPdgIdName=f"{prefix}TruthLabelPdgId",
120 LabelPositionDPhiName=f"{prefix}TruthLabelPositionDPhi",
121 LabelPositionDEtaName=f"{prefix}TruthLabelPositionDEta",
122 LabelBarcodeName=f"{prefix}TruthLabelBarcode",
123 ChildLxyName=f"{prefix}TruthLabelChildLxy",
124 ChildPtName=f"{prefix}TruthLabelChildPt",
125 ChildPdgIdName=f"{prefix}TruthLabelChildPdgId",
126 ChildPositionDPhiName=f"{prefix}TruthLabelChildPositionDPhi",
127 ChildPositionDEtaName=f"{prefix}TruthLabelChildPositionDEta",
128 )
129
130
131# ATLASRECTS-8290: remove use_barcode here
132def getJetDeltaRFlavorLabelTool(name='jetdrlabeler', jet_pt_min=5000, collection="Final", dr_max=0.3, use_barcode=False):
133 """Get the standard flavor tagging delta-R labeling tool
134
135 Uses cone matching to B, C and tau truth particles.
136 """
137 prefix_to_name = "HadronConeExcl"
138 if collection != "Final":
139 prefix_to_name += collection
140 name+=collection
141
142 return CompFactory.ParticleJetDeltaRLabelTool(
143 name,
144 **_getCommonLabelNames(prefix_to_name),
145 BLabelName = "ConeExclBHadrons"+collection,
146 CLabelName = "ConeExclCHadrons"+collection,
147 TauLabelName = "ConeExclTausFinal",
148 BParticleCollection = "TruthLabelBHadrons"+collection,
149 CParticleCollection = "TruthLabelCHadrons"+collection,
150 TauParticleCollection = "TruthLabelTausFinal",
151 PartPtMin = 5000.,
152 DRMax = dr_max,
153 MatchMode = "MinDR",
154 JetPtMin = jet_pt_min,
155 useBarcode=use_barcode, # ATLASRECTS-8290: remove this eventually
156 )
157
158
159def getJetQuarkChargeLabelTool(name='jetquarkcharge',
160 output_label = "QuarkChargeTruthLabelID",
161 hadron_label = "HadronGhostInitialTruthLabelPdgId",
162 parton_label = "PartonExtendedTruthLabelID"):
163 """Get the flavor tagging labeling tool to store the quark charge of a jet
164 It is necessary to have saved before an hadron label and a parton label, otherwise the code will break
165 """
166
167 import ParticleJetTools.quarkChargeMap as qcMap
168 charge_map = qcMap.hadrons_dict
169
170 return CompFactory.JetQuarkChargeLabelingTool(
171 name,
172 HadronDecorationName = hadron_label,
173 PartonDecorationName = parton_label,
174 HadronChargeMap = charge_map,
175 OutputName = output_label,
176 )
177
178def getJetDeltaRLabelTool(jetdef, modspec):
179 """returns a ParticleJetDeltaRLabelTool
180 Cone matching for B, C and tau truth for all but track jets.
181
182 This function is meant to be used as callback from JetRecConfig where
183 it is called as func(jetdef, modspec). Hence the jetdef argument even if not used in this case.
184 """
185 jetptmin = float(modspec)
186 name = "jetdrlabeler_jetpt{0}GeV".format(int(jetptmin/1000))
187 return getJetDeltaRFlavorLabelTool(name, jetptmin)
188
189
190def getJetQuarkChargeTool(jetdef, modspec):
191 """returns a JetQuarkChargeLabelingTool
192
193 This function is meant to be used as callback from JetRecConfig where
194 it is called as func(jetdef, modspec). Hence the jetdef argument even if not used.
195 """
196 if modspec == "":
198
199 outputLabel,hadronLabel,partonLabel = modspec.split(",")
200
201 name = f"jetquarkcharge_{outputLabel}_{hadronLabel}_{partonLabel}"
202 return getJetQuarkChargeLabelTool(name,output_label = outputLabel, hadron_label = hadronLabel, parton_label = partonLabel)
203
204def getJetDeltaRInitialLabelTool(jetdef, modspec):
205 """returns a ParticleJetDeltaRLabelTool
206 Cone matching for B, C and tau truth for all but track jets.
207
208 This function is meant to be used as callback from JetRecConfig where
209 it is called as func(jetdef, modspec). Hence the jetdef argument even if not used in this case.
210 """
211 jetptmin = float(modspec)
212 name = "jetdrlabeler_jetpt{0}GeV".format(int(jetptmin/1000))
213 return getJetDeltaRFlavorLabelTool(name, jetptmin, collection = "Initial")
214
215
216# ATLASRECTS-8290: remove use_barcode here
218 name="jetghostlabeler",
219 collection="Final",
220 use_barcode=False):
221
222 prefix_to_name = "HadronGhost"
223 if collection != "Final":
224 prefix_to_name += collection
225 name+=collection
226 return CompFactory.ParticleJetGhostLabelTool(
227 name,
228 **_getCommonLabelNames(prefix_to_name),
229 GhostBName = "GhostBHadrons"+collection,
230 GhostCName = "GhostCHadrons"+collection,
231 GhostTauName = "GhostTausFinal",
232 useBarcode = use_barcode, # ATLASRECTS-8290: remove this eventually
233 PartPtMin = 5000.0
234 )
235
236def getJetGhostInitialLabelTool(jetdef, modspec):
237 """get ghost-based flavor tagging labeling
238
239 This is a wrapper for JetRecConfig where it's called as
240 func(jetdef, modspec)
241 """
242 return getJetGhostFlavorLabelTool(modspec,collection = "Initial")
243
244def getJetGhostLabelTool(jetdef, modspec):
245 """get ghost-based flavor tagging labeling
246
247 This is a wrapper for JetRecConfig where it's called as
248 func(jetdef, modspec)
249 """
250 return getJetGhostFlavorLabelTool(modspec)
251
252
253# Settings of JetTruthLabelingTool for each truth label
254truthLabelSettings = {
255 # Large R labels
256 "R10TruthLabel_R21Precision_2022v1": dict(
257 TruthJetContainer = "AntiKt10TruthJets",
258 MatchUngroomedParent = True,
259 dRTruthJet = 0.75,
260 ),
261
262 "R10TruthLabel_R22v1": dict(
263 TruthJetContainer = "AntiKt10TruthJets",
264 GetTruthGroomedJetValues = True,
265 TruthGroomedJetContainer = "AntiKt10TruthSoftDropBeta100Zcut10Jets",
266 MatchUngroomedParent = True,
267 dRTruthJet = 0.75,
268 ),
269
270 "R10WZTruthLabel_R22v1": dict(
271 TruthJetContainer = "AntiKt10TruthDressedWZJets",
272 GetTruthGroomedJetValues = True,
273 TruthGroomedJetContainer = "AntiKt10TruthDressedWZSoftDropBeta100Zcut10Jets",
274 MatchUngroomedParent = True,
275 dRTruthJet = 0.75,
276 ),
277
278 # Small R labels
279 "R4TruthLabel": dict(TruthJetContainer = "AntiKt4TruthJets", dRTruthJet = 0.3, DoLargeRLabels = False),
280 "R4TruthDressedWZLabel": dict(TruthJetContainer = "AntiKt4TruthDressedWZJets", dRTruthJet = 0.3, DoLargeRLabels = False),
281 "R4InTimeTruthLabel": dict(TruthJetContainer = "InTimeAntiKt4TruthJets", dRTruthJet = 0.3, DoLargeRLabels = False),
282 "R4OutOfTimeTruthLabel": dict(TruthJetContainer = "OutOfTimeAntiKt4TruthJets", dRTruthJet = 0.3, DoLargeRLabels = False),
283}
284
285# end of truth label definition
286
287def getJetTruthLabelTool(jetdef, modspec):
288
289 isTruthJet = 'Truth' in jetdef.fullname()
290 addopts = None
291
292 if not isinstance(modspec, str):
293 raise ValueError("JetTruthLabelingTool can only be scheduled with str as modspec")
294 else:
295 if ':' in modspec:
296 truthLabel, addopts = modspec.split(':',1)
297 else:
298 truthLabel = modspec
299
300 kwargs = dict(truthLabelSettings[truthLabel])
301 if addopts:
302 if 'DeltaR' in addopts:
303 kwargs['UseGhostJetMatch'] = False
304
305 jetTruthLabelTool = CompFactory.JetTruthLabelingTool('truthlabeler_{0}'.format(truthLabel),
306 RecoJetContainer = jetdef.fullname(),
307 IsTruthJetCollection = isTruthJet,
308 TruthLabelName = truthLabel,
309 **kwargs)
310
311 return jetTruthLabelTool
312
313def getJetTruthLabelToolPrereqs(jetdef, modspec):
314 labelconfig = modspec
315 if ':' in modspec:
316 labelconfig = modspec.split(':')[0]
317 prereqs = []
318 if (jetdef._cflags.Input.isMC):
319 prereqs.append({
320 "R10WZTruthLabel_R22v1": "input:AntiKt10TruthDressedWZSoftDropBeta100Zcut10Jets",
321 "R4TruthLabel": "input:AntiKt4TruthJets",
322 "R4TruthDressedWZLabel": "input:AntiKt4TruthDressedWZJets",
323 "R4InTimeTruthLabel": "input:InTimeAntiKt4TruthJets",
324 "R4OutOfTimeTruthLabel": "input:OutOfTimeAntiKt4TruthJets",
325 "R10TruthLabel_R21Precision_2022v1": "input:AntiKt10TruthJets",
326 "R10TruthLabel_R22v1": "input:AntiKt10TruthSoftDropBeta100Zcut10Jets",
327 }[labelconfig])
328 return prereqs
329
330def getJetPileupLabelTool(jetdef, modspec):
331
332 jetPileupLabelTool = CompFactory.JetPileupLabelingTool('pileuplabeler',
333 RecoJetContainer = jetdef.fullname(),
334 TruthJetContainer= "AntiKt4TruthDressedWZJets")
335
336 return jetPileupLabelTool
337
338def getJetIRCSafeLabelTool(jetdef, modspec):
339 """returns the IRCSafe labelling tools, applying four new flavour labelling
340 schemes to truth particle jets and then matching them in terms of deltaR
341 to any type of reconstructed jets (for now the radius of truth jets is
342 set by hand to R = 0.4, so shouldnt really be used for other jets)
343 """
344 tool_kwargs = dict(
345 LabelNameIFN = "IRCSafeLabelIFN",
346 LabelNameCMP = "IRCSafeLabelCMP",
347 LabelNameGHS = "IRCSafeLabelGHS",
348 LabelNameSDF = "IRCSafeLabelSDF",
349 LabelNameAKT = "IRCSafeLabelAKT",
350 BParticleCollection = "TruthLabelBHadronsFinal",
351 CParticleCollection = "TruthLabelCHadronsFinal",
352 TruthParticleCollection = "JetInputTruthParticles",
353 EnabledAlgorithms = ["IFN","CMP","GHS","SDF","AKT"],
354 TruthJetPtMin = 5000.0,
355 JetPtMin = 10000.0,
356 DRMax = 0.3,
357 TruthR = 0.4
358 )
359 return CompFactory.JetIRCSafeLabelTool("jetircsafelabeler", **tool_kwargs)
getJetTruthLabelToolPrereqs(jetdef, modspec)
getJetGhostLabelTool(jetdef, modspec)
getJetDeltaRLabelTool(jetdef, modspec)
getCopyTruthJetParticlesGEN(modspec, cflags)
getJetQuarkChargeTool(jetdef, modspec)
getJetIRCSafeLabelTool(jetdef, modspec)
getJetDeltaRInitialLabelTool(jetdef, modspec)
getJetPileupLabelTool(jetdef, modspec)
getJetGhostInitialLabelTool(jetdef, modspec)
getCopyTruthJetParticles(modspec, cflags)
getJetQuarkChargeLabelTool(name='jetquarkcharge', output_label="QuarkChargeTruthLabelID", hadron_label="HadronGhostInitialTruthLabelPdgId", parton_label="PartonExtendedTruthLabelID")
getJetDeltaRFlavorLabelTool(name='jetdrlabeler', jet_pt_min=5000, collection="Final", dr_max=0.3, use_barcode=False)
getJetGhostFlavorLabelTool(name="jetghostlabeler", collection="Final", use_barcode=False)
getJetTruthLabelTool(jetdef, modspec)