python.TriggerEDM Namespace Reference

Functions
	recordable (arg)
	_addExtraCollectionsToEDMList (edmList, extraList)
	getRawTriggerEDMList (flags, runVersion=-1)
	getTriggerEDMList (flags, key, runVersion=-1)
	_getRun3TrigObjProducedInView (theKey, trigEDMList)
	_handleRun3ViewContainers (el, HLTList)
	getRun3BSList (flags, keys)
	getSafeEDMInsertPosition (edm_list)
	addHLTNavigationToEDMList (flags, edmList, allDecisions, hypoDecisions)
	_getRun3TrigObjList (destination, trigEDMList)
	_getRun3TrigEDMSlimList (key, HLTList)
	_getTriggerRun2EDMSlimList (key, edmList)
	getCategory (s)
	_getTypeAndKey (s)
	_keyToLabel (key)
	_getTriggerRun1Run2ObjList (destination, lst)
	getLvl1ESDList ()
	getLvl1AODList ()
	_getHLTPreregistrationList ()
	getPreregistrationList (version=2, doxAODConversion=True)
	getClassesToIgnore (flags)
	_getHLTBSTypeList ()
	getTPList (version=2)
	getEDMLibraries ()
	_InsertContainerNameForHLT (typedict)
	isCLIDDefined (cgen, typename)
	persistent (transient)
	tpMap ()
	testEDMList (edm_list, check_edmdetails_for_version=-1)
	dumpListToJson (fileName, runVersion)

Variables
	log = logging.getLogger('TriggerEDM')
list	AllowedOutputFormats = ['BS', 'ESD', 'AODFULL', 'AODSLIM', 'AODBLSSLIM' ]
list	_allowedEDMPrefixes = ['HLT_', 'EF_', 'L1_', 'LVL1']

Function Documentation

_addExtraCollectionsToEDMList()

_addExtraCollectionsToEDMList ( edmList, extraList )

protected

Extend edmList with extraList, keeping track whether a completely new
collection is being added, or a dynamic variable is added to an existing collection, or new targets are added to an existing collection.
The format of extraList is the same as those of TriggerHLTListRun3.

Definition at line 73 of file TriggerEDM.py.

def _addExtraCollectionsToEDMList(edmList, extraList):
    """
    Extend edmList with extraList, keeping track whether a completely new
    collection is being added, or a dynamic variable is added to an existing collection, or new targets are added to an existing collection.
    The format of extraList is the same as those of TriggerHLTListRun3.
    """
    existing_collections = [(c[0].split("#")[1]).split(".")[0] for c in edmList]
    insert_idx = getSafeEDMInsertPosition(edmList)
    for item in extraList:
        colname = (item[0].split("#")[1]).split(".")[0]
        if colname not in existing_collections:
            # a new collection and its Aux container are inserted in front of 'allowTruncation' items.
            if 'Aux' in colname:
                edmList.insert(insert_idx+1,item)
            else:
                edmList.insert(insert_idx,item)
            log.info("added new item to Trigger EDM: {}".format(item))
        else:
            # Maybe extra dynamic variables or EDM targets are added
            isAux = "Aux." in item[0]
            # find the index of the existing item
            existing_item_nr = [i for i,s in enumerate(edmList) if colname == (s[0].split("#")[1]).split(".")[0]]
            if len(existing_item_nr) != 1:
                log.error("Found {} existing edm items corresponding to new item {}, but it must be exactly one!".format(len(existing_item_nr), item))
            existingItem = edmList[existing_item_nr[0]]
            if isAux:
                dynVars = (item[0].split("#")[1]).split(".")[1:]
                existing_dynVars = (existingItem[0].split("#")[1]).split(".")[1:]
                existing_dynVars.extend(dynVars)
                dynVars = list(dict.fromkeys(existing_dynVars))
                if '' in dynVars:
                    dynVars.remove('')
                newVars = '.'.join(dynVars)
            edmTargets = item[1].split(" ") if len(item) > 1 else []
            existing_edmTargets = existingItem[1].split(" ")
            edmTargets.extend(existing_edmTargets)
            edmTargets = list(dict.fromkeys(edmTargets))
            newTargets = " ".join(edmTargets)
            typename = item[0].split("#")[0]
            log.info("old item in Trigger EDM    : {}".format(existingItem))
            signature = existingItem[2] # NOT updated at the moment
            tags = existingItem[3] if len(existingItem) > 3 else None  # NOT updated at the moment
            edmList.pop(existing_item_nr[0])
            combName = typename + "#" + colname
            if isAux:
                combName += "." + newVars
            if tags:
                edmList.insert(existing_item_nr[0], (combName, newTargets, signature, tags))
            else:
                edmList.insert(existing_item_nr[0] , (combName, newTargets, signature))
            log.info("updated item in Trigger EDM: {}".format(edmList[existing_item_nr[0]]))
 
    if testEDMList(edmList):
        log.error("edmList contains inconsistencies!")
 

_getHLTBSTypeList()

_getHLTBSTypeList ( )

protected

 List of HLT types to be read from BS, used by the TP

Definition at line 624 of file TriggerEDM.py.

def _getHLTBSTypeList():
    """ List of HLT types to be read from BS, used by the TP
    """
    l = []
    for item in TriggerHLTList:
        t,k = _getTypeAndKey(item[0])
        ctype = t
        if 'collection' in EDMDetails[t]:
            ctype = EDMDetails[t]['collection']
        l += [ctype]
    return l
 

_getHLTPreregistrationList()

_getHLTPreregistrationList ( )

protected

List (Literally Python list) of trigger objects to be preregistered i.e. this objects we want in every event for merged L2/EF in addition to default L2 and EF

Definition at line 569 of file TriggerEDM.py.

def _getHLTPreregistrationList():
    """
    List (Literally Python list) of trigger objects to be preregistered i.e. this objects we want in every event for merged L2/EF in addition to default L2 and EF
    """
    l = []
    for item in TriggerHLTList:
        if len (item[1]) == 0: continue
        t,k = _getTypeAndKey(item[0])
        if('Aux' in t):
            continue #we don't wat to preregister Aux containers
        l += [t+"#"+_keyToLabel(k)]
    return l
 
 

_getRun3TrigEDMSlimList()

_getRun3TrigEDMSlimList ( key, HLTList )

protected

Run 3 version
Modified EDM list to remove all dynamic variables
Requires changing the list to have 'Aux.-'

Definition at line 401 of file TriggerEDM.py.

def _getRun3TrigEDMSlimList(key, HLTList):
    """
    Run 3 version
    Modified EDM list to remove all dynamic variables
    Requires changing the list to have 'Aux.-'
    """
    _edmList = _getRun3TrigObjList(key,[HLTList])
 
    output = {}
    for k,v in _edmList.items():
        output[k] = [_handleRun3ViewContainers( el, HLTList ) for el in v]
    return output
 
#************************************************************
#
#  For Run 1 and Run 2 (not modified (so far))
#
#************************************************************

_getRun3TrigObjList()

_getRun3TrigObjList ( destination, trigEDMList )

protected

Run 3 version
Gives back the Python dictionary  with the content of ESD/AOD (dst) which can be inserted in OKS.

Definition at line 378 of file TriggerEDM.py.

def _getRun3TrigObjList(destination, trigEDMList):
    """
    Run 3 version
    Gives back the Python dictionary  with the content of ESD/AOD (dst) which can be inserted in OKS.
    """
    dset = set(destination.split())
    toadd = defaultdict(list)
 
    for item in itertools.chain(*trigEDMList):
        if item[1] == '': # no output has been defined
            continue
 
        confset = set(item[1].split())
 
        if dset & confset: # intersection of the sets
            colltype, k = _getTypeAndKey(item[0])
 
            if k not in toadd[colltype]:
                toadd[colltype] += [k]
 
    return toadd
 
 

_getRun3TrigObjProducedInView()

_getRun3TrigObjProducedInView ( theKey, trigEDMList )

protected

Run 3 only
Finds a given key from within the trigEDMList.
Returns true if this collection is produced inside EventViews
(Hence, has the special viewIndex Aux decoration applied by steering)

Definition at line 255 of file TriggerEDM.py.

def _getRun3TrigObjProducedInView(theKey, trigEDMList):
    """
    Run 3 only
    Finds a given key from within the trigEDMList.
    Returns true if this collection is produced inside EventViews
    (Hence, has the special viewIndex Aux decoration applied by steering)
    """
    from TrigEDMConfig.TriggerEDMRun3 import InViews
 
    return any(coll for coll in itertools.chain(*trigEDMList) if
               len(coll)>3 and theKey==coll[0].split('#')[1] and
               any(isinstance(v, InViews) for v in coll[3]))
 
 

_getTriggerRun1Run2ObjList()

_getTriggerRun1Run2ObjList ( destination, lst )

protected

Gives back the Python dictionary  with the content of ESD/AOD (dst) which can be inserted in OKS.

Definition at line 531 of file TriggerEDM.py.

def _getTriggerRun1Run2ObjList(destination, lst):
    """
    Gives back the Python dictionary  with the content of ESD/AOD (dst) which can be inserted in OKS.
    """
    dset = set(destination.split())
 
    toadd = {}
 
    for item in itertools.chain(*lst):
        if item[1] == '':
            continue
        confset = set(item[1].split())
        if dset & confset: # intersection of the sets
            t,k = _getTypeAndKey(item[0])
            colltype = t
            if 'collection' in EDMDetails[t]:
                colltype = EDMDetails[t]['collection']
            if colltype in toadd:
                if k not in toadd[colltype]:
                    toadd[colltype] += [k]
            else:
                toadd[colltype] = [k]
    return _InsertContainerNameForHLT(toadd)
 
 

_getTriggerRun2EDMSlimList()

_getTriggerRun2EDMSlimList ( key, edmList )

protected

Run 2 version
Modified EDM list to remove all dynamic variables
Requires changing the list to have 'Aux.-'

Definition at line 419 of file TriggerEDM.py.

def _getTriggerRun2EDMSlimList(key, edmList):
    """
    Run 2 version
    Modified EDM list to remove all dynamic variables
    Requires changing the list to have 'Aux.-'
    """
    output = {}
    for k,v in edmList.items():
        newnames = []
        for el in v:
            if 'Aux' in el:
                newnames+=[el.split('.')[0]+'.-']
            else:
                newnames+=[el]
            output[k] = newnames
    return output
 

_getTypeAndKey()

_getTypeAndKey ( s )

protected

 From the strings containing type and key of trigger EDM extract type and key

Definition at line 518 of file TriggerEDM.py.

def _getTypeAndKey(s):
    """ From the strings containing type and key of trigger EDM extract type and key
    """
    return s[:s.index('#')], s[s.index('#')+1:]
 

_handleRun3ViewContainers()

_handleRun3ViewContainers ( el, HLTList )

protected

Definition at line 269 of file TriggerEDM.py.

def _handleRun3ViewContainers( el, HLTList ):
    if 'Aux.' in el:
        # Get equivalent non-aux string (fragile!!!)
        keyNoAux = el.split('.')[0].replace('Aux','')
        # Check if this interface container is produced inside a View
        inView = _getRun3TrigObjProducedInView(keyNoAux, [HLTList])
        if el.split('.')[1] == '':
            # Aux lists zero dynamic vars to save ...
            if inView:
                # ... but it was produced in a View, so we need to add the viewIndex dynamic aux
                return el.split('.')[0]+'.viewIndex'
            else:
                # ... and was not in a View, strip all dynamic
                return el.split('.')[0]+'.-'
        else:
            # Aux lists one or more dynamic vars to save ...
            if inView:
                # ... and was produced in a View, so add the viewIndex dynamic as well
                return el+'.viewIndex'
            else:
                # ... and was not produced in a View, keep user-supplied list
                return el
    else: # no Aux
        return el
 
 

_InsertContainerNameForHLT()

_InsertContainerNameForHLT ( typedict )

protected

Definition at line 661 of file TriggerEDM.py.

def _InsertContainerNameForHLT(typedict):
    import re
    output = {}
    for k,v in typedict.items():
        newnames = []
        for el in v:
            if el.startswith('HLT_') or el == 'HLT':
                prefixAndLabel = el.split('_',1) #only split on first underscore
                containername = k if 'Aux' not in k else EDMDetails[k]['parent'] #we want the type in the Aux SG key to be the parent type #104811
                #maybe this is not needed anymore since we are now versionless with the CLIDs but it's not hurting either
                containername = re.sub('::','__',re.sub('_v[0-9]+$','',containername))
                newnames+=['_'.join([prefixAndLabel[0],containername]+([prefixAndLabel[1]] if len(prefixAndLabel) > 1 else []))]
            else:
                newnames+=[el]
            output[k] = newnames
    return output
 

_keyToLabel()

_keyToLabel ( key )

protected

 The key is usually HLT_*, this function returns second part of it or empty string

Definition at line 523 of file TriggerEDM.py.

def _keyToLabel(key):
    """ The key is usually HLT_*, this function returns second part of it or empty string
    """
    if '_' not in key:
        return ''
    else:
        return key[key.index('_'):].lstrip('_')
 

addHLTNavigationToEDMList()

addHLTNavigationToEDMList	(		flags,
			edmList,
			allDecisions,
			hypoDecisions )

Extend TriggerHLTListi Run3/Run4 with HLT Navigation objects

Definition at line 341 of file TriggerEDM.py.

def addHLTNavigationToEDMList(flags, edmList, allDecisions, hypoDecisions):
    """
    Extend TriggerHLTListi Run3/Run4 with HLT Navigation objects
    """
 
    # TODO: "EF" for Run 4.
 
    # HLTNav_* object list is built dynamically during job configuration, here we only define its output targets
    HLTNavEDMTargets = ''
 
    insert_idx = getSafeEDMInsertPosition(edmList)
 
    if not flags.Trigger.doOnlineNavigationCompactification:
        # If we are not compacting the online EDM, then we must write out all of the individual collections
        # ESD is added for MC support
        HLTNavEDMTargets = 'BS ESD'
 
    for decisionCollection in allDecisions:
        dynamic = '.-' # Exclude dynamic
        if decisionCollection in hypoDecisions:
            # Include dynamic
            dynamic = '.remap_linkColIndices.remap_linkColKeys'
            if 'PEBInfoWriter' in decisionCollection:
                dynamic += '.PEBROBList.PEBSubDetList'
        typeName = 'xAOD::TrigCompositeContainer#{:s}'.format(decisionCollection)
        typeNameAux = 'xAOD::TrigCompositeAuxContainer#{:s}Aux{:s}'.format(decisionCollection, dynamic)
 
        # Cost monitoring only requires a sub-set of the navigation collections.
        # (And CANNOT use any slimmed/merged collection, as the container names are important)
        thisCollectionHLTNavEDMTargets = HLTNavEDMTargets
        if decisionCollection.startswith("HLTNav_FStep") or decisionCollection == "HLTNav_Summary" or decisionCollection.startswith("HLTNav_L1"):
            thisCollectionHLTNavEDMTargets += ' CostMonDS'
 
        edmList[insert_idx:insert_idx] = [
            (typeName,    thisCollectionHLTNavEDMTargets, 'Steer'),
            (typeNameAux, thisCollectionHLTNavEDMTargets, 'Steer')]
 

dumpListToJson()

dumpListToJson	(		fileName,
			runVersion )

Definition at line 856 of file TriggerEDM.py.

def dumpListToJson(fileName,runVersion):
  import json
  edmDict = dict([(fmt, getTriggerEDMList(flags=None, key=fmt, runVersion=runVersion)) for fmt in AllowedOutputFormats])
  with open(fileName,'w') as f:
    json.dump(edmDict, f)

getCategory()

getCategory

(

s

)

From name of object in AOD/ESD found by checkFileTrigSize.py, return category 

Clean up object name 

Definition at line 436 of file TriggerEDM.py.

def getCategory(s):
    """ From name of object in AOD/ESD found by checkFileTrigSize.py, return category """
 
    """ Clean up object name """
    s = s.strip()
 
    # To-do
    # seperate the first part of the string at the first '_'
    # search in EDMDetails for the key corresponding to the persistent value
    # if a key is found, use this as the first part of the original string
    # put the string back together
 
    if s.count('.') : s = s[:s.index('.')]
    if s.count('::'): s = s[s.index(':')+2:]
    if s.count('<'):  s = s[s.index('<')+1:]
    if s.count('>'):  s = s[:s.index('>')]
    if s.count('.') : s = s[:s.index('.')]
    if s.count('Dyn') : s = s[:s.index('Dyn')]
 
    # containers from Run 1-2 and 3 require different preprocessing
    # s12 is for Run 1-2, s is for Run 3
    s12 = s
 
    if s12.startswith('HLT_xAOD__') or s12.startswith('HLT_Rec__') or s12.startswith('HLT_Analysis__') :
        s12 = s12[s12.index('__')+2:]
        s12 = s12[s12.index('_')+1:]
        #if s12.count('.') : s12 = s12[:s12.index('.')]
        s12 = "HLT_"+s12
    elif s12.startswith('HLT_'):
        #if s.count('Dyn') : s = s[:s.index('Dyn')]
        if s12.count('_'): s12 = s12[s12.index('_')+1:]
        if s12.count('_'): s12 = s12[s12.index('_')+1:]
        s12 = "HLT_"+s12
 
    TriggerListRun2 = TriggerResultsList + TriggerLvl1List + TriggerHLTList
    TriggerListRun3 = getRawTriggerEDMList(flags=None, runVersion=3)
 
    category = ''
    bestMatch = ''
 
    """ Loop over all objects already defined in lists (and hopefully categorized!!) """
    for item in TriggerListRun2:
        t,k = _getTypeAndKey(item[0])
 
        """ Clean up type name """
        if t.count('::'): t = t[t.index(':')+2:]
        if t.count('<'):  t = t[t.index('<')+1:]
        if t.count('>'):  t = t[:t.index('>')]
        if (s12.startswith(t) and s12.endswith(k)) and (len(t) > len(bestMatch)):
            bestMatch = t
            category = item[2]
 
        if k.count('.'): k = k[:k.index('.')]
        if (s12 == k):
            bestMatch = k
            category = item[2]
 
    for item in TriggerListRun3:
        t,k = _getTypeAndKey(item[0])
 
        """ Clean up type name """
        if t.count('::'): t = t[t.index(':')+2:]
        if t.count('<'):  t = t[t.index('<')+1:]
        if t.count('>'):  t = t[:t.index('>')]
 
        if (s.startswith(t) and s.endswith(k)) and (len(t) > len(bestMatch)):
            bestMatch = t
            category = item[2]
 
        if k.count('.'): k = k[:k.index('.')]
        if (s == k):
            bestMatch = k
            category = item[2]
 
    if category == '' and 'HLTNav' in s:
        category = 'HLTNav'
 
    if category == '': return 'NOTFOUND'
    return category
 
 
 

getClassesToIgnore()

getClassesToIgnore

(

flags

)

Get list of classes to ignore during deserialization

Definition at line 599 of file TriggerEDM.py.

def getClassesToIgnore(flags):
    """Get list of classes to ignore during deserialization"""
    l = []
 
    if flags.Trigger.EDMVersion == 2:
        # Ignore Run-1 EDM classes that were initially/mistakenly written as
        # empty containers into Run-2 files (ATR-32944).
        l.append("145610168")   # TrigMissingET
        l.append("1271751257")  # ElectronMuonTopoInfoContainer
        l.append("1142962358")  # TrigEFBjetContainer
        l.append("243892660")   # TrigMonEvent (CostMon)
        l.append("253562967")   # TrigMonConfig (CostMon)
        l.append("1500")        # MuonFeature
        l.append("1501")        # CombinedMuonFeature
        l.append("1503")        # TileMuFeature
        l.append("77762301")    # TileTrackMuFeature
        l.append("110010498")   # IsoMuonFeature
        l.append("233283613")   # TrigMuonClusterFeature
        l.append("262323491")   # MuonFeatureDetails
        l.append("1173853172")  # TrigMuonEFInfoContainer
        l.append("1175295175")  # TrigMuonEFIsolationContainer
        l.append("1314529658")  # MuonSegmentCombinationCollection
    return l
 
 

getEDMLibraries()

getEDMLibraries

(

)

Definition at line 658 of file TriggerEDM.py.

def getEDMLibraries():
    return EDMLibraries
 

getLvl1AODList()

getLvl1AODList

(

)

Gives back the Python dictionary  with the lvl1 trigger result content of AOD which can be inserted in OKS.

Definition at line 562 of file TriggerEDM.py.

def getLvl1AODList():
    """
    Gives back the Python dictionary  with the lvl1 trigger result content of AOD which can be inserted in OKS.
    """
    return _getTriggerRun1Run2ObjList('AODFULL',[TriggerLvl1List])
 
 

getLvl1ESDList()

getLvl1ESDList

(

)

Gives back the Python dictionary  with the lvl1 trigger result content of ESD which can be inserted in OKS.

Definition at line 556 of file TriggerEDM.py.

def getLvl1ESDList():
    """
    Gives back the Python dictionary  with the lvl1 trigger result content of ESD which can be inserted in OKS.
    """
    return _getTriggerRun1Run2ObjList('ESD',[TriggerLvl1List])
 

getPreregistrationList()

getPreregistrationList	(		version = 2,
			doxAODConversion = True )

List (Literally Python list) of trigger objects to be preregistered i.e. this objects we want for all levels
version can be: '1 (Run1)', '2 (Run2)'

Definition at line 583 of file TriggerEDM.py.

def getPreregistrationList(version=2, doxAODConversion=True):
    """
    List (Literally Python list) of trigger objects to be preregistered i.e. this objects we want for all levels
    version can be: '1 (Run1)', '2 (Run2)'
    """
 
    l=[]
    if version==2:
        l = _getHLTPreregistrationList()
    elif version==1:
        raise RuntimeError("Run-1 EDM is no longer supported")
    else:
        raise RuntimeError("Invalid version=%s supplied to getPreregistrationList" % version)
    return l
 
 

getRawTriggerEDMList()

getRawTriggerEDMList	(		flags,
			runVersion = -1 )

The static EDM list does still need some light manipulation before it can be used commonly.
Never import TriggerHLTListRun3 or TriggerHLTListRun4 directly, always fetch them via this function

Definition at line 128 of file TriggerEDM.py.

def getRawTriggerEDMList(flags, runVersion=-1):
    """
    The static EDM list does still need some light manipulation before it can be used commonly.
    Never import TriggerHLTListRun3 or TriggerHLTListRun4 directly, always fetch them via this function
    """
    if runVersion == -1:
        runVersion = flags.Trigger.EDMVersion
 
    if runVersion == 3:
        edmListCopy = TriggerHLTListRun3.copy()
        if flags and flags.Trigger.addRun3LowMuEDM:
            LowMuEDM = getRun3LowMuEDM(flags)
            log.info( "Adding low mu collections to EDM %i: %s", runVersion, str(LowMuEDM))
            _addExtraCollectionsToEDMList(edmListCopy, LowMuEDM)
    elif runVersion == 4:
        edm4ListCopy = TriggerHLTListRun4.copy()
        edm4protoListCopy = TriggerHLTListProtoRun4.copy()
        log.debug("Removing duplicated item between TriggerHLTListProtoRun4 and TriggerHLTListRun4.")
        for i in range(len(edm4protoListCopy)-1, -1, -1): # Back iterate by index, we might be removing as we go
            for r4item in edm4ListCopy:
                if edm4protoListCopy[i][0] == r4item[0]:
                    del edm4protoListCopy[i]
                    log.error(f"- Dupe: {r4item} appears in both TriggerHLTListProtoRun4.py and TriggerHLTListRun4.py - please resolve the duplication.")
                    break
        lenPreMerge = len(edm4ListCopy)
        edm4ListCopy.extend(edm4protoListCopy)
        lenPostMerge = len(edm4ListCopy)
        edmListCopy = edm4ListCopy
        log.info(f"Added TriggerHLTListProtoRun4 to TriggerHLTListRun4. EDM entries {lenPreMerge} -> {lenPostMerge}")
    else:
        errMsg="ERROR the getRawTriggerEDMList function supports runs 3 and 4."
        log.error(errMsg)
        raise RuntimeError(errMsg)
 
    if flags and flags.Trigger.ExtraEDMList:
        log.info( "Adding extra collections to EDM %i: %s", runVersion, str(flags.Trigger.ExtraEDMList))
        _addExtraCollectionsToEDMList(edmListCopy, flags.Trigger.ExtraEDMList)
 
    return edmListCopy
 

getRun3BSList()

getRun3BSList	(		flags,
			keys )

The keys should contain BS and all the identifiers used for scouting.
Returns list of tuples (typename#key, [keys], [properties]).

Definition at line 295 of file TriggerEDM.py.

def getRun3BSList(flags, keys):
    """
    The keys should contain BS and all the identifiers used for scouting.
    Returns list of tuples (typename#key, [keys], [properties]).
    """
 
    keys = set(keys[:])
    collections = []
    _HLTList = getRawTriggerEDMList(flags, 3)
    for definition in _HLTList:
 
        typename,collkey = definition[0].split("#")
        # normalise collection name and the key (decorations)
        typename = persistent(typename)
        collkey  = _handleRun3ViewContainers( collkey, _HLTList )
        destination = keys & set(definition[1].split())
        if len(destination) > 0:
            collections.append( (typename+"#"+collkey, list(destination),
                                 definition[3] if len(definition)>3 else []) )
 
    return collections
 
# Run3/Run4 fn added as simply appending new HLT Nav entries to start of list
# during runtime appears to cause Deserialisation issues (ATR-29945).
# Appending new entries towards end is safer.

getSafeEDMInsertPosition()

getSafeEDMInsertPosition

(

edm_list

)

Need to avoid inserting new runtime EDM entries at end of list
as 'allowTruncation' items need to be at end of list for correct
serialisation.
Function returns one position before
first 'allowTruncation' EDM item. If there is no 'allowTruncation'
EDM item, the position returned is the length of the list, i.e. the next
index in the list.

Definition at line 320 of file TriggerEDM.py.

def getSafeEDMInsertPosition(edm_list):
  """
  Need to avoid inserting new runtime EDM entries at end of list
  as 'allowTruncation' items need to be at end of list for correct
  serialisation.
  Function returns one position before
  first 'allowTruncation' EDM item. If there is no 'allowTruncation'
  EDM item, the position returned is the length of the list, i.e. the next
  index in the list.
  """
 
  insert_idx = len(edm_list)
 
  # start at end of list
  for i,entry in enumerate(reversed(edm_list)):
      if len(entry) < 4 or allowTruncation not in entry[3]:
          insert_idx -= i
          return insert_idx
  return insert_idx
 
 

getTPList()

getTPList

(

version = 2

)

Mapping  of Transient objects to Peristent during serialization (BS creation)
version can be: '1 (Run1)', '2 (Run2)'

Definition at line 636 of file TriggerEDM.py.

def getTPList(version=2):
    """
    Mapping  of Transient objects to Peristent during serialization (BS creation)
    version can be: '1 (Run1)', '2 (Run2)'
    """
    l = {}
    if version==2:
        bslist = _getHLTBSTypeList()
    elif version==1:
        raise RuntimeError("Run-1 EDM is no longer supported")
    else:
        raise RuntimeError("Invalid version=%s supplied to getTPList" % version)
        
    for t,d in EDMDetails.items():
        colltype = t
        if 'collection' in d:
            colltype = EDMDetails[t]['collection']
        if colltype in bslist:
            l[colltype] = d['persistent']
    return l
 
 

getTriggerEDMList()

getTriggerEDMList	(		flags,
			key,
			runVersion = -1 )

List (Literally Python dict) of trigger objects to be placed with flags:
flags is the CA flag container
key can be" 'ESD', 'AODSLIM', 'AODFULL'
runVersion can be: '-1 (Auto-configure)', '1 (Run1)', '2 (Run2)', '3' (Run 3), '4' (Run 4)

Definition at line 168 of file TriggerEDM.py.

def getTriggerEDMList(flags, key, runVersion=-1):
    """
    List (Literally Python dict) of trigger objects to be placed with flags:
    flags is the CA flag container
    key can be" 'ESD', 'AODSLIM', 'AODFULL'
    runVersion can be: '-1 (Auto-configure)', '1 (Run1)', '2 (Run2)', '3' (Run 3), '4' (Run 4)
    """
    # We allow for this to be overriden as Run1 bytestream actually need to request the Run2 EDM due to it additionally undergoing a transient xAOD migration. 
    if runVersion == -1:
        runVersion = flags.Trigger.EDMVersion
 
    if runVersion == 1:
        raise RuntimeError("Run-1 EDM is no longer supported")
 
    elif runVersion == 2:
        edmList = _getTriggerRun1Run2ObjList(key, [TriggerHLTList, TriggerResultsList])
        return _getTriggerRun2EDMSlimList(key, edmList) if 'SLIM' in key else edmList
 
    elif runVersion >= 3:
        RawEDMList = getRawTriggerEDMList(flags=flags, runVersion=runVersion)
 
        if key not in AllowedOutputFormats: # AllowedOutputFormats is the entire list of output formats including ESD         
            log.warning('Output format: %s is not in list of allowed formats, please check!', key)
            return _getRun3TrigObjList(key, [RawEDMList])
            
        # this keeps only the dynamic variables that have been specified in TriggerEDMRun3
        Run3TrigEDM = {}
        Run3TrigEDMSLIM = {}
 
        if "AODFULL" in key: 
            Run3TrigEDM.update(_getRun3TrigEDMSlimList(key, RawEDMList))
 
        elif "AODSLIM" in key:
            # remove the variables that are defined in TriggerEDMRun3.varToRemoveFromAODSLIM from the containers
            
            # get all containers from list that are marked with AODSLIM
            if len(varToRemoveFromAODSLIM) == 0:
                Run3TrigEDM.update(_getRun3TrigEDMSlimList(key, RawEDMList))
                log.info("No decorations are listed to be removed from AODSLIM")
            else:
                Run3TrigEDMSLIM.update(_getRun3TrigEDMSlimList(key, RawEDMList))
                log.info("The following decorations are going to be removed from the listed collections in AODSLIM {}".format(varToRemoveFromAODSLIM))
                # Go through all container values and remove the variables to remove
                # Format of Run3TrigEDMSLIM is {'xAOD::Cont': ['coll1.varA.varB', 'coll2.varD',...],...} 
                for cont, values in Run3TrigEDMSLIM.items():
                    if (isinstance(values, list)):
                        newValues = []
                        for value in values:                       
                            newValue = value+'.'
                            coll = value.split('.')[0]
                            
                            varRemovedFlag = False
                            for myTuple in varToRemoveFromAODSLIM:
                                var = myTuple[0]
                                
                                if var in value and coll in myTuple:
                                    varRemovedFlag = True
                                    removeVar =  '.'+var+'.'
                                    newValue = newValue.replace(removeVar, '.')
                                    
                            if newValue[-1:] == '.':
                                newValue = newValue[:-1]
 
                            if varRemovedFlag is False: 
                                newValues.append(value)
                            elif varRemovedFlag is True:
                                newValues.append(newValue)                                        
                            else:
                                raise RuntimeError("Decoration removed but no new Value was available, not sure what to do...")
 
                        # Filling the Run3TrigEDM dictionary with the new set of values for each cont
                        Run3TrigEDM[cont] = newValues
                    else:
                        raise RuntimeError("Value in Run3TrigEDM dictionary is not a list")
 
        else: # ESD
            Run3TrigEDM.update(_getRun3TrigEDMSlimList(key, RawEDMList))
 
        log.debug('TriggerEDM for EDM set {} contains the following collections: {}'.format(key, Run3TrigEDM) ) 
        return Run3TrigEDM
 
 
    else:
        raise RuntimeError("Invalid runVersion=%s supplied to getTriggerEDMList" % runVersion)
 
 
 

isCLIDDefined()

isCLIDDefined	(		cgen,
			typename )

Checks container type name is hashable

Definition at line 678 of file TriggerEDM.py.

def isCLIDDefined(cgen,typename):
  """
  Checks container type name is hashable
  """
  c = cgen.genClidFromName(typename)
  return (cgen.getNameFromClid(c) is not None)
 

persistent()

persistent

(

transient

)

Retrieve persistent EDM class, for xAOD it is the actual class version

If absent assumes v1

Definition at line 685 of file TriggerEDM.py.

def persistent( transient ):
    """
    Retrieve persistent EDM class, for xAOD it is the actual class version
 
    If absent assumes v1
    """
 
    #TODO drop EDMDetailsRun3 once migrated HLT reco to Run 4
    _EDMDetails = EDMDetailsRun3 | EDMDetailsRun4
 
    if transient in _EDMDetails and 'persistent' in _EDMDetails[transient]:
        return _EDMDetails[transient]['persistent']
    return transient
 
 

recordable()

recordable

(

arg

)

Verify that the name is in the list of recorded objects and conform to the name convention

In Run 2 it was a delicate process to configure correctly what got recorded
as it had to be set in the algorithm that produced it as well in the TriggerEDM.py in a consistent manner.

For Run 3 every alg input/output key can be crosschecked against the list of objects to record which is defined here.
I.e. in the configuration alg developer would do this:
from TriggerEDM.TriggerEDMRun3 import recordable

alg.outputKey = recordable("SomeKey")
If the names are correct the outputKey is assigned with SomeKey, if there is a missmatch an exception is thrown.

Definition at line 37 of file TriggerEDM.py.

def recordable(arg):
    """
    Verify that the name is in the list of recorded objects and conform to the name convention
 
    In Run 2 it was a delicate process to configure correctly what got recorded
    as it had to be set in the algorithm that produced it as well in the TriggerEDM.py in a consistent manner.
 
    For Run 3 every alg input/output key can be crosschecked against the list of objects to record which is defined here.
    I.e. in the configuration alg developer would do this:
    from TriggerEDM.TriggerEDMRun3 import recordable
 
    alg.outputKey = recordable("SomeKey")
    If the names are correct the outputKey is assigned with SomeKey, if there is a missmatch an exception is thrown.
 
    """
 
    # Allow passing DataHandle as argument - convert to string and remove store name
    name = str(arg).replace('StoreGateSvc+','')
 
    if "HLTNav_" in name:
        log.error( "Don't call recordable({0}), or add any \"HLTNav_\" collection manually to the EDM. See:collectDecisionObjects.".format( name ) )
        pass
    else: #negative filtering
        if not any([name.startswith(p) for p in _allowedEDMPrefixes]):
            raise RuntimeError( f"The collection name {name} does not start with any of the allowed prefixes: {_allowedEDMPrefixes}" )
        if "Aux" in name and not name[-1] != ".":
            raise RuntimeError( f"The collection name {name} is Aux but the name does not end with the '.'" )
 
    #TODO Remove TriggerHLTListProtoRun4 once fully migrated to Run 4.
    for entry in TriggerHLTListProtoRun4 + TriggerHLTListRun4:
        if entry[0].split( "#" )[1] == name:
            return arg
    msg = "The collection name {0} is not declared to be stored by HLT. Add it to TriggerEDMRun4.py or TriggerHLTListProtoRun4.py".format( name )
    log.error("ERROR in recordable() - see following stack trace.")
    raise RuntimeError( msg )
 

testEDMList()

testEDMList	(		edm_list,
			check_edmdetails_for_version = -1 )

Checks EDM list entries for serialization and configuration compliance.

Definition at line 715 of file TriggerEDM.py.

def testEDMList(edm_list, check_edmdetails_for_version=-1):
    """
    Checks EDM list entries for serialization and configuration compliance.
    """
 
    #xAOD types that don't expect accompanying Aux containers
    _noAuxList = ["xAOD::" + contType for contType in ["TrigConfKeys", "BunchConfKey"]]
 
    cgen = clidGenerator("", False)
    return_code = 0
    found_allow_truncation = False
    serializable_names = []
    serializable_names_no_label = []
    serializable_names_no_properties = []
 
    for i, edm in enumerate(edm_list):
 
        #check has sufficient entries
        if len(edm) < 3:
            log.error("EDM entry too short for " + edm[0])
            return_code = 1
            continue
 
        serializable_name = edm[0]
        serializable_name_no_label = re.sub(r"\#.*", "", serializable_name)
        serializable_name_no_properties = serializable_name.split('.')[0]
 
        serializable_names.append(serializable_name)
        serializable_names_no_label.append(serializable_name_no_label)
        serializable_names_no_properties.append(serializable_name_no_properties)
 
        #check container type name is hashable
        if not isCLIDDefined(cgen,serializable_name_no_label):
            log.error("no CLID for " + serializable_name)
            return_code = 1
 
        #check that no '.' in entries _not_ containing 'Aux'
        if "Aux" not in serializable_name and "." in serializable_name:
            log.error("A '.' found in non-Aux container name " + serializable_name)
            return_code = 1
 
        #check for Aux "."
        if "Aux" in serializable_name and "Aux." not in serializable_name:
            log.error("no final Aux. in label for " + serializable_name)
            return_code = 1
 
        #check contains exactly one #
        if serializable_name.count("#") != 1:
            log.error("Invalid naming structure for " + serializable_name)
            return_code = 1
        else: # only proceed if type and name can be separated
            #check that every interface xAOD container directly followed by matching Aux container.
            if serializable_name.startswith("xAOD") and "Aux" not in serializable_name:
                cont_type,cont_name = serializable_name.split("#")
                if cont_type not in _noAuxList:
                    auxmismatch = False
                    if len(edm_list) == i+1:
                        auxmismatch = True
                        cont_to_test = "nothing"
                    else:
                        cont_to_test = edm_list[i+1][0].split(".")[0]+"."
                        cont_type_short = cont_type.replace("Container","")
                        pattern = re.compile(cont_type_short+r".*Aux.*\#"+cont_name+"Aux.")
                        if not pattern.match(cont_to_test):
                          #test if shallow container type.
                          shallow_pattern = re.compile("xAOD::ShallowAuxContainer#"+cont_name+"Aux.")
                          if not shallow_pattern.match(cont_to_test):
                            auxmismatch = True
                    if auxmismatch:
                        log.error("Expected relevant Aux container following interface container %s, but found %s instead.",serializable_name,cont_to_test)
                        return_code = 1
                    else:
                        #check that targets of interface and aux container match
                        targets = set(edm[1].split())
                        if len(edm_list[i+1]) > 1 and cont_to_test.count("#") == 1:
                            contname_to_test = cont_to_test.split("#")[1]
                            targets_to_test = set(edm_list[i+1][1].split())
                            if len(targets ^ targets_to_test) > 0:
                                log.error("Targets of %s (%s) and %s (%s) do not match",cont_name,targets,contname_to_test,targets_to_test)
                                return_code = 1
 
        #check that Aux always follows non-Aux (our deserialiser relies on that)
        if i>0 and "Aux" in serializable_name and "Aux" in edm_list[i-1][0]:
            log.error(f"Aux container {serializable_name} needs to folow the "
                      "associated interface container in the EDM list")
            return_code = 1
 
        #check target types are valid. Check that target lists containing higher level targets
        #have required low level targets (ESD for AOD targets, AODFULL for SLIM targets).
        file_types = edm[1].split() # might return empty list, this is fine - 0 output file types allowed for an EDM entry (in case of obsolete containers)
        for file_type in file_types:
          if file_type not in AllowedOutputFormats:
              log.error("unknown file type " + file_type + " for " + serializable_name)
              return_code = 1
          for higher_level,required_lower_level in [('AOD','ESD'), ('SLIM','AODFULL')]:
              if higher_level in file_type and required_lower_level not in file_types:
                  log.error("Target list for %s containing '%s' must also contain lower level target '%s'.",serializable_name,file_type,required_lower_level)
                  return_code = 1
 
        # Check allowTuncation is only at the end
        tags = edm[3] if len(edm) > 3 else None
        allow_truncation_flag = False
        if tags:
            allow_truncation_flag = allowTruncation in tags
            if allow_truncation_flag:
                found_allow_truncation = True
 
        if found_allow_truncation and not allow_truncation_flag:
            log.error("All instances of 'allowTruncation' need to be at the END of the EDM serialisation list")
            return_code = 1
 
    #end of for loop over entries. Now do complete list checks.
 
    #check for duplicates:
    #check that no two EDM entries match after stripping out characters afer '.'
    if len(set(serializable_names_no_properties)) != len(serializable_names_no_properties):
        log.error("Duplicates in EDM list! Duplicates found:")
        import collections.abc
        for item, count in collections.Counter(serializable_names_no_properties).items():
            if count > 1:
                log.error(str(count) + "x: " + str(item))
        return_code = 1
 
    #check EDMDetails
    if check_edmdetails_for_version > 0:
        EDMDetailList = []
        if check_edmdetails_for_version == 3:
            EDMDetailList = EDMDetailsRun3
        elif check_edmdetails_for_version >= 4:
            EDMDetailList = EDMDetailsRun4
        else: log.warning("No EDMDetails for EDM version %d. Skipping EDMDetails check.", check_edmdetails_for_version)
 
        for EDMDetail in EDMDetailList:
            if EDMDetail not in serializable_names_no_label:
                msg = "EDMDetail for " + EDMDetail + " does not correspond to any name in TriggerList"
                log.error(msg)
                return_code = 1
    else: log.debug("Skipping EDMDetails check.")
 
    return return_code
 

tpMap()

tpMap

(

)

List

Definition at line 700 of file TriggerEDM.py.

def tpMap():
    """
    List
    """
    l = {}
 
    #TODO drop EDMDetailsRun3 once migrated HLT reco to Run 4
    _EDMDetails = EDMDetailsRun3 | EDMDetailsRun4
    for tr in _EDMDetails:
        if "xAOD" in tr:
            continue
        l[tr] = persistent(tr)
    return l
 
 

Variable Documentation

_allowedEDMPrefixes

list python.TriggerEDM._allowedEDMPrefixes = ['HLT_', 'EF_', 'L1_', 'LVL1']

protected

Definition at line 36 of file TriggerEDM.py.

AllowedOutputFormats

list python.TriggerEDM.AllowedOutputFormats = ['BS', 'ESD', 'AODFULL', 'AODSLIM', 'AODBLSSLIM' ]

Definition at line 32 of file TriggerEDM.py.

log

python.TriggerEDM.log = logging.getLogger('TriggerEDM')

Definition at line 21 of file TriggerEDM.py.