ATLAS Offline Software
Loading...
Searching...
No Matches
InDetGNNTrackingConfig.py
Go to the documentation of this file.
2# Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
3#
4
5from pathlib import Path
6
7from AthenaConfiguration.ComponentAccumulator import ComponentAccumulator
8from AthenaConfiguration.ComponentFactory import CompFactory
9from InDetGNNTracking.InDetGNNTrackingConfigFlags import GNNTrackFinderToolType
10
11
13 flags, name="DumpObjects", outfile="Dump_GNN4Itk.root", **kwargs):
14 '''
15 create algorithm which dumps GNN training information to ROOT file
16 '''
17 acc = ComponentAccumulator()
18
19 acc.addService(
20 CompFactory.THistSvc(
21 Output=[f"{name} DATAFILE='{outfile}', OPT='RECREATE'"]
22 )
23 )
24
25 kwargs.setdefault("NtupleFileName", flags.Tracking.GNN.DumpObjects.NtupleFileName)
26 kwargs.setdefault("NtupleTreeName", flags.Tracking.GNN.DumpObjects.NtupleTreeName)
27 kwargs.setdefault("rootFile", True)
28
29 acc.addEventAlgo(CompFactory.InDet.DumpObjects(name, **kwargs))
30 return acc
31
32def GNNTrackFinderToolCfg(flags, name='GNNTrackFinderTool', **kwargs):
33 """Sets up a GNNTrackFinderTool tool and returns it."""
34 acc = ComponentAccumulator()
35
36
37 kwargs.setdefault("embeddingDim", flags.Tracking.GNN.TrackFinder.embeddingDim)
38 kwargs.setdefault("rVal", flags.Tracking.GNN.TrackFinder.rVal)
39 kwargs.setdefault("knnVal", flags.Tracking.GNN.TrackFinder.knnVal)
40 kwargs.setdefault("filterCut", flags.Tracking.GNN.TrackFinder.filterCut)
41 kwargs.setdefault("inputMLModelDir", flags.Tracking.GNN.TrackFinder.inputMLModelDir)
42 kwargs.setdefault("ccCut", flags.Tracking.GNN.TrackFinder.ccCut)
43 kwargs.setdefault("walkMin", flags.Tracking.GNN.TrackFinder.walkMin)
44 kwargs.setdefault("walkMax", flags.Tracking.GNN.TrackFinder.walkMax)
45 kwargs.setdefault("EmbeddingFeatureNames", flags.Tracking.GNN.TrackFinder.EmbeddingFeatureNames)
46 kwargs.setdefault("EmbeddingFeatureScales", flags.Tracking.GNN.TrackFinder.EmbeddingFeatureScales)
47 kwargs.setdefault("FilterFeatureNames", flags.Tracking.GNN.TrackFinder.FilterFeatureNames)
48 kwargs.setdefault("FilterFeatureScales", flags.Tracking.GNN.TrackFinder.FilterFeatureScales)
49 kwargs.setdefault("GNNFeatureNames", flags.Tracking.GNN.TrackFinder.GNNFeatureNames)
50 kwargs.setdefault("GNNFeatureScales", flags.Tracking.GNN.TrackFinder.GNNFeatureScales)
51
52 from AthOnnxComps.OnnxRuntimeInferenceConfig import OnnxRuntimeInferenceToolCfg
53 ort_exe_provider = flags.Tracking.GNN.TrackFinder.ORTExeProvider
54 kwargs.setdefault("Embedding", acc.popToolsAndMerge(
55 OnnxRuntimeInferenceToolCfg(flags, str(Path(kwargs["inputMLModelDir"]) / "embedding.onnx"),
56 ort_exe_provider, name="Embedding")
57 ))
58 kwargs.setdefault("Filtering", acc.popToolsAndMerge(
59 OnnxRuntimeInferenceToolCfg(flags, str(Path(kwargs["inputMLModelDir"]) / "filtering.onnx"),
60 ort_exe_provider, name="Filtering")
61 ))
62 kwargs.setdefault("GNN", acc.popToolsAndMerge(
63 OnnxRuntimeInferenceToolCfg(flags, str(Path(kwargs["inputMLModelDir"]) / "gnn.onnx"),
64 ort_exe_provider, name="GNN")
65 ))
66
67 acc.setPrivateTools(CompFactory.InDet.SiGNNTrackFinderTool(name, **kwargs))
68 return acc
69
70
71def GNNTrackFinderTritonToolCfg(flags, name='GNNTrackFinderTritonTool', **kwargs):
72 """Sets up a GNNTrackFinderTritonTool tool and returns it."""
73 from AthTritonComps.TritonToolConfig import TritonToolCfg
74
75 acc = ComponentAccumulator()
76
77 kwargs.setdefault("TritonTool", acc.popToolsAndMerge(
78 TritonToolCfg(flags, model_name=flags.Tracking.GNN.Triton.model,
79 url=flags.Tracking.GNN.Triton.url,
80 port=flags.Tracking.GNN.Triton.port,
81 AddModelNameHeader=flags.Tracking.GNN.Triton.addModelNameHeader,
82 ))
83 )
84 kwargs.setdefault("SpacepointFeatureTool", acc.popToolsAndMerge(SpacepointFeatureToolCfg(flags)))
85 kwargs.setdefault("FeatureNames", flags.Tracking.GNN.spacepointFeatures)
86 acc.setPrivateTools(CompFactory.InDet.GNNTrackFinderTritonTool(name, **kwargs))
87 return acc
88
89
90def ActsGnnModuleMapFinderToolCfg(flags, name='ActsGnnModuleMapFinderTool', **kwargs):
91 """Sets up an ActsGnnModuleMapFinderTool and returns it."""
92 acc = ComponentAccumulator()
93
94 kwargs.setdefault("moduleMapPath", flags.Tracking.GNN.ActsPipeline.moduleMapPath)
95 kwargs.setdefault("gnnPath", flags.Tracking.GNN.ActsPipeline.gnnPath)
96 kwargs.setdefault("edgeCut", flags.Tracking.GNN.ActsPipeline.edgeCut)
97 kwargs.setdefault("numTrtContexts", flags.Tracking.GNN.ActsPipeline.numTrtContexts)
98 kwargs.setdefault("minCandidateMeasurements", flags.Tracking.GNN.ActsPipeline.minCandidateMeasurements)
99 kwargs.setdefault("trackBuilder", flags.Tracking.GNN.ActsPipeline.trackBuilder.value)
100 kwargs.setdefault("elcMaxHitsPerTrack", flags.Tracking.GNN.ActsPipeline.elcMaxHitsPerTrack)
101 kwargs.setdefault("SpacepointFeatureTool", acc.popToolsAndMerge(SpacepointFeatureToolCfg(flags)))
102
103 acc.setPrivateTools(CompFactory.InDet.ActsGnnModuleMapFinderTool(name, **kwargs))
104 return acc
105
106
107def SeedFitterToolCfg(flags, name="SeedFitterTool", **kwargs):
108 """Sets up a SeedFitter tool and returns it."""
109 acc = ComponentAccumulator()
110
111
112 acc.setPrivateTools(CompFactory.InDet.SeedFitterTool(name, **kwargs))
113 return acc
114
115
116def SpacepointFeatureToolCfg(flags, name="SpacepointFeatureTool", **kwargs):
117 """Sets up a SpacepointFeature tool and returns it."""
118 acc = ComponentAccumulator()
119
120
121 acc.setPrivateTools(CompFactory.InDet.SpacepointFeatureTool(name, **kwargs))
122 return acc
123
124
125def GNNTrackReaderToolCfg(flags, name='GNNTrackReaderTool', **kwargs):
126 """Set up a GNNTrackReader tool and return it."""
127 acc = ComponentAccumulator()
128
129
130 kwargs.setdefault("inputTracksDir", flags.Tracking.GNN.TrackReader.inputTracksDir)
131 kwargs.setdefault("csvPrefix", flags.Tracking.GNN.TrackReader.csvPrefix)
132
133 acc.setPrivateTools(CompFactory.InDet.GNNTrackReaderTool(name, **kwargs))
134 return acc
135
136def GNNTrackMakerCfg(flags, name="GNNTrackMaker", **kwargs):
137 """Sets up a GNNTrackMaker algorithm and returns it."""
138
139 if flags.Tracking.GNN.usePixelHitsOnly:
140 return GNNSeedingTrackMakerCfg(flags, name, **kwargs)
141
142 return GNNEndToEndTrackMaker(flags, name, **kwargs)
143
144def GNNEndToEndTrackMaker(flags, name="GNNEndToEndTrackMaker", **kwargs):
145 """Sets up a GNNTrackMaker algorithm and returns it."""
146
147 acc = ComponentAccumulator()
148
149
150 SeedFitterTool = acc.popToolsAndMerge(SeedFitterToolCfg(flags))
151 kwargs.setdefault("SeedFitterTool", SeedFitterTool)
152
153 from TrkConfig.CommonTrackFitterConfig import ITkTrackFitterCfg
154 InDetTrackFitter = acc.popToolsAndMerge(ITkTrackFitterCfg(flags))
155 kwargs.setdefault("TrackFitter", InDetTrackFitter)
156
157 if "TrackSummaryTool" not in kwargs:
158 from TrkConfig.TrkTrackSummaryToolConfig import ITkTrackSummaryToolCfg
159
160 kwargs.setdefault(
161 "TrackSummaryTool", acc.popToolsAndMerge(ITkTrackSummaryToolCfg(flags))
162 )
163
164 if flags.Tracking.GNN.ToolType == GNNTrackFinderToolType.TrackFinder:
165 InDetGNNTrackFinderTool = acc.popToolsAndMerge(GNNTrackFinderToolCfg(flags))
166 kwargs.setdefault("GNNTrackFinderTool", InDetGNNTrackFinderTool)
167 kwargs.setdefault("GNNTrackReaderTool", None)
168 elif flags.Tracking.GNN.ToolType == GNNTrackFinderToolType.TrackReader:
169 InDetGNNTrackReader = acc.popToolsAndMerge(GNNTrackReaderToolCfg(flags))
170 kwargs.setdefault("GNNTrackReaderTool", InDetGNNTrackReader)
171 kwargs.setdefault("GNNTrackFinderTool", None)
172 elif flags.Tracking.GNN.ToolType == GNNTrackFinderToolType.Triton:
173 InDetGNNTrackFinderTool = acc.popToolsAndMerge(GNNTrackFinderTritonToolCfg(flags))
174 kwargs.setdefault("GNNTrackReaderTool", None)
175 kwargs.setdefault("GNNTrackFinderTool", InDetGNNTrackFinderTool)
176 elif flags.Tracking.GNN.ToolType == GNNTrackFinderToolType.ActsPipeline:
177 InDetGNNTrackFinderTool = acc.popToolsAndMerge(ActsGnnModuleMapFinderToolCfg(flags))
178 kwargs.setdefault("GNNTrackReaderTool", None)
179 kwargs.setdefault("GNNTrackFinderTool", InDetGNNTrackFinderTool)
180 else:
181 raise RuntimeError("GNNTrackFinder or GNNTrackReader must be enabled!")
182
183 kwargs.setdefault("areInputClusters", flags.Tracking.GNN.useClusterTracks)
184 kwargs.setdefault("doRecoTrackCuts", flags.Tracking.GNN.doRecoTrackCuts)
185 kwargs.setdefault("saveEdgeScore", flags.Tracking.GNN.ActsPipeline.saveEdgeScore)
186
187 # add eta dependent cut service
188 if "InDetEtaDependentCutSvc" not in kwargs:
189 from InDetConfig.InDetEtaDependentCutsConfig import ITkEtaDependentCutsSvcCfg
190 acc.merge(ITkEtaDependentCutsSvcCfg(flags))
191 kwargs.setdefault("InDetEtaDependentCutsSvc", acc.getService("ITkEtaDependentCutsSvc"+flags.Tracking.ActiveConfig.extension))
192
193 kwargs.setdefault("minClusters", flags.Tracking.GNN.minClusters)
194 kwargs.setdefault("pTmin", flags.Tracking.GNN.pTmin)
195 kwargs.setdefault("etamax", flags.Tracking.GNN.etamax)
196 kwargs.setdefault("minPixelClusters", flags.Tracking.GNN.minPixelClusters)
197 kwargs.setdefault("minStripClusters", flags.Tracking.GNN.minStripClusters)
198
199 acc.addEventAlgo(CompFactory.InDet.SiSPGNNTrackMaker(name, **kwargs))
200 return acc
201
202def GNNSeedingTrackMakerCfg(flags, name="GNNSeedingTrackMaker", **kwargs):
203 """Sets up a GNN for seeding algorithm and returns it."""
204 acc = ComponentAccumulator()
205
206 from InDetConfig.SiCombinatorialTrackFinderToolConfig import SiDetElementBoundaryLinksCondAlg_xk_ITkPixel_Cfg, SiDetElementBoundaryLinksCondAlg_xk_ITkStrip_Cfg
207 acc.merge(SiDetElementBoundaryLinksCondAlg_xk_ITkPixel_Cfg(flags))
208 acc.merge(SiDetElementBoundaryLinksCondAlg_xk_ITkStrip_Cfg(flags))
209
210 # To produce AtlasFieldCacheCondObj
211 from MagFieldServices.MagFieldServicesConfig import (
212 AtlasFieldCacheCondAlgCfg)
213 acc.merge(AtlasFieldCacheCondAlgCfg(flags))
214
215 from TrkConfig.TrkRIO_OnTrackCreatorConfig import ITkRotCreatorCfg
216 ITkRotCreator = acc.popToolsAndMerge(ITkRotCreatorCfg(
217 flags, name="ITkRotCreator"+flags.Tracking.ActiveConfig.extension))
218 acc.addPublicTool(ITkRotCreator)
219 kwargs.setdefault("RIOonTrackTool", ITkRotCreator)
220
221 from TrkConfig.TrkExRungeKuttaPropagatorConfig import (
222 RungeKuttaPropagatorCfg)
223 ITkPatternPropagator = acc.popToolsAndMerge(
224 RungeKuttaPropagatorCfg(flags, name="ITkPatternPropagator"))
225 acc.addPublicTool(ITkPatternPropagator)
226 kwargs.setdefault("PropagatorTool", ITkPatternPropagator)
227
228 from TrkConfig.TrkMeasurementUpdatorConfig import KalmanUpdator_xkCfg
229 ITkPatternUpdator = acc.popToolsAndMerge(
230 KalmanUpdator_xkCfg(flags, name="ITkPatternUpdator"))
231 acc.addPublicTool(ITkPatternUpdator)
232 kwargs.setdefault("UpdatorTool", ITkPatternUpdator)
233
234 from InDetConfig.InDetBoundaryCheckToolConfig import ITkBoundaryCheckToolCfg
235 kwargs.setdefault("BoundaryCheckTool", acc.popToolsAndMerge(
236 ITkBoundaryCheckToolCfg(flags)))
237
238 from PixelConditionsTools.ITkPixelConditionsSummaryConfig import (
239 ITkPixelConditionsSummaryCfg)
240 kwargs.setdefault("PixelSummaryTool", acc.popToolsAndMerge(
241 ITkPixelConditionsSummaryCfg(flags)))
242
243 from SCT_ConditionsTools.ITkStripConditionsToolsConfig import (
244 ITkStripConditionsSummaryToolCfg)
245 kwargs.setdefault("StripSummaryTool", acc.popToolsAndMerge(
246 ITkStripConditionsSummaryToolCfg(flags)))
247
248 if flags.Tracking.GNN.useTrackFinder:
249 kwargs.setdefault("GNNTrackFinderTool", acc.popToolsAndMerge(GNNTrackFinderToolCfg(flags)))
250 kwargs.setdefault("GNNTrackReaderTool", None)
251 elif flags.Tracking.GNN.useTrackReader:
252 kwargs.setdefault("GNNTrackReaderTool", acc.popToolsAndMerge(GNNTrackReaderToolCfg(flags)))
253 kwargs.setdefault("GNNTrackFinderTool", None)
254 else:
255 raise RuntimeError("GNNTrackFinder or GNNTrackReader must be enabled!")
256
257 kwargs.setdefault("SeedFitterTool", acc.popToolsAndMerge(SeedFitterToolCfg(flags)))
258
259 from TrkConfig.CommonTrackFitterConfig import ITkTrackFitterCfg
260 kwargs.setdefault("TrackFitter", acc.popToolsAndMerge(ITkTrackFitterCfg(flags)))
261
262 from InDetConfig.SiDetElementsRoadToolConfig import ITkSiDetElementsRoadMaker_xkCfg
263 kwargs.setdefault("RoadTool", acc.popToolsAndMerge(ITkSiDetElementsRoadMaker_xkCfg(flags)))
264
265 # configurations for Kalman filter.
266 # similar to https://gitlab.cern.ch/atlas/athena/-/blob/main/InnerDetector/InDetConfig/python/SiTrackMakerConfig.py#L188
267 kwargs.setdefault("nClustersMin", flags.Tracking.ActiveConfig.minClusters[0])
268 kwargs.setdefault("nWeightedClustersMin", flags.Tracking.ActiveConfig.nWeightedClustersMin[0])
269 kwargs.setdefault("nHolesMax", flags.Tracking.ActiveConfig.maxHoles[0])
270 kwargs.setdefault("nHolesGapMax", flags.Tracking.ActiveConfig.maxHoles[0])
271
272 kwargs.setdefault("pTmin", flags.Tracking.ActiveConfig.minPT[0])
273 kwargs.setdefault("pTminBrem", flags.Tracking.ActiveConfig.minPTBrem[0])
274 kwargs.setdefault("Xi2max", flags.Tracking.ActiveConfig.Xi2max[0])
275 kwargs.setdefault("Xi2maxNoAdd", flags.Tracking.ActiveConfig.Xi2maxNoAdd[0])
276 kwargs.setdefault("Xi2maxMultiTracks", flags.Tracking.ActiveConfig.Xi2max[0])
277 kwargs.setdefault("doMultiTracksProd", False)
278
279 acc.addEventAlgo(CompFactory.InDet.GNNSeedingTrackMaker(name, **kwargs))
280 return acc
GNNTrackReaderToolCfg(flags, name='GNNTrackReaderTool', **kwargs)
GNNTrackMakerCfg(flags, name="GNNTrackMaker", **kwargs)
DumpObjectsCfg(flags, name="DumpObjects", outfile="Dump_GNN4Itk.root", **kwargs)
GNNSeedingTrackMakerCfg(flags, name="GNNSeedingTrackMaker", **kwargs)
ActsGnnModuleMapFinderToolCfg(flags, name='ActsGnnModuleMapFinderTool', **kwargs)
GNNEndToEndTrackMaker(flags, name="GNNEndToEndTrackMaker", **kwargs)
GNNTrackFinderToolCfg(flags, name='GNNTrackFinderTool', **kwargs)
SpacepointFeatureToolCfg(flags, name="SpacepointFeatureTool", **kwargs)
SeedFitterToolCfg(flags, name="SeedFitterTool", **kwargs)
GNNTrackFinderTritonToolCfg(flags, name='GNNTrackFinderTritonTool', **kwargs)