OverlayConfigFlags.py

Go to the documentation of this file.

"""Construct Overlay configuration flags
 
Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
"""
 
from AthenaConfiguration.AthConfigFlags import AthConfigFlags
from AthenaConfiguration.AutoConfigFlags import GetFileMD
from AthenaConfiguration.Enums import ProductionStep
 
 
def createOverlayConfigFlags():
    """Return an AthConfigFlags object with required flags"""
    flags = AthConfigFlags()
    # Data overlay flag
    flags.addFlag("Overlay.DataOverlay", lambda prevFlags : GetFileMD(prevFlags.Input.Files).get("IsDataOverlay", "False") == "True")
    # Data overlay conditions
    flags.addFlag("Overlay.DataOverlayConditions", "")
    # Overlay skip secondary events
    flags.addFlag("Overlay.SkipSecondaryEvents", -1)
    # Overlay background StoreGate key prefix
    flags.addFlag("Overlay.BkgPrefix", "Bkg_")
    # Overlay signal StoreGate key prefix
    flags.addFlag("Overlay.SigPrefix", "Sig_")
    # Overlay extra input dependencies
    flags.addFlag("Overlay.ExtraInputs", [("McEventCollection", "TruthEvent")])
    # track overlay flag
    flags.addFlag("Overlay.doTrackOverlay", False)
    # Ignore background inputs
    flags.addFlag("Overlay.IgnoreBkgInputs", False)
    # Do not align TRT for data overlay
    flags.addFlag("Overlay.DynamicAlignTRT", lambda prevFlags : prevFlags.GeoModel.Align.Dynamic and \
                                             (not prevFlags.Overlay.DataOverlay or prevFlags.Common.ProductionStep is ProductionStep.MinbiasPreprocessing))
    return flags