MuonConfigFlags.py

Go to the documentation of this file.

# Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
 
from AthenaConfiguration.AthConfigFlags import AthConfigFlags
from AthenaConfiguration.Enums import BeamType, LHCPeriod, ProductionStep, Project, FlagEnum
    
import re
 
# Some comments from Ed about existing flags
# MuonCnvExample
# - MuonCnvFlags - not sure we need this - it really only configures single properties of the various cablings - we can just do this directly.
# - MuonCalibFlags - looks like we need this
 
class GeoTrfCacheMode(FlagEnum):
    
    SlopyCache = 1
    
    ActsSlopyALineCond = 2
    
    SplitCache = 3
    
    ActsSplitALineCond = 4
    
    FullCacheCond = 5
 
class MMClusterBuilderEnum(FlagEnum):
    """Flag values for Muon.MMClusterCalibRecoTool"""
    Centroid = "Centroid"
    ClusterTimeProjection = "ClusterTimeProjection"
 
def _muonAlignMode(flags):
    # Small function that determines if the alignment flags should be true or false
    # follows the logic in https://acode-browser1.usatlas.bnl.gov/lxr/source/athena/MuonSpectrometer/MuonReconstruction/MuonRecExample/python/MuonAlignFlags.py
    problematic_tags = ['COMCOND-HLT[A-C]-00[01]-00', 'COMCOND-ES1C-00[01]-00', 'COMCOND-REPC-001', 'COMCOND-SIM-01-00']
    if any(re.match(tag,flags.IOVDb.DatabaseInstance) for tag in problematic_tags):
        return False
    elif flags.Input.isMC or not flags.Muon.enableAlignment:
        return False
    else:
        return True
 
def createMuonConfigFlags(): 
    mcf=AthConfigFlags()
 
    # stages of processing
    # 0. Geometry
 
    
    from AthenaConfiguration.AutoConfigFlags import DetDescrInfo
    
    mcf.addFlag("Muon.usePhaseIIGeoSetup",lambda prevFlags : prevFlags.Detector.GeometryMuon and
                                                                  DetDescrInfo(prevFlags.GeoModel.AtlasVersion, 
                                                                               prevFlags.GeoModel.SQLiteDB ,
                                                                               prevFlags.GeoModel.SQLiteDBFullPath)["Muon"]["useR4Plugin"] )
    
    mcf.addFlag("Muon.AlignedGeoTrfCacheMode",  GeoTrfCacheMode.FullCacheCond, type = GeoTrfCacheMode)
    
    
    mcf.addFlag("Muon.trackGeometryActiveMaterial", True)
    
    mcf.addFlag("Muon.trackGeometryPassiveMaterial", lambda prevFlags: prevFlags.Muon.usePhaseIIGeoSetup and \
                                                                       len(prevFlags.Muon.trackGeometryMaterialMap) > 0)
 
    mcf.addFlag("Muon.trackGeometryMaterialMap", "")
    # 1. Digitization
    mcf.addFlag("Muon.doFastMMDigitization", False) 
    mcf.addFlag("Muon.doFastsTGCDigitization",True) 
    mcf.addFlag("Muon.doFastRpcDigitization",False)  
    mcf.addFlag("Muon.setupTruthAlgorithms", lambda prevFlags: prevFlags.Muon.usePhaseIIGeoSetup and \
                                                               prevFlags.Input.isMC and \
                                                               not prevFlags.Trigger.doHLT)
 
    
    # 2. Reco MuonRecFlags 
 
    
    try:
        from TrkConfig.TrkConfigFlags import TrackingComponent
        mcf.addFlag("Muon.scheduleActsReco", lambda prevFlags: prevFlags.Muon.usePhaseIIGeoSetup and \
                            prevFlags.Tracking.recoChain[0] in [TrackingComponent.ActsChain , TrackingComponent.ActsLegacyChain ]) 
    except ImportError:
        mcf.addFlag("Muon.scheduleActsReco", False)
 
    try:
        from ActsConfig.ActsConfigFlags import TrackFitterType
        mcf.addFlag("Muon.TrackFitterType", TrackFitterType.GlobalChiSquareFitter)
    except ImportError:
        mcf.addFlag("Muon.TrackFitterType", "None")
 
    
    mcf.addFlag("Muon.includePileUpTruth", False)
    
    mcf.addFlag("Muon.enableMLBucketFilter", False)
    
    mcf.addFlag("Muon.expressMsTrackAtEntrance", False)
    
    mcf.addFlag("Muon.buildMETrack", lambda prevFlags: prevFlags.Reco.EnableTracking and\
                                                        not prevFlags.Muon.MuonTrigger )
 
    mcf.addFlag("Muon.doMSVertex", True) # Run MS vertex (arXiv:1311.7070)
    mcf.addFlag("Muon.doSegmentT0Fit",lambda prevFlags : prevFlags.Beam.Type is not BeamType.Collisions) # Fit MDT segments using a variable t0. Used for cosmics and single beam to compensate for large errors on the trigger time.
    mcf.addFlag("Muon.enableErrorTuning",True) # turn on error tuning to account for misalignments
    mcf.addFlag("Muon.useLooseErrorTuning",False) 
    mcf.addFlag("Muon.useTGCPriorNextBC",False) # Use TGC measurements from Prior and Next Bunch Crossings. These measurements are available in the real data since somewhere in 2008.
    mcf.addFlag("Muon.useAlignmentCorrections",True) # Apply alignment corrections to MuonGeoModel. The corrections are read from a COOL database
    
    mcf.addFlag("Muon.makePRDs",True) # Disable when e.g. re-running from ESD
    
    mcf.addFlag("Muon.enableNRPC", lambda prevFlags: prevFlags.Detector.GeometryRPC and \
                                                     prevFlags.Muon.usePhaseIIGeoSetup )
    # MuonStandaloneFlags.py 
    mcf.addFlag("Muon.printSummary", False) # Print out a summary for each event at each reco stage
    mcf.addFlag("Muon.segmentOrigin", "Muon") # Can be 'Muon','TruthTracking'
    # reconstructionMode - I think this is a complete duplication of global.BeamType. Dropping.
    mcf.addFlag("Muon.strategy", []) # CutSeedsOnTracks, CombineSegInStation, DynamicSeeding, PreferOutsideIn, AllowOneSharedHit, DoRefinement, DoAmbiSolving
    mcf.addFlag("Muon.straightLineFitMomentum", 2000.0 ) 
    #mcf.addFlag("Muon.doSegmentsOnly", True) # Also in MuonRecFlags ... redundant in both?
    mcf.addFlag("Muon.Chi2NDofCut", 20.0 )  # chi-squared per degree of freedom cut in fitter.
    mcf.addFlag("Muon.enableCurvedSegmentFinding", False ) # TODO I think this one could possibly be removed, since it really is a Tool level configuration.
    mcf.addFlag("Muon.updateSegmentSecondCoordinate", lambda prevFlags : prevFlags.Beam.Type is BeamType.Collisions) # Do not use for cosmics or singlebeam 
    
    mcf.addFlag("Muon.useSegmentMatching", lambda prevFlags : prevFlags.Beam.Type is BeamType.Collisions) # Do not use for cosmics or singlebeam 
    mcf.addFlag("Muon.useTrackSegmentMatching", True )
    mcf.addFlag("Muon.runCommissioningChain", lambda prevFlags: ( False and (prevFlags.Detector.EnableMM or prevFlags.Detector.EnablesTGC) \
                                                                 and prevFlags.Beam.Type is BeamType.Collisions) )
    
    mcf.addFlag("Muon.applyMMPassivation", lambda prevFlags: prevFlags.Detector.EnableMM and not prevFlags.Common.isOnline and (prevFlags.Common.Project is not Project.AthSimulation \
                                                      and (prevFlags.Common.ProductionStep not in [ProductionStep.Simulation, ProductionStep.FastChain] or prevFlags.Overlay.DataOverlay)))
    # CalibFlags
    mcf.addFlag("Muon.Calib.readMdtJSON", lambda prevFlags: prevFlags.GeoModel.Run > LHCPeriod.Run3 and prevFlags.Muon.usePhaseIIGeoSetup) # Toggle whether the calibration constants are read from the JSON format. Enabled by default for a Run4 geometry read by the muon phase II geometry setup 
    mcf.addFlag("Muon.Calib.fitAnalyticRt", False) #Toggle whether the look-up  R-t tables shall undergo an intermediate polynomial fit
 
    mcf.addFlag("Muon.Calib.readMDTCalibFromBlob", True)  # Read mdt tube calibration from blob-folders
    mcf.addFlag("Muon.Calib.correctMdtRtForBField", lambda prevFlags : (prevFlags.Input.isMC is False and prevFlags.Beam.Type is BeamType.Collisions)) # Apply B-field correction to drift times only for collision data (as done in https://acode-browser1.usatlas.bnl.gov/lxr/source/athena/MuonSpectrometer/MuonCnv/MuonCnvExample/python/MuonCalibFlags.py#0028)
    mcf.addFlag("Muon.Calib.correctMdtRtForTimeSlewing", lambda prevFlags : prevFlags.Input.isMC is False) # Apply time slewing correction to drift time only for data (as done in https://acode-browser1.usatlas.bnl.gov/lxr/source/athena/MuonSpectrometer/MuonCnv/MuonCnvExample/python/MuonCalibFlags.py#0028)
    
    mcf.addFlag("Muon.Calib.applySigPropUncert", lambda prevFlags: prevFlags.Muon.usePhaseIIGeoSetup )
    mcf.addFlag("Muon.Calib.useMLRt", True) # use ML-RT functions from COOL
    mcf.addFlag("Muon.Calib.applyRtScaling", False) # TODO - apparently not needed, but currently used in MuonCalibConfig. Set false to match https://acode-browser1.usatlas.bnl.gov/lxr/source/athena/MuonSpectrometer/MuonCnv/MuonCnvExample/python/MuonCalibFlags.py#0072
    mcf.addFlag("Muon.Calib.mdtCalibrationSource", "MDT") # Source for MDT t0s and rts
    mcf.addFlag("Muon.Calib.mdtPropagationSpeedBeta", lambda prevFlags : 1.0 if prevFlags.Input.isMC else 0.85) #
     
    mcf.addFlag("Muon.Calib.CscPedFromLocalFile", False)  
    mcf.addFlag("Muon.Calib.CscNoiseFromLocalFile", False)  
    mcf.addFlag("Muon.Calib.CscPSlopeFromLocalFile", False)  
    mcf.addFlag("Muon.Calib.CscStatusFromLocalFile", False)  
    mcf.addFlag("Muon.Calib.CscRmsFromLocalFile", False)  
    mcf.addFlag("Muon.Calib.CscF001FromLocalFile", False)  
    mcf.addFlag("Muon.Calib.CscT0BaseFromLocalFile", False)  
    mcf.addFlag("Muon.Calib.CscT0PhaseFromLocalFile", False)  
    
    mcf.addFlag("Muon.Calib.EventTag", "MoMu") 
    
    #  Choose the (MDT) calibration mode.
    # 'ntuple'       : write standard calibration ntuple (up to segments)
    # 'trackNtuple'  : write standard ntuple + tracks
    # 'regionNtuple' : write one ntuple per calibration region
    # 't0Classic'    : do classic t0 calibration
    # 't0MT'         : do MT t0 calibration
    # 'rtClassic'    : do classic rt calibration
    # 'rtAnalytic'   : do analytic rt calibration
    mcf.addFlag("Muon.Calib.mdtMode", "ntuple")
 
 
    # for now the T0 calibration in the NSW should be disabled by default until a final calibration is available. Introducing the flags anyhow to allow for studies of the calibration 
    # do not apply NSW T0 calibration if we are running online or MC or a RUN4 geometry, keep only for 23 or 24 
    mcf.addFlag("Muon.Calib.applyMmT0Correction",   lambda prevFlags: prevFlags.GeoModel.Run==LHCPeriod.Run3 and prevFlags.Input.DataYear != 2022 and not prevFlags.Common.isOnline and not prevFlags.Input.isMC )
    mcf.addFlag("Muon.Calib.applysTgcT0Correction", lambda prevFlags: prevFlags.GeoModel.Run<LHCPeriod.Run4  and not prevFlags.Common.isOnline and not prevFlags.Input.isMC and False) 
    mcf.addFlag("Muon.Calib.applyMmBFieldCalib", True) 
    
    # Muon Align flags
    
    mcf.addFlag("Muon.Align.UseALines", lambda prevFlags: (_muonAlignMode(prevFlags)))
    mcf.addFlag("Muon.Align.UseBLines", lambda prevFlags: prevFlags.Muon.Align.UseALines)
    mcf.addFlag("Muon.Align.UseILines", lambda prevFlags: (_muonAlignMode(prevFlags))  and  \
                                                          prevFlags.Detector.GeometryCSC and 'HLT' not in prevFlags.IOVDb.GlobalTag)
    mcf.addFlag("Muon.Align.UseAsBuilt", lambda prevFlags: (_muonAlignMode(prevFlags)) and not \
                                                           (prevFlags.IOVDb.DatabaseInstance == 'COMP200' or \
                                                            'HLT' in prevFlags.IOVDb.GlobalTag or prevFlags.Common.isOnline) )
    mcf.addFlag("Muon.Align.UsesTGCAsBuild", lambda prevFlags: (_muonAlignMode(prevFlags)) and not prevFlags.Common.isOnline and prevFlags.GeoModel.Run == LHCPeriod.Run3)
 
    # Muon Trigger Flags
    mcf.addFlag("Muon.MuonTrigger", False) 
    mcf.addFlag("Muon.SAMuonTrigger", False) 
    mcf.addFlag("Muon.disableNSWForL2SA", True)
 
    mcf.addFlag("Muon.enableAlignment",lambda flags: (flags.Common.Project is not Project.AthSimulation \
                                                      and not (flags.Common.ProductionStep in [ProductionStep.Simulation, ProductionStep.FastChain] or flags.Overlay.DataOverlay)))
    mcf.addFlag("Muon.enableTrigIDtrackReuse", False)
    # configuration of the DESDM_MCP output format 
 
    mcf.addFlag("Muon.DESDM_MCP.doAlignmentFormat", False) # Flag to stear the DESDM_MCP format which switches to a looser event selection for toroid off runs used for alignment. 
    mcf.addFlag("Muon.DESDM_MCP.doExtendedAlignmentContent", False) # Flag to enable electron, photon and jet containers in DESDM_MCP for dedicate studies of the toroid off data. 
 
    # configuration to write out RPC RDO for trigger timing calibration
    mcf.addFlag("Muon.doWriteRpcRDO", True)
 
    mcf.addFlag("Muon.writeSDOs", lambda prevFlags : prevFlags.Output.doWriteESD and prevFlags.Input.isMC)
 
    # configure the MM cluster reco method that is used in the cluster calibration step 
    #Use charge weighted only for trigger and 2022 where not sure if the t0 calibrations that we have are ok dor the commissioning phase of the NSW in 2022
    mcf.addFlag("Muon.MMClusterCalibRecoTool", lambda prevFlags: MMClusterBuilderEnum.Centroid if (prevFlags.Common.isOnline or prevFlags.Input.DataYear == 2022 or prevFlags.Beam.Type is not BeamType.Collisions) else MMClusterBuilderEnum.ClusterTimeProjection, type=MMClusterBuilderEnum)
 
    mcf.addFlag("Muon.writexAODPRD", lambda prevFlags: prevFlags.Muon.usePhaseIIGeoSetup) # Output new xAOD format from convertors (to be removed once the old format is deprecated)
    # use the MDT DCS data to determine if a chamber is alive or not. This is used in the hole search and the region selector. Needs to be false if the job is running online or is the reconstruction of the MDT calib stream
    mcf.addFlag("Muon.useMdtDcsData", lambda prevFlags : not prevFlags.Common.isOnline and prevFlags.Detector.GeometryMDT)
 
 
    # TODO - add configuration for above    
        
    return mcf