Collaboration diagram for python.TriggerAPI.TriggerAPI.TriggerAPI:

Public Member Functions
	reset (cls)
	init (cls)
	setConfigFlags (cls, flags)
	setRelease (cls, release)
	setCustomGRL (cls, grl)
	getLowestUnprescaled (cls, period, triggerType=TriggerType.ALL, additionalTriggerType=TriggerType.UNDEFINED, matchPattern="", livefraction=1.0, reparse=False)
	getLowestUnprescaledAnyPeriod (cls, period, triggerType=TriggerType.ALL, additionalTriggerType=TriggerType.UNDEFINED, matchPattern="", livefraction=1.0, reparse=False)
	getUnprescaled (cls, period, triggerType=TriggerType.ALL, additionalTriggerType=TriggerType.UNDEFINED, matchPattern="", livefraction=1.0, reparse=False)
	getUnprescaledAnyPeriod (cls, period, triggerType=TriggerType.ALL, additionalTriggerType=TriggerType.UNDEFINED, matchPattern="", livefraction=1.0, reparse=False)
	getInactive (cls, period, triggerType=TriggerType.ALL, additionalTriggerType=TriggerType.UNDEFINED, matchPattern="", livefraction=1e-99, reparse=False)
	getActive (cls, period, triggerType=TriggerType.ALL, additionalTriggerType=TriggerType.UNDEFINED, matchPattern="", livefraction=1e-99, reparse=False)
	getAllHLT (cls, period, triggerType=TriggerType.ALL, additionalTriggerType=TriggerType.UNDEFINED, matchPattern="", livefraction=0, reparse=False)
	checkPeriodConsistency (cls, period=TriggerPeriod.future, triggerType=TriggerType.ALL, additionalTriggerType=TriggerType.UNDEFINED, matchPattern="", reparse=False)
	dumpAPI (cls, full=False)

Static Public Attributes
	log = logging.getLogger(__name__)
dict	dbQueries = {}
	customGRL = None
	flags = None
	release = None
bool	cacheread = False

Protected Member Functions
	_loadTriggerPeriod (cls, period, reparse)

Detailed Description

Definition at line 13 of file TriggerAPI.py.

Member Function Documentation

◆ _loadTriggerPeriod()

python.TriggerAPI.TriggerAPI.TriggerAPI._loadTriggerPeriod	(	cls,
		period,
		reparse )

protected

Definition at line 152 of file TriggerAPI.py.

    def _loadTriggerPeriod(cls, period, reparse):
        if period != TriggerPeriod.customGRL and not period & TriggerPeriod.future: cls.init()
        if (period,cls.customGRL) not in cls.dbQueries:
            if TriggerPeriod.isRunNumber(period) or (isinstance(period,TriggerPeriod) and period.isBasePeriod()):
                cls.dbQueries[(period,cls.customGRL)] = TriggerInfo(period,cls.customGRL,cls.release,cls.flags)
            else:
                basePeriods = [tp for tp in TriggerPeriod.basePeriods() if tp & period]
                for bp in basePeriods:
                    cls._loadTriggerPeriod(bp,reparse)
                cls.dbQueries[(period,cls.customGRL)] = TriggerInfo.merge([cls.dbQueries[(bp,cls.customGRL)] for bp in basePeriods])
        if reparse: cls.dbQueries[(period,cls.customGRL)].reparse()
 

◆ checkPeriodConsistency()

python.TriggerAPI.TriggerAPI.TriggerAPI.checkPeriodConsistency	(	cls,
		period = TriggerPeriod.future,
		triggerType = TriggerType.ALL,
		additionalTriggerType = TriggerType.UNDEFINED,
		matchPattern = "",
		reparse = False )

 Returns a list of triggers that are tighter than the lowest unprescaled but are not flagged as primary
    This only makes sense for future periods, the past is already consistent :)
    See getLowestUnprescaled for a detailed description of the options

Definition at line 142 of file TriggerAPI.py.

    def checkPeriodConsistency(cls, period=TriggerPeriod.future, triggerType=TriggerType.ALL, additionalTriggerType=TriggerType.UNDEFINED, matchPattern="", reparse=False):
        ''' Returns a list of triggers that are tighter than the lowest unprescaled but are not flagged as primary
            This only makes sense for future periods, the past is already consistent :)
            See getLowestUnprescaled for a detailed description of the options
        '''
        period &= TriggerPeriod.future #Only meaningful for future periods
        cls._loadTriggerPeriod(period,reparse)
        return cls.dbQueries[(period,cls.customGRL)]._checkPeriodConsistency(triggerType, additionalTriggerType, matchPattern)
        

◆ dumpAPI()

python.TriggerAPI.TriggerAPI.TriggerAPI.dumpAPI	(		cls,
			full = False )

Definition at line 165 of file TriggerAPI.py.

    def dumpAPI(cls, full=False):
        if not full: #store only what is not in the central pickle/json
            for period,grl in list(cls.dbQueries.keys()):
                if TriggerPeriod.isRunNumber(period) or (isinstance(period,TriggerPeriod) and period.isBasePeriod()): continue
                del cls.dbQueries[(period,grl)]
        SerializeAPI.dump(cls.dbQueries)
        cls.log.info(sorted(cls.dbQueries.keys()))
 
 

◆ getActive()

python.TriggerAPI.TriggerAPI.TriggerAPI.getActive	(	cls,
		period,
		triggerType = TriggerType.ALL,
		additionalTriggerType = TriggerType.UNDEFINED,
		matchPattern = "",
		livefraction = 1e-99,
		reparse = False )

 Returns a list of HLT chains that were active at some point, including disabled chains in rerun.
    See getLowestUnprescaled for a detailed description of the options

Definition at line 124 of file TriggerAPI.py.

    def getActive(cls, period, triggerType=TriggerType.ALL, additionalTriggerType=TriggerType.UNDEFINED, matchPattern="", livefraction=1e-99, reparse=False):
        ''' Returns a list of HLT chains that were active at some point, including disabled chains in rerun.
            See getLowestUnprescaled for a detailed description of the options
        '''
        cls._loadTriggerPeriod(period,reparse)
        return cls.dbQueries[(period,cls.customGRL)]._getActive(triggerType, additionalTriggerType, matchPattern, livefraction)
    

◆ getAllHLT()

python.TriggerAPI.TriggerAPI.TriggerAPI.getAllHLT	(	cls,
		period,
		triggerType = TriggerType.ALL,
		additionalTriggerType = TriggerType.UNDEFINED,
		matchPattern = "",
		livefraction = 0,
		reparse = False )

 Returns a map of {HLT chains: average live fraction} for a given period.
    The average live fraction is an approximation weighting the number of lumiblocks by prescale.
    *** Don't use this number in analysis!!! ***
    See getLowestUnprescaled for a detailed description of the options

Definition at line 132 of file TriggerAPI.py.

    def getAllHLT(cls, period, triggerType=TriggerType.ALL, additionalTriggerType=TriggerType.UNDEFINED, matchPattern="",  livefraction=0, reparse=False):
        ''' Returns a map of {HLT chains: average live fraction} for a given period.
            The average live fraction is an approximation weighting the number of lumiblocks by prescale.
            *** Don't use this number in analysis!!! ***
            See getLowestUnprescaled for a detailed description of the options
        '''
        cls._loadTriggerPeriod(period,reparse)
        return cls.dbQueries[(period,cls.customGRL)]._getAllHLT(triggerType, additionalTriggerType, matchPattern, livefraction)
        

◆ getInactive()

python.TriggerAPI.TriggerAPI.TriggerAPI.getInactive	(	cls,
		period,
		triggerType = TriggerType.ALL,
		additionalTriggerType = TriggerType.UNDEFINED,
		matchPattern = "",
		livefraction = 1e-99,
		reparse = False )

 Returns a list of HLT chains that were fully inactive, excluding disabled chains in rerun.
    See getLowestUnprescaled for a detailed description of the options

Definition at line 116 of file TriggerAPI.py.

    def getInactive(cls, period, triggerType=TriggerType.ALL, additionalTriggerType=TriggerType.UNDEFINED, matchPattern="", livefraction=1e-99, reparse=False):
        ''' Returns a list of HLT chains that were fully inactive, excluding disabled chains in rerun.
            See getLowestUnprescaled for a detailed description of the options
        '''
        cls._loadTriggerPeriod(period,reparse)
        return cls.dbQueries[(period,cls.customGRL)]._getInactive(triggerType, additionalTriggerType, matchPattern, livefraction)
    

◆ getLowestUnprescaled()

python.TriggerAPI.TriggerAPI.TriggerAPI.getLowestUnprescaled	(	cls,
		period,
		triggerType = TriggerType.ALL,
		additionalTriggerType = TriggerType.UNDEFINED,
		matchPattern = "",
		livefraction = 1.0,
		reparse = False )

 Returns a list of the lowest-pt-threshold HLT chains that were always unprescaled in the given period.
    period: see TriggerEnums.TriggerPeriod for all possibilities, recommeded TriggerPeriod.y2018
    triggerType: see TriggerEnums.TriggerType for all possibilities, example TriggerType.el_single
    additionalTriggerType: can request additional types to match, use TriggerType.ALL to show combined triggers of any kind
                           accepts also a list as input in that case all types have to match
    matchPattern: provide additionally a regex-like expression to be applied
    livefraction: accept items that are not unprescaled but have a live fraction above this threshold, example 0.95
                  The live fraction is only an approximation, weighting the number of lumiblocks by prescale.

Definition at line 63 of file TriggerAPI.py.

    def getLowestUnprescaled(cls, period, triggerType=TriggerType.ALL, additionalTriggerType=TriggerType.UNDEFINED, matchPattern="", livefraction=1.0, reparse=False):
        ''' Returns a list of the lowest-pt-threshold HLT chains that were always unprescaled in the given period.
            period: see TriggerEnums.TriggerPeriod for all possibilities, recommeded TriggerPeriod.y2018
            triggerType: see TriggerEnums.TriggerType for all possibilities, example TriggerType.el_single
            additionalTriggerType: can request additional types to match, use TriggerType.ALL to show combined triggers of any kind
                                   accepts also a list as input in that case all types have to match
            matchPattern: provide additionally a regex-like expression to be applied
            livefraction: accept items that are not unprescaled but have a live fraction above this threshold, example 0.95
                          The live fraction is only an approximation, weighting the number of lumiblocks by prescale.
        '''
        cls._loadTriggerPeriod(period,reparse)
        return cls.dbQueries[(period,cls.customGRL)]._getLowestUnprescaled(triggerType, additionalTriggerType, matchPattern, livefraction)
    

◆ getLowestUnprescaledAnyPeriod()

python.TriggerAPI.TriggerAPI.TriggerAPI.getLowestUnprescaledAnyPeriod	(	cls,
		period,
		triggerType = TriggerType.ALL,
		additionalTriggerType = TriggerType.UNDEFINED,
		matchPattern = "",
		livefraction = 1.0,
		reparse = False )

 Returns a list of the lowest-pt-threshold HLT chains that were unprescaled in at least one of 
    the subperiods within the given period. The lowest granularity can be seen in TriggerEnums.TriggerPeriod
    See getLowestUnprescaled for a detailed description of the options

Definition at line 77 of file TriggerAPI.py.

    def getLowestUnprescaledAnyPeriod(cls, period, triggerType=TriggerType.ALL, additionalTriggerType=TriggerType.UNDEFINED, matchPattern="", livefraction=1.0, reparse=False):
        ''' Returns a list of the lowest-pt-threshold HLT chains that were unprescaled in at least one of 
            the subperiods within the given period. The lowest granularity can be seen in TriggerEnums.TriggerPeriod
            See getLowestUnprescaled for a detailed description of the options
        '''
        lowset = set()
        for i, ibin in enumerate(reversed(bin(period)[2:])): #to binary
            ibin = int(ibin)
            if not ibin: continue
            subperiod = 2**i
            cls._loadTriggerPeriod(subperiod, reparse)
            subperiodset = set( cls.dbQueries[(subperiod,cls.customGRL)]._getLowestUnprescaled(triggerType, additionalTriggerType, matchPattern, livefraction) )
            lowset |= subperiodset
        return list(lowset)
    

◆ getUnprescaled()

python.TriggerAPI.TriggerAPI.TriggerAPI.getUnprescaled	(	cls,
		period,
		triggerType = TriggerType.ALL,
		additionalTriggerType = TriggerType.UNDEFINED,
		matchPattern = "",
		livefraction = 1.0,
		reparse = False )

 Returns a list of always-unprescaled HLT chains, including backup items with higher thresholds.
    See getLowestUnprescaled for a detailed description of the options

Definition at line 93 of file TriggerAPI.py.

    def getUnprescaled(cls, period, triggerType=TriggerType.ALL, additionalTriggerType=TriggerType.UNDEFINED, matchPattern="", livefraction=1.0, reparse=False):
        ''' Returns a list of always-unprescaled HLT chains, including backup items with higher thresholds.
            See getLowestUnprescaled for a detailed description of the options
        '''
        return cls.dbQueries[(period,cls.customGRL)]._getUnprescaled(triggerType, additionalTriggerType, matchPattern, livefraction)
    

◆ getUnprescaledAnyPeriod()

python.TriggerAPI.TriggerAPI.TriggerAPI.getUnprescaledAnyPeriod	(	cls,
		period,
		triggerType = TriggerType.ALL,
		additionalTriggerType = TriggerType.UNDEFINED,
		matchPattern = "",
		livefraction = 1.0,
		reparse = False )

 Returns a list of HLT chains that were unprescaled in at least one of 
    the subperiods within the given period. The lowest granularity can be seen in TriggerEnums.TriggerPeriod
    See getLowestUnprescaled for a detailed description of the options

Definition at line 100 of file TriggerAPI.py.

    def getUnprescaledAnyPeriod(cls, period, triggerType=TriggerType.ALL, additionalTriggerType=TriggerType.UNDEFINED, matchPattern="", livefraction=1.0, reparse=False):
        ''' Returns a list of HLT chains that were unprescaled in at least one of 
            the subperiods within the given period. The lowest granularity can be seen in TriggerEnums.TriggerPeriod
            See getLowestUnprescaled for a detailed description of the options
        '''
        lowset = set()
        for i, ibin in enumerate(reversed(bin(period)[2:])): #to binary
            ibin = int(ibin)
            if not ibin: continue
            subperiod = 2**i
            cls._loadTriggerPeriod(subperiod, reparse)
            subperiodset = set( cls.dbQueries[(subperiod,cls.customGRL)]._getUnprescaled(triggerType, additionalTriggerType, matchPattern, livefraction) )
            lowset |= subperiodset
        return list(lowset)
        

◆ init()

python.TriggerAPI.TriggerAPI.TriggerAPI.init ( cls )

Definition at line 30 of file TriggerAPI.py.

    def init(cls):
        if cls.cacheread: return
        cls.cacheread = True
        cls.dbQueries = SerializeAPI.load()
        todel = [(p,grl) for p,grl in cls.dbQueries if p  & TriggerPeriod.future]
        for key in todel:
            del cls.dbQueries[key]
 

◆ reset()

python.TriggerAPI.TriggerAPI.TriggerAPI.reset ( cls )

Definition at line 22 of file TriggerAPI.py.

    def reset(cls):
        cls.dbQueries = {}
        cls.customGRL = None
        cls.flags     = None
        cls.release   = None
        cls.cacheread = False
 

◆ setConfigFlags()

python.TriggerAPI.TriggerAPI.TriggerAPI.setConfigFlags	(		cls,
			flags )

Set ConfigFlags (only required for "future" periods)

Definition at line 39 of file TriggerAPI.py.

    def setConfigFlags(cls, flags):
        """Set ConfigFlags (only required for "future" periods)"""
        cls.flags = flags
 

◆ setCustomGRL()

python.TriggerAPI.TriggerAPI.TriggerAPI.setCustomGRL	(		cls,
			grl )

Definition at line 54 of file TriggerAPI.py.

    def setCustomGRL(cls, grl):
        if TriggerInfo.testCustomGRL(grl):
            cls.customGRL = grl
        else:
            cls.log.warning("Couldn't set GRL: "+grl)
            cls.log.warning("Will use default GRL")
            cls.customGRL = None
 

◆ setRelease()

python.TriggerAPI.TriggerAPI.TriggerAPI.setRelease	(		cls,
			release )

Definition at line 44 of file TriggerAPI.py.

    def setRelease(cls, release):
        import re
        if release and re.match(r'21\.1(\.[0-9]+)+$',release):
            cls.release = release
        elif release=="current": #Don't allow the release to be automatically overwritten
            cls.release = release
        else:
            cls.log.warning("Release doesn't seem to be a well-formed 21.1 release, ignoring: "+release)
 

Member Data Documentation

◆ cacheread

bool python.TriggerAPI.TriggerAPI.TriggerAPI.cacheread = False

static

Definition at line 19 of file TriggerAPI.py.

◆ customGRL

python.TriggerAPI.TriggerAPI.TriggerAPI.customGRL = None

static

Definition at line 16 of file TriggerAPI.py.

◆ dbQueries

python.TriggerAPI.TriggerAPI.TriggerAPI.dbQueries = {}

static

Definition at line 15 of file TriggerAPI.py.

◆ flags

python.TriggerAPI.TriggerAPI.TriggerAPI.flags = None

static

Definition at line 17 of file TriggerAPI.py.

◆ log

python.TriggerAPI.TriggerAPI.TriggerAPI.log = logging.getLogger(__name__)

static

Definition at line 14 of file TriggerAPI.py.

◆ release

python.TriggerAPI.TriggerAPI.TriggerAPI.release = None

static

Definition at line 18 of file TriggerAPI.py.

The documentation for this class was generated from the following file:

TriggerAPI.py

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ _loadTriggerPeriod()

◆ checkPeriodConsistency()

◆ dumpAPI()

◆ getActive()

◆ getAllHLT()

◆ getInactive()

◆ getLowestUnprescaled()

◆ getLowestUnprescaledAnyPeriod()

◆ getUnprescaled()

◆ getUnprescaledAnyPeriod()

◆ init()

◆ reset()

◆ setConfigFlags()

◆ setCustomGRL()

◆ setRelease()

Member Data Documentation

◆ cacheread

◆ customGRL

◆ dbQueries

◆ flags

◆ log

◆ release