python.TriggerAnalysisConfig.TriggerAnalysisBlock Class Reference

Inheritance diagram for python.TriggerAnalysisConfig.TriggerAnalysisBlock:

Collaboration diagram for python.TriggerAnalysisConfig.TriggerAnalysisBlock:

Public Member Functions
	__init__ (self)
	instanceName (self)
	makeTriggerSelectionAlg (self, config, decisionTool)
	makeAlgs (self, config)

Static Public Member Functions
	makeTriggerDecisionTool (config)
	makeTriggerMatchingTool (config, decisionTool)

Public Attributes
	triggerChainsForSelection
	prescaleLumiCalcFilesPerYear
	prescaleLumiCalcFiles
dict	multiTriggerChainsPerYear

Static Protected Member Functions
list[str]	_get_lumicalc_triggers (list[str] lumicalc_files)

Detailed Description

the ConfigBlock for trigger analysis

Definition at line 27 of file TriggerAnalysisConfig.py.

Constructor & Destructor Documentation

__init__()

python.TriggerAnalysisConfig.TriggerAnalysisBlock.__init__

(

self

)

Definition at line 30 of file TriggerAnalysisConfig.py.

    def __init__ (self) :
        super ().__init__ ()
        self.addOption ('triggerChainsPerYear', {}, type=dict,
            info="a dictionary with key (string) the year and value (list of "
            "strings) the trigger chains. You can also use `||` within a string "
            "to enforce an OR of triggers without looking up the individual "
            "triggers. Used for both trigger selection and SFs.")
        self.addOption ('multiTriggerChainsPerYear', {}, type=dict,
            info="a dictionary with key (string) a trigger set name and value a "
            "`triggerChainsPerYear` dictionary, following the previous convention. "
            "Relevant for analyses using different triggers in different categories, "
            "where the trigger global scale factors shouldn't be combined.")
        self.addOption ('triggerChainsForSelection', [], type=list,
            info="a list of trigger chains (list of strings) to be used for "
            "trigger selection. Only set it if you need a different setup "
            "than for trigger SFs.")
        self.addOption ('triggerChainsForDecoration', [], type=list,
            info="a list of trigger chains (list of strings) to be used for "
            "trigger decoration, if it needs to be different from the selection one.")
        self.addOption ('prescaleDecoration', 'prescale', type=str,
            info="name of the decoration for trigger prescales.")
        self.addOption ('prescaleLumiCalcFiles', [], type=list,
            info="a list of lumicalc files (list of strings) to calculate "
            "trigger prescales. Mutually "
            "exclusive with `prescaleLumiCalcFilesPerYear`.")
        self.addOption ('prescaleLumiCalcFilesPerYear', {}, type=dict,
            info="a dicrionary with key (string) the year and value (list of "
            "strings) the list of lumicalc files to calculate trigger prescales "
            "for an individual data year. "
            "Mutually exclusive with `prescaleLumiCalcFiles`.")
        self.addOption ('prescaleTriggersFormula', '', type=str,
            info="a formula used in (un)prescaling, producing overall prescale "
            "factor instead of prescale per trigger.")
        self.addOption ('prescaleMC', False, type=bool,
            info="output trigger prescales when running on MC.")
        self.addOption ('unprescaleData', False, type=bool,
            info="output trigger prescales when running on Data.")
        self.addOption ('prescaleIncludeAllYearsPerRun', False, type=bool,
            info="trigger prescales will include all configured years "
            "from `prescaleLumiCalcFilesPerYear` in all jobs.")
        self.addOption ('splitPerLHCRun', False, type=bool,
            info="trigger branches will only be processed for the current LHC run.")
        self.addOption ('noFilter', False, type=bool,
            info="do not apply an event filter (i.e. keep events not passing trigger selection or matching).")
        self.addOption ('noL1', False, type=bool,
            info="toggle off the L1 trigger decision. This flag is required e.g. for running the algorithm on TLA stream data.")
 

Member Function Documentation

_get_lumicalc_triggers()

list[str] python.TriggerAnalysisConfig.TriggerAnalysisBlock._get_lumicalc_triggers ( list[str] lumicalc_files )

staticprotected

Definition at line 121 of file TriggerAnalysisConfig.py.

    def _get_lumicalc_triggers(lumicalc_files: list[str]) -> list[str]:
        return [lumicalc.split(":")[-1] for lumicalc in lumicalc_files if ":" in lumicalc]
 

instanceName()

python.TriggerAnalysisConfig.TriggerAnalysisBlock.instanceName

(

self

)

Return the instance name for this block

Definition at line 77 of file TriggerAnalysisConfig.py.

    def instanceName (self) :
        """Return the instance name for this block"""
        return '' # no instance name, as this is a singleton block
 

makeAlgs()

python.TriggerAnalysisConfig.TriggerAnalysisBlock.makeAlgs	(		self,
			config )

Definition at line 211 of file TriggerAnalysisConfig.py.

    def makeAlgs (self, config) :
 
        if (self.multiTriggerChainsPerYear and self.triggerChainsPerYear and
            self.triggerChainsPerYear is not self.multiTriggerChainsPerYear.get('')):
            raise Exception('multiTriggerChainsPerYear and triggerChainsPerYear cannot be configured at the same time!')
 
        if self.prescaleLumiCalcFiles and self.prescaleLumiCalcFilesPerYear:
            raise Exception('prescaleLumiCalcFiles and prescaleLumiCalcFilesPerYear cannot be configured at the same time!')
 
        if self.prescaleIncludeAllYearsPerRun and not self.prescaleLumiCalcFilesPerYear:
            raise Exception('prescaleIncludeAllYearsPerRun requires prescaleLumiCalcFilesPerYear to be configured!')
 
        if (self.prescaleLumiCalcFiles or self.prescaleLumiCalcFilesPerYear) and not (
            self.unprescaleData or self.prescaleMC
        ):
            raise Exception('Lumicalc files are provided but no trigger prescale output is configured! Specify output with "unprescaleData" and/or "prescaleMC".')
 
        if self.triggerChainsPerYear and not self.multiTriggerChainsPerYear:
            self.multiTriggerChainsPerYear = {'': self.triggerChainsPerYear}
 
        # if we are only given the trigger dictionary, we fill the selection list automatically
        # (configuring only multiTriggerChainsPerYear intentionally does not auto-fill triggerChainsForSelection)
        if self.triggerChainsPerYear and not self.triggerChainsForSelection:
            triggers_for_selection = set()
            triggers_for_decoration = set()
            from TriggerAnalysisAlgorithms.TriggerAnalysisSFConfig import get_input_years
            years = get_input_years(config)
            for trigger_chains in self.multiTriggerChainsPerYear.values():
                for year, chain_list in trigger_chains.items():
                    if self.splitPerLHCRun and not is_year_in_current_period(config, year):
                        continue
                    target_triggers = triggers_for_selection if int(year) in years else triggers_for_decoration
                    for chain in chain_list:
                        if '||' in chain:
                            chains = chain.split('||')
                            target_triggers.update(map(str.strip, chains))
                        else:
                            target_triggers.add(chain.strip())
            self.triggerChainsForSelection = list(triggers_for_selection)
            self.triggerChainsForDecoration += list(triggers_for_decoration)
 
        # Create the decision algorithm, keeping track of the decision tool for later
        decisionTool = self.makeTriggerDecisionTool(config)
 
        if self.triggerChainsForSelection:
            self.makeTriggerSelectionAlg(config, decisionTool)
 
        return
 
 
 
@groupBlocks

makeTriggerDecisionTool()

python.TriggerAnalysisConfig.TriggerAnalysisBlock.makeTriggerDecisionTool ( config )

static

Definition at line 82 of file TriggerAnalysisConfig.py.

    def makeTriggerDecisionTool(config):
        # Might have already been added
        toolName = "TrigDecisionTool"
        if toolName in config._algorithms:
            return config._algorithms[toolName]
 
        # Create public trigger tools
        xAODConfTool = config.createPublicTool("TrigConf::xAODConfigTool", "xAODConfigTool")
        decisionTool = config.createPublicTool("Trig::TrigDecisionTool", toolName)
        decisionTool.ConfigTool = f"{xAODConfTool.getType()}/{xAODConfTool.getName()}"
        decisionTool.HLTSummary = config.hltSummary()
        if config.geometry() is LHCPeriod.Run3:
            # Read Run 3 navigation
            # (options are "TrigComposite" for R3 or "TriggElement" for R2,
            # R2 navigation is not kept in most DAODs)
            decisionTool.NavigationFormat = "TrigComposite"
 
        return decisionTool
 

makeTriggerMatchingTool()

python.TriggerAnalysisConfig.TriggerAnalysisBlock.makeTriggerMatchingTool ( config, decisionTool )

static

Definition at line 102 of file TriggerAnalysisConfig.py.

    def makeTriggerMatchingTool(config, decisionTool):
        # Might have already been added
        toolName = "TrigMatchingTool"
        if toolName in config._algorithms:
            return config._algorithms[toolName]
 
        # Create public trigger tools
        if config.geometry() is LHCPeriod.Run3:
            drScoringTool = config.createPublicTool("Trig::DRScoringTool", "DRScoringTool")
            matchingTool = config.createPublicTool("Trig::R3MatchingTool", toolName)
            matchingTool.ScoringTool = f"{drScoringTool.getType()}/{drScoringTool.getName()}"
            matchingTool.TrigDecisionTool = f"{decisionTool.getType()}/{decisionTool.getName()}"
        else:
            matchingTool = config.createPublicTool("Trig::MatchFromCompositeTool", toolName)
            if config.isPhyslite():
                matchingTool.InputPrefix = "AnalysisTrigMatch_"
        return matchingTool
 

makeTriggerSelectionAlg()

python.TriggerAnalysisConfig.TriggerAnalysisBlock.makeTriggerSelectionAlg	(		self,
			config,
			decisionTool )

Definition at line 124 of file TriggerAnalysisConfig.py.

    def makeTriggerSelectionAlg(self, config, decisionTool):
 
        # Set up the trigger selection:
        alg = config.createAlgorithm( 'CP::TrigEventSelectionAlg', 'TrigEventSelectionAlg' )
        alg.tool = f'{decisionTool.getType()}/{decisionTool.getName()}'
        alg.triggers = self.triggerChainsForSelection
        alg.selectionDecoration = 'trigPassed'
        alg.noFilter = self.noFilter
        alg.noL1 = self.noL1
 
        for t in self.triggerChainsForSelection :
            t = sanitizeTriggerChainName(t)
            config.addOutputVar ('EventInfo', 'trigPassed_' + t, 'trigPassed_' + t, noSys=True)
 
        # for decoration, make sure we only get the triggers not already in the selection list
        triggerChainsForDeco = list(set(self.triggerChainsForDecoration) - set(self.triggerChainsForSelection))
        if triggerChainsForDeco :
            alg = config.createAlgorithm( 'CP::TrigEventSelectionAlg', 'TrigEventSelectionAlgDeco' )
            alg.tool = f'{decisionTool.getType()}/{decisionTool.getName()}'
            alg.triggers = triggerChainsForDeco
            alg.selectionDecoration = 'trigPassed'
            alg.noFilter = True
            alg.noL1 = self.noL1
 
            for t in triggerChainsForDeco :
                t = sanitizeTriggerChainName(t)
                config.addOutputVar ('EventInfo', 'trigPassed_' + t, 'trigPassed_' + t, noSys=True)
 
        # Calculate trigger prescales
        if (self.prescaleLumiCalcFiles or self.prescaleLumiCalcFilesPerYear) and (
            self.unprescaleData if config.dataType() is DataType.Data else self.prescaleMC
        ):
 
            lumicalc_files = []
            if self.prescaleLumiCalcFiles:
                lumicalc_files = self.prescaleLumiCalcFiles
            elif self.prescaleLumiCalcFilesPerYear:
                from TriggerAnalysisAlgorithms.TriggerAnalysisSFConfig import get_input_years, get_year_data
 
                years = get_input_years(config)
                for year in years:
                    lumicalc_files.extend(get_year_data(self.prescaleLumiCalcFilesPerYear, year))
 
            prescale_triggers = self._get_lumicalc_triggers(lumicalc_files)
            prescale_triggersAll = self.triggerChainsForSelection
 
            # Schedule trigger prescale output branches
            prescale_triggers_output = set(prescale_triggers)
            if self.prescaleIncludeAllYearsPerRun and self.prescaleLumiCalcFilesPerYear:
                all_lumicalc_files = [
                    lumicalc
                    for lumicalc_year, lumicalc_values in self.prescaleLumiCalcFilesPerYear.items()
                    for lumicalc in lumicalc_values
                    if is_year_in_current_period(config, int(lumicalc_year))
                ]
                prescale_triggers_output.update(self._get_lumicalc_triggers(all_lumicalc_files))
                prescale_triggersAll = list(prescale_triggers_output)
 
            if not self.prescaleTriggersFormula and not prescale_triggersAll:
                return
 
            alg = config.createAlgorithm( 'CP::TrigPrescalesAlg', 'TrigPrescalesAlg' )
            config.addPrivateTool( 'pileupReweightingTool', 'CP::PileupReweightingTool' )
            alg.pileupReweightingTool.LumiCalcFiles = lumicalc_files
            alg.selectionDecoration = 'trigPassed'
            alg.prescaleMC = config.dataType() is not DataType.Data
            alg.prescaleDecoration = self.prescaleDecoration
            if self.prescaleTriggersFormula != '':
                alg.triggersFormula = self.prescaleTriggersFormula
                config.addOutputVar("EventInfo", alg.prescaleDecoration, alg.prescaleDecoration, noSys=True)
            else:
                alg.triggers = prescale_triggers
                alg.triggersAll = prescale_triggersAll
 
                # Schedule trigger prescale output branches
                for trigger in prescale_triggers_output & set(prescale_triggersAll):
                    trigger = sanitizeTriggerChainName(trigger)
                    config.addOutputVar(
                        "EventInfo",
                        alg.prescaleDecoration + "_" + trigger,
                        alg.prescaleDecoration + "_" + trigger,
                        noSys=True,
                    )
 
        return
 
 

Member Data Documentation

multiTriggerChainsPerYear

dict python.TriggerAnalysisConfig.TriggerAnalysisBlock.multiTriggerChainsPerYear

Definition at line 228 of file TriggerAnalysisConfig.py.

prescaleLumiCalcFiles

python.TriggerAnalysisConfig.TriggerAnalysisBlock.prescaleLumiCalcFiles

Definition at line 158 of file TriggerAnalysisConfig.py.

prescaleLumiCalcFilesPerYear

python.TriggerAnalysisConfig.TriggerAnalysisBlock.prescaleLumiCalcFilesPerYear

Definition at line 153 of file TriggerAnalysisConfig.py.

triggerChainsForSelection

python.TriggerAnalysisConfig.TriggerAnalysisBlock.triggerChainsForSelection

Definition at line 134 of file TriggerAnalysisConfig.py.

---

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

• TriggerAnalysisConfig.py