ITkStripByteStreamCnvConfig.py

Go to the documentation of this file.

#
# Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
#
 
from AthenaConfiguration.ComponentAccumulator import ComponentAccumulator
from AthenaConfiguration.ComponentFactory import CompFactory
from AthenaConfiguration.Enums import ProductionStep
from ITkStripCabling.ITkStripCablingConfig import ITkStripCablingToolCfg
from StripGeoModelXml.ITkStripGeoModelConfig import ITkStripReadoutGeometryCfg
 
 
def ITkStripRawContByteStreamToolCfg(flags, name="ITkStripRawContByteStreamToolCustom", **kwargs) :
    acc = ComponentAccumulator()
    if "ITkStripsRodEncoder" not in kwargs :
        kwargs.setdefault("Encoder", acc.popToolsAndMerge(ITkStripsRodEncoderCfg(flags)))
    acc.setPrivateTools( CompFactory.ITkStripsRawContByteStreamTool(name=name,**kwargs))
    return acc
 
def ITkStripRawContByteStreamToolProviderToolCfg(flags, name="SCTRawContByteStreamToolProviderTool", **kwargs) :
    acc = ComponentAccumulator()
    if "RawContByteStreamTool" not in kwargs :
        kwargs.setdefault("RawContByteStreamTool", acc.popToolsAndMerge(ITkStripRawContByteStreamToolCfg(flags)))
    acc.addPublicTool( CompFactory.ITkStripRawContByteStreamToolProviderTool(name=name,**kwargs))
    return acc
 
def ITkStripsRodEncoderCfg(flags, name='ITkStripRodEncoder', **kwargs):
    acc = ComponentAccumulator()    
    acc.merge(ITkStripReadoutGeometryCfg(flags))
    if "DataRateMonitoringTool" not in kwargs:
        kwargs.setdefault("DataRateMonitoringTool", acc.getPrimaryAndMerge(ITkStripDataRateMonToolCfg(flags, doExpertPlots=False)))    
    kwargs.setdefault("ITkStripCablingTool", acc.popToolsAndMerge(ITkStripCablingToolCfg(flags)))
    acc.setPrivateTools(CompFactory.ITkStripsRodEncoder(name,**kwargs))
    return acc
 
def ITkStripsRodDecoderCfg(flags, name='ITkStripsRodDecoder', **kwargs):
    acc = ComponentAccumulator()
    acc.merge(ITkStripReadoutGeometryCfg(flags))
    kwargs.setdefault("ITkStripCablingTool", acc.popToolsAndMerge(ITkStripCablingToolCfg(flags)))
    acc.setPrivateTools(CompFactory.ITkStripsRodDecoder(name,**kwargs))
    return acc
 
def ITkStripRawDataProviderToolCfg(flags, name="ITkStripRawDataProviderTool", **kwargs):
    acc = ComponentAccumulator()
    kwargs.setdefault("Decoder", acc.popToolsAndMerge(ITkStripsRodDecoderCfg(flags)))
    acc.setPrivateTools(CompFactory.ITkStripRawDataProviderTool(name, **kwargs))
    return acc
 
def ITkStripRawDataProviderCfg(flags, **kwargs):
    """ Configures the main algorithm for ITk raw data decoding """
    acc = ComponentAccumulator()    
    kwargs.setdefault("ProviderTool", acc.popToolsAndMerge(ITkStripRawDataProviderToolCfg(flags)))
 
    if flags.Common.ProductionStep is ProductionStep.MinbiasPreprocessing:
        kwargs.setdefault("RDOKey", f"{flags.Overlay.BkgPrefix}ITkStripRDOs")
        kwargs.setdefault("LVL1IDKey", f"{flags.Overlay.BkgPrefix}ITkStripLVL1ID")
        kwargs.setdefault("BCIDKey", f"{flags.Overlay.BkgPrefix}ITkStripBCID")
 
    acc.addEventAlgo(CompFactory.ITkStripRawDataProvider(name="ITkStripRawDataProvider",**kwargs))
    return acc
 
def ITkStripsEventFlagWriterCfg(flags, **kwargs):
    acc = ComponentAccumulator()
    if flags.Common.ProductionStep is ProductionStep.MinbiasPreprocessing:
        kwargs.setdefault("xAODEventInfoKey", f"{flags.Overlay.BkgPrefix}EventInfo")
    acc.addEventAlgo(CompFactory.SCTEventFlagWriter(name="ITkStripsEventFlagWriter", **kwargs))
 
    return acc
 
def ITkStripDataRateMonToolCfg(flags,
                               name = "ITkStripDataRateMonTool",
                               doExpertPlots = False,
                               HistogramGroup: str="DataRateMon",
                               FileName: str='ITkStripEncodingMonitoring.root') -> ComponentAccumulator:
    acc = ComponentAccumulator()
 
    histSvc = CompFactory.THistSvc(Output = [f"{HistogramGroup} DATAFILE='{FileName}', OPT='RECREATE'"] )
    acc.addService(histSvc)
 
    monitor = CompFactory.ITkStripDataRateMonTool(name)
    monitor.HistSvc = histSvc
    monitor.DoExpertPlots = doExpertPlots
 
    acc.addPublicTool(monitor, primary=True)
    return acc