ITkPixelOverlayConfig.py

Go to the documentation of this file.

"""Define methods to construct configured ITk Pixel overlay algorithms
 
Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
"""
 
from AthenaConfiguration.ComponentAccumulator import ComponentAccumulator
from AthenaConfiguration.ComponentFactory import CompFactory
 
 
def ITkPixelOverlayAlgCfg(flags, name="ITkPixelOverlay", **kwargs):
    """Return a ComponentAccumulator for ITk PixelOverlay algorithm"""
    acc = ComponentAccumulator()
 
    kwargs.setdefault("BkgInputKey", f"{flags.Overlay.BkgPrefix}ITkPixelRDOs" if not flags.Overlay.IgnoreBkgInputs else "")
    kwargs.setdefault("SignalInputKey", f"{flags.Overlay.SigPrefix}ITkPixelRDOs")
    kwargs.setdefault("OutputKey", "ITkPixelRDOs")
 
    # Input setup
    if kwargs["BkgInputKey"]:
        from SGComps.SGInputLoaderConfig import SGInputLoaderCfg
        acc.merge(SGInputLoaderCfg(flags, [f'PixelRDO_Container#{kwargs["BkgInputKey"]}']))
 
    # Do Pixel overlay
    acc.addEventAlgo(CompFactory.PixelOverlay(name, **kwargs))
 
    # Setup output
    if flags.Output.doWriteRDO:
        from OutputStreamAthenaPool.OutputStreamConfig import OutputStreamCfg
        acc.merge(OutputStreamCfg(flags, "RDO", ItemList=[
            "PixelRDO_Container#ITkPixelRDOs"
        ]))
 
        if not flags.Input.isMC:
            acc.merge(OutputStreamCfg(flags, "RDO", ItemList=[
                "IDCInDetBSErrContainer#ITkPixelByteStreamErrs"
            ]))
 
    if flags.Output.doWriteRDO_SGNL:
        from OutputStreamAthenaPool.OutputStreamConfig import OutputStreamCfg
        acc.merge(OutputStreamCfg(flags, "RDO_SGNL", ItemList=[
            f"PixelRDO_Container#{flags.Overlay.SigPrefix}ITkPixelRDOs"
        ]))
 
    # for track overlay, write out the signal RDOs because reco tracking will only run on them
    if flags.Overlay.doTrackOverlay:
        acc.merge(OutputStreamCfg(flags, "RDO", ItemList=[
            f"PixelRDO_Container#{flags.Overlay.SigPrefix}ITkPixelRDOs"
        ]))
 
    return acc
 
 
def ITkPixelTruthOverlayCfg(flags, name="ITkPixelSDOOverlay", **kwargs):
    """Return a ComponentAccumulator for the ITk Pixel SDO overlay algorithm"""
    acc = ComponentAccumulator()
 
    # We do not need background Pixel SDOs for data overlay
    if not flags.Input.isMC:
        kwargs.setdefault("BkgInputKey", "")
    else:
        kwargs.setdefault("BkgInputKey", f"{flags.Overlay.BkgPrefix}ITkPixelSDO_Map")
 
    if kwargs["BkgInputKey"]:
        from SGComps.SGInputLoaderConfig import SGInputLoaderCfg
        acc.merge(SGInputLoaderCfg(flags, [f'InDetSimDataCollection#{kwargs["BkgInputKey"]}']))
 
    kwargs.setdefault("SignalInputKey", f"{flags.Overlay.SigPrefix}ITkPixelSDO_Map")
    kwargs.setdefault("OutputKey", "ITkPixelSDO_Map")
 
    # Do Pixel truth overlay
    acc.addEventAlgo(CompFactory.InDetSDOOverlay(name, **kwargs))
 
    # Setup output
    if flags.Output.doWriteRDO:
        from OutputStreamAthenaPool.OutputStreamConfig import OutputStreamCfg
        acc.merge(OutputStreamCfg(flags, "RDO", ItemList=[
            "InDetSimDataCollection#ITkPixelSDO_Map"
        ]))
 
    if flags.Output.doWriteRDO_SGNL:
        from OutputStreamAthenaPool.OutputStreamConfig import OutputStreamCfg
        acc.merge(OutputStreamCfg(flags, "RDO_SGNL", ItemList=[
            f"InDetSimDataCollection#{flags.Overlay.SigPrefix}ITkPixelSDO_Map"
        ]))
 
    return acc
 
 
def ITkPixelOverlayCfg(flags):
    """Configure and return a ComponentAccumulator for Pixel overlay"""
    acc = ComponentAccumulator()
 
    # Add ITk Pixel overlay digitization algorithm
    from PixelDigitization.ITkPixelDigitizationConfig import ITkPixelOverlayDigitizationBasicCfg
    acc.merge(ITkPixelOverlayDigitizationBasicCfg(flags))
 
    # Add ITk Pixel overlay algorithm
    acc.merge(ITkPixelOverlayAlgCfg(flags))
 
    # Add ITk Pixel truth overlay
    if flags.Digitization.EnableTruth:
        acc.merge(ITkPixelTruthOverlayCfg(flags))
 
    return acc