ATLAS Offline Software
Functions
python.OverlayTransformHelpers Namespace Reference

Functions

def addOverlayTrfArgs (parser)
 
def addDataOverlayTrfArgs (parser)
 
def addMCOverlayTrfArgs (parser)
 
def addOverlayArguments (parser, in_reco_chain=False)
 
def addOverlaySubstep (executor_set, in_reco_chain=False)
 
def appendOverlaySubstep (trf, in_reco_chain=False)
 

Detailed Description

Main overlay transform configuration helpers

Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration

Function Documentation

◆ addDataOverlayTrfArgs()

def python.OverlayTransformHelpers.addDataOverlayTrfArgs (   parser)
Add data overlay command-line parser arguments.

Definition at line 27 of file OverlayTransformHelpers.py.

27 def addDataOverlayTrfArgs(parser):
28  """Add data overlay command-line parser arguments."""
29  parser.defineArgGroup('DataOverlay', 'Data Overlay Options')
30  parser.add_argument('--inputBS_SKIMFile', nargs='+',
31  type=argFactory(argBSFile, io='input'),
32  help='Input skimmed RAW BS for pileup overlay',
33  group='DataOverlay')
34  parser.add_argument('--fSampltag',
35  type=argFactory(argSubstep, defaultSubstep='overlay'),
36  help='The cool tag for /LAR/ElecCalib/fSampl/Symmetry, see https://twiki.cern.ch/twiki/bin/viewauth/Atlas/LArCalibMCPoolCool',
37  group='DataOverlay')
38 
39 

◆ addMCOverlayTrfArgs()

def python.OverlayTransformHelpers.addMCOverlayTrfArgs (   parser)
Add MC overlay command-line parser arguments.

Definition at line 40 of file OverlayTransformHelpers.py.

40 def addMCOverlayTrfArgs(parser):
41  """Add MC overlay command-line parser arguments."""
42  parser.defineArgGroup('MCOverlay', 'MC Overlay Options')
43  parser.add_argument('--inputRDO_BKGFile', nargs='+',
44  type=argFactory(argRDOFile, io='input'),
45  help='Input background RDO for MC+MC overlay',
46  group='MCOverlay')
47 
48 

◆ addOverlayArguments()

def python.OverlayTransformHelpers.addOverlayArguments (   parser,
  in_reco_chain = False 
)
Add all overlay command-line parser arguments.

Definition at line 49 of file OverlayTransformHelpers.py.

49 def addOverlayArguments(parser, in_reco_chain=False):
50  """Add all overlay command-line parser arguments."""
51  # TODO: are forward detectors really needed?
52  from SimuJobTransforms.simTrfArgs import addBasicDigiArgs # , addForwardDetTrfArgs
53  addBasicDigiArgs(parser)
54  # addForwardDetTrfArgs(parser)
55  addOverlayTrfArgs(parser)
56  addMCOverlayTrfArgs(parser)
57  if not in_reco_chain:
58  addDataOverlayTrfArgs(parser)
59 
60 

◆ addOverlaySubstep()

def python.OverlayTransformHelpers.addOverlaySubstep (   executor_set,
  in_reco_chain = False 
)

Definition at line 61 of file OverlayTransformHelpers.py.

61 def addOverlaySubstep(executor_set, in_reco_chain=False):
62  executor = athenaExecutor(name='Overlay',
63  skeletonCA='OverlayConfiguration.OverlaySkeleton',
64  substep='overlay',
65  tryDropAndReload=False,
66  perfMonFile='ntuple.pmon.gz',
67  inData=['RDO_BKG', 'BS_SKIM', 'HITS'],
68  outData=['RDO', 'RDO_SGNL'])
69 
70  if in_reco_chain:
71  executor.inData = []
72  executor.outData = []
73 
74  executor_set.add(executor)
75 
76 

◆ addOverlayTrfArgs()

def python.OverlayTransformHelpers.addOverlayTrfArgs (   parser)
Add common overlay command-line parser arguments.

Definition at line 10 of file OverlayTransformHelpers.py.

10 def addOverlayTrfArgs(parser):
11  """Add common overlay command-line parser arguments."""
12  parser.defineArgGroup('Overlay', 'Common Overlay Options')
13  parser.add_argument('--detectors', nargs='+',
14  type=argFactory(argList),
15  help='Detectors autoconfiguration string',
16  group='Overlay')
17  parser.add_argument('--skipSecondaryEvents', nargs='+',
18  type=argFactory(argSubstepInt, defaultSubstep='first'),
19  help='Number of secondary input events to skip over in the first processing step (skipping substep can be overridden)',
20  group='Overlay')
21  parser.add_argument('--outputRDO_SGNLFile', nargs='+',
22  type=argFactory(argRDOFile, io='output'),
23  help='The output RDO file of the MC signal alone',
24  group='Overlay')
25 
26 

◆ appendOverlaySubstep()

def python.OverlayTransformHelpers.appendOverlaySubstep (   trf,
  in_reco_chain = False 
)
Add overlay transform substep.

Definition at line 77 of file OverlayTransformHelpers.py.

77 def appendOverlaySubstep(trf, in_reco_chain=False):
78  """Add overlay transform substep."""
79  executor = set()
80  addOverlaySubstep(executor, in_reco_chain)
81  trf.appendToExecutorSet(executor)
python.OverlayTransformHelpers.appendOverlaySubstep
def appendOverlaySubstep(trf, in_reco_chain=False)
Definition: OverlayTransformHelpers.py:77
python.OverlayTransformHelpers.addOverlayTrfArgs
def addOverlayTrfArgs(parser)
Definition: OverlayTransformHelpers.py:10
python.OverlayTransformHelpers.addOverlayArguments
def addOverlayArguments(parser, in_reco_chain=False)
Definition: OverlayTransformHelpers.py:49
python.OverlayTransformHelpers.addOverlaySubstep
def addOverlaySubstep(executor_set, in_reco_chain=False)
Definition: OverlayTransformHelpers.py:61
python.OverlayTransformHelpers.addMCOverlayTrfArgs
def addMCOverlayTrfArgs(parser)
Definition: OverlayTransformHelpers.py:40
python.simTrfArgs.addBasicDigiArgs
def addBasicDigiArgs(parser)
Add Basic digitization arguments to an argparse ArgumentParser.
Definition: simTrfArgs.py:35
CxxUtils::set
constexpr std::enable_if_t< is_bitmask_v< E >, E & > set(E &lhs, E rhs)
Convenience function to set bits in a class enum bitmask.
Definition: bitmask.h:232
python.OverlayTransformHelpers.addDataOverlayTrfArgs
def addDataOverlayTrfArgs(parser)
Definition: OverlayTransformHelpers.py:27