InDetTrackPerfMonFlags.py

Go to the documentation of this file.

# Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
 
#from AthenaConfiguration.Enums import LHCPeriod
 
 
def __createIDTPMConfigFlags():
    from AthenaConfiguration.AthConfigFlags import AthConfigFlags
    icf = AthConfigFlags()
 
    icf.addFlag( "DirName", "InDetTrackPerfMonPlots/" )
    icf.addFlag( "trkAnaNames", ["Default"] )
    icf.addFlag( "plotsDefFormat", "JSON" )
    icf.addFlag( "plotsDefFileList" , "InDetTrackPerfMon/PlotsDefFileList_default.txt" )
    icf.addFlag( "plotsCommonValuesFile", "" )
    icf.addFlag( "sortPlotsByChain", False )
    
    icf.addFlag( "trkAnaCfgFile", '' )
    icf.addFlag( 'outputFilePrefix','myIDTPM_out')
    icf.addFlag( 'unpackTrigChains', False )
    icf.addFlag( 'commonTrkAnaFlags', [] )
    return icf
 
 
 
def __createIDTPMTrkAnaConfigFlags():
    from AthenaConfiguration.AthConfigFlags import AthConfigFlags
    icf = AthConfigFlags()
 
    # General properties
    icf.addFlag( "enabled", True )
    icf.addFlag( "anaTag", "" )
    icf.addFlag( "SubFolder", "" )
    # Test-Reference collections properties
    icf.addFlag( "TestType", "Offline" )
    icf.addFlag( "RefType", "Truth" )
    icf.addFlag( "doTrigNavigation", False )
    icf.addFlag( "TrigTrkKey"    , "" )
    icf.addFlag( "OfflineTrkKey" , "InDetTrackParticles" )
    icf.addFlag( "TruthPartKey"  , "TruthParticles" )
    icf.addFlag( "TrigVtxKey"    , "" )
    icf.addFlag( "OfflineVtxKey" , "PrimaryVertices" )
    icf.addFlag( "TruthVtxKey"  , "TruthVertices" )
    icf.addFlag( "pileupSwitch"  , "HardScatter" )
    # Cluster/space-point collections properties (for offline-type, ITk/ACTS only)
    icf.addFlag( "doClusterValidation"      , False )
    icf.addFlag( "PixelClusterKey"          , "" )
    icf.addFlag( "StripClusterKey"          , "" )
    icf.addFlag( "PixelSpacePointKey"       , "" )
    icf.addFlag( "StripSpacePointKey"       , "" )
    icf.addFlag( "StripOverlapSpacePointKey", "" )
    # Matching properties
    icf.addFlag( "MatchingType"    , "DeltaRMatch" )
    icf.addFlag( "dRmax"           , 0.05 )
    icf.addFlag( "pTResMax"        , -9.9 )
    icf.addFlag( "truthProbCut"    , 0.5 )
    # Trigger-specific properties
    icf.addFlag( "ChainNames"    , [] )
    icf.addFlag( "RoiKey"        , "" )
    icf.addFlag( "ChainLeg"      , -1 )
    icf.addFlag( "doTagNProbe"   , False )
    icf.addFlag( "RoiKeyTag"     , "" )
    icf.addFlag( "ChainLegTag"   , 0 )
    icf.addFlag( "RoiKeyProbe"   , "" )
    icf.addFlag( "ChainLegProbe" , 1 )
    # Offline tracks selection properties
    icf.addFlag( "SelectOfflineObject", "" )
    icf.addFlag( "OfflineQualityWP"   , "", help="Apply track quality selection cuts to the reconstructed tracks, if blank no selections is done" )
    icf.addFlag( "DoOfflineSelection", False )
    icf.addFlag( "offlMaxZ0SinTheta",               -9999. )
    icf.addFlag( "offlMinNInnermostLayerHits",      -9999. )
    icf.addFlag( "offlMinNBothInnermostLayersHits", -9999. )
    icf.addFlag( "offlMaxNInnermostLayerSharedHits",-9999. )
    icf.addFlag( "offlMinNSiHits",                  -9999. )
    icf.addFlag( "offlMaxNSiSharedHits",            -9999. )
    icf.addFlag( "offlMaxNSiHoles",                 -9999. )
    icf.addFlag( "offlMinNPixelHits",               -9999. )
    icf.addFlag( "offlMaxNPixelSharedHits",         -9999. )
    icf.addFlag( "offlMaxNPixelHoles",              -9999. )
    icf.addFlag( "offlMinNSctHits",                 -9999. )
    icf.addFlag( "offlMaxNSctSharedHits",           -9999.)
    icf.addFlag( "offlMaxNSctHoles",                -9999. )
    icf.addFlag( "offlMaxChiSq",                    -9999. )
    icf.addFlag( "offlMaxChiSqperNdf",              -9999. )
    icf.addFlag( "offlMinPt"   , -9999.)
    icf.addFlag( "offlMaxPt"   , -9999. )
    icf.addFlag( "offlMinEta"  , -9999. )
    icf.addFlag( "offlMaxEta"  , -9999. )
    icf.addFlag( "offlMinPhi"  , -9999. )
    icf.addFlag( "offlMaxPhi"  , -9999. )
    icf.addFlag( "offlMinD0"   , -9999. )
    icf.addFlag( "offlMaxD0"   , -9999. )
    icf.addFlag( "offlMinZ0"   , -9999. )
    icf.addFlag( "offlMaxZ0"   , -9999. )
    icf.addFlag( "offlMinQoPT" , -9999. )
    icf.addFlag( "offlMaxQoPT" , -9999. )
    icf.addFlag( "offlMaxAbsEta"  , -9999. )
    icf.addFlag( "offlMinAbsEta"  , -9999. )
    icf.addFlag( "offlMinAbsPhi"  , -9999. )
    icf.addFlag( "offlMaxAbsPhi"  , -9999. )
    icf.addFlag( "offlMinAbsD0"   , -9999. )
    icf.addFlag( "offlMaxAbsD0"   , -9999. )
    icf.addFlag( "offlMinAbsZ0"   , -9999. )
    icf.addFlag( "offlMaxAbsZ0"   , -9999. )
    icf.addFlag( "offlMinAbsQoPT" , -9999. )
    icf.addFlag( "offlMaxAbsQoPT" , -9999. )
 
    icf.addFlag( "offlEtaBins"  , [] )
    icf.addFlag( "offlMinHitsVector" , [] )
    icf.addFlag( "offlMinPtVector" , [] )
    icf.addFlag( "offlMaxD0Vector" , [] )
    icf.addFlag( "offlMaxZ0Vector" , [] )
    icf.addFlag( "offlMinProb"        ,  -9999. )
    icf.addFlag( "ObjectQuality"      , "Medium" )
    icf.addFlag( "TauType"            , "RNN" )
    icf.addFlag( "TauNprongs"         , 1 )
    icf.addFlag( "TruthProbMin"       , 0.5 )
    # Truth particles selection properties
    icf.addFlag( "SelectTruthObject"   , "" )
    icf.addFlag( "truthMinPt"   , -9999., help="Apply minimum pt cut to truth particle" )
    icf.addFlag( "truthMaxPt"   , -9999., help="Apply maximum pt cut to truth particle" )
    icf.addFlag( "truthMinEta"  , -9999., help="Apply minimum eta cut to truth particle" )
    icf.addFlag( "truthMaxEta"  , -9999., help="Apply maximum eta cut to truth particle" )
    icf.addFlag( "truthMinPhi"  , -9999., help="Apply minimum phi cut to truth particle" )
    icf.addFlag( "truthMaxPhi"  , -9999., help="Apply maximum phi cut to truth particle" )
    icf.addFlag( "truthMinD0"   , -9999., help="Apply minimum d0 cut to truth particle" )
    icf.addFlag( "truthMaxD0"   , -9999., help="Apply maximum d0 cut to truth particle" )
    icf.addFlag( "truthMinZ0"   , -9999., help="Apply minimum z0 cut to truth particle" )
    icf.addFlag( "truthMaxZ0"   , -9999., help="Apply maximum z0 cut to truth particle" )
    icf.addFlag( "truthMinQoPT" , -9999., help="Apply minimum q/pt cut to truth particle" )
    icf.addFlag( "truthMaxQoPT" , -9999., help="Apply maximum q/pt cut to truth particle" )
    icf.addFlag( "truthMinAbsEta"  , -9999., help="Apply minimum |eta| cut to truth particle" )
    icf.addFlag( "truthMaxAbsEta"  , -9999., help="Apply maximum |eta| cut to truth particle" )
    icf.addFlag( "truthMinAbsPhi"  , -9999., help="Apply minimum |phi| cut to truth particle" )
    icf.addFlag( "truthMaxAbsPhi"  , -9999., help="Apply maximum |phi| cut to truth particle" )
    icf.addFlag( "truthMinAbsD0"   , -9999., help="Apply minimum |d0| cut to truth particle" )
    icf.addFlag( "truthMaxAbsD0"   , -9999., help="Apply maximum |d0| cut to truth particle" )
    icf.addFlag( "truthMinAbsZ0"   , -9999., help="Apply minimum |z0| cut to truth particle" )
    icf.addFlag( "truthMaxAbsZ0"   , -9999., help="Apply maximum |z0| cut to truth particle" )
    icf.addFlag( "truthMinAbsQoPT" , -9999., help="Apply minimum |q/pt| cut to truth particle" )
    icf.addFlag( "truthMaxAbsQoPT" , -9999., help="Apply maximum |q/pt| cut to truth particle" )
    icf.addFlag( "truthPdgId"   , -9999., help="Apply pdgId selection to truth particle" )
 
    icf.addFlag( "truthMinParentPt" , -9999. )
    icf.addFlag( "truthMaxParentPt", -9999. )
 
 
    # Jet-track matching properties
    icf.addFlag( "JetContainerName", "InTimeAntiKt4TruthJets" )
    icf.addFlag( "maxTrkJetDR", 0.4 )
    icf.addFlag( "jetMinAbsEta", -9999. )
    icf.addFlag( "jetMaxAbsEta", 4.0 )
    icf.addFlag( "jetMinPt", 1000.0 )
    icf.addFlag( "jetMaxPt", 5000000.0 )
    # Histogram properties
    icf.addFlag( "plotTrackParameters"      , True )
    icf.addFlag( "plotTrackParametersErrors", False )
    icf.addFlag( "plotTrackMultiplicities"  , True )
    icf.addFlag( "plotEfficiencies"         , True )
    icf.addFlag( "plotTechnicalEfficiencies", False )
    icf.addFlag( "useActsSiMeasurements"    , False )
    icf.addFlag( "plotResolutions"          , True )
    icf.addFlag( "plotFakeRates"            , True )
    icf.addFlag( "unlinkedAsFakes"          , True )
    icf.addFlag( "plotDuplicateRates"       , False )
    icf.addFlag( "plotHitsOnTracks"         , True )
    icf.addFlag( "plotHitsOnTracksExpert"   , False )
    icf.addFlag( "plotHitsOnTracksReference", False )
    icf.addFlag( "plotHitsOnMatchedTracks"  , False )
    icf.addFlag( "plotHitsOnFakeTracks"     , False )
    icf.addFlag( "plotVertexParameters"     , True )
    icf.addFlag( "useSelectedVertexTracks"  , False )
    icf.addFlag( "plotOfflineElectrons"     , False )
    icf.addFlag( "ResolutionMethod"         , "iterRMS" )
    
    return icf
 
 
def initializeIDTPMConfigFlags(flags):
    flags.addFlagsCategory( "PhysVal.IDTPM",
                           __createIDTPMConfigFlags , prefix=True )
    
    flags.addFlag( 'Output.doWriteAOD_IDTPM', False )
    flags.addFlag( 'Output.AOD_IDTPMFileName', 'myIDTPM_out.AOD_IDTPM.pool.root' )
    return flags
 
 
 
def initializeIDTPMTrkAnaConfigFlags( flags ):
    # Set output file names
    prefix = flags.PhysVal.IDTPM.outputFilePrefix
    if 'HIST.root' in prefix :
        flags.PhysVal.OutputFileName = prefix
        flags.Output.AOD_IDTPMFileName = prefix.replace( 'HIST', 'AOD_IDTPM.pool' )
    else :
        flags.PhysVal.OutputFileName = prefix + '.HIST.root'
        flags.Output.AOD_IDTPMFileName = prefix + '.AOD_IDTPM.pool.root'
 
    # Default TrackAnalysis configuration flags category
    flags.addFlagsCategory( "PhysVal.IDTPM.Default", 
                            __createIDTPMTrkAnaConfigFlags, 
                            prefix=True )
 
    # Common TrackAnalysis configuration flags category
    # to override individual flags in all the trkanalyses configurations with a common value
    flags.addFlagsCategory( "PhysVal.IDTPM.Common",
                            __createIDTPMTrkAnaConfigFlags,
                            prefix=True )
 
    
    commonTrkAnaFlags_new = []
    for f in flags.PhysVal.IDTPM.commonTrkAnaFlags :
        if "PhysVal.IDTPM.Common." not in f :
            commonTrkAnaFlags_new.append( "PhysVal.IDTPM.Common."+f )
        else : commonTrkAnaFlags_new.append(f)
 
    # Update PhysVal.IDTPM.Common flags category with values parsed from commonTrkAnaFlags_new
    # This is used to keep flags values of the correct/consitent type
    if commonTrkAnaFlags_new :
        flags.fillFromArgs( listOfArgs=commonTrkAnaFlags_new )
 
    from InDetTrackPerfMon.ConfigUtils import getTrkAnaDicts
    analysesDict = getTrkAnaDicts( flags )
    trkAnaNames = []
 
    if analysesDict:
        for trkAnaName, trkAnaDict in analysesDict.items():
            # Append TrkAnalysisName to list
            trkAnaNames.append( trkAnaName )
 
            # separate flag category for each TrkAnalysis
            flags.addFlagsCategory( "PhysVal.IDTPM."+trkAnaName, 
                                    __createIDTPMTrkAnaConfigFlags, 
                                    prefix=True )
 
            # set flags from values in trkAnaDict
            for fname, fvalue in trkAnaDict.items():
                
                if fname.startswith( "_comment" ): continue
                
                setattr( flags.PhysVal.IDTPM, trkAnaName+"."+fname, fvalue )
 
            # override flags for this trkAna with common ones from commonTrkAnaFlags
            for cflag in commonTrkAnaFlags_new :
                cfname  = cflag.split('=')[0].split('.')[-1] # parsing only the name of the flag
                cfvalue = getattr( flags.PhysVal.IDTPM.Common, cfname ) # getting its value in the correct type
                setattr( flags.PhysVal.IDTPM, trkAnaName+"."+cfname, cfvalue )
 
            
            types = [ getattr( flags.PhysVal.IDTPM, trkAnaName+".TestType" ),
                      getattr( flags.PhysVal.IDTPM, trkAnaName+".RefType" ) ]
            if "Trigger" in types :
                setattr( flags.PhysVal.IDTPM, trkAnaName+".doTrigNavigation", True )
 
    if trkAnaNames:
        flags.PhysVal.IDTPM.trkAnaNames = trkAnaNames
 
    return flags