Classes
class	MetaDataHelperLists

Functions
	metadata_creator (func)
	createCutFlowMetaData (tools, result, flags, **kwargs)
	createByteStreamMetaData (tools, result, flags, **kwargs)
	createLumiBlockMetaData (tools, result, flags, **kwargs)
	createTriggerMenuMetaData (tools, result, flags, **kwargs)
	createTruthMetaData (tools, result, flags, **kwargs)
	createIOVMetaData (tools, result, flags, **kwargs)
	createEventStreamInfo (tools, result, flags, **kwargs)
	propagateMetaData (flags, streamName="", category=None)
	SetupMetaDataForStreamCfg (flags, streamName="", AcceptAlgs=None, createMetadata=None, propagateMetadataFromInput=True, args, *kwargs)

Variables
list	defaultIOVFolders
dict	excludeStreamToIOVFolders

Function Documentation

◆ createByteStreamMetaData()

InfileMetaDataConfig.createByteStreamMetaData	(		tools,
			result,
			flags,
		**	kwargs )

Definition at line 87 of file InfileMetaDataConfig.py.

def createByteStreamMetaData(tools, result, flags, **kwargs):
    tools.mdItems += ["ByteStreamMetadataContainer#*"]
    if flags.Input.Format == Format.BS and not flags.Common.isOnline:
        from ByteStreamCnvSvc.ByteStreamConfig import ByteStreamReadCfg
 
        result.merge(ByteStreamReadCfg(flags))
 
 
@metadata_creator

◆ createCutFlowMetaData()

InfileMetaDataConfig.createCutFlowMetaData	(		tools,
			result,
			flags,
		**	kwargs )

Definition at line 76 of file InfileMetaDataConfig.py.

def createCutFlowMetaData(tools, result, flags, **kwargs):
    from EventBookkeeperTools.EventBookkeeperToolsConfig import (
        CutFlowOutputList,
        CutFlowSvcCfg,
    )
 
    result.merge(CutFlowSvcCfg(flags))
    tools.mdItems += CutFlowOutputList(flags)
 
 
@metadata_creator

◆ createEventStreamInfo()

InfileMetaDataConfig.createEventStreamInfo	(		tools,
			result,
			flags,
		**	kwargs )

Definition at line 147 of file InfileMetaDataConfig.py.

def createEventStreamInfo(tools, result, flags, **kwargs):
        esiTool = CompFactory.MakeEventStreamInfo(
            f"{outputStreamName(kwargs.get('streamName', ''))}_MakeEventStreamInfo",
            Key=outputStreamName(kwargs.get('streamName', '')),
            DataHeaderKey=outputStreamName(kwargs.get('streamName', '')),
            EventInfoKey=f"{flags.Overlay.BkgPrefix}EventInfo"
            if flags.Common.ProductionStep
            in [ProductionStep.PileUpPresampling, ProductionStep.PileUpPretracking, ProductionStep.MinbiasPreprocessing]
            else "EventInfo",
        )
        tools.mdItems += [
            f"EventStreamInfo#{outputStreamName(kwargs.get('streamName', ''))}",
        ]
        tools.helperTools.append(esiTool)
 

◆ createIOVMetaData()

InfileMetaDataConfig.createIOVMetaData	(		tools,
			result,
			flags,
		**	kwargs )

Definition at line 132 of file InfileMetaDataConfig.py.

def createIOVMetaData(tools, result, flags, **kwargs):
    streamName = kwargs.get("streamName", "")
    if streamName not in excludeStreamToIOVFolders:
        tools.mdItems += ["IOVMetaDataContainer#*"]
    else:
        tools.mdItems += [
            f"IOVMetaDataContainer#{folder}"
            for folder in defaultIOVFolders
            if folder not in excludeStreamToIOVFolders[streamName]
        ]
    from IOVDbSvc.IOVDbSvcConfig import IOVDbSvcCfg
    result.merge(IOVDbSvcCfg(flags))
 
 
@metadata_creator

◆ createLumiBlockMetaData()

InfileMetaDataConfig.createLumiBlockMetaData	(		tools,
			result,
			flags,
		**	kwargs )

Definition at line 96 of file InfileMetaDataConfig.py.

def createLumiBlockMetaData(tools, result, flags, **kwargs):
    if flags.Input.Format == Format.BS and not flags.Common.isOnline:
        from LumiBlockComps.CreateLumiBlockCollectionFromFileConfig import (
            CreateLumiBlockCollectionFromFileCfg,
        )
 
        result.merge(CreateLumiBlockCollectionFromFileCfg(flags))
        tools.mdItems += [
            "xAOD::LumiBlockRangeContainer#*",
            "xAOD::LumiBlockRangeAuxContainer#*",
        ]
 
 
@metadata_creator

◆ createTriggerMenuMetaData()

InfileMetaDataConfig.createTriggerMenuMetaData	(		tools,
			result,
			flags,
		**	kwargs )

Definition at line 110 of file InfileMetaDataConfig.py.

def createTriggerMenuMetaData(tools, result, flags, **kwargs):
    tools.mdTools.append(
        CompFactory.xAODMaker.TriggerMenuMetaDataTool("TriggerMenuMetaDataTool")
    )
    tools.mdItems += [
        "xAOD::TriggerMenuContainer#*",
        "xAOD::TriggerMenuAuxContainer#*",
        "xAOD::TriggerMenuJsonContainer#*",
        "xAOD::TriggerMenuJsonAuxContainer#*",
    ]
 
 
@metadata_creator

◆ createTruthMetaData()

InfileMetaDataConfig.createTruthMetaData	(		tools,
			result,
			flags,
		**	kwargs )

Definition at line 123 of file InfileMetaDataConfig.py.

def createTruthMetaData(tools, result, flags, **kwargs):
    tools.mdItems += [
        "xAOD::TruthMetaDataContainer#TruthMetaData",
        "xAOD::TruthMetaDataAuxContainer#TruthMetaDataAux.",
    ]
    tools.mdTools.append(CompFactory.xAODMaker.TruthMetaDataTool("TruthMetaDataTool"))
 
 
@metadata_creator

◆ metadata_creator()

InfileMetaDataConfig.metadata_creator ( func )

Decorator function which:
- creates default MetaDataHelperLists() and ComponentAccumulator() instances
- passes them to wrapped create*MetaData functions responsible for configuration of helper lists and CA, specific to metadata category
- returns configured instances of MetaDataHelperLists() (used by MetaDataSvc and AthenaOutputStream) and CA

Definition at line 57 of file InfileMetaDataConfig.py.

def metadata_creator(func):
    """
    Decorator function which:
    - creates default MetaDataHelperLists() and ComponentAccumulator() instances
    - passes them to wrapped create*MetaData functions responsible for configuration of helper lists and CA, specific to metadata category
    - returns configured instances of MetaDataHelperLists() (used by MetaDataSvc and AthenaOutputStream) and CA
    """
 
    @wraps(func)
    def wrapper(*args, **kwargs):
        tools = MetaDataHelperLists()
        result = ComponentAccumulator()
        func(tools, result, *args, **kwargs)
        return tools, result
 
    return wrapper
 
 
@metadata_creator

◆ propagateMetaData()

InfileMetaDataConfig.propagateMetaData	(	flags,
		streamName = "",
		category = None )

Returns the tuple of MetaDataHelperLists and ComponentAccumulator.
The former combines the lists needed to setup given metadata category
for the output stream configuration and metadata service.
The latter contains the CA needed for a given metadata category.

Definition at line 162 of file InfileMetaDataConfig.py.

def propagateMetaData(flags, streamName="", category=None):
    """
    Returns the tuple of MetaDataHelperLists and ComponentAccumulator.
    The former combines the lists needed to setup given metadata category
    for the output stream configuration and metadata service.
    The latter contains the CA needed for a given metadata category.
    """
    tools = MetaDataHelperLists()
    result = ComponentAccumulator()
    log = logging.getLogger("SetupMetaDataForStreamCfg")
 
    if category == MetadataCategory.FileMetaData:
        tools.mdToolNames.append("xAODMaker::FileMetaDataTool")
        tools.mdItems += [
            "xAOD::FileMetaData#FileMetaData",
            "xAOD::FileMetaDataAuxInfo#FileMetaDataAux.",
        ]
        tools.helperTools.append(
            CompFactory.xAODMaker.FileMetaDataCreatorTool(
                f"{outputStreamName(streamName)}_FileMetaDataCreatorTool",
                OutputKey="FileMetaData",
                StreamName=outputStreamName(streamName),
                EventInfoKey=f"{flags.Overlay.BkgPrefix}EventInfo"
                    if flags.Common.ProductionStep in [ProductionStep.PileUpPresampling, ProductionStep.PileUpPretracking, ProductionStep.MinbiasPreprocessing]
                    else "EventInfo",
            )
        )
    elif category == MetadataCategory.EventStreamInfo:
        tools.mdTools += [
            CompFactory.CopyEventStreamInfo(
                f"{outputStreamName(streamName)}_CopyEventStreamInfo",
                Keys=[outputStreamName(streamName)],
            ),
        ]
 
    elif category == MetadataCategory.EventFormat:
        efTool = CompFactory.xAODMaker.EventFormatStreamHelperTool(
            f"{outputStreamName(streamName)}_EventFormatStreamHelperTool",
            Key=f"EventFormat{outputStreamName(streamName)}",
            DataHeaderKey=outputStreamName(streamName),
        )
        tools.mdItems += [
            f"xAOD::EventFormat#EventFormat{outputStreamName(streamName)}",
        ]
        tools.helperTools.append(efTool)
        tools.mdToolNames.append("xAODMaker::EventFormatMetaDataTool")
    elif category == MetadataCategory.CutFlowMetaData:
        if "CutBookkeepers" in flags.Input.MetadataItems:
            from EventBookkeeperTools.EventBookkeeperToolsConfig import (
                CutFlowOutputList,
            )
 
            tools.mdToolNames.append("BookkeeperTool")
            tools.mdItems += CutFlowOutputList(flags)
 
    elif category == MetadataCategory.TriggerMenuMetaData:
        if any("TriggerMenu" in item for item in flags.Input.MetadataItems):
            _tools, _ = createTriggerMenuMetaData(flags)
            tools.mdTools = _tools.mdTools
            tools.mdItems = _tools.mdItems
 
    elif category == MetadataCategory.TruthMetaData:
        if "TruthMetaData" in flags.Input.MetadataItems:
            tools.mdItems += [
                "xAOD::TruthMetaDataContainer#TruthMetaData",
                "xAOD::TruthMetaDataAuxContainer#TruthMetaDataAux.",
            ]
            tools.mdTools.append(
                CompFactory.xAODMaker.TruthMetaDataTool("TruthMetaDataTool")
            )
    elif category == MetadataCategory.ByteStreamMetaData:
        if "ByteStreamMetadata" in flags.Input.MetadataItems:
            tools.mdItems += ["ByteStreamMetadataContainer#*"]
    elif category == MetadataCategory.LumiBlockMetaData:
        if any(
            lb in flags.Input.MetadataItems
            for lb in ["SuspectLumiBlocks", "IncompleteLumiBlocks", "LumiBlocks"]
        ):
            tools.mdToolNames.append("LumiBlockMetaDataTool")
            tools.mdItems += [
                "xAOD::LumiBlockRangeContainer#*",
                "xAOD::LumiBlockRangeAuxContainer#*",
            ]
    elif category == MetadataCategory.IOVMetaData:
        if "IOVMetaDataContainer" in flags.Input.MetadataItems.values():
            if streamName not in excludeStreamToIOVFolders:
                tools.mdItems += ["IOVMetaDataContainer#*"]
            else:
                tools.mdItems += [
                    f"IOVMetaDataContainer#{folder}"
                    for folder, container in flags.Input.MetadataItems.items()
                    if container == "IOVMetaDataContainer" and folder not in excludeStreamToIOVFolders[streamName]
                ]
 
    else:
        log.warning(f"Requested metadata category: {category} could not be configured")
    return tools, result
 
 

◆ SetupMetaDataForStreamCfg()

InfileMetaDataConfig.SetupMetaDataForStreamCfg	(		flags,
			streamName = "",
			AcceptAlgs = None,
			createMetadata = None,
			propagateMetadataFromInput = True,
		*	args,
		**	kwargs )

Set up metadata for the stream named streamName

It takes optional arguments: createMetadata to specify a list of metadata
categories to create (empty by default) and propagateMetadataFromInput (bool)
to propagate metadata existing in the input (True by default).

The additional argument, AcceptAlgs, is needed for workflows with custom kernels.

Returns CA to be merged

Definition at line 261 of file InfileMetaDataConfig.py.

):
    """
    Set up metadata for the stream named streamName
 
    It takes optional arguments: createMetadata to specify a list of metadata
    categories to create (empty by default) and propagateMetadataFromInput (bool)
    to propagate metadata existing in the input (True by default).
 
    The additional argument, AcceptAlgs, is needed for workflows with custom kernels.
 
    Returns CA to be merged
    """
    log = logging.getLogger("SetupMetaDataForStreamCfg")
    result = ComponentAccumulator()
    if not isinstance(streamName, str) or not streamName:
        return result
    if AcceptAlgs is None:
        AcceptAlgs = []
    if createMetadata is None:
        createMetadata = []
    createMetadata += [MetadataCategory.EventStreamInfo]
 
    helperLists = MetaDataHelperLists()
 
    if propagateMetadataFromInput:
        for mdCategory in MetadataCategory:
            lists, caConfig = propagateMetaData(
                flags,
                streamName,
                mdCategory,
            )
            helperLists += lists
            result.merge(caConfig)
 
    for md in createMetadata:
        try:
            lists, caConfig = globals()[f"create{md.name}"](
                flags,
                streamName=streamName,
            )
        except KeyError:
            log.warning(
                f"Requested metadata category: {md.name} could not be configured"
            )
            continue
        helperLists += lists
        result.merge(caConfig)
 
    # Configure the relevant output stream
    result.merge(
        addToMetaData(
            flags,
            streamName=streamName,
            itemOrList=helperLists.mdItems,
            AcceptAlgs=AcceptAlgs,
            HelperTools=helperLists.helperTools,
            **kwargs,
        )
    )
    # Configure the MetaDataSvc and pass the relevant tools
    from AthenaServices.MetaDataSvcConfig import MetaDataSvcCfg
 
    result.merge(
        MetaDataSvcCfg(
            flags, tools=helperLists.mdTools, toolNames=helperLists.mdToolNames
        )
    )
    return result

Variable Documentation

◆ defaultIOVFolders

list InfileMetaDataConfig.defaultIOVFolders

Initial value:

=  [
    "/Generation/Parameters",
    "/GLOBAL/BField/Maps",
    "/Simulation/Parameters",
    "/Digitization/Parameters",
    "/TagInfo",
    "/TRIGGER/HLT/HltConfigKeys",
    "/TRIGGER/HLT/Menu",
    "/TRIGGER/HLT/PrescaleKey",
    "/TRIGGER/HLT/Prescales",
    "/TRIGGER/LVL1/ItemDef",
    "/TRIGGER/LVL1/Lvl1ConfigKey",
    "/TRIGGER/LVL1/Menu",
    "/TRIGGER/LVL1/Prescales",
    "/TRIGGER/LVL1/Thresholds",
]

Definition at line 13 of file InfileMetaDataConfig.py.

◆ excludeStreamToIOVFolders

dict InfileMetaDataConfig.excludeStreamToIOVFolders