BeamEffectsAlgConfig Namespace Reference

Functions
	ValidityCheckerCfg (flags, name="GenEventValidityChecker", **kwargs)
	GenEventRotatorCfg (flags, name="GenEventRotator", **kwargs)
	GenEventBeamEffectBoosterCfg (flags, name="GenEventBeamEffectBooster", **kwargs)
	GenEventVertexPositionerCfg (flags, name="GenEventVertexPositioner", **kwargs)
	VertexBeamCondPositionerCfg (flags, name="VertexBeamCondPositioner", **kwargs)
	LRAVertexPositionerCfg (flags, name="LRAVertexPositionerCfg", **kwargs)
	MatchingBkgVertexPositionerCfg (flags, name="MatchingBkgVertexPositioner", **kwargs)
	CrabKissingVertexPositionerCfg (flags, name="CrabKissingVertexPositioner", **kwargs)
	LongBeamspotVertexPositionerCfg (flags, name="LongBeamspotVertexPositioner", **kwargs)
	BeamEffectsAlgCfg (flags, name="BeamEffectsAlg", **kwargs)
	BeamEffectsAlgOutputCfg (flags, **kwargs)
	BeamSpotFixerAlgCfg (flags, name="BeamSpotFixerAlg", **kwargs)
	ZeroLifetimePositionerCfg (flags, name="ZeroLifetimePositioner", **kwargs)
	BeamSpotReweightingAlgCfg (flags, name="BeamSpotReweightingAlg", **kwargs)

Variables
	flags = initConfigFlags()
	inputDir
	Files
	HITSFileName
	VertexSource
	isMC
	AtlasVersion
	GlobalTag
	RunNumbers
	cfg = MainServicesCfg(flags)
	Dump
	withDetails
	maxEvents

Detailed Description

Define methods to configure beam effects with the ComponentAccumulator

Function Documentation

BeamEffectsAlgCfg()

BeamEffectsAlgCfg	(		flags,
			name = "BeamEffectsAlg",
		**	kwargs )

Return an accumulator and algorithm for beam effects, wihout output

Definition at line 123 of file BeamEffectsAlgConfig.py.

def BeamEffectsAlgCfg(flags, name="BeamEffectsAlg", **kwargs):
    """Return an accumulator and algorithm for beam effects, wihout output"""
    acc = ComponentAccumulator()
 
    from SimulationConfig.SimEnums import LArParameterization
    if flags.Sim.LArParameterization is LArParameterization.FastCaloSim:
        kwargs.setdefault("ISFRun", True)
    else:
        kwargs.setdefault("ISFRun", flags.Sim.ISFRun)
 
    # Set default properties
    if flags.Sim.DoFullChain and flags.Digitization.PileUp:
        kwargs.setdefault("InputMcEventCollection", "OriginalEvent_SG+GEN_EVENT")
    else:
        kwargs.setdefault("InputMcEventCollection", "GEN_EVENT")
 
    if flags.Sim.DoFullChain and flags.Common.isOverlay and not flags.Overlay.DataOverlay:
        kwargs.setdefault('OutputMcEventCollection', f"{flags.Overlay.SigPrefix}TruthEvent")
    else:
        kwargs.setdefault('OutputMcEventCollection', 'BeamTruthEvent')
 
    # Set (todo) the appropriate manipulator tools
    manipulators = []
    manipulators.append(acc.popToolsAndMerge(ValidityCheckerCfg(flags)))
    from SimulationConfig.SimEnums import VertexSource
    if not flags.Sim.VertexSource == VertexSource.AsGenerated:
        # Vertex manipulation required
        from SimulationConfig.SimEnums import CavernBackground
        if flags.Beam.Type not in [BeamType.Cosmics, BeamType.TestBeam] and flags.Sim.CavernBackground is not CavernBackground.Read:
            manipulators.append(acc.popToolsAndMerge(GenEventVertexPositionerCfg(flags)))
        # manipulators.append(acc.popToolsAndMerge(GenEventBeamEffectBoosterCfg(flags))) # todo segmentation violation
        # manipulators.append(acc.popToolsAndMerge(CrabKissingVertexPositionerCfg(flags))) # todo Callback registration failed
    kwargs.setdefault("GenEventManipulators", manipulators)
 
    acc.addEventAlgo(CompFactory.Simulation.BeamEffectsAlg(name, **kwargs), primary=True)
    return acc
 
 

BeamEffectsAlgOutputCfg()

BeamEffectsAlgOutputCfg	(		flags,
		**	kwargs )

Return an accumulator and algorithm for beam effects, with output

Definition at line 161 of file BeamEffectsAlgConfig.py.

def BeamEffectsAlgOutputCfg(flags, **kwargs):
    """Return an accumulator and algorithm for beam effects, with output"""
    acc = BeamEffectsAlgCfg(flags, **kwargs)
    # Set to write HITS pool file
    alg = acc.getPrimary()
    ItemList = ["McEventCollection#" + alg.OutputMcEventCollection]
    from OutputStreamAthenaPool.OutputStreamConfig import OutputStreamCfg
    acc.merge(OutputStreamCfg(flags, "HITS", ItemList=ItemList, disableEventTag=True))
    return acc
 
 

BeamSpotFixerAlgCfg()

BeamSpotFixerAlgCfg	(		flags,
			name = "BeamSpotFixerAlg",
		**	kwargs )

Definition at line 172 of file BeamEffectsAlgConfig.py.

def BeamSpotFixerAlgCfg(flags, name="BeamSpotFixerAlg", **kwargs):
    from BeamSpotConditions.BeamSpotConditionsConfig import BeamSpotCondAlgCfg
    acc = BeamSpotCondAlgCfg(flags)
 
    kwargs.setdefault("InputKey", "Input_EventInfo")
    if flags.Common.ProductionStep == ProductionStep.PileUpPresampling:
        kwargs.setdefault("OutputKey", flags.Overlay.BkgPrefix + "EventInfo")
    else:
        kwargs.setdefault("OutputKey", "EventInfo")
 
    acc.addEventAlgo(CompFactory.Simulation.BeamSpotFixerAlg(name, **kwargs))
    return acc
 
 

BeamSpotReweightingAlgCfg()

BeamSpotReweightingAlgCfg	(		flags,
			name = "BeamSpotReweightingAlg",
		**	kwargs )

Definition at line 194 of file BeamEffectsAlgConfig.py.

def BeamSpotReweightingAlgCfg(flags, name="BeamSpotReweightingAlg", **kwargs):
    from BeamSpotConditions.BeamSpotConditionsConfig import BeamSpotCondAlgCfg
    acc = BeamSpotCondAlgCfg(flags)
 
    kwargs.setdefault("Input_beam_sigma_z", flags.Digitization.InputBeamSigmaZ)
 
    acc.addEventAlgo(CompFactory.Simulation.BeamSpotReweightingAlg(name, **kwargs))
 
    # Ignore dependencies
    from AthenaConfiguration.MainServicesConfig import OutputUsageIgnoreCfg
    acc.merge(OutputUsageIgnoreCfg(flags, name))
 
    return acc
 
 

CrabKissingVertexPositionerCfg()

CrabKissingVertexPositionerCfg	(		flags,
			name = "CrabKissingVertexPositioner",
		**	kwargs )

Return a Crab-Kissing vertex positioner tool

Definition at line 106 of file BeamEffectsAlgConfig.py.

def CrabKissingVertexPositionerCfg(flags, name="CrabKissingVertexPositioner", **kwargs):
    """Return a Crab-Kissing vertex positioner tool"""
    # todo needs BunchLength, RandomSvc, BunchShape
    acc = ComponentAccumulator()
    acc.setPrivateTools(CompFactory.Simulation.CrabKissingVertexPositioner(name, **kwargs))
    return acc
 
 

GenEventBeamEffectBoosterCfg()

GenEventBeamEffectBoosterCfg	(		flags,
			name = "GenEventBeamEffectBooster",
		**	kwargs )

Return a lorentz booster tool

Definition at line 31 of file BeamEffectsAlgConfig.py.

def GenEventBeamEffectBoosterCfg(flags, name="GenEventBeamEffectBooster", **kwargs):
    """Return a lorentz booster tool"""
    # todo needs random seed, more?
    acc = ComponentAccumulator()
    acc.setPrivateTools(CompFactory.Simulation.GenEventBeamEffectBooster(name, **kwargs))
    return acc
 
 

GenEventRotatorCfg()

GenEventRotatorCfg	(		flags,
			name = "GenEventRotator",
		**	kwargs )

Return a event rotator tool

Definition at line 24 of file BeamEffectsAlgConfig.py.

def GenEventRotatorCfg(flags, name="GenEventRotator", **kwargs):
    """Return a event rotator tool"""
    acc = ComponentAccumulator()
    acc.setPrivateTools(CompFactory.Simulation.GenEventRotator(name, **kwargs))
    return acc
 
 

GenEventVertexPositionerCfg()

GenEventVertexPositionerCfg	(		flags,
			name = "GenEventVertexPositioner",
		**	kwargs )

Return a vertex positioner tool

Definition at line 39 of file BeamEffectsAlgConfig.py.

def GenEventVertexPositionerCfg(flags, name="GenEventVertexPositioner", **kwargs):
    """Return a vertex positioner tool"""
    # todo needs input file(s?)
 
    acc = ComponentAccumulator()
 
    from SimulationConfig.SimEnums import VertexSource
    if flags.Sim.VertexSource is VertexSource.MatchingBkg:
        kwargs.setdefault("VertexShifters", [acc.popToolsAndMerge(MatchingBkgVertexPositionerCfg(flags))])
    elif flags.Sim.VertexSource is VertexSource.CondDB:
        kwargs.setdefault("VertexShifters", [acc.popToolsAndMerge(VertexBeamCondPositionerCfg(flags))])
    elif flags.Sim.VertexSource is VertexSource.LongBeamspotVertexPositioner:
        kwargs.setdefault("VertexShifters", [acc.popToolsAndMerge(LongBeamspotVertexPositionerCfg(flags))])
    elif flags.Sim.VertexSource is VertexSource.LRAPositioner:
        kwargs.setdefault("VertexShifters", [acc.popToolsAndMerge(LRAVertexPositionerCfg(flags))])
 
    acc.setPrivateTools(CompFactory.Simulation.GenEventVertexPositioner(name, **kwargs))
    return acc
 
 
# LorentzVectorGenerators

LongBeamspotVertexPositionerCfg()

LongBeamspotVertexPositionerCfg	(		flags,
			name = "LongBeamspotVertexPositioner",
		**	kwargs )

Return a long beamspot vertex positioner tool

Definition at line 114 of file BeamEffectsAlgConfig.py.

def LongBeamspotVertexPositionerCfg(flags, name="LongBeamspotVertexPositioner", **kwargs):
    """Return a long beamspot vertex positioner tool"""
    # todo needs LParameter and RandomSvc
    acc = ComponentAccumulator()
    kwargs.setdefault("SimpleTimeSmearing", flags.Sim.VertexTimeSmearing)
    acc.setPrivateTools(CompFactory.Simulation.LongBeamspotVertexPositioner(name, **kwargs))
    return acc
 
 

LRAVertexPositionerCfg()

LRAVertexPositionerCfg	(		flags,
			name = "LRAVertexPositionerCfg",
		**	kwargs )

Definition at line 77 of file BeamEffectsAlgConfig.py.

def LRAVertexPositionerCfg(flags, name="LRAVertexPositionerCfg", **kwargs):
    from RngComps.RngCompsConfig import AthRNGSvcCfg
 
    acc = ComponentAccumulator()
 
    kwargs.setdefault("FileName", flags.Beam.vdMScan.ConfigFile)
    kwargs.setdefault("HistName", flags.Beam.vdMScan.PV.PDF)
 
    kwargs.setdefault("RNGService", acc.getPrimaryAndMerge(AthRNGSvcCfg(flags)).name)
 
    acc.setPrivateTools(CompFactory.Simulation.LRAVertexPositioner(name, **kwargs))
    return acc
 

MatchingBkgVertexPositionerCfg()

MatchingBkgVertexPositionerCfg	(		flags,
			name = "MatchingBkgVertexPositioner",
		**	kwargs )

Return a vertex positioner tool that reads a matching vertex from the background input file.

Definition at line 90 of file BeamEffectsAlgConfig.py.

def MatchingBkgVertexPositionerCfg(flags, name="MatchingBkgVertexPositioner", **kwargs):
    """Return a vertex positioner tool that reads a matching vertex from the background input file."""
    acc = ComponentAccumulator()
 
    if flags.Overlay.DataOverlay:
        kwargs.setdefault("PrimaryVertexContainerName", f"{flags.Overlay.BkgPrefix}PrimaryVertices")
 
        from SGComps.SGInputLoaderConfig import SGInputLoaderCfg
        acc.merge(SGInputLoaderCfg(flags, [f'xAOD::VertexContainer#{kwargs["PrimaryVertexContainerName"]}']))
    else:
        kwargs.setdefault("McEventCollectionName", f"{flags.Overlay.BkgPrefix}TruthEvent")
 
    acc.setPrivateTools(CompFactory.Simulation.MatchingBkgVertexPositioner(name, **kwargs))
    return acc
 
 

ValidityCheckerCfg()

ValidityCheckerCfg	(		flags,
			name = "GenEventValidityChecker",
		**	kwargs )

Return a validity checker tool

Definition at line 17 of file BeamEffectsAlgConfig.py.

def ValidityCheckerCfg(flags, name="GenEventValidityChecker", **kwargs):
    """Return a validity checker tool"""
    acc = ComponentAccumulator()
    acc.setPrivateTools(CompFactory.Simulation.GenEventValidityChecker(name, **kwargs))
    return acc
 
 

VertexBeamCondPositionerCfg()

VertexBeamCondPositionerCfg	(		flags,
			name = "VertexBeamCondPositioner",
		**	kwargs )

Return a conditional (? todo) vertex positioner tool

Definition at line 60 of file BeamEffectsAlgConfig.py.

def VertexBeamCondPositionerCfg(flags, name="VertexBeamCondPositioner", **kwargs):
    """Return a conditional (? todo) vertex positioner tool"""
    from RngComps.RngCompsConfig import AthRNGSvcCfg
 
    acc = ComponentAccumulator()
 
    kwargs.setdefault("RandomSvc", acc.getPrimaryAndMerge(AthRNGSvcCfg(flags)))
    kwargs.setdefault("SimpleTimeSmearing", flags.Sim.VertexTimeSmearing)
    kwargs.setdefault("TimeWidth", flags.Sim.VertexTimeWidth)
 
    from BeamSpotConditions.BeamSpotConditionsConfig import BeamSpotCondAlgCfg
    acc.merge(BeamSpotCondAlgCfg(flags))
 
    acc.setPrivateTools(CompFactory.Simulation.VertexBeamCondPositioner(name, **kwargs))
    return acc
 
 

ZeroLifetimePositionerCfg()

ZeroLifetimePositionerCfg	(		flags,
			name = "ZeroLifetimePositioner",
		**	kwargs )

Definition at line 186 of file BeamEffectsAlgConfig.py.

def ZeroLifetimePositionerCfg(flags, name="ZeroLifetimePositioner", **kwargs):
    result = ComponentAccumulator()
    kwargs.setdefault('ApplyPatch', True)
    kwargs.setdefault('RemovePatch', True)
    result.addService(CompFactory.Simulation.ZeroLifetimePositioner(name, **kwargs), primary = True)
    return result
 
 

Variable Documentation

AtlasVersion

BeamEffectsAlgConfig.AtlasVersion

Definition at line 242 of file BeamEffectsAlgConfig.py.

cfg

BeamEffectsAlgConfig.cfg = MainServicesCfg(flags)

Definition at line 250 of file BeamEffectsAlgConfig.py.

Dump

BeamEffectsAlgConfig.Dump

Definition at line 257 of file BeamEffectsAlgConfig.py.

Files

BeamEffectsAlgConfig.Files

Definition at line 226 of file BeamEffectsAlgConfig.py.

flags

BeamEffectsAlgConfig.flags = initConfigFlags()

Definition at line 217 of file BeamEffectsAlgConfig.py.

GlobalTag

BeamEffectsAlgConfig.GlobalTag

Definition at line 243 of file BeamEffectsAlgConfig.py.

HITSFileName

BeamEffectsAlgConfig.HITSFileName

Definition at line 232 of file BeamEffectsAlgConfig.py.

inputDir

BeamEffectsAlgConfig.inputDir

Initial value:

=  os.environ.get("ATLAS_REFERENCE_DATA",
                              "/cvmfs/atlas-nightlies.cern.ch/repo/data/data-art")

Definition at line 223 of file BeamEffectsAlgConfig.py.

isMC

BeamEffectsAlgConfig.isMC

Definition at line 241 of file BeamEffectsAlgConfig.py.

maxEvents

BeamEffectsAlgConfig.maxEvents

Definition at line 266 of file BeamEffectsAlgConfig.py.

RunNumbers

BeamEffectsAlgConfig.RunNumbers

Definition at line 244 of file BeamEffectsAlgConfig.py.

VertexSource

BeamEffectsAlgConfig.VertexSource

Definition at line 237 of file BeamEffectsAlgConfig.py.

withDetails

BeamEffectsAlgConfig.withDetails

Definition at line 258 of file BeamEffectsAlgConfig.py.