xAODTrackingCnvConfig.py

Go to the documentation of this file.

"""Define methods to construct configured Tracking conversion algorithms
 
Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
"""
from AthenaConfiguration.ComponentAccumulator import ComponentAccumulator
from AthenaConfiguration.ComponentFactory import CompFactory
from TrkConfig.TrkConfigFlags import PerigeeExpression
 

 
def TrackCollectionCnvToolCfg(flags, name="TrackCollectionCnvTool", **kwargs):
    if flags.Detector.GeometryITk:
        name = name.replace("InDet", "ITk")
        return ITkTrackCollectionCnvToolCfg(flags, name, **kwargs)
 
    result = ComponentAccumulator()
 
    if "TrackParticleCreator" not in kwargs:
        from TrkConfig.TrkParticleCreatorConfig import (
            TrackParticleCreatorToolCfg)
        TrackParticleCreator = result.popToolsAndMerge(
            TrackParticleCreatorToolCfg(flags))
        result.addPublicTool(TrackParticleCreator)
        kwargs.setdefault("TrackParticleCreator", TrackParticleCreator)
 
    result.setPrivateTools(
        CompFactory.xAODMaker.TrackCollectionCnvTool(name, **kwargs))
    return result
 
def ITkTrackCollectionCnvToolCfg(flags, name="ITkTrackCollectionCnvTool", 
                                 isActsAmbi: bool = False,
                                 **kwargs):
    result = ComponentAccumulator()
 
    if "TrackParticleCreator" not in kwargs:
        from TrkConfig.TrkParticleCreatorConfig import ITkTrackParticleCreatorToolCfg
        TrackParticleCreator = result.popToolsAndMerge(
            ITkTrackParticleCreatorToolCfg(flags, RunningTIDE_Ambi = not isActsAmbi ))
        result.addPublicTool(TrackParticleCreator)
        kwargs.setdefault("TrackParticleCreator", TrackParticleCreator)
 
    result.setPrivateTools(CompFactory.xAODMaker.TrackCollectionCnvTool(name, **kwargs))
    return result
 
def MuonTrackCollectionCnvToolCfg(flags, name = "MuonTrackCollectionCnvTool", **kwargs):
    result = ComponentAccumulator()
 
    if "TrackParticleCreator" not in kwargs:
        from TrkConfig.TrkParticleCreatorConfig import MuonCombinedParticleCreatorCfg
        TrackParticleCreator = result.popToolsAndMerge(
            MuonCombinedParticleCreatorCfg(flags))
        result.addPublicTool(TrackParticleCreator)
        kwargs.setdefault("TrackParticleCreator", TrackParticleCreator)
 
    result.setPrivateTools(CompFactory.xAODMaker.TrackCollectionCnvTool(name, **kwargs))
    return result
 

 
def TrackParticleCnvAlgCfg(flags, name="TrackParticleCnvAlg",
                           ClusterSplitProbabilityName = "",
                           AssociationMapName = "",
                           **kwargs):
    if flags.Detector.GeometryITk:
        name = name.replace("InDet", "ITk")
        return ITkTrackParticleCnvAlgCfg(flags, name,
                                         ClusterSplitProbabilityName,
                                         AssociationMapName,
                                         **kwargs)
 
    result = ComponentAccumulator()
    kwargs.setdefault("ConvertTracks", True)
    kwargs.setdefault("TrackContainerName", "CombinedInDetTracks")
    kwargs.setdefault("xAODTrackParticlesFromTracksContainerName", "InDetTrackParticles")
 
    if "TrackParticleCreator" not in kwargs:
        from TrkConfig.TrkParticleCreatorConfig import TrackParticleCreatorToolCfg
        kwargs.setdefault("TrackParticleCreator", result.popToolsAndMerge(
            TrackParticleCreatorToolCfg(
                flags,
                name = kwargs["xAODTrackParticlesFromTracksContainerName"] \
                + "CreatorTool",
                ClusterSplitProbabilityName = ClusterSplitProbabilityName,
                AssociationMapName = AssociationMapName)))
 
    if "TrackCollectionCnvTool" not in kwargs:
        result.addPublicTool(kwargs["TrackParticleCreator"])
        kwargs.setdefault("TrackCollectionCnvTool", result.popToolsAndMerge(
            TrackCollectionCnvToolCfg(
                flags,
                TrackParticleCreator = kwargs["TrackParticleCreator"])))
 
    if flags.Tracking.doTruth:
        kwargs.setdefault("TrackTruthContainerName",
                          kwargs["TrackContainerName"]+"TruthCollection")
        kwargs.setdefault("AddTruthLink", True)
        if "MCTruthClassifier" not in kwargs:
            from MCTruthClassifier.MCTruthClassifierConfig import MCTruthClassifierCfg
            kwargs.setdefault("MCTruthClassifier", result.popToolsAndMerge(
                MCTruthClassifierCfg(flags)))
    else:
        kwargs.setdefault("AddTruthLink", False)
 
    if flags.Tracking.perigeeExpression is PerigeeExpression.Vertex:
        from AthenaConfiguration.Enums import ProductionStep
        if flags.Common.ProductionStep is ProductionStep.MinbiasPreprocessing:
            kwargs.setdefault("PrimaryVerticesName", f"{flags.Overlay.BkgPrefix}PrimaryVertices")
        else:    
            kwargs.setdefault("PrimaryVerticesName", "PrimaryVertices")
 
    result.addEventAlgo(CompFactory.xAODMaker.TrackParticleCnvAlg(name, **kwargs))
    return result
 
 
def TrigTrackParticleCnvAlgCfg(flags, name="TrigTrackParticleCnvAlg",
                               ClusterSplitProbabilityName = "",
                               AssociationMapName = "",
                               **kwargs):
    
    if flags.Detector.GeometryITk:
        name = name.replace("InDet", "ITk")
        return TrigITkTrackParticleCnvAlgCfg(flags, name,
                                             ClusterSplitProbabilityName,
                                             AssociationMapName,
                                             **kwargs)
 
    kwargs.setdefault("ConvertTracks", True)
    kwargs.setdefault("TrackContainerName", "CombinedInDetTracks")
    kwargs.setdefault("xAODTrackParticlesFromTracksContainerName", "InDetTrackParticles")
    kwargs.setdefault("AddTruthLink", False)
    
    result = ComponentAccumulator()
    
    if "TrackParticleCreator" not in kwargs:
        from TrkConfig.TrkParticleCreatorConfig import InDetTrigParticleCreatorToolCfg, \
            InDetTrigParticleCreatorToolTRTPidCfg
        
        if flags.Tracking.ActiveConfig.electronPID:
            partCreatorToolCfg = InDetTrigParticleCreatorToolTRTPidCfg
        else:
            partCreatorToolCfg = InDetTrigParticleCreatorToolCfg
 
        
        kwargs.setdefault("TrackParticleCreator", result.popToolsAndMerge(
            partCreatorToolCfg(
                flags,
                name = kwargs["xAODTrackParticlesFromTracksContainerName"] + "CreatorTool",
                ClusterSplitProbabilityName = ClusterSplitProbabilityName,
                AssociationMapName = AssociationMapName)
        ))
 
    if "TrackCollectionCnvTool" not in kwargs:
        result.addPublicTool(kwargs["TrackParticleCreator"])
        kwargs.setdefault("TrackCollectionCnvTool", result.popToolsAndMerge(
            TrackCollectionCnvToolCfg(
                flags,
                TrackParticleCreator = kwargs["TrackParticleCreator"])))
 
    #temporarily - move base methods to ActiveConfig
    if flags.Tracking.ActiveConfig.perigeeExpression is PerigeeExpression.Vertex:
        kwargs.setdefault("PrimaryVerticesName", "PrimaryVertices")
    else:
        kwargs.setdefault("PrimaryVerticesName", "")
 
    result.merge(TrackParticleCnvAlgCfg(flags, name,
                                        ClusterSplitProbabilityName,
                                        AssociationMapName,
                                        **kwargs)
                 )
    
    return result
 
 
def BeamLineTrackParticleCnvAlgCfg(flags, name="BeamLineTrackParticleCnvAlg",
                                   ClusterSplitProbabilityName = "",
                                   AssociationMapName = "",
                                   **kwargs):
    result = ComponentAccumulator()
 
    if "TrackParticleCreator" not in kwargs:
        from TrkConfig.TrkParticleCreatorConfig import TrackParticleCreatorToolCfg
        kwargs.setdefault("TrackParticleCreator", result.popToolsAndMerge(
              TrackParticleCreatorToolCfg(
                  flags,
                  name="InDetxAODParticleCreatorToolBeamLine",
                  ClusterSplitProbabilityName = ClusterSplitProbabilityName,
                  AssociationMapName = AssociationMapName,
                  PerigeeExpression = "BeamLine")))
    
    if flags.Tracking.perigeeExpression is PerigeeExpression.Vertex:
        kwargs.setdefault("PrimaryVerticesName", "")
 
    result.merge(TrackParticleCnvAlgCfg(flags, name, **kwargs))
    return result
 
def TrackParticleCnvAlgPIDCheckCfg(flags, name,
                                   ClusterSplitProbabilityName = "",
                                   AssociationMapName = "",
                                   **kwargs):
    result = ComponentAccumulator()
 
    if "TrackParticleCreator" not in kwargs:
        from TrkConfig.TrkParticleCreatorConfig import TrackParticleCreatorToolPIDCheckCfg
        kwargs.setdefault("TrackParticleCreator", result.popToolsAndMerge(
            TrackParticleCreatorToolPIDCheckCfg(
                flags,
                name = kwargs["xAODTrackParticlesFromTracksContainerName"] \
                + "CreatorTool",
                ClusterSplitProbabilityName = ClusterSplitProbabilityName,
                AssociationMapName = AssociationMapName)))
 
    result.merge(TrackParticleCnvAlgCfg(flags, name, **kwargs))
    return result
 
def TrackParticleCnvAlgNoPIDCfg(flags, name,
                                ClusterSplitProbabilityName = "",
                                AssociationMapName = "",
                                **kwargs):
    result = ComponentAccumulator()
 
    if "TrackParticleCreator" not in kwargs:
        from TrkConfig.TrkParticleCreatorConfig import TrackParticleCreatorToolNoPIDCfg
        kwargs.setdefault("TrackParticleCreator", result.popToolsAndMerge(
            TrackParticleCreatorToolNoPIDCfg(
                flags,
                name = kwargs["xAODTrackParticlesFromTracksContainerName"] \
                + "CreatorTool",
                ClusterSplitProbabilityName = ClusterSplitProbabilityName,
                AssociationMapName = AssociationMapName)))
 
    result.merge(TrackParticleCnvAlgCfg(flags, name,
                                        ClusterSplitProbabilityName,
                                        AssociationMapName, **kwargs))
    return result
 
def ObserverTrackParticleCnvAlgCfg(flags, name="ObserverTrackParticleCnvAlg",
                                   ClusterSplitProbabilityName = "",
                                   AssociationMapName = "",
                                   **kwargs):
     kwargs.setdefault("TrackContainerName", "ObservedTracksCollection")
     kwargs.setdefault("xAODTrackParticlesFromTracksContainerName", "InDetObservedTrackParticles")
     kwargs.setdefault("AugmentObservedTracks", True)
     kwargs.setdefault("TracksMapName", "ObservedTracksCollectionMap")
 
     return TrackParticleCnvAlgCfg(flags, name, ClusterSplitProbabilityName, AssociationMapName, **kwargs)
 
def ITkTrackParticleCnvAlgCfg(flags, name="ITkTrackParticleCnvAlg",
                              ClusterSplitProbabilityName = "",
                              AssociationMapName = "",
                              isActsAmbi: bool = False,
                              **kwargs):
    result = ComponentAccumulator()
 
    kwargs.setdefault("ConvertTracks", True)
    kwargs.setdefault("TrackContainerName", "CombinedITkTracks")
    kwargs.setdefault("xAODTrackParticlesFromTracksContainerName", "InDetTrackParticles")
    if flags.Tracking.perigeeExpression is PerigeeExpression.Vertex:
        kwargs.setdefault('PrimaryVerticesName', 'PrimaryVertices')
    
    if "TrackParticleCreator" not in kwargs:
        from TrkConfig.TrkParticleCreatorConfig import ITkTrackParticleCreatorToolCfg
        kwargs.setdefault("TrackParticleCreator", result.popToolsAndMerge(
            ITkTrackParticleCreatorToolCfg(
                flags,
                name = kwargs["xAODTrackParticlesFromTracksContainerName"] \
                + "CreatorTool",
                ClusterSplitProbabilityName = ClusterSplitProbabilityName if not isActsAmbi else "",
                AssociationMapName = AssociationMapName)))
 
    if "TrackCollectionCnvTool" not in kwargs:
        result.addPublicTool(kwargs["TrackParticleCreator"])
        kwargs.setdefault("TrackCollectionCnvTool", result.popToolsAndMerge(
            ITkTrackCollectionCnvToolCfg(
                flags,
                TrackParticleCreator = kwargs["TrackParticleCreator"],
                isActsAmbi = isActsAmbi)))
 
    if flags.Tracking.doTruth:
        kwargs.setdefault("TrackTruthContainerName",
                          kwargs["TrackContainerName"]+"TruthCollection")
        kwargs.setdefault("AddTruthLink", True)
        if "MCTruthClassifier" not in kwargs:
            from MCTruthClassifier.MCTruthClassifierConfig import MCTruthClassifierCfg
            kwargs.setdefault("MCTruthClassifier", result.popToolsAndMerge(
                MCTruthClassifierCfg(flags)))
    else:
        kwargs.setdefault("AddTruthLink", False)
 
    result.addEventAlgo(CompFactory.xAODMaker.TrackParticleCnvAlg(name, **kwargs))
    return result
 
def TrigITkTrackParticleCnvAlgCfg(flags, name="ITkTrackParticleCnvAlg",
                                  ClusterSplitProbabilityName = "",
                                  AssociationMapName = "",
                                  isActsAmbi: bool = False,
                                  **kwargs):
    result = ComponentAccumulator()
 
    kwargs.setdefault("ConvertTracks", True)
    kwargs.setdefault("TrackContainerName", "CombinedITkTracks")
    kwargs.setdefault("xAODTrackParticlesFromTracksContainerName", "InDetTrackParticles")
    
    if flags.Tracking.ActiveConfig.perigeeExpression is PerigeeExpression.Vertex:
        kwargs.setdefault('PrimaryVerticesName', 'PrimaryVertices')
    
    if "TrackParticleCreator" not in kwargs:
        from TrkConfig.TrkParticleCreatorConfig import ITkTrackParticleCreatorToolCfg
        kwargs.setdefault("TrackParticleCreator", result.popToolsAndMerge(
            ITkTrackParticleCreatorToolCfg(
                flags,
                name = kwargs["xAODTrackParticlesFromTracksContainerName"] \
                + "CreatorTool",
                ClusterSplitProbabilityName = ClusterSplitProbabilityName if not isActsAmbi else "",
                AssociationMapName = AssociationMapName)))
 
    if "TrackCollectionCnvTool" not in kwargs:
        result.addPublicTool(kwargs["TrackParticleCreator"])
        kwargs.setdefault("TrackCollectionCnvTool", result.popToolsAndMerge(
            ITkTrackCollectionCnvToolCfg(
                flags,
                TrackParticleCreator = kwargs["TrackParticleCreator"],
                isActsAmbi = isActsAmbi)))
 
    if flags.Tracking.ActiveConfig.doTruth:
        kwargs.setdefault("TrackTruthContainerName",
                          kwargs["TrackContainerName"]+"TruthCollection")
        kwargs.setdefault("AddTruthLink", True)
        if "MCTruthClassifier" not in kwargs:
            from MCTruthClassifier.MCTruthClassifierConfig import MCTruthClassifierCfg
            kwargs.setdefault("MCTruthClassifier", result.popToolsAndMerge(
                MCTruthClassifierCfg(flags)))
    else:
        kwargs.setdefault("AddTruthLink", False)
 
    result.addEventAlgo(CompFactory.xAODMaker.TrackParticleCnvAlg(name, **kwargs))
    return result
 
def MuonStandaloneTrackParticleCnvAlgCfg(flags, name = "MuonStandaloneTrackParticleCnvAlg",**kwargs):
    from TrkConfig.TrkParticleCreatorConfig import MuonParticleCreatorToolCfg
    from BeamSpotConditions.BeamSpotConditionsConfig import BeamSpotCondAlgCfg
 
    result=ComponentAccumulator()
    result.merge(BeamSpotCondAlgCfg(flags))
 
    muonparticlecreatortool = result.popToolsAndMerge(MuonParticleCreatorToolCfg(flags))
    result.addPublicTool(muonparticlecreatortool) # Public in TrackCollectionCnvTool
 
    kwargs.setdefault("TrackParticleCreator", muonparticlecreatortool)
    muontrackcollectioncnvtool = result.popToolsAndMerge(
        MuonTrackCollectionCnvToolCfg(flags, TrackParticleCreator = muonparticlecreatortool))
    kwargs.setdefault("TrackCollectionCnvTool", muontrackcollectioncnvtool)
 
    kwargs.setdefault("TrackContainerName", "MuonSpectrometerTracks")
    kwargs.setdefault("xAODTrackParticlesFromTracksContainerName", "MuonSpectrometerTrackParticles")
    kwargs.setdefault("xAODTruthLinkVector",  "")
    kwargs.setdefault("ConvertTracks", True)
    kwargs.setdefault("AddTruthLink", False)
 
    result.addEventAlgo(CompFactory.xAODMaker.TrackParticleCnvAlg(name, **kwargs))
    return result