ActsConfigFlags.py

Go to the documentation of this file.

# Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
 
from AthenaConfiguration.AthConfigFlags import AthConfigFlags
from AthenaConfiguration.Enums import FlagEnum, LHCPeriod
 
class SeedingStrategy(FlagEnum):
    GridTriplet = "GridTriplet"
    Gbts = "Gbts"
    F150 = "F150"
    Gnn = "Gnn"
 
class AmbiguitySolverStrategy(FlagEnum):
    Greedy = "GreedySolver"
    ScoreBased = "ScoreBasedAmbiguitySolver"
 
# Which implementation to use for space point formation
# ActsTrk  : the Athena implementation
# ActsCore : the ACTS space point builders, and the only one supporting cosmics
class SpacePointStrategy(FlagEnum):
    ActsTrk = "ActsTrk"
    ActsCore = "ActsCore"
 
# Define the Ambiguity resolution strategy modes
# OUTSIDE_TF : run the ambiguity resolution in a separate algorithm
# END_OF_TF  : run the ambiguity resolution at the end of the track finding, on the track candidate container
# DURING_TF  : remove the tracks that share too many hits during track finding, when deciding good candidates
class AmbiguitySolverMode(FlagEnum):
    OUTSIDE_TF = 0
    END_OF_TF = 1
    DURING_TF = 2
 
# Define the Pixel cluster calibration error strategy modes (the errors that will be used for filtering)
# CALIBRATED : load the calibration constants from database
# PITCH  : if we used broad clusters during clustering (so the error is the cluster width) rescale it by the number of pixels
#          to assign the pitch as error to the cluster
class PixelErrorStrategy(FlagEnum):
    CALIBRATED = 0
    PITCH = 1
 
# Define the Strip clustering errors assigned to the measurements during clustering
# These errors will be used during track finding
# PITCH : assign the pitch as cluster error
# WIDTH : use the cluster width as cluster error
# TUNED : use an error 1.05 x pitch for 1strip clusters, a 0.27 x width for 2strip clusters and width for >=3strip clusters
class StripClusteringErrorMode(FlagEnum):
    PITCH = 0
    WIDTH = 1
    TUNED = 2
 
# Define the Strip cluster calibration error strategy modes (the errors that will be used for filtering)
# CLUSTERING : Use directly the clustering errors
# PITCH  : if we used broad clusters during clustering (so the error is the cluster width) rescale it by the number of pixels
#          to assign the pitch as error to the cluster
class StripErrorStrategy(FlagEnum):
    CLUSTERING = 0
    PITCH = 1
 
class TrackFitterType(FlagEnum):
    KalmanFitter = 'KalmanFitter' # default ACTS fitter to choose
    GaussianSumFitter = 'GaussianSumFitter' # new experimental implementation
    GlobalChiSquareFitter = 'GlobalChiSquareFitter' # new experimental implementation
 
# Flag for pixel calibration strategy during track finding
# - use cluster as is (Uncalibrated)
# - perform AnalogueClustering either before selecting
#   measurements for extending tracks (AnalogueClusteringBeforeSelection)
# - or only apply the AnalogueClustering to selected measurements
#   (AnalogueClustering)
# - or add NN corrections, again either on the selected measurements
#   (NNClustering) or on all candidates (NNClusteringBeforeSelection)
# - or use truth information (TruthClusterSplitting)
class PixelCalibrationStrategy(FlagEnum):
    Uncalibrated = "Uncalibrated"
    AnalogueClusteringBeforeSelection = "AnalogueClusteringBeforeSelection"
    AnalogueClustering = "AnalogueClustering"
    NNClusteringBeforeSelection = "NNClusteringBeforeSelection"
    NNClustering = "NNClustering"
    TruthClusterSplitting = "TruthClusterSplitting"
 
    def usesCalibration(self):
        """whether a calibrator is needed at all"""
        return self is not PixelCalibrationStrategy.Uncalibrated
 
    def usesNN(self):
        """whether NN corrections are applied on top"""
        return self in (PixelCalibrationStrategy.NNClustering,
                        PixelCalibrationStrategy.NNClusteringBeforeSelection)
 
    def calibrateBeforeSelection(self):
        """whether only the selected measurements are calibrated"""
        return self in (PixelCalibrationStrategy.AnalogueClusteringBeforeSelection,
                        PixelCalibrationStrategy.NNClustering)
 
# Flag for strip calibration strategy during track finding
# - use cluster as is (Uncalibrated)
# - use strip pitch / sqrt(12) as error either before selecting
#   measurements for extending tracks (DigitalCalibrationBeforeSelection)
# - or only apply it to selected measurements (DigitalCalibration)
class StripCalibrationStrategy(FlagEnum):
    Uncalibrated = "Uncalibrated"
    DigitalCalibrationBeforeSelection = "DigitalCalibrationBeforeSelection"
    DigitalCalibration = "DigitalCalibration"
 
    def usesCalibration(self):
        """whether a calibrator is needed at all"""
        return self is not StripCalibrationStrategy.Uncalibrated
 
    def calibrateBeforeSelection(self):
        """whether only the selected measurements are calibrated"""
        return self is StripCalibrationStrategy.DigitalCalibrationBeforeSelection
 
# Define which space points of a seed are used for the track parameter estimation
# FirstThree             : the first 3 SPs
# FirstThreeLongMomentum : the first 3 SPs, with q/p from the first, middle and last SPs
# FirstMiddleLast        : the first, middle and last SPs
# MinDeltaR              : the first 3 SPs, that are separated by more than Acts.minDeltaRParameterEstimation
# All                    : a helix fit of all SPs
class ParameterEstimationMode(FlagEnum):
    FirstThree = 0
    FirstThreeLongMomentum = 1
    FirstMiddleLast = 2
    MinDeltaR = 3
    All = 4
 
 
def createActsConfigFlags():
    actscf = AthConfigFlags()
 
    # General Flags
    actscf.addFlag('Acts.EDM.PersistifyClusters', lambda pcf: pcf.Acts.EDM.PersistifySpacePoints and not pcf.Tracking.StoreSlimmedDataPreparation)
    actscf.addFlag('Acts.EDM.PersistifySpacePoints', lambda pcf: pcf.Tracking.StoreSlimmedDataPreparation)
    actscf.addFlag('Acts.EDM.PersistifyTracks', False)
    # set to True to use the PhaseII pixel and strip RAW data EDM
    actscf.addFlag('Acts.EDM.PhaseII', False)
    actscf.addFlag('Acts.useCache', False)
    # special persistifications
    actscf.addFlag('Acts.EDM.SlimContent', lambda pcf: pcf.Tracking.StoreSlimmedDataPreparation)
 
    # Scheduling
    from InDetConfig.ITkActsHelpers import primaryPassUsesActs
    actscf.addFlag('Acts.doITkConversion', lambda pcf: (
        pcf.Detector.EnableCalo and primaryPassUsesActs(pcf)))
    actscf.addFlag('Acts.doLargeRadius', True)
    actscf.addFlag('Acts.doLowPt', False)
 
    # Geometry Flags
 
    # MaterialSource can be:
    # a path to a local JSON file
    # 'Default' : material map source is evaluated from the geometry tag
    # 'None'    : no material map is provided
    actscf.addFlag('Acts.TrackingGeometry.MaterialSource', 'Default')
    actscf.addFlag('Acts.TrackingGeometry.MaterialCalibrationFolder', 'ACTS/MaterialMaps/ITk')
    actscf.addFlag('Acts.TrackingGeometry.MaterialFileExtension', '')
    actscf.addFlag('Acts.TrackingGeometry.UseBlueprint', False)
    actscf.addFlag('Acts.TrackingGeometry.BuildDetrayGeometry', False)
    actscf.addFlag('Acts.TrackingGeometry.ObjDebugOutput', False)
    actscf.addFlag('Acts.TrackingGeometry.FrustumNav', False)
    actscf.addFlag('Acts.TrackingGeometry.KeepGoingOnMaterialMergeFailure', False)
    # ITkMaterialSource can be:
    # a path to a local file
    # 'Default' : material map source is evaluated from the geometry tag
    # 'None'    : no material map is provided
    actscf.addFlag('Acts.TrackingGeometry.ITkHgtdMaterialSource', 'Default')
    actscf.addFlag('Acts.TrackingGeometry.ITkHgtdMaterialMapPath', 'ACTS/MaterialMaps/gen3')
 
    #MuonMaterialSource can be:
    # a path to a local file
    # 'Default' : material map source is evaluated from the geometry tag
    # 'None'    : no material map is provided
    actscf.addFlag('Acts.TrackingGeometry.MuonMaterialSource', 'Default')
    actscf.addFlag('Acts.TrackingGeometry.MuonMaterialMapPath', 'ACTS/MaterialMaps/gen3')
 
    
    actscf.addFlag('Acts.TrackingGeometry.InsertITkPassiveMaterialLayers', False)
    actscf.addFlag('Acts.TrackingGeometry.PassiveITkInnerPixelBarrelLayerRadii', [70.])
    actscf.addFlag('Acts.TrackingGeometry.PassiveITkInnerPixelBarrelLayerHalflengthZ', [240.])
    actscf.addFlag('Acts.TrackingGeometry.PassiveITkInnerPixelBarrelLayerThickness', [1.])
    actscf.addFlag('Acts.TrackingGeometry.PassiveITkOuterPixelBarrelLayerRadii', [195., 260.])
    actscf.addFlag('Acts.TrackingGeometry.PassiveITkOuterPixelBarrelLayerHalflengthZ', [370., 370.])
    actscf.addFlag('Acts.TrackingGeometry.PassiveITkOuterPixelBarrelLayerThickness', [1., 1.])
    actscf.addFlag('Acts.TrackingGeometry.PassiveITkStripBarrelLayerRadii', [480., 665., 880.])
    actscf.addFlag('Acts.TrackingGeometry.PassiveITkStripBarrelLayerHalflengthZ', [1370., 1370., 1370.])
    actscf.addFlag('Acts.TrackingGeometry.PassiveITkStripBarrelLayerThickness', [1., 1., 1.])
    #Flags to enable the active and the passive material in the muon tracking geometry.
    #Enable chamber material blending on the portals of the chambers
    actscf.addFlag('Acts.TrackingGeometry.MuonActiveMaterial', True)
    #Enable the construction of binned material surfaces that are decorated with the passive material maps
    actscf.addFlag('Acts.TrackingGeometry.MuonPassiveMaterial', True)
    # Monitoring
    actscf.addFlag('Acts.doMonitoring', False)
    actscf.addFlag('Acts.doAnalysis', False)
    actscf.addFlag('Acts.doAnalysisNtuples', lambda pcf: pcf.Acts.doAnalysis)
    actscf.addFlag('Acts.Clusters.doAnalysis', lambda pcf: pcf.Acts.doAnalysis)
    actscf.addFlag('Acts.Seeds.doAnalysis', lambda pcf: pcf.Acts.doAnalysis)
    actscf.addFlag('Acts.Tracks.doAnalysis', lambda pcf: pcf.Acts.doAnalysis)
    actscf.addFlag('Acts.Particles.doAnalysis', lambda pcf: pcf.Acts.doAnalysis)
    actscf.addFlag('Acts.storeTrackStateInfo', False)
    actscf.addFlag('Acts.doTruthInspection', False)
    # Truth match probability from the truth-linked measurements only (measurements without truth particle weigh 1
    # and cannot be the best match); by default it is computed the legacy way
    actscf.addFlag('Acts.truthLinkedFakeRate', False)
    # Save Trk::Track link for combined muon reconstruction, temporary
    actscf.addFlag('Acts.doxAODToTrkConversion', True)
 
    # Cluster
    actscf.addFlag("Acts.Clusters.UseWeightedPosition", False)
    actscf.addFlag("Acts.Clusters.RetrieveChargeInformation", True)
    actscf.addFlag("Acts.Clusters.StripClusteringErrorMode", StripClusteringErrorMode.PITCH,type=StripClusteringErrorMode)
    actscf.addFlag("Acts.Clusters.UsePixelBroadErrors", False)
 
    # SpacePoint
    actscf.addFlag('Acts.SpacePoints.useBeamSpotConstraintStrips', True)
    actscf.addFlag('Acts.SpacePoints.doPixel', lambda pcf: pcf.Detector.EnableITkPixel)
    actscf.addFlag('Acts.SpacePoints.doStrip', lambda pcf: (
        pcf.Detector.EnableITkStrip and (
            not pcf.Tracking.doITkFastTracking or
            pcf.Acts.doLargeRadius or pcf.Acts.doLowPt or
            pcf.Acts.doITkConversion)))
    actscf.addFlag('Acts.SpacePoints.doAnalysis', lambda pcf: pcf.Acts.doAnalysis)
 
    # Strip and pixel are chosen separately so that either can be validated on its own
    actscf.addFlag('Acts.SpacePointStrategy', SpacePointStrategy.ActsCore, type=SpacePointStrategy)
    actscf.addFlag('Acts.PixelSpacePointStrategy', SpacePointStrategy.ActsCore, type=SpacePointStrategy)
 
    # Seeding
    actscf.addFlag("Acts.Gbts.connectionTable", 'binTables_ITK_RUN4.txt')
    actscf.addFlag("Acts.Gbts.connectionTableLrt", 'binTables_ITK_RUN4_LRT.txt')
    actscf.addFlag("Acts.Gbts.dumpGbtsGeometry", False)
    actscf.addFlag("Acts.Gbts.geometryDump", 'gbts_layer_geometry.txt') # for gbts training tool
 
    # GBTS Training
    
    actscf.addFlag("Acts.Gbts.Training.enable", False)
    actscf.addFlag("Acts.Gbts.Training.outputConnectionTable", "gbts_connection_table.txt")
    actscf.addFlag("Acts.Gbts.Training.doSymmetrization", False)
    actscf.addFlag("Acts.Gbts.Training.useOldFormatting", False)
    actscf.addFlag("Acts.Gbts.Training.probThreshold", -1.0)
    
    actscf.addFlag("Acts.Gbts.Training.usePixelClusters", True)
    actscf.addFlag("Acts.Gbts.Training.useStripClusters", True)
 
    # Track finding
    actscf.addFlag('Acts.PixelCalibrationStrategy', PixelCalibrationStrategy.Uncalibrated, type=PixelCalibrationStrategy)
    actscf.addFlag('Acts.StripCalibrationStrategy', StripCalibrationStrategy.Uncalibrated, type=StripCalibrationStrategy)
    actscf.addFlag('Acts.doRotCorrection', True)
    actscf.addFlag('Acts.doPrintTrackStates', False)
    actscf.addFlag('Acts.skipDuplicateSeeds', True)
    actscf.addFlag('Acts.doTwoWayCKF', True) # run CKF twice, first with forward propagation with smoothing, then with backward propagation
    actscf.addFlag('Acts.useStripSeedsFirst', False) # switch order of seed collections
    actscf.addFlag('Acts.useHGTDClusterInTrackFinding', False) # use HGTD cluster in track finding
    actscf.addFlag('Acts.branchStopperMeasCutReduce', 2)
    actscf.addFlag('Acts.branchStopperAbsEtaMeasCut', 1.2)
    actscf.addFlag('Acts.SeedRefitOutlierChi2Cut', float('inf'))  # OutlierChi2Cut for the seed refit Kalman fitter, applied whenever a seed refit is scheduled. inf == disabled.
    actscf.addFlag('Acts.LrtStripSeedRefit', False)  # Toggle the LRT strip-seed refit (KF on strip seeds before CKF).
    actscf.addFlag('Acts.stripCalibrationIterations', 1)  # Strip-SP calibration iterations in TrackParamsEstimationTool (all passes).
    actscf.addFlag('Acts.parameterEstimationMode', ParameterEstimationMode.FirstMiddleLast,
            type=ParameterEstimationMode)  # SPs of a seed used in TrackParamsEstimationTool (the GNN chain uses its own flag)
    actscf.addFlag('Acts.minDeltaRParameterEstimation', 15.0)  # Minimum separation (mm) of the SPs used in TrackParamsEstimationTool for ParameterEstimationMode.MinDeltaR
    actscf.addFlag('Acts.forceTrackOnSeed', True) # force track to use the seed measurements; steer from the outside if a setup needs it disabled
    actscf.addFlag('Acts.PixelNNCalibrationModelsFolder', 'ITkPixelClusterization/nn-01-01-01/') # location of models for pixel ONNX files, extpected content of the foder are: number.onnx, pos1.onnx, pos2.onnx, pos3.onnx
                                                                       # the files are located in /cvmfs/atlas.cern.ch/repo/sw/database/GroupData/
                                                                       # this flag is used only if PixelCalibrationStrategy is one of the NN strategies
    actscf.addFlag('Acts.refitSeeds', False) # refit seeds for CKF initial parameters
    actscf.addFlag('Acts.initialVarInflation', [1., 1., 1., 1., 1., 1.]) # inflate variances after track parameter estimation
    actscf.addFlag('Acts.doBremRecovery', False)
    actscf.addFlag('Acts.phiWidthROI', lambda pcf: pcf.Tracking.phiWidthBrem)
    actscf.addFlag('Acts.etaWidthROI', lambda pcf: pcf.Tracking.etaWidthBrem)
 
    # Ambiguity resolution
    actscf.addFlag('Acts.doAmbiguityResolution', False)
    actscf.addFlag('Acts.AmbiguitySolverStrategy', AmbiguitySolverStrategy.Greedy, type=AmbiguitySolverStrategy)  # Define Ambiguity Solver Strategy
    actscf.addFlag('Acts.AmbiguitySolverMode', lambda pcf: AmbiguitySolverMode.OUTSIDE_TF if pcf.Acts.doAmbiguityResolution else AmbiguitySolverMode.DURING_TF, type=AmbiguitySolverMode)
 
    # Calibrations
    actscf.addFlag('Acts.OnTrackCalibration.performCovarianceCalibration', True) # perform calibration of covariance during on track analogue cluster calibration
 
    # Track fitting
    actscf.addFlag('Acts.writeTrackCollection', False) # save to file (ESD, AOD) the Resolved and Refitted track collections
    actscf.addFlag('Acts.fitFromPRD', False) # Acts.writeTrackCollection needs to be True for either cases. If Acts.fitFromPRD is False, fit from ROT; else, fit from PRD
    actscf.addFlag('Acts.trackFitterType', TrackFitterType.KalmanFitter, type=TrackFitterType) # Define Tracking algorithm for refitting
 
    # GSF specific flags
    actscf.addFlag("Acts.GsfRefitLegacyTrk", False) # Refit Legacy tracks using ACTS GSF
    actscf.addFlag("Acts.GsfRefitActs", lambda pcf:
                   pcf.GeoModel.Run >= LHCPeriod.Run4) # Refit ACTS tracks using ACTS GSF
    actscf.addFlag("Acts.GsfMaxComponents", 12)
    actscf.addFlag("Acts.GsfComponentMergeMethod", 'MaxWeight')
    actscf.addFlag("Acts.GsfWeightCutoff", 1e-4)
    actscf.addFlag("Acts.GsfDirectNavigation", lambda pcf:
                   pcf.GeoModel.Run >= LHCPeriod.Run4)
    actscf.addFlag("Acts.GsfOutlierChi2Cut", 1e4) # Effectively no cut. Compatible with legacy
    actscf.addFlag("Acts.extrapolateElectronsLegacy", lambda pcf:
                   not pcf.Acts.TrackingGeometry.UseBlueprint) # Use legacy calo extrapolation with ACTS tracks
 
    # Decorations
    actscf.addFlag('Acts.decoratePRD.sdoSiHit', lambda pcf: pcf.Tracking.doTIDE_AmbiTrackMonitoring)
 
    # GPU track reconstruction
    actscf.addFlag("Acts.Device.doCellSorting", True)
    actscf.addFlag("Acts.Device.doClusterization", False)
    actscf.addFlag("Acts.Device.doSpacePointFormation", False)
    actscf.addFlag("Acts.Device.doSeeding", False)
    actscf.addFlag("Acts.Device.seedingStrategy", SeedingStrategy.GridTriplet, type=SeedingStrategy)
    actscf.addFlag("Acts.Device.doTrackReconstruction", False)
    actscf.addFlag("Acts.Device.doLargeRadiusPass", False)
 
    # GNN specific flags (scoped)
    actscf.addFlag("Acts.GNN.Enable", False)
    actscf.addFlag("Acts.GNN.ModuleMapPath", "<default>")
    actscf.addFlag("Acts.GNN.ModelPath", "<default>")
    actscf.addFlag("Acts.GNN.NumTrtContexts", 1)
    actscf.addFlag("Acts.GNN.MaxGpuInstances", 1)
    actscf.addFlag("Acts.GNN.VarianceInflation", 1.0)
    actscf.addFlag("Acts.GNN.TightSeeds", False)
    actscf.addFlag("Acts.GNN.MinCandidateMeasurements", 7)
    actscf.addFlag("Acts.GNN.EdgeCut", 0.5)
    actscf.addFlag("Acts.GNN.NumFeatures", 12)  # input features per spacepoint, 4 for pixel-only models
    actscf.addFlag("Acts.GNN.RelaxCentralHoleSel", False)
    actscf.addFlag("Acts.GNN.RelaxMeasurementSel", True)
    actscf.addFlag("Acts.GNN.OfflineZ0Sel", False)
    actscf.addFlag("Acts.GNN.ParameterEstimationMode", ParameterEstimationMode.All, type=ParameterEstimationMode)  # SPs of a GNN seed used in TrackParamsEstimationTool
 
    return actscf