EventCleaningConfig.py

Go to the documentation of this file.

# Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
 
# AnaAlgorithm import(s):
from AnalysisAlgorithmsConfig.ConfigBlock import ConfigBlock
from AnalysisAlgorithmsConfig.ConfigAccumulator import DataType
 
 
class EventCleaningBlock (ConfigBlock):
    """the ConfigBlock for event cleaning"""
 
    def __init__ (self) :
        super (EventCleaningBlock, self).__init__ ()
        self.addOption ('runPrimaryVertexSelection', True, type=bool,
            info="whether to run primary vertex selection.")
        self.addOption ('runEventCleaning', False, type=bool,
            info="whether to run event cleaning (sets up an instance of "
            "`CP::EventFlagSelectionAlg`).")
        self.addOption ('runGRL', True, type=bool,
            info="whether to run GRL decoration/selection.")
        self.addOption ('userGRLFiles', [], type=list,
            info="a list of GRL files (list of strings) to select data from.")
        self.addOption ('minTracksPerVertex', 2, type=int,
            info="minimum number of tracks per vertex.")
        self.addOption ('selectionFlags', ['DFCommonJets_eventClean_LooseBad'], type=list,
            info="flags (list of strings) to use for jet cleaning.")
        # This is a vector<bool>, so parsing True/False is not handled
        # in AnalysisBase, but we can evade this with numerical values
        self.addOption ('invertFlags', [0], type=list,
            info="list of booleans determining whether to invert the cut of the "
            "above selectionFlags. In AnalysisBase, use 0/1 values instead.")
        self.addOption ('GRLDict', {}, type=dict, info="a custom GRL dictionary with key some name and value a GRL file. Leaving it empty will use the recommended values.")
        self.addOption ('GRLSuffixDict', {}, type=dict, info="a year-suffix dictionary to help with autoconfiguration of GRL selection, e.g. selecting 'BjetHLT'.")
        self.addOption ('noFilter', False, type=bool,
            info="whether to toggle off event filtering.")
        self.addOption ('useRandomRunNumber', False, type=bool,
            info="use `RandomRunNumber` to compute GRL info. Only supported for MC.")
 
        if self.runGRL and self.userGRLFiles:
            raise ValueError("No userGRLFiles should be specified if runGRL=False")
 
    def instanceName (self) :
        """Return the instance name for this block"""
        return '' # no instance name needed for singleton block
 
    def getDefaultGRLs (self, data_year) :
        """ returns a reasonable set of GRLs that should be suited for most analyses """
        from GoodRunsLists.GoodRunsListsDictionary import getGoodRunsLists
        GRLDict = getGoodRunsLists()
 
        GRLKey = 'GRL' + str(data_year)
        if data_year in self.GRLSuffixDict:
            GRLKey = GRLKey + '_' + self.GRLSuffixDict[data_year]
        elif data_year in [2017, 2018]:
            GRLKey = GRLKey + '_Triggerno17e33prim'
        return GRLDict[GRLKey]
 
    def makeAlgs (self, config) :
        
        # Apply GRL
        if self.runGRL and (config.dataType() is DataType.Data or self.useRandomRunNumber):
            if config.dataType() is DataType.Data and self.useRandomRunNumber:
                raise ValueError ("UseRandomRunNumber is only supported for MC!")
 
            if self.noFilter:
                # here we only decorate the PHYSLITE events with a boolean and don't do any cleaning
                # Set up the GRL Decoration
                if not self.GRLDict:
                    raise ValueError ("No GRLDict specified for GRL decoration, please specify a GRLDict")
 
                for GRLDecoratorName, GRLFileList in self.GRLDict.items():
                    if isinstance(GRLFileList, str):
                        GRLFileList = [GRLFileList]
 
                    alg = config.createAlgorithm("GRLSelectorAlg", GRLDecoratorName)
                    config.addPrivateTool("Tool", "GoodRunsListSelectionTool")
                    alg.Tool.UseRandomRunNumber = self.useRandomRunNumber
                    alg.Tool.GoodRunsListVec = GRLFileList
                    alg.noFilter = True
                    alg.grlKey = f"EventInfo.{GRLDecoratorName}"
 
                    config.addOutputVar("EventInfo", GRLDecoratorName, GRLDecoratorName, noSys=True, auxType="char")
            else:
                # Set up the GRL selection:
                alg = config.createAlgorithm( 'GRLSelectorAlg', 'GRLSelectorAlg' )
                config.addPrivateTool( 'Tool', 'GoodRunsListSelectionTool' )
                alg.Tool.UseRandomRunNumber = self.useRandomRunNumber
                if self.userGRLFiles:
                    alg.Tool.GoodRunsListVec = self.userGRLFiles
                else:
                    alg.Tool.GoodRunsListVec = self.getDefaultGRLs( config.dataYear() )
 
        # Skip events with no primary vertex:
        if self.runPrimaryVertexSelection:
            alg = config.createAlgorithm( 'CP::VertexSelectionAlg',
                                          'PrimaryVertexSelectorAlg',
                                           reentrant=True )
            alg.VertexContainer = 'PrimaryVertices'
            alg.MinVertices = 1
            alg.MinTracks = self.minTracksPerVertex
 
        # Set up the event cleaning selection:
        if self.runEventCleaning:
            if config.dataType() is DataType.Data:
                alg = config.createAlgorithm( 'CP::EventStatusSelectionAlg', 'EventStatusSelectionAlg' )
                alg.FilterKey = 'EventErrorState'
                alg.FilterDescription = 'selecting events without any error state set'
 
            alg = config.createAlgorithm( 'CP::EventFlagSelectionAlg', 'EventFlagSelectionAlg' )
            alg.FilterKey = 'JetCleaning'
            alg.selectionFlags = [f'{sel},as_char' for sel in self.selectionFlags]
            alg.invertFlags = self.invertFlags
            alg.FilterDescription = f"selecting events passing: {','.join(alg.selectionFlags)}"