L1TopoOnlineMonitoringConfig.py

Go to the documentation of this file.

# Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
 
from AthenaConfiguration.ComponentFactory import CompFactory
from AthenaMonitoringKernel.GenericMonitoringTool import GenericMonitoringTool
from TrigConfigSvc.TriggerConfigAccess import getL1MenuAccess
 
 
def getL1TopoOnlineMonitorHypo(flags):
    hypo = CompFactory.L1TopoOnlineMonitorHypo()
    return hypo
 
def L1TopoOnlineMonitorHypoToolGen(flags, chainDict):
    tool = CompFactory.L1TopoOnlineMonitorHypoTool(
        chainDict['chainName'],
        # Select error flags to accept events
        ErrorFlagsKey = 'L1TopoErrorFlags',
        AcceptTrivialFlag = True)
 
    return tool
 
def getL1TopoLabels(flags,connectors = {0: 'LegacyTopo0', 1: 'LegacyTopo1'}, bmax = 128):
    topo_trigline_labels = ["" for i in range(bmax)]
    lvl1access  = getL1MenuAccess(flags)
    for connector_id, connectorKey in connectors.items():
        topo_triglines_dict = lvl1access.connector(connectorKey)['triggerlines']
        if not isinstance(topo_triglines_dict, list):
            for fpga_id in [0,1]:
                topo_fpga = topo_triglines_dict['fpga{:d}'.format(fpga_id)]
                for clock_id in [0,1]:
                    topo_clock = topo_fpga['clock{:d}'.format(clock_id)]
                    for topo_trigline in topo_clock:
                        topo_trigline_name = topo_trigline['name']
                        bit_id = topo_trigline['startbit']
                        topo_trigline_index = 64*connector_id + 32*fpga_id + 2*bit_id + clock_id
                        topo_trigline_labels[topo_trigline_index] = topo_trigline_name
        else:
            for topo_trigline in topo_triglines_dict:
                topo_trigline_name = topo_trigline['name']
                topo_trigline_name= topo_trigline_name.replace("TOPO_","")
                bit_id = topo_trigline['startbit']
                fpga_id = topo_trigline['fpga']
                clock_id = topo_trigline['clock']
                topo_trigline_index = 64*connector_id + 32*fpga_id + 2*bit_id + clock_id
                topo_trigline_labels[topo_trigline_index] = topo_trigline_name
 
        for i in range(len(topo_trigline_labels)):
            if ( topo_trigline_labels[i] == ""):
                topo_trigline_labels[i] = "-- Unassigned Item --"
 
    return topo_trigline_labels
 
def getMultiplicityLabels(flags,topoModule):
    topo_trigline_labels = ["" for i in range(128)]
    lvl1access  = getL1MenuAccess(flags)
    topo_triglines_dict = lvl1access.connector(topoModule)['triggerlines']
 
    for topo_trigline in topo_triglines_dict:
        topo_trigline_name = topo_trigline['name']
        bit_id = topo_trigline['startbit']
        topo_trigline_labels[bit_id] = topo_trigline_name
        if ( topo_trigline_labels[bit_id].find("SPARE") >= 0):
            topo_trigline_labels[bit_id] = "-- Unassigned Item --"
 
    return topo_trigline_labels
 
def Phase1TopoMonitoringCfg(flags):
    IsData = not flags.Input.isMC
    return getL1TopoPhase1DQMonitor(flags,"L1TopoInL1CaloDQMonitor",doHwMon=IsData,doComp=IsData, doMultComp=IsData)
 
def getL1TopoPhase1OnlineMonitor(flags, name='L1TopoOnlineMonitor', 
                                 doSimMon=True, 
                                 doHwMonCtp=False, 
                                 doHwMon=False,
                                 doComp=False,
                                 doMultComp=False, 
                                 forceCtp=False, 
                                 logLevel = None, 
                                 toolName="L1TopoMonitoringTool"):
 
    # Do not plot triggers that can not be reproduced by the simulation
    AlgoVetoList = ["jXE40delay","TeATIME"]
    MultVetoList = ["ZeroBiasA","ZeroBiasB"]
 
    alg = CompFactory.L1TopoOnlineMonitor(toolName,
                                          doHwMon = doHwMon,
                                          doHwErrorMon = False,
                                          doSimMon = doSimMon,
                                          doHwMonCTP = doHwMonCtp,
                                          doComp = doComp,
                                          doMultComp = doMultComp,
                                          forceCTPasHdw=forceCtp,
                                          AlgorithmVetoList    = AlgoVetoList,
                                          MultiplicityVetoList = MultVetoList)
    if logLevel : alg.OutputLevel=logLevel
    alg.MonTool = GenericMonitoringTool(flags, 'MonTool')
    alg.MonTool.HistPath = name
    configureHistograms(alg, flags, doHwMonCtp, doHwMon, doComp, doMultComp)
 
    return alg
 
def getL1TopoPhase1DQMonitor(flags, name='L1TopoDQMonitor', 
                             doSimMon=True, 
                             doHwMonCtp=False, 
                             doHwMon=False, 
                             doComp=False, 
                             doMultComp=False, 
                             forceCtp=False, 
                             logLevel = None, 
                             toolName="L1TopoMonitoringTool"):
 
    # Do not plot triggers that can not be reproduced by the simulation
    AlgoVetoList = ["jXE40delay","TeATIME"]
    MultVetoList = ["ZeroBiasA","ZeroBiasB"]
    # Ignore expected mismatches from these triggers in the DQ plots
    AlgoIgnoreList = ["*:ADBDT*", "*:ADVAE*", "*:ARTEMIS*"]
    MultIgnoreList = []
 
    from TrigT1CaloMonitoring.LVL1CaloMonitoringConfig import L1CaloMonitorCfgHelper
    helper = L1CaloMonitorCfgHelper(flags,CompFactory.L1TopoOnlineMonitor,toolName,
                                    doHwMon = doHwMon,
                                    doHwErrorMon = False,
                                    doSimMon = doSimMon,
                                    doHwMonCTP = doHwMonCtp,
                                    doComp = doComp,
                                    doMultComp = doMultComp,
                                    AlgorithmVetoList    = AlgoVetoList,
                                    MultiplicityVetoList = MultVetoList,
                                    forceCTPasHdw=forceCtp)
 
    #Define the Monitoring plots for L1Calo DQ
    helper.defineDQAlgorithm("L1TopoAlgMismatchRate",
                             hanConfig={"libname":"libdqm_summaries.so","name":"Bins_GreaterThan_Threshold","BinThreshold":"0.002","PublishBins":"1",
                                        "IgnoreBins":"\""+",".join(AlgoIgnoreList)+"\""},
                             thresholdConfig={"NBins":[0,1]}, # warn if any high rate, error if more than 1 bin anywhere.
                             )
 
    helper.defineDQAlgorithm("L1TopoMultMismatchRate",
                             hanConfig={"libname":"libdqm_summaries.so","name":"Bins_GreaterThan_Threshold","BinThreshold":"0.002","PublishBins":"1",
                                        "IgnoreBins":"\""+",".join(MultIgnoreList)+"\""},
                             thresholdConfig={"NBins":[0,1]}, # warn if any high rate, error if more than 1 bin anywhere.
                             )
 
    helper.defineDQAlgorithm("L1TopoMismatchCountVerticalRange",
                             hanConfig={"libname":"libdqm_summaries.so","name":"Bins_GreaterThan_Threshold","BinThreshold":"0.001","PublishBins":"1","yMax":"2"},
                             thresholdConfig={"NBins":[0,1]}, # warn if any high rate, error if more than 1 bin anywhere.
                             )
 
    #Multiplicity mismatches between Sim and Hdw
    ylabels = ['#splitline{Sim counts <}{Hdw counts}','#splitline{Sim counts >}{Hdw counts}','#splitline{Sim counts =}{Hdw counts}']
    name = 'LBN,MultiplicityAllBoards,L1TopoMultiplicityMissMatchVsLumi;L1TopoMultiplicityMismatchRateVsLumi'
    AllLabels = []
    for cable in range(4):
        topoName = 'Topo1Opt'+str(cable)
        AllLabels+=getMultiplicityLabels(flags=flags,topoModule=topoName)
 
    AllLabels = [x for x in AllLabels if x]
 
    helper.defineHistogram(name,
                           fillGroup="L1TopoDQ_mismatches",
                           paths=['Expert/Sim','Shifter/Sim'],
                           hanConfig={"algorithm":"L1TopoMultMismatchRate","description":"Drag the y-axis to make the text bigger","display":"SetPalette(87),Draw=COLZ"},
                           type='TProfile2D',
                           title="L1Topo Multiplicities Sim/Hdw mismatch rate;LB", xbins=32, ybins=len(AllLabels),
                           xmin=0, xmax=32,
                           ymin=0, ymax=len(AllLabels),
                           ylabels = AllLabels,
                           opt=['kAddBinsDynamically','kCanRebin','kAlwaysCreate'],merge='merge')
 
    for cable in range(4):
 
        topoName = 'Topo1Opt'+str(cable)
        name = 'MultiplicityTopo1Opt'+str(cable)+',MultiplicityMatchTopo1Opt'+str(cable)
        name += f';{topoName}_mismatch'
        title = f'Topo Optical Cable {cable} Miss/Matches Summary'
        labels = getMultiplicityLabels(flags=flags,topoModule=topoName)
        xlabels = [x for x in labels if x]
 
        helper.defineHistogram(name,
                               fillGroup="L1TopoDQ_mismatches",
                               paths=['Developer/Sim/detail/L1Topo/Multiplicities'],
                               hanConfig={"algorithm":"L1TopoMismatchCountVerticalRange","description":"Agreements and Mismatches between L1Topo Simulation and Hdw per L1Topo Item (x-axis). The upper row should be filled (Sim and Hdw agrees), while the lower two rows shouldn't have any entry","display":"SetPalette(55)"},
                               type='TH2D',
                               title=title, xbins=len(xlabels), ybins=3,
                               xlabels=xlabels,ylabels=ylabels,
                               xmin=0, xmax=len(xlabels),
                               ymin=0, ymax=len(ylabels),
                               opt=['kAddBinsDynamically','kCanRebin','kAlwaysCreate'],merge='merge')
 
    label_topo_all = []
    for cable in range(2):
        name = 'CableElec_'+str(cable+2)
        name += ';Topo'+str(cable+2)+'El'
        title = f'Topo Electric Cable {cable+2}'
        labels = getL1TopoLabels(flags,{0: f'Topo{cable+2}El'},64)
        label_topo_all += labels
 
    #L1Topo Algorithms mismatches
    #ylabels = ['#frac{HdwNotSim}{Hdw}','#frac{SimNotHdw}{Sim}','#frac{HdwAndSim}{HdwOrSim}','#frac{Hdw}{Sim}']
    ylabels = ['#splitline{Sim counts <}{Hdw counts}','#splitline{Sim counts >}{Hdw counts}','#splitline{Sim counts =}{Hdw counts}']
    nameLB = 'LBN,L1TopoAlgorithmAllBoards,L1TopoAlgorithmMissMatchVsLumi;L1TopoAlgoMismatchRateVsLB'
 
    helper.defineHistogram(nameLB,
                           fillGroup="L1TopoDQ_mismatches",
                           paths=['Expert/Sim','Shifter/Sim'],
                           hanConfig={"algorithm":"L1TopoAlgMismatchRate","description":"Drag the y-axis to make the text bigger","display":"SetPalette(87),Draw=COLZ"},
                           type='TProfile2D',
                           title="L1Topo Algorithms Sim/Hdw mismatch rate;LB",xbins=32,ybins=128,
                           #weight=f'Phase1TopoWeight_{topo[0]}',
                           ylabels=label_topo_all,
                           xmin=0, xmax=32,
                           ymin=0, ymax=128,
                           opt=['kAddBinsDynamically','kCanRebin','kAlwaysCreate'],merge='merge')
 
    for topo in [(0,'2a'),(1,'2b'),(2,'3a'),(3,'3b')]:
        name   = f'Phase1TopoTrigger_{topo[0]},L1TopoAlgorithmMissMatch_{topo[0]};L1TopoAlgo_{topo[1]}'
        title = f'L1Topo_Algo_{topo[1]} Miss/Matches Summary'
        helper.defineHistogram(name,
                               fillGroup="L1TopoDQ_mismatches",
                               paths=['Developer/Sim/detail/L1Topo/Algos'],
                               hanConfig={"algorithm":"L1TopoMismatchCountVerticalRange","description":"Agreements and Mismatches between L1Topo Simulation and Hardware per L1Topo Item (x-axis). The upper row should be filled (Sim and Hdw agrees), while the lower two rows shouldn't have any entry","display":"SetPalette(55)"},
                               type='TH2F',
                               title=title,xbins=32,ybins=3,
                               #weight=f'Phase1TopoWeight_{topo[0]}',
                               xlabels=label_topo_all[topo[0]*32:(topo[0]+1)*32],
                               ylabels=ylabels,
                               xmin=0, xmax=32,
                               ymin=0, ymax=len(ylabels),
                               opt=['kAddBinsDynamically','kCanRebin','kAlwaysCreate'],merge='merge')
 
    '''
    #Not Including Overflow plots for now
    #L1Topo Algorithms Overflow mismatches
    #ylabelsOF = ['#frac{HdwOFnotSimOF}{HdwOF}','#frac{SimOFnotHdwOF}{SimOF}','#frac{HdwOFandSimOF}{HdwOForSimOF}','#frac{HdwOF}{SimOF}']
    ylabelsOF = ['#splitline{Sim counts <}{Hdw counts}','#splitline{Sim counts >}{Hdw counts}','#splitline{Sim counts =}{Hdw counts}']
    for topo in [(0,'2a'),(1,'2b'),(2,'3a'),(3,'3b')]:
        #name_OF = f'Phase1TopoTrigger_{topo[0]},Phase1TopoMissMatch_{topo[0]};Ph1Topo{topo[1]}_overflows'
        name_OF = f'Phase1TopoTrigger_{topo[0]},L1TopoAlgorithmOverflowMissMatch_{topo[0]};L1TopoAlgo_OF{topo[1]}'
        title_OF = f' L1Topo_Algo_{topo[1]} Overflow Miss/Matches Summary'
        helper.defineHistogram(name_OF,
                               fillGroup="L1TopoDQ_mismatches",
                               paths=['Expert/Sim/detail/L1Topo/Algos/Overflows'],
                               hanConfig={"description":"Agreements and Mismatches between L1Topo Simulation and Hardware per L1Topo Item (x-axis). The upper row should be filled (Sim and Hdw agrees), while the lower two rows shouldn't have any entry","display":"SetPalette(55)"},  type='TH2F',
                               title=title_OF,xbins=32,ybins=3,
                               #weight=f'Phase1TopoOFWeight_{topo[0]}',
                               xlabels=label_topo_all[topo[0]*32:(topo[0]+1)*32],
                               ylabels=ylabelsOF,
                               xmin=0, xmax=32,
                               ymin=0, ymax=len(ylabelsOF),
                               opt=['kAddBinsDynamically','kCanRebin','kAlwaysCreate'],merge='merge')
    '''
 
    helper.alg.MonTool = helper.fillGroups["L1TopoDQ_mismatches"]
    return helper.result()
 
 
def configureHistograms(alg, flags, doHwMonCtp, doHwMon, doComp, doMultComp):
 
    label_topo_all = []
    for cable in range(2):
        name = 'CableElec_'+str(cable+2)
        name += ';Topo'+str(cable+2)+'El'
        title = f'Topo Electric Cable {cable+2}'
        labels = getL1TopoLabels(flags,{0: f'Topo{cable+2}El'},64)
        label_topo_all += labels
        alg.MonTool.defineHistogram(name, path='EXPERT', type='TH1I',
                                    title=title, xbins=64, xlabels=labels,
                                    xmin=0, xmax=64)
 
    for cable in range(4):
        topoName = 'Topo1Opt'+str(cable)
        name = 'CableOpti_'+str(cable)
        weight = name+'_weight'
        name += f';{topoName}'
        title = f'Topo Optical Cable {cable}'
        labels = getMultiplicityLabels(flags=flags,topoModule=topoName)
        xlabels = [x for x in labels if x]
        alg.MonTool.defineHistogram(name, path='EXPERT', type='TH1I',
                                    title=title, xbins=len(xlabels), xlabels=xlabels,
                                    weight=weight,
                                    xmin=0, xmax=len(xlabels))
    for cable in range(4):
        topoName = 'Topo1Opt'+str(cable)
        name = 'HdwTopo1Opt'+str(cable)
        weight = name+'_weight'
        name += f';{topoName}_data'
        title = f'Topo Optical Cable {cable} (Data)'
        labels = getMultiplicityLabels(flags=flags,topoModule=topoName)
        xlabels = [x for x in labels if x]
        alg.MonTool.defineHistogram(name, path='EXPERT', type='TH1I',
                                    title=title, xbins=len(xlabels), xlabels=xlabels,
                                    weight=weight,
                                    xmin=0, xmax=len(xlabels))
 
    for cable in range(4):
        ylabels = ['#splitline{Sim counts <}{Hdw counts}','#splitline{Sim counts >}{Hdw counts}','#splitline{Sim counts =}{Hdw counts}']
        topoName = 'Topo1Opt'+str(cable)
        name = 'MultiplicityTopo1Opt'+str(cable)+',MultiplicityMatchTopo1Opt'+str(cable)
        name += f';{topoName}_mismatch'
        title = f'Topo Optical Cable {cable} Miss/Matches Summary'
        labels = getMultiplicityLabels(flags=flags,topoModule=topoName)
        xlabels = [x for x in labels if x]
        alg.MonTool.defineHistogram(name, path='EXPERT', type='TH2F',
                                    title=title, xbins=len(xlabels), ybins=3,
                                    xlabels=xlabels,ylabels=ylabels,
                                    xmin=0, xmax=len(xlabels),
                                    ymin=0, ymax=len(ylabels))
 
    for cable in range(4):
        topoName = 'Topo1Opt'+str(cable)
        labels = getMultiplicityLabels(flags=flags,topoModule=topoName)
        labels = [x for x in labels if x]
        for i,label in enumerate(labels):
            name = f'Topo1Opt{cable}_{i}_Sim,Topo1Opt{cable}_{i}_Hdw;Topo1Opt{cable}_{label}'
            title = f'Topo1Opt{cable}_{label};Simulation Counts;Hardware Counts'
            alg.MonTool.defineHistogram(name, path='EXPERT', type='TH2F',
                                        title=title,xbins=10,ybins=10,
                                        xmin=0, xmax=10,
                                        ymin=0, ymax=10)
 
    alg.MonTool.defineHistogram('TopoSim', path='EXPERT', type='TH1I',
                                title='Simulation Results for L1Topo', xbins=128, xlabels=label_topo_all,
                                xmin=0, xmax=128)
    alg.MonTool.defineHistogram('TopoSim_overflows', path='EXPERT', type='TH1I',
                                title='Overflow Simulation Results for L1Topo', xbins=128, xlabels=label_topo_all,
                                xmin=0, xmax=128)
    alg.MonTool.defineHistogram('TopoSim_ambiguity', path='EXPERT', type='TH1I',
                                title='Ambiguity Results for L1Topo', xbins=128, xlabels=label_topo_all,
                                xmin=0, xmax=128)
 
    if doHwMonCtp:
        alg.MonTool.defineHistogram('TopoCTP', path='EXPERT', type='TH1I',
                                    title='CTP Results for L1Topo', xbins=128, xlabels=label_topo_all,
                                    xmin=0, xmax=128)
 
    if doComp:
        alg.MonTool.defineHistogram('SimNotHdwL1TopoResult', path='EXPERT', type='TH1I',
                                    title='L1Topo events with simulation accept and hardware fail',
                                    xbins=128, xlabels=label_topo_all,
                                    xmin=0, xmax=128)
        alg.MonTool.defineHistogram('HdwNotSimL1TopoResult', path='EXPERT', type='TH1I',
                                    title='L1Topo events with hardware accept and simulation fail',
                                    xbins=128, xlabels=label_topo_all,
                                    xmin=0, xmax=128)
        alg.MonTool.defineHistogram('Ambiguity_SimANDHdwDecisions', path='EXPERT', type='TH1I',
                                    title='L1Topo ambiguity events with simulation accept and hardware accept',
                                    xbins=128, xlabels=label_topo_all,
                                    xmin=0, xmax=128)
        alg.MonTool.defineHistogram('Ambiguity_DecisionMismatches', path='EXPERT', type='TH1I',
                                    title='L1Topo ambiguity events with mismatches between simulation and hardware',
                                    xbins=128, xlabels=label_topo_all,
                                    xmin=0, xmax=128)
 
    if doMultComp:
        ylabels = ['#frac{HdwNotSim}{Hdw}','#frac{SimNotHdw}{Sim}','#frac{HdwAndSim}{HdwOrSim}','#frac{Hdw}{Sim}']
        for topo in [(0,'2a'),(1,'2b'),(2,'3a'),(3,'3b')]:
            name = f'Phase1TopoTrigger_{topo[0]},Phase1TopoMissMatch_{topo[0]};Ph1Topo{topo[1]}'
            title = f'Phase1 Topo{topo[1]} Miss/Matches Summary'
            alg.MonTool.defineHistogram(name, path='EXPERT', type='TH2F',
                                        title=title,xbins=32,ybins=4,
                                        weight=f'Phase1TopoWeight_{topo[0]}',
                                        xlabels=label_topo_all[topo[0]*32:(topo[0]+1)*32],
                                        ylabels=ylabels,
                                        xmin=0, xmax=32,
                                        ymin=0, ymax=len(ylabels))
        ylabelsOF = ['#frac{HdwOFnotSimOF}{HdwOF}','#frac{SimOFnotHdwOF}{SimOF}','#frac{HdwOFandSimOF}{HdwOForSimOF}','#frac{HdwOF}{SimOF}']
        for topo in [(0,'2a'),(1,'2b'),(2,'3a'),(3,'3b')]:
            name_OF = f'Phase1TopoTrigger_{topo[0]},Phase1TopoMissMatch_{topo[0]};Ph1Topo{topo[1]}_overflows'
            title_OF = f'Phase1 Topo{topo[1]} Overflow Miss/Matches Summary'
            alg.MonTool.defineHistogram(name_OF, path='EXPERT', type='TH2F',
                                        title=title_OF,xbins=32,ybins=4,
                                        weight=f'Phase1TopoOFWeight_{topo[0]}',
                                        xlabels=label_topo_all[topo[0]*32:(topo[0]+1)*32],
                                        ylabels=ylabelsOF,
                                        xmin=0, xmax=32,
                                        ymin=0, ymax=len(ylabelsOF))
 
    if doHwMon:
        alg.MonTool.defineHistogram('HdwResults', path='EXPERT', type='TH1I',
                                    title='Hardware Results for L1Topo', xbins=128, xlabels=label_topo_all,
                                    xmin=0, xmax=128)
        alg.MonTool.defineHistogram('OverflowResults', path='EXPERT', type='TH1I',
                                    title='Overflow Results for L1Topo', xbins=128, xlabels=label_topo_all,
                                    xmin=0, xmax=128)
        rod_errors_labels = ["CT", "pc", "hc", "pe", "lm", "hm", "pt"]
        alg.MonTool.defineHistogram('ROD_Errors', path='EXPERT', type='TH1I',
                                    title='Counts of ROD errors', xbins=len(rod_errors_labels), xlabels=rod_errors_labels,
                                    xmin=0, xmax=len(rod_errors_labels))
        fpga_errors_labels = ["CT", "sm", "pe", "lm", "hm", "pt"]
        fpga_indexes = ["topo1fpga1", "topo1fpga0", "topo2fpga1", "topo2fpga0", "topo3fpga1", "topo3fpga0"]
        alg.MonTool.defineHistogram('FPGA_Errors, FPGA_Labels; FPGA_Errors', path='EXPERT', type='TH2I',
                                    title='Counts of FPGA errors',xbins=len(fpga_errors_labels),ybins=len(fpga_indexes),
                                    xlabels=fpga_errors_labels,
                                    ylabels=fpga_indexes,
                                    xmin=0, xmax=len(fpga_errors_labels),
                                    ymin=0, ymax=len(fpga_indexes))
 
 
    mon_failure_labels = ['doHwMon', 'doSimMon', 'doHwMonCTP', 'doComp', 'doMultComp']
    alg.MonTool.defineHistogram('MonitoringFailures', path='EXPERT', type='TH1F',
                                title='Counts of mon functions returning failure;;Entries',
                                xlabels=mon_failure_labels, xbins=len(mon_failure_labels),
                                xmin=0, xmax=len(mon_failure_labels))