MetAnalysisSequence.py

Go to the documentation of this file.

# Copyright (C) 2002-2019 CERN for the benefit of the ATLAS collaboration
 
# AnaAlgorithm import(s):
from AnaAlgorithm.AnaAlgSequence import AnaAlgSequence
from AnaAlgorithm.DualUseConfig import createAlgorithm, addPrivateTool
 
def makeMetAnalysisSequence( dataType, metSuffix,
                             postfix = '',
                             useFJVT = False,
                             treatPUJets = False,
                             setMuonJetEMScale = True,
                             electronsSelection = "",
                             muonsSelection = "",
                             photonsSelection = "",
                             tausSelection = ""):
    """Create a met analysis algorithm sequence
 
    After creating the sequence object, it needs to be configured with a call
    like:
 
       metSequence.configure( inputName = {
                                 'jets'      : 'AntiKt4EMPFlowJets_%SYS%',
                                 'electrons' : 'AnalysisElectrons_%SYS%',
                                 'photons'   : 'AnalysisPhotons_%SYS%',
                                 'muons'     : 'AnalysisMuons_%SYS%',
                                 'taus'      : 'AnalysisTaus_%STS%',
                              },
                              outputName = 'AnalysisMET_%SYS%' )
 
    Note that defining a jet container is mandatory, but all other input
    containers are optional.
 
    Selections on each container can also be defined
 
    Keyword arguments:
      dataType -- The data type to run on ("data", "mc" or "afii")
      metSuffix -- Suffix for the (core) MET objects to use from the input
                   (file)
      useFJVT -- Use FJVT decision for the calculation
      treatPUJets -- Treat pile-up jets in the MET significance calculation
    """
 
    if dataType not in ["data", "mc", "afii"] :
        raise ValueError ("invalid data type: " + dataType)
 
    if not useFJVT and treatPUJets:
        raise ValueError ("MET significance pile-up treatment requires fJVT")
 
    # Remove b-tagging calibration from the MET suffix name
    btIndex = metSuffix.find('_BTagging')
    if btIndex != -1:
        metSuffix = metSuffix[:btIndex]
 
    # Create the analysis algorithm sequence object:
    seq = AnaAlgSequence( "MetAnalysisSequence" + postfix )
 
    # Set up the met maker algorithm:
    alg = createAlgorithm( 'CP::MetMakerAlg', 'MetMakerAlg' + postfix)
    addPrivateTool( alg, 'makerTool', 'met::METMaker' )
    
    alg.makerTool.DoPFlow = 'PFlow' in metSuffix or metSuffix=="AnalysisMET"
    alg.makerTool.DoSetMuonJetEMScale = setMuonJetEMScale
    
    if useFJVT:
        alg.makerTool.JetRejectionDec = 'passFJVT'
    if dataType != "data" :
        addPrivateTool( alg, 'systematicsTool', 'met::METSystematicsTool' )
    alg.metCore = 'MET_Core_' + metSuffix
    alg.metAssociation = 'METAssoc_' + metSuffix
    alg.electronsSelection = electronsSelection
    alg.muonsSelection = muonsSelection
    alg.photonsSelection = photonsSelection
    alg.tausSelection = tausSelection
    seq.append( alg,
                inputPropName = { 'jets'      : 'jets',
                                  'electrons' : 'electrons',
                                  'photons'   : 'photons',
                                  'muons'     : 'muons',
                                  'taus'      : 'taus',
                                  'invisible' : 'invisible'},
                outputPropName = 'met' )
 
    # Set up the met builder algorithm:
    alg = createAlgorithm( 'CP::MetBuilderAlg', 'MetBuilderAlg' + postfix )
    seq.append( alg, inputPropName = 'met' )
 
    # Set up the met significance algorithm:
    alg = createAlgorithm( 'CP::MetSignificanceAlg', 'MetSignificanceAlg' + postfix )
    addPrivateTool( alg, 'significanceTool', 'met::METSignificance' )
    alg.significanceTool.SoftTermParam = 0
    alg.significanceTool.TreatPUJets = treatPUJets
    alg.significanceTool.IsAFII = dataType == "afii"
    seq.append( alg, inputPropName = 'met' )
 
    # Return the sequence:
    return seq