BTaggingConfigFlags Namespace Reference

Functions
def	getGrades (flags)
def	getTaggerList (flags)
def	minimumJetPtForTrackAssociation (flags)
def	calibrationTag (flags)
def	saveSv1 (prevFlags)
def	runOldSecVrtSecIncl (prevFlags)
def	isRun3Derivation (flags)
def	runFlipTag (flags)
def	getNNs (flags)
def	createBTaggingConfigFlags ()

Variables
	Run1Grades
	Run2Grades
	Run4Grades
	calibrationChannelAliases

Function Documentation

calibrationTag()

def BTaggingConfigFlags.calibrationTag

(

flags

)

Definition at line 55 of file BTaggingConfigFlags.py.

def calibrationTag(flags):
    if flags.GeoModel.Run >= LHCPeriod.Run4:
        return "BTagCalibITk-23-00-03-v1"
    return ""
 
 

createBTaggingConfigFlags()

def BTaggingConfigFlags.createBTaggingConfigFlags

(

)

Definition at line 158 of file BTaggingConfigFlags.py.

def createBTaggingConfigFlags():
    btagcf = AthConfigFlags()
 
    btagcf.addFlag("BTagging.taggerList", getTaggerList)
    btagcf.addFlag("BTagging.databaseScheme", '')
    btagcf.addFlag("BTagging.calibrationChannelAliases",
                   calibrationChannelAliases)
    btagcf.addFlag("BTagging.forcedCalibrationChannel", '')
    btagcf.addFlag("BTagging.calibrationTag",
                   calibrationTag)
 
    # the track association minimum is set to 4 GeV because of track
    # jets in offline reconstruction.
    btagcf.addFlag("BTagging.minimumJetPtForTrackAssociation",
                   minimumJetPtForTrackAssociation)
 
    # these are only used for IPxD and SV1 likelihoods
    btagcf.addFlag("BTagging.RunModus", "analysis") # reference mode used in FlavourTagPerformanceFramework (RetagFragment.py)
    btagcf.addFlag("BTagging.ReferenceType", "ALL") # reference type for IP and SV taggers (B, UDSG, ALL)
    btagcf.addFlag("BTagging.JetPtMinRef", 15e3) # in MeV for uncalibrated pt
    btagcf.addFlag("BTagging.Grades", getGrades)
 
 
    # Taggers for validation
    btagcf.addFlag("BTagging.SaveSV1Probabilities", saveSv1)
    # Run the flip taggers
    btagcf.addFlag("BTagging.RunFlipTaggers", runFlipTag)
 
   # Trackless approach
    btagcf.addFlag("BTagging.Trackless", False)
    btagcf.addFlag("BTagging.Trackless_JetCollection", "AntiKt4EMPFlowJets")
    btagcf.addFlag("BTagging.Trackless_JetPtMin", 250*Units.GeV)
    btagcf.addFlag("BTagging.Trackless_dR", 0.4)
 
    # more aggressive trackless approach
    btagcf.addFlag("BTagging.savePixelHits", False)
    btagcf.addFlag("BTagging.saveSCTHits", False)
 
    # experimental flags
    btagcf.addFlag("BTagging.Pseudotrack", False)
 
    #NewVrtSecInclusiveAlg
    btagcf.addFlag("BTagging.RunNewVrtSecInclusive", runOldSecVrtSecIncl)
 
    # track classification tool flags
    btagcf.addFlag("BTagging.TrkClassFiveBinMode",False)
 
    # a flag to add V0finder
    btagcf.addFlag("BTagging.AddV0Finder", False)
 
    # GNN vertex fitter
    btagcf.addFlag("BTagging.GNNVertexFitter", False)
 
    # (multifold) NN trainings, each jet collection maps to a list of
    # dicts. The dict has several keys:
    #  - folds: list of NNs to run
    #  - remapping (optional): any variable remapping
    btagcf.addFlag("BTagging.NNs", getNNs)
 
    return btagcf

getGrades()

def BTaggingConfigFlags.getGrades

(

flags

)

Definition at line 28 of file BTaggingConfigFlags.py.

def getGrades(flags):
    if flags.GeoModel.Run is LHCPeriod.Run1:
        return Run1Grades
    elif flags.GeoModel.Run in [LHCPeriod.Run2, LHCPeriod.Run3]:
        return Run2Grades
    else:
        return Run4Grades
 
 

getNNs()

def BTaggingConfigFlags.getNNs

(

flags

)

Gets the paths of models to run via MultiFoldTagger.

Definition at line 78 of file BTaggingConfigFlags.py.

def getNNs(flags):
    '''
    Gets the paths of models to run via MultiFoldTagger.
    '''
 
    # dummy for now
    caldir = 'BTagging/20231205/GN2v01/antikt4empflow'
    pf_nns = [f'{caldir}/network_fold{n}.onnx' for n in range(4)]
 
    # We can save our results to the jet container, rather than the b-tagging container
    # but this functionality is not yet setup for non multi-fold taggers. The easiest (/hackiest)
    # solution is to pass all the GN3 paths below as seperate single-fold-multi-fold-taggers
    # But this *should* be cleaned up at some point
    # Note also, reco tests failing due to leptonID missing, so for now don't run taggers unless derivation
    # https://gitlab.cern.ch/atlas/athena/-/merge_requests/77764#note_9063625
    gn3v00_paths = [
        "BTagging/20250213/GN3V00/antikt4empflow/network.onnx", # Only tracks
        "BTagging/20250213/GN3PflowMuonsV00/antikt4empflow/network.onnx", # Tracks+Muons+PFlow
    ] if isRun3Derivation(flags) else []
    gn3v01_paths = [
        "BTagging/20250912/GN3EPCLV01/antikt4empflow/network.onnx", # Electrons+Pflow+Charge+Muons
    ] if isRun3Derivation(flags) else []
    # Combine the paths for GN3v00 and GN3v01 models
    gn3_paths = gn3v00_paths + gn3v01_paths
 
    lrj_paths = [
             "BTagging/20230705/gn2xv01/antikt10ufo/network.onnx",
             "BTagging/20240925/GN2Xv02/antikt10ufo/network.onnx",
             "BTagging/20250310/GN2XTauV00/antikt10ufo/network.onnx",
             "BTagging/20250912/GN3XPV01/antikt10ufo/network.onnx",
             "JetCalibTools/CalibArea-00-04-83/CalibrationFactors/bbJESJMS_calibFactors_R22_MC20_CSSKUFO_bJR10v00Ext_20250212.onnx", # bJR10v00Ext
             "JetCalibTools/CalibArea-00-04-83/CalibrationFactors/bbJESJMS_calibFactors_R22_MC20MC23_CSSKUFO_bJR10v01_20250212.onnx" # bJR10v01
    ]
    # we can't flip large-R taggers
    noflip = dict(flip=False)
 
    return {
        'AntiKt4EMPFlowJets': [
            {
                'folds': pf_nns,
                'hash': 'jetFoldHash',
                'cone_association': True,
            },
            *[{'folds' : [nn_path]} for nn_path in gn3_paths]
        ],
        'AntiKt4EMTopoJets': [
            {
                'folds': pf_nns,
                'hash': 'jetFoldHash',
                'cone_association': True,
            },
        ],
        'AntiKt4EMPFlowCustomVtxJets': [
            {
                'folds': pf_nns,
                'hash': 'jetFoldHash',
                'cone_association': True
            },
            *[{'folds' : [nn_path]} for nn_path in gn3_paths]
        ],
        'AntiKt4EMPFlowByVertexJets': [
            {
                'folds': pf_nns,
                'hash': 'jetFoldHash',
                'cone_association': True
            }
        ],
        'AntiKt10UFOCSSKSoftDropBeta100Zcut10Jets': [
            {'folds' : [nn_path], **noflip} for nn_path in lrj_paths
        ],
        'DFAntiKt4HIJets': [
            {
                'folds': pf_nns,
                'hash': 'jetFoldHash',
                'cone_association': True
            }
        ]
    }
 
 

getTaggerList()

def BTaggingConfigFlags.getTaggerList

(

flags

)

Definition at line 37 of file BTaggingConfigFlags.py.

def getTaggerList(flags):
    base = ['IP2D','IP3D','SV1','JetFitterNN']
    if flags.Trigger.doHLT:
        base = []
    elif flags.GeoModel.Run >= LHCPeriod.Run4:
        base += ['MV2c10']
    flip = ['IP2DNeg', 'IP3DNeg','IP2DFlip', 'IP3DFlip','SV1Flip']
    if flags.BTagging.RunFlipTaggers:
        return base + flip
    return base
 
 

isRun3Derivation()

def BTaggingConfigFlags.isRun3Derivation

(

flags

)

Definition at line 69 of file BTaggingConfigFlags.py.

def isRun3Derivation(flags):
    derivation = flags.Common.ProductionStep is ProductionStep.Derivation
    before_the_future = flags.GeoModel.Run < LHCPeriod.Run4
    return derivation and before_the_future
 
 

minimumJetPtForTrackAssociation()

def BTaggingConfigFlags.minimumJetPtForTrackAssociation

(

flags

)

Definition at line 49 of file BTaggingConfigFlags.py.

def minimumJetPtForTrackAssociation(flags):
    if flags.Trigger.doHLT:
        return 5e3
    return 4e3
 
 

runFlipTag()

def BTaggingConfigFlags.runFlipTag

(

flags

)

Definition at line 75 of file BTaggingConfigFlags.py.

def runFlipTag(flags):
    return isRun3Derivation(flags)
 

runOldSecVrtSecIncl()

def BTaggingConfigFlags.runOldSecVrtSecIncl

(

prevFlags

)

Definition at line 65 of file BTaggingConfigFlags.py.

def runOldSecVrtSecIncl(prevFlags):
    return prevFlags.Common.ProductionStep is ProductionStep.Derivation
 
 

saveSv1()

def BTaggingConfigFlags.saveSv1

(

prevFlags

)

Definition at line 61 of file BTaggingConfigFlags.py.

def saveSv1(prevFlags):
    return prevFlags.GeoModel.Run >= LHCPeriod.Run4
 
 

Variable Documentation

calibrationChannelAliases

BTaggingConfigFlags.calibrationChannelAliases

Definition at line 18 of file BTaggingConfigFlags.py.

Run1Grades

BTaggingConfigFlags.Run1Grades

Definition at line 8 of file BTaggingConfigFlags.py.

Run2Grades

BTaggingConfigFlags.Run2Grades

Definition at line 9 of file BTaggingConfigFlags.py.

Run4Grades

BTaggingConfigFlags.Run4Grades

Definition at line 15 of file BTaggingConfigFlags.py.