Functions
	ByteStreamReadCfg (flags, type_names=None)
	ByteStreamWriteCfg (flags, type_names=None)
	MCEventInfoByteStreamToolCfg (flags, name="MCEventInfoByteStreamTool", writeBS=False)
	TransientByteStreamCfg (flags, item_list=None, type_names=None, extra_inputs=None)
	ByteStreamCfg (flags, **kwargs)

Variables
	log = logging.getLogger('ByteStreamConfig')
	flags = initConfigFlags()
	Files
	doWriteBS
	read = ByteStreamReadCfg(flags)
	write = ByteStreamWriteCfg(flags)
	acc = MainServicesCfg(flags)

Detailed Description

Set up to read and/or write bytestream files.

This module configures the Athena components required to read from
RAW/bytestream input. Use either byteStreamReadCfg to set up for reading
and byteStreamWriteCfg to set up for writing. Merge the component accumulator
the functions return into your job configuration as needed.

Executing this module will run a short test over 10 events. The events are read
from the default bytestream input on CVMFS and written to a local bytestream
file.

    Typical usage examples:

        component_accumulator.merge(byteStreamReadCfg(flags))

Function Documentation

◆ ByteStreamCfg()

ByteStreamConfig.ByteStreamCfg	(		flags,
		**	kwargs )

Definition at line 5 of file graphics/EventDisplaysOnline/python/ByteStreamConfig.py.

def ByteStreamCfg(flags, **kwargs):
 
    acc = ComponentAccumulator()
 
    from ByteStreamEmonSvc.EmonByteStreamConfig import EmonByteStreamCfg
    acc.merge(EmonByteStreamCfg(flags))
 
    bytestreamInput = acc.getService("ByteStreamInputSvc")
    bytestreamInput.Partition = flags.OnlineEventDisplays.PartitionName
    bytestreamInput.GroupName = "EventDisplaysOnline"
    bytestreamInput.PublishName = "EventDisplays"
    bytestreamInput.Key = "dcm"
    bytestreamInput.KeyCount = 1
    bytestreamInput.Timeout = 600000
    bytestreamInput.UpdatePeriod = 200
    bytestreamInput.BufferSize = 10
    bytestreamInput.ISServer = '' # Disable histogramming
    bytestreamInput.StreamNames = flags.OnlineEventDisplays.TriggerStreams
    bytestreamInput.ProcessCorruptedEvents = True
    #bytestreamInput.StreamType = "physics" #comment out for all streams, e.g. if you also want claibration streams
    bytestreamInput.StreamLogic = "Or"
 
    if flags.OnlineEventDisplays.BeamSplashMode:
        bytestreamInput.KeyCount = 64 # equal or greater than the number of DCMs for beam splashes
        bytestreamInput.BufferSize = 192 # at least three times of keycount for beam splashes
        bytestreamInput.Timeout = 144000000 #(40 hrs)
        bytestreamInput.StreamType = "physics" #if trigger fails it will go to debug_HltError
 
    if flags.OnlineEventDisplays.PartitionName != 'ATLAS':
        bytestreamInput.KeyValue = [ 'Test_emon_push' ]
        bytestreamInput.KeyCount = 1
 
    return acc

◆ ByteStreamReadCfg()

ByteStreamConfig.ByteStreamReadCfg	(		flags,
			type_names = None )

Set up to read from a bytestream file

The function adds the components required to read events and metadata from
bytestream input. May be used to read events from a secondary input as well
primary input file.

Args:
    flags:      Job configuration flags
    type_names: (optional) specific type names for address provider to find

Returns:
    A component accumulator fragment containing the components required to
    read from bytestream. Should be merged into main job configuration.

Definition at line 26 of file Event/ByteStreamCnvSvc/python/ByteStreamConfig.py.

def ByteStreamReadCfg(flags, type_names=None):
    """Set up to read from a bytestream file
 
    The function adds the components required to read events and metadata from
    bytestream input. May be used to read events from a secondary input as well
    primary input file.
 
    Args:
        flags:      Job configuration flags
        type_names: (optional) specific type names for address provider to find
 
    Returns:
        A component accumulator fragment containing the components required to
        read from bytestream. Should be merged into main job configuration.
    """
    result = ComponentAccumulator()
 
    bytestream_conversion = CompFactory.ByteStreamCnvSvc(
        IsSimulation=flags.Input.isMC,
    )
    result.addService(bytestream_conversion)
 
    # For MC ByteStream, add the MCEventInfoByteStreamTool to decode MC EventInfo
    if flags.Input.isMC:
        mcEventInfoTool = CompFactory.MCEventInfoByteStreamTool(
            name="MCEventInfoByteStreamTool",
            ROBIDs=[0x00ff0001],  # SubDetector=OTHER=0xFF, ModuleId=0x01
            EventInfoReadKey="",  # Empty for decoding mode
        )
        result.addPublicTool(mcEventInfoTool)
 
        result.merge(SGInputLoaderCfg(flags, [('ByteStreamMetadataContainer', 'InputMetaDataStore+ByteStreamMetadata')]))
 
    eiName = "EventInfo"
    if flags.Common.isOnline and not any(flags.Input.Files) and not (flags.Trigger.doHLT or flags.Trigger.doLVL1):
        bytestream_input = CompFactory.ByteStreamEmonInputSvc("ByteStreamInputSvc")
    else:
        eiName = "{}EventInfo".format(flags.Overlay.BkgPrefix if flags.Common.ProductionStep is ProductionStep.MinbiasPreprocessing else "")
        bytestream_input = CompFactory.ByteStreamEventStorageInputSvc(
            name="ByteStreamInputSvc",
            EventInfoKey=eiName)
    result.addService(bytestream_input)
 
    if flags.Input.SecondaryFiles:
        event_selector = CompFactory.EventSelectorByteStream(
            name="SecondaryEventSelector",
            IsSecondary=True,
            Input=flags.Input.SecondaryFiles,
            SkipEvents=flags.Exec.SkipEvents if flags.Overlay.SkipSecondaryEvents >= 0 else flags.Exec.SkipEvents,
            ByteStreamInputSvc=bytestream_input.name,
        )
        result.addService(event_selector)
    else:
        event_selector = CompFactory.EventSelectorByteStream(
            name="EventSelector",
            Input=flags.Input.Files,
            SkipEvents=flags.Exec.SkipEvents,
            ByteStreamInputSvc=bytestream_input.name,
        )
        result.addService(event_selector)
        result.setAppProperty("EvtSel", event_selector.name)
 
    event_persistency = CompFactory.EvtPersistencySvc(
        name="EventPersistencySvc", CnvServices=[bytestream_conversion.name]
    )
    result.addService(event_persistency)
 
    result.addService(CompFactory.ROBDataProviderSvc())
 
    address_provider = CompFactory.ByteStreamAddressProviderSvc(
        TypeNames=type_names if type_names else list(),
    )
    result.addService(address_provider)
 
    result.merge(
        MetaDataSvcCfg(flags, ["IOVDbMetaDataTool", "ByteStreamMetadataTool"])
    )
 
    proxy = CompFactory.ProxyProviderSvc(ProviderNames = [address_provider.name])
    result.addService(proxy)
 
    result.merge(SGInputLoaderCfg(flags, address_provider.TypeNames,
           ExtraOutputs=[("xAOD::EventInfo",f"StoreGateSvc+{eiName}"),
                      ("xAOD::EventAuxInfo",f"StoreGateSvc+{eiName}Aux.")]))
 
    return result
 
 

◆ ByteStreamWriteCfg()

ByteStreamConfig.ByteStreamWriteCfg	(		flags,
			type_names = None )

Set up output stream in RAW/bytestream format

Configure components responsible for writing bytestream format. Write job
results to bytestream file. ATLAS file naming conventions are enforced as
determined from the given configuration flags.

Args:
    flags:      Job configuration flags
    type_names: (optional) Specify item list for output stream to write

Returns:
    A component accumulator fragment containing the components required to
    write to bytestream. Should be merged into main job configuration.

Definition at line 114 of file Event/ByteStreamCnvSvc/python/ByteStreamConfig.py.

def ByteStreamWriteCfg(flags, type_names=None):
    """Set up output stream in RAW/bytestream format
 
    Configure components responsible for writing bytestream format. Write job
    results to bytestream file. ATLAS file naming conventions are enforced as
    determined from the given configuration flags.
 
    Args:
        flags:      Job configuration flags
        type_names: (optional) Specify item list for output stream to write
 
    Returns:
        A component accumulator fragment containing the components required to
        write to bytestream. Should be merged into main job configuration.
    """
    all_runs = set(flags.Input.RunNumbers)
    assert (
        len(all_runs) == 1
    ), "Input is from multiple runs, do not know which one to use {}".format(
        all_runs
    )
    result = ComponentAccumulator(CompFactory.AthSequencer('AthOutSeq', StopOverride=True))
 
    event_storage_output = CompFactory.ByteStreamEventStorageOutputSvc(
        MaxFileMB=15000,
        MaxFileNE=15000000,  # event (beyond which it creates a new file)
        OutputDirectory="./",
        SimpleFileName=flags.Output.BSFileName,
        AppName="Athena",
        RunNumber=all_runs.pop(),
    )
    result.addService(event_storage_output)
    # release variable depends the way the env is configured
    # FileTag = release
 
    bytestream_conversion = CompFactory.ByteStreamCnvSvc(
        name="ByteStreamCnvSvc",
        ByteStreamOutputSvcList=[event_storage_output.getName()],
        IsSimulation=flags.Input.isMC,
    )
    result.addService(bytestream_conversion)
 
    # ByteStreamCnvSvc::connectOutput() requires xAOD::EventInfo
    event_info_input = ('xAOD::EventInfo','StoreGateSvc+EventInfo')
 
    output_stream = CompFactory.AthenaOutputStream(
        name="BSOutputStreamAlg",
        EvtConversionSvc=bytestream_conversion.name,
        OutputFile="ByteStreamEventStorageOutputSvc",
        ItemList=type_names if type_names else list(),
        ExtraInputs=[event_info_input]
    )
    result.addEventAlgo(output_stream, primary=True)
 
    result.merge(IOVDbSvcCfg(flags))
 
    result.merge(
        MetaDataSvcCfg(flags, ["IOVDbMetaDataTool", "ByteStreamMetadataTool"])
    )
 
    return result
 

◆ MCEventInfoByteStreamToolCfg()

ByteStreamConfig.MCEventInfoByteStreamToolCfg	(	flags,
		name = "MCEventInfoByteStreamTool",
		writeBS = False )

Configure the MCEventInfoByteStreamTool for encoding/decoding MC EventInfo

This tool serializes MC-specific EventInfo fields (mcChannelNumber, mcEventNumber,
mcEventWeights, pileup information, etc.) into a dedicated ROB fragment for MC
ByteStream files (RDO->BS workflow).

Args:
    flags:    Job configuration flags
    name:     Tool name
    writeBS:  If True, configure for encoding, else for decoding

Returns:
    A component accumulator fragment containing the configured tool

Definition at line 176 of file Event/ByteStreamCnvSvc/python/ByteStreamConfig.py.

def MCEventInfoByteStreamToolCfg(flags, name="MCEventInfoByteStreamTool", writeBS=False):
    """Configure the MCEventInfoByteStreamTool for encoding/decoding MC EventInfo
 
    This tool serializes MC-specific EventInfo fields (mcChannelNumber, mcEventNumber,
    mcEventWeights, pileup information, etc.) into a dedicated ROB fragment for MC
    ByteStream files (RDO->BS workflow).
 
    Args:
        flags:    Job configuration flags
        name:     Tool name
        writeBS:  If True, configure for encoding, else for decoding
 
    Returns:
        A component accumulator fragment containing the configured tool
    """
    from AthenaConfiguration.ComponentAccumulator import ComponentAccumulator
    from AthenaConfiguration.ComponentFactory import CompFactory
 
    acc = ComponentAccumulator()
    tool = CompFactory.MCEventInfoByteStreamTool(name)
 
    # ROB ID for MC EventInfo (SubDetector=OTHER=0xFF, ModuleId=0x01)
    mc_eventinfo_robid = 0x00ff0001
    tool.ROBIDs = [mc_eventinfo_robid]
 
    if writeBS:
        # write BS == read xAOD (encoding mode)
        tool.EventInfoReadKey = "EventInfo"
    else:
        # read BS == write xAOD (decoding mode)
        tool.EventInfoReadKey = ""
 
    acc.setPrivateTools(tool)
    return acc
 
 

◆ TransientByteStreamCfg()

ByteStreamConfig.TransientByteStreamCfg	(	flags,
		item_list = None,
		type_names = None,
		extra_inputs = None )

Set up transient ByteStream output stream

Configure components responsible for writing bytestream format. Write the
specified objects to ByteStream into the cache of the ROBDataProviderSvc.
The data can then be read downstream as if they were coming from a BS file.

Args:
    flags:        Job configuration flags
    item_list:    (optional) List of objects to be written to transient ByteStream
    type_names:   (optional) List of types/names to register in BS conversion service
                  as available to be read from (transient) ByteStream
    extra_inputs: (optional) List of objects which need to be produced before transient
                  ByteStream streaming is scheduled - ensures correct scheduling

Returns:
    A component accumulator fragment containing the components required to
    write transient bytestream. Should be merged into main job configuration.

Definition at line 212 of file Event/ByteStreamCnvSvc/python/ByteStreamConfig.py.

def TransientByteStreamCfg(flags, item_list=None, type_names=None, extra_inputs=None):
    """Set up transient ByteStream output stream
 
    Configure components responsible for writing bytestream format. Write the
    specified objects to ByteStream into the cache of the ROBDataProviderSvc.
    The data can then be read downstream as if they were coming from a BS file.
 
    Args:
        flags:        Job configuration flags
        item_list:    (optional) List of objects to be written to transient ByteStream
        type_names:   (optional) List of types/names to register in BS conversion service
                      as available to be read from (transient) ByteStream
        extra_inputs: (optional) List of objects which need to be produced before transient
                      ByteStream streaming is scheduled - ensures correct scheduling
 
    Returns:
        A component accumulator fragment containing the components required to
        write transient bytestream. Should be merged into main job configuration.
    """
 
    result = ComponentAccumulator()
 
    result.addService(CompFactory.ROBDataProviderSvc())
 
    rdp_output = CompFactory.ByteStreamRDP_OutputSvc()
    result.addService(rdp_output)
 
    bytestream_conversion = CompFactory.ByteStreamCnvSvc(
        name="ByteStreamCnvSvc",
        FillTriggerBits=False,  # ATR-25971, transient BS is produced before trigger bits in RDOtoRDOTrigger
        ByteStreamOutputSvcList=[rdp_output.getName()],
        IsSimulation=flags.Input.isMC,
    )
    result.addService(bytestream_conversion)
 
    # Special fictitious extra output which can be used to ensure correct
    # scheduling of transient ByteStream clients
    extra_outputs = [("TransientBSOutType","StoreGateSvc+TransientBSOutKey")]
 
    # ByteStreamCnvSvc::connectOutput() requires xAOD::EventInfo
    event_info_input = ('xAOD::EventInfo','StoreGateSvc+EventInfo')
    if not extra_inputs:
        extra_inputs = [event_info_input]
    elif event_info_input not in extra_inputs:
        extra_inputs.append(event_info_input)
 
    output_stream = CompFactory.AthenaOutputStream(
        name="TransBSStreamAlg",
        EvtConversionSvc=bytestream_conversion.name,
        OutputFile="ByteStreamRDP_OutputSvc",
        ItemList=item_list if item_list else list(),
        ExtraInputs=extra_inputs,
        ExtraOutputs=extra_outputs
    )
    result.addEventAlgo(output_stream,
                        primary=True)
 
    address_provider = CompFactory.ByteStreamAddressProviderSvc(
        TypeNames=type_names if type_names else list(),
    )
    result.addService(address_provider)
 
    result.addService(CompFactory.ProxyProviderSvc(
        ProviderNames = [address_provider.name]))
 
    result.merge(SGInputLoaderCfg(flags, Load=address_provider.TypeNames))
 
    return result
 
 