Collaboration diagram for python.ConfigAccumulator.ConfigAccumulator:

Public Member Functions
def	__init__ (self, algSeq, dataType=None, isPhyslite=False, geometry=None, dsid=0, campaign=None, runNumber=None, autoconfigFromFlags=None, noSysSuffix=False, noSystematics=None, dataYear=0)

def	noSystematics (self)

def	autoconfigFlags (self)

def	dataType (self)

def	isPhyslite (self)

def	geometry (self)

def	dsid (self)

def	campaign (self)

def	runNumber (self)

def	dataYear (self)

def	generatorInfo (self)

def	hltSummary (self)

def	createAlgorithm (self, type, name, reentrant=False)

def	createService (self, type, name)

def	createPublicTool (self, type, name)

def	addPrivateTool (self, propertyName, toolType)

def	setSourceName (self, containerName, sourceName, *originalName=None, calibMode=None, isMet=False)

def	writeName (self, containerName, *isMet=None)

def	readName (self, containerName)

def	copyName (self, containerName)

def	wantCopy (self, containerName)

def	originalName (self, containerName)

def	calibMode (self, containerName)

def	isMetContainer (self, containerName)

def	readNameAndSelection (self, containerName, *excludeFrom=None)

def	nextPass (self)

def	getPreselection (self, containerName, selectionName, *asList=False)

def	getFullSelection (self, containerName, selectionName, *skipBase=False, excludeFrom=None)

def	getSelectionCutFlow (self, containerName, selectionName)

def	addEventCutFlow (self, selection, decorations)

def	getEventCutFlow (self, selection)

def	addSelection (self, containerName, selectionName, decoration, **kwargs)

def	addOutputContainer (self, containerName, outputContainerName)

def	getOutputContainerOrigin (self, outputContainerName)

def	addOutputVar (self, containerName, variableName, outputName, *noSys=False, enabled=True)

def	getOutputVars (self, containerName)

def	getSelectionNames (self, containerName, excludeFrom=None)

Public Attributes
	CA

Private Attributes
	_autoconfigFlags

	_dataType

	_isPhyslite

	_geometry

	_dsid

	_campaign

	_runNumber

	_dataYear

	_generatorInfo

	_algSeq

	_noSystematics

	_noSysSuffix

	_containerConfig

	_outputContainers

	_pass

	_algorithms

	_currentAlg

	_selectionNameExpr

	_eventcutflow

	_hltSummary

Detailed Description

a class that accumulates a configuration from blocks into an
algorithm sequence

This is used as argument to the ConfigurationBlock methods, which
need to be called in the correct order.  This class will track all
meta-information that needs to be communicated between blocks
during configuration, and also add the created algorithms to the
sequence.

Use/access of containers in the event store is handled via
references that this class hands out.  This happens in a separate
step before the algorithms are created, as the naming of
containers will depend on where in the chain the container is
used.

Definition at line 94 of file ConfigAccumulator.py.

Constructor & Destructor Documentation

◆ init()

def python.ConfigAccumulator.ConfigAccumulator.__init__	(	self,
		algSeq,
		dataType = `None`,
		isPhyslite = `False`,
		geometry = `None`,
		dsid = `0`,
		campaign = `None`,
		runNumber = `None`,
		autoconfigFromFlags = `None`,
		noSysSuffix = `False`,
		noSystematics = `None`,
		dataYear = `0`
	)

Definition at line 111 of file ConfigAccumulator.py.

     def __init__ (self, algSeq, dataType=None, isPhyslite=False, geometry=None, dsid=0,
             campaign=None, runNumber=None, autoconfigFromFlags=None, noSysSuffix=False,
             noSystematics=None, dataYear=0):
         self._autoconfigFlags = autoconfigFromFlags
         if autoconfigFromFlags is not None:
             if autoconfigFromFlags.Input.isMC:
                 if autoconfigFromFlags.Sim.ISF.Simulator.usesFastCaloSim():
                     dataType = DataType.FastSim
                 else:
                     dataType = DataType.FullSim
             else:
                 dataType = DataType.Data
             isPhyslite = 'StreamDAOD_PHYSLITE' in autoconfigFromFlags.Input.ProcessingTags
             if geometry is None:
                 geometry = autoconfigFromFlags.GeoModel.Run
             if dsid == 0 and dataType is not DataType.Data:
                 dsid = autoconfigFromFlags.Input.MCChannelNumber
             if campaign is None:
                 campaign = autoconfigFromFlags.Input.MCCampaign
             if runNumber is None:
                 runNumber = int(autoconfigFromFlags.Input.RunNumbers[0])
             if dataYear == 0:
                 dataYear = autoconfigFromFlags.Input.DataYear
             generatorInfo = autoconfigFromFlags.Input.GeneratorsInfo
             from TrigDecisionTool.TrigDecisionToolHelpers import (
                 getRun3NavigationContainerFromInput_forAnalysisBase)
             hltSummary = getRun3NavigationContainerFromInput_forAnalysisBase(autoconfigFromFlags)
         else:
             # legacy mappings of string arguments
             if isinstance(dataType, str):
                 if dataType == 'mc':
                     dataType = DataType.FullSim
                 elif dataType == 'afii':
                     dataType = DataType.FastSim
                 else:
                     dataType = DataType(dataType)
             generatorInfo = None
             hltSummary = 'HLTNav_Summary_DAODSlimmed'
             if runNumber is None:
                 runNumber = 284500
         # allow possible string argument for `geometry` and convert it to enum
         geometry = LHCPeriod(geometry)
         if geometry is LHCPeriod.Run1:
             raise ValueError ("invalid Run geometry: %s" % geometry.value)
         # store also the data year for data
         self._dataType = dataType
         self._isPhyslite = isPhyslite
         self._geometry = geometry
         self._dsid = dsid
         self._campaign = campaign
         self._runNumber = runNumber
         self._dataYear = dataYear
         self._generatorInfo = generatorInfo
         self._algSeq = algSeq
         self._noSystematics = noSystematics
         self._noSysSuffix = noSysSuffix
         self._containerConfig = {}
         self._outputContainers = {}
         self._pass = 0
         self._algorithms = {}
         self._currentAlg = None
         self._selectionNameExpr = re.compile ('[A-Za-z_][A-Za-z_0-9]+')
         self.setSourceName ('EventInfo', 'EventInfo')
         self._eventcutflow = {}
         self._hltSummary = hltSummary
  
         # If we are in an Athena environment with ComponentAccumulator configuration
         # then the AlgSequence, which is Gaudi.AthSequencer, does not support '+=',
         # and we in any case want to produce an output ComponentAccumulator
         self.CA = None
         if DualUseConfig.useComponentAccumulator:
             from AthenaConfiguration.ComponentAccumulator import ComponentAccumulator
             self.CA = ComponentAccumulator()
             # if we have a component accumulator the user is not required to pass
             # in a sequence, but if they do let's add it
             if algSeq :
                 self.CA.addSequence(algSeq)
  
  

Member Function Documentation

◆ addEventCutFlow()

def python.ConfigAccumulator.ConfigAccumulator.addEventCutFlow	(	self,
		selection,
		decorations
	)

register a new event cutflow, adding it to the dictionary with key 'selection'
and value 'decorations', a list of decorated selections

Definition at line 572 of file ConfigAccumulator.py.

     def addEventCutFlow (self, selection, decorations) :
  
         """register a new event cutflow, adding it to the dictionary with key 'selection'
         and value 'decorations', a list of decorated selections
         """
         if self._pass == 0:
             if selection in self._eventcutflow.keys():
                 raise ValueError ('the event cutflow dictionary already contains an entry ' + selection)
             else:
                 self._eventcutflow[selection] = decorations
  
  

◆ addOutputContainer()

def python.ConfigAccumulator.ConfigAccumulator.addOutputContainer	(	self,
		containerName,
		outputContainerName
	)

register a copy of a container used in outputs

Definition at line 605 of file ConfigAccumulator.py.

     def addOutputContainer (self, containerName, outputContainerName) :
         """register a copy of a container used in outputs"""
         if containerName not in self._containerConfig :
             raise KeyError ("container unknown: " + containerName)
         if outputContainerName in self._outputContainers :
             raise KeyError ("duplicate output container name: " + outputContainerName)
         self._outputContainers[outputContainerName] = containerName
  
  

◆ addOutputVar()

def python.ConfigAccumulator.ConfigAccumulator.addOutputVar	(		self,
			containerName,
			variableName,
			outputName,
		*	noSys = `False`,
			enabled = `True`
	)

add an output variable for the given container to the output

Definition at line 625 of file ConfigAccumulator.py.

     def addOutputVar (self, containerName, variableName, outputName,
                       *, noSys=False, enabled=True) :
         """add an output variable for the given container to the output
         """
  
         if containerName not in self._containerConfig :
             raise KeyError ("container unknown: " + containerName)
         baseConfig = self._containerConfig[containerName].outputs
         if outputName in baseConfig :
             raise KeyError ("duplicate output variable name: " + outputName)
         config = OutputConfig (containerName, variableName, noSys=noSys, enabled=enabled)
         baseConfig[outputName] = config
  
  

◆ addPrivateTool()

def python.ConfigAccumulator.ConfigAccumulator.addPrivateTool	(	self,
		propertyName,
		toolType
	)

add a private tool to the current algorithm

Definition at line 311 of file ConfigAccumulator.py.

     def addPrivateTool (self, propertyName, toolType) :
         """add a private tool to the current algorithm"""
         if self._pass == 0 :
             DualUseConfig.addPrivateTool (self._currentAlg, propertyName, toolType)
  
  

◆ addSelection()

def python.ConfigAccumulator.ConfigAccumulator.addSelection	(		self,
			containerName,
			selectionName,
			decoration,
		**	kwargs
	)

add another selection decoration to the selection of the given
name for the given container

Definition at line 592 of file ConfigAccumulator.py.

     def addSelection (self, containerName, selectionName, decoration,
                       **kwargs) :
         """add another selection decoration to the selection of the given
         name for the given container"""
         if selectionName != '' and not self._selectionNameExpr.fullmatch (selectionName) :
             raise ValueError ('invalid selection name: ' + selectionName)
         if containerName not in self._containerConfig :
             self._containerConfig[containerName] = ContainerConfig (containerName, containerName, noSysSuffix=self._noSysSuffix)
         config = self._containerConfig[containerName]
         selection = SelectionConfig (selectionName, decoration, **kwargs)
         config.selections.append (selection)
  
  

◆ autoconfigFlags()

def python.ConfigAccumulator.ConfigAccumulator.autoconfigFlags ( self )

auto configuration flags

Definition at line 194 of file ConfigAccumulator.py.

     def autoconfigFlags (self) :
         """auto configuration flags"""
         return self._autoconfigFlags
  

◆ calibMode()

def python.ConfigAccumulator.ConfigAccumulator.calibMode	(	self,
		containerName
	)

get the calibration mode of the given container

Definition at line 400 of file ConfigAccumulator.py.

     def calibMode (self, containerName) :
         """get the calibration mode of the given container
         """
         if containerName not in self._containerConfig :
             raise Exception ("container unknown: " + containerName)
         result = self._containerConfig[containerName].calibMode
         if result is None :
             raise Exception ("no calibration mode for: " + containerName)
         return result
  

◆ campaign()

def python.ConfigAccumulator.ConfigAccumulator.campaign ( self )

the MC campaign we run on

Definition at line 214 of file ConfigAccumulator.py.

     def campaign(self) :
         """the MC campaign we run on"""
         return self._campaign
  

◆ copyName()

def python.ConfigAccumulator.ConfigAccumulator.copyName	(	self,
		containerName
	)

register that a copy of the container will be made and return
its name

Definition at line 366 of file ConfigAccumulator.py.

     def copyName (self, containerName) :
         """register that a copy of the container will be made and return
         its name"""
         if containerName not in self._containerConfig :
             raise Exception ("unknown container: " + containerName)
         self._containerConfig[containerName].index += 1
         return self._containerConfig[containerName].currentName()
  
  

◆ createAlgorithm()

def python.ConfigAccumulator.ConfigAccumulator.createAlgorithm	(	self,
		type,
		name,
		reentrant = `False`
	)

create a new algorithm and register it as the current algorithm

Definition at line 234 of file ConfigAccumulator.py.

     def createAlgorithm (self, type, name, reentrant=False) :
         """create a new algorithm and register it as the current algorithm"""
         if self._pass == 0 :
             if name in self._algorithms :
                 raise Exception ('duplicate algorithms: ' + name)
             if reentrant:
                 alg = DualUseConfig.createReentrantAlgorithm (type, name)
             else:
                 alg = DualUseConfig.createAlgorithm (type, name)
  
             if DualUseConfig.useComponentAccumulator:
                 if self._algSeq :
                     self.CA.addEventAlgo(alg,self._algSeq.name)
                 else :
                     self.CA.addEventAlgo(alg)
             else:
                 self._algSeq += alg
             self._algorithms[name] = alg
             self._currentAlg = alg
             return alg
         else :
             if name not in self._algorithms :
                 raise Exception ('unknown algorithm requested: ' + name)
             self._currentAlg = self._algorithms[name]
             if self.CA and self._currentAlg != self.CA.getEventAlgo(name) :
                 raise Exception ('change to algorithm object: ' + name)
             return self._algorithms[name]
  
  

◆ createPublicTool()

def python.ConfigAccumulator.ConfigAccumulator.createPublicTool	(	self,
		type,
		name
	)

create a new public tool and register it as the "current algorithm"

Definition at line 287 of file ConfigAccumulator.py.

     def createPublicTool (self, type, name) :
         '''create a new public tool and register it as the "current algorithm"'''
         if self._pass == 0 :
             if name in self._algorithms :
                 raise Exception ('duplicate public tool: ' + name)
             tool = DualUseConfig.createPublicTool (type, name)
             # Avoid importing AthenaCommon.AppMgr in a CA Athena job
             # as it modifies Gaudi behaviour
             if DualUseConfig.isAthena:
                 if DualUseConfig.useComponentAccumulator:
                     self.CA.addPublicTool(tool)
             else:
                 # We're not, so let's remember this as a "normal" algorithm:
                 self._algSeq += tool
             self._algorithms[name] = tool
             self._currentAlg = tool
             return tool
         else :
             if name not in self._algorithms :
                 raise Exception ('unknown public tool requested: ' + name)
             self._currentAlg = self._algorithms[name]
             return self._algorithms[name]
  
  

◆ createService()

def python.ConfigAccumulator.ConfigAccumulator.createService	(	self,
		type,
		name
	)

create a new service and register it as the "current algorithm"

Definition at line 263 of file ConfigAccumulator.py.

     def createService (self, type, name) :
         '''create a new service and register it as the "current algorithm"'''
         if self._pass == 0 :
             if name in self._algorithms :
                 raise Exception ('duplicate service: ' + name)
             service = DualUseConfig.createService (type, name)
             # Avoid importing AthenaCommon.AppMgr in a CA Athena job
             # as it modifies Gaudi behaviour
             if DualUseConfig.isAthena:
                 if DualUseConfig.useComponentAccumulator:
                     self.CA.addService(service)
             else:
                 # We're not, so let's remember this as a "normal" algorithm:
                 self._algSeq += service
             self._algorithms[name] = service
             self._currentAlg = service
             return service
         else :
             if name not in self._algorithms :
                 raise Exception ('unknown service requested: ' + name)
             self._currentAlg = self._algorithms[name]
             return self._algorithms[name]
  
  

◆ dataType()

def python.ConfigAccumulator.ConfigAccumulator.dataType ( self )

the data type we run on (data, fullsim, fastsim)

Definition at line 198 of file ConfigAccumulator.py.

     def dataType (self) :
         """the data type we run on (data, fullsim, fastsim)"""
         return self._dataType
  

◆ dataYear()

def python.ConfigAccumulator.ConfigAccumulator.dataYear ( self )

for data, the corresponding year; for MC, zero

Definition at line 222 of file ConfigAccumulator.py.

     def dataYear(self) :
         """for data, the corresponding year; for MC, zero"""
         return self._dataYear
  

◆ dsid()

def python.ConfigAccumulator.ConfigAccumulator.dsid ( self )

the mcChannelNumber or DSID of the sample we run on

Definition at line 210 of file ConfigAccumulator.py.

     def dsid(self) :
         """the mcChannelNumber or DSID of the sample we run on"""
         return self._dsid
  

◆ generatorInfo()

def python.ConfigAccumulator.ConfigAccumulator.generatorInfo ( self )

the dictionary of MC generators and their versions for the sample we run on

Definition at line 226 of file ConfigAccumulator.py.

     def generatorInfo(self) :
         """the dictionary of MC generators and their versions for the sample we run on"""
         return self._generatorInfo
  

◆ geometry()

def python.ConfigAccumulator.ConfigAccumulator.geometry ( self )

the LHC Run period we run on

Definition at line 206 of file ConfigAccumulator.py.

     def geometry (self) :
         """the LHC Run period we run on"""
         return self._geometry
  

◆ getEventCutFlow()

def python.ConfigAccumulator.ConfigAccumulator.getEventCutFlow	(	self,
		selection
	)

get the list of decorated selections for an event cutflow,  corresponding to
key 'selection'

Definition at line 584 of file ConfigAccumulator.py.

     def getEventCutFlow (self, selection) :
  
         """get the list of decorated selections for an event cutflow,  corresponding to
         key 'selection'
         """
         return self._eventcutflow[selection]
  
  

◆ getFullSelection()

def python.ConfigAccumulator.ConfigAccumulator.getFullSelection	(		self,
			containerName,
			selectionName,
		*	skipBase = `False`,
			excludeFrom = `None`
	)

get the selection string for the given selection on the given
container

This can handle both individual selections or selection
expressions (e.g. `loose||tight`) with the later being
properly expanded.  Either way the base selection (i.e. the
selection without a name) will always be applied on top.

containerName --- the container the selection is defined on
selectionName --- the name of the selection, or a selection
          expression based on multiple named selections
skipBase --- will avoid the base selection, and should normally
     not be used by the end-user.
excludeFrom --- a set of string names of selection sources to exclude
        e.g. to exclude OR selections from MET

Definition at line 477 of file ConfigAccumulator.py.

     def getFullSelection (self, containerName, selectionName,
                           *, skipBase = False, excludeFrom = None) :
  
         """get the selection string for the given selection on the given
         container
  
         This can handle both individual selections or selection
         expressions (e.g. `loose||tight`) with the later being
         properly expanded.  Either way the base selection (i.e. the
         selection without a name) will always be applied on top.
  
         containerName --- the container the selection is defined on
         selectionName --- the name of the selection, or a selection
                           expression based on multiple named selections
         skipBase --- will avoid the base selection, and should normally
                      not be used by the end-user.
         excludeFrom --- a set of string names of selection sources to exclude
                         e.g. to exclude OR selections from MET
         """
         if containerName not in self._containerConfig :
             return ""
  
         if excludeFrom is None :
             excludeFrom = set()
         elif not isinstance(excludeFrom, set) :
             raise ValueError ('invalid excludeFrom argument (need set of strings): ' + str(excludeFrom))
  
         # Check if this is actually a selection expression,
         # e.g. `A||B` and if so translate it into a complex expression
         # for the user.  I'm not trying to do any complex syntax
         # recognition, but instead just produce an expression that the
         # C++ parser ought to be able to read.
         if selectionName != '' and \
            not self._selectionNameExpr.fullmatch (selectionName) :
             result = ''
             while selectionName != '' :
                 match = self._selectionNameExpr.match (selectionName)
                 if not match :
                     result += selectionName[0]
                     selectionName = selectionName[1:]
                 else :
                     subname = match.group(0)
                     subresult = self.getFullSelection (containerName, subname, skipBase = True, excludeFrom=excludeFrom)
                     if subresult != '' :
                         result += '(' + subresult + ')'
                     else :
                         result += 'true'
                     selectionName = selectionName[len(subname):]
             subresult = self.getFullSelection (containerName, '', excludeFrom=excludeFrom)
             if subresult != '' :
                 result = subresult + '&&(' + result + ')'
             return result
  
         config = self._containerConfig[containerName]
         decorations = []
         hasSelectionName = False
         for selection in config.selections :
             if ((selection.name == '' and not skipBase) or selection.name == selectionName) and (selection.comesFrom not in excludeFrom) :
                 decorations += [selection.decoration]
             if selection.name == selectionName :
                 hasSelectionName = True
         if not hasSelectionName and selectionName != '' :
             raise KeyError ('invalid selection name: ' + containerName + '.' + selectionName)
         return '&&'.join (decorations)
  
  

◆ getOutputContainerOrigin()

def python.ConfigAccumulator.ConfigAccumulator.getOutputContainerOrigin	(	self,
		outputContainerName
	)

Get the name of the actual container, for which an output is registered

Definition at line 614 of file ConfigAccumulator.py.

     def getOutputContainerOrigin (self, outputContainerName) :
         """Get the name of the actual container, for which an output is registered"""
         try:
             return self._outputContainers[outputContainerName]
         except KeyError:
             try:
                 return self._containerConfig[outputContainerName].name
             except KeyError:
                 raise KeyError ("output container unknown: " + outputContainerName)
  
  

◆ getOutputVars()

def python.ConfigAccumulator.ConfigAccumulator.getOutputVars	(	self,
		containerName
	)

get the output variables for the given container

Definition at line 639 of file ConfigAccumulator.py.

     def getOutputVars (self, containerName) :
         """get the output variables for the given container"""
         if containerName in self._outputContainers :
             containerName = self._outputContainers[containerName]
         if containerName not in self._containerConfig :
             raise KeyError ("unknown container for output: " + containerName)
         return self._containerConfig[containerName].outputs
  
  

◆ getPreselection()

def python.ConfigAccumulator.ConfigAccumulator.getPreselection	(		self,
			containerName,
			selectionName,
		*	asList = `False`
	)

get the preselection string for the given selection on the given
container

Definition at line 456 of file ConfigAccumulator.py.

     def getPreselection (self, containerName, selectionName, *, asList = False) :
  
         """get the preselection string for the given selection on the given
         container
         """
         if selectionName != '' and not self._selectionNameExpr.fullmatch (selectionName) :
             raise ValueError ('invalid selection name: ' + selectionName)
         if containerName not in self._containerConfig :
             return ""
         config = self._containerConfig[containerName]
         decorations = []
         for selection in config.selections :
             if (selection.name == '' or selection.name == selectionName) and \
                selection.preselection :
                 decorations += [selection.decoration]
         if asList :
             return decorations
         else :
             return '&&'.join (decorations)
  
  

◆ getSelectionCutFlow()

def python.ConfigAccumulator.ConfigAccumulator.getSelectionCutFlow	(	self,
		containerName,
		selectionName
	)

get the individual selections as a list for producing the cutflow for
the given selection on the given container

This can only handle individual selections, not selection
expressions (e.g. `loose||tight`).

Definition at line 543 of file ConfigAccumulator.py.

     def getSelectionCutFlow (self, containerName, selectionName) :
  
         """get the individual selections as a list for producing the cutflow for
         the given selection on the given container
  
         This can only handle individual selections, not selection
         expressions (e.g. `loose||tight`).
  
         """
         if containerName not in self._containerConfig :
             return []
  
         # Check if this is actually a selection expression,
         # e.g. `A||B` and if so translate it into a complex expression
         # for the user.  I'm not trying to do any complex syntax
         # recognition, but instead just produce an expression that the
         # C++ parser ought to be able to read.
         if selectionName != '' and \
            not self._selectionNameExpr.fullmatch (selectionName) :
             raise ValueError ('not allowed to do cutflow on selection expression: ' + selectionName)
  
         config = self._containerConfig[containerName]
         decorations = []
         for selection in config.selections :
             if (selection.name == '' or selection.name == selectionName) :
                 decorations += [selection.decoration]
         return decorations
  
  

◆ getSelectionNames()

def python.ConfigAccumulator.ConfigAccumulator.getSelectionNames	(	self,
		containerName,
		excludeFrom = `None`
	)

Retrieve set of unique selections defined for a given container

Definition at line 648 of file ConfigAccumulator.py.

     def getSelectionNames (self, containerName, excludeFrom = None) :
         """Retrieve set of unique selections defined for a given container"""
         if containerName not in self._containerConfig :
             return []
         if excludeFrom is None:
             excludeFrom = set()
         elif not isinstance(excludeFrom, set) :
             raise ValueError ('invalid excludeFrom argument (need set of strings): ' + str(excludeFrom))
  
         config = self._containerConfig[containerName]
         # because cuts are registered individually, selection names can repeat themselves
         # but we are interested in unique names only
         selectionNames = set()
         for selection in config.selections:
             if selection.comesFrom in excludeFrom:
                 continue
             # skip flags which should be disabled in output
             if selection.writeToOutput:
                 selectionNames.add(selection.name)
         return selectionNames

◆ hltSummary()

def python.ConfigAccumulator.ConfigAccumulator.hltSummary ( self )

the HLTSummary configuration to be used for the trigger decision tool

Definition at line 230 of file ConfigAccumulator.py.

     def hltSummary(self) :
         """the HLTSummary configuration to be used for the trigger decision tool"""
         return self._hltSummary
  

◆ isMetContainer()

def python.ConfigAccumulator.ConfigAccumulator.isMetContainer	(	self,
		containerName
	)

whether the given container is registered as a MET container

This is mostly/exclusively used for determining whether to
write out the whole container or just a single MET term.

Definition at line 410 of file ConfigAccumulator.py.

     def isMetContainer (self, containerName) :
         """whether the given container is registered as a MET container
  
         This is mostly/exclusively used for determining whether to
         write out the whole container or just a single MET term.
         """
         if containerName not in self._containerConfig :
             raise Exception ("container unknown: " + containerName)
         return self._containerConfig[containerName].isMet
  
  

◆ isPhyslite()

def python.ConfigAccumulator.ConfigAccumulator.isPhyslite ( self )

whether we run on PHYSLITE

Definition at line 202 of file ConfigAccumulator.py.

     def isPhyslite (self) :
         """whether we run on PHYSLITE"""
         return self._isPhyslite
  

◆ nextPass()

def python.ConfigAccumulator.ConfigAccumulator.nextPass ( self )

switch to the next configuration pass

Configuration happens in two steps, with all the blocks processed
twice.  This switches from the first to the second pass.

Definition at line 441 of file ConfigAccumulator.py.

     def nextPass (self) :
         """switch to the next configuration pass
  
         Configuration happens in two steps, with all the blocks processed
         twice.  This switches from the first to the second pass.
         """
         if self._pass != 0 :
             raise Exception ("already performed final pass")
         for name in self._containerConfig :
             self._containerConfig[name].nextPass ()
         self._pass = 1
         self._currentAlg = None
         self._outputContainers = {}
  
  

◆ noSystematics()

def python.ConfigAccumulator.ConfigAccumulator.noSystematics ( self )

noSystematics flag used by CommonServices block

Definition at line 190 of file ConfigAccumulator.py.

     def noSystematics (self) :
         """noSystematics flag used by CommonServices block"""
         return self._noSystematics
  

◆ originalName()

def python.ConfigAccumulator.ConfigAccumulator.originalName	(	self,
		containerName
	)

get the "original" name of the given container

This is mostly/exclusively used for jet containers, so that
subsequent configurations know which jet container they
operate on.

Definition at line 386 of file ConfigAccumulator.py.

     def originalName (self, containerName) :
         """get the "original" name of the given container
  
         This is mostly/exclusively used for jet containers, so that
         subsequent configurations know which jet container they
         operate on.
         """
         if containerName not in self._containerConfig :
             raise Exception ("container unknown: " + containerName)
         result = self._containerConfig[containerName].originalName
         if result is None :
             raise Exception ("no original name for: " + containerName)
         return result
  

◆ readName()

def python.ConfigAccumulator.ConfigAccumulator.readName	(	self,
		containerName
	)

get the name of the "current copy" of the given container

As extra copies get created during processing this will track
the correct name of the current copy.  Optionally one can pass
in the name of the container before the first copy.

Definition at line 354 of file ConfigAccumulator.py.

     def readName (self, containerName) :
         """get the name of the "current copy" of the given container
  
         As extra copies get created during processing this will track
         the correct name of the current copy.  Optionally one can pass
         in the name of the container before the first copy.
         """
         if containerName not in self._containerConfig :
             raise Exception ("no source container for: " + containerName)
         return self._containerConfig[containerName].currentName()
  
  

◆ readNameAndSelection()

def python.ConfigAccumulator.ConfigAccumulator.readNameAndSelection	(		self,
			containerName,
		*	excludeFrom = `None`
	)

get the name of the "current copy" of the given container, and the
selection string

This is mostly meant for MET and OR for whom the actual object
selection is relevant, and which as such allow to pass in the
working point as "ObjectName.WorkingPoint".

Definition at line 421 of file ConfigAccumulator.py.

     def readNameAndSelection (self, containerName, *, excludeFrom = None) :
         """get the name of the "current copy" of the given container, and the
         selection string
  
         This is mostly meant for MET and OR for whom the actual object
         selection is relevant, and which as such allow to pass in the
         working point as "ObjectName.WorkingPoint".
         """
         split = containerName.split (".")
         if len(split) == 1 :
             objectName = split[0]
             selectionName = ''
         elif len(split) == 2 :
             objectName = split[0]
             selectionName = split[1]
         else :
             raise Exception ('invalid object selection name: ' + containerName)
         return self.readName (objectName), self.getFullSelection (objectName, selectionName, excludeFrom=excludeFrom)
  
  

◆ runNumber()

def python.ConfigAccumulator.ConfigAccumulator.runNumber ( self )

the MC runNumber

Definition at line 218 of file ConfigAccumulator.py.

     def runNumber(self) :
         """the MC runNumber"""
         return self._runNumber
  

◆ setSourceName()

def python.ConfigAccumulator.ConfigAccumulator.setSourceName	(		self,
			containerName,
			sourceName,
		*	originalName = `None`,
			calibMode = `None`,
			isMet = `False`
	)

set the (default) name of the source/original container

This is essentially meant to allow using e.g. the muon
configuration and the user not having to manually specify that
they want to use the Muons/AnalysisMuons container from the
input file.

In addition it allows to set the original name of the
container (which may be different from the source name), which
is mostly/exclusively used for jet containers, so that
subsequent configurations know which jet container they
operate on.

CalibMode can also be configured to pass it down to some algs which use this
information to be configured, like the METSignificance

Definition at line 317 of file ConfigAccumulator.py.

     def setSourceName (self, containerName, sourceName,
                        *, originalName = None, calibMode = None, isMet = False) :
         """set the (default) name of the source/original container
  
         This is essentially meant to allow using e.g. the muon
         configuration and the user not having to manually specify that
         they want to use the Muons/AnalysisMuons container from the
         input file.
  
         In addition it allows to set the original name of the
         container (which may be different from the source name), which
         is mostly/exclusively used for jet containers, so that
         subsequent configurations know which jet container they
         operate on.
  
         CalibMode can also be configured to pass it down to some algs which use this
         information to be configured, like the METSignificance
         """
         if containerName not in self._containerConfig :
             self._containerConfig[containerName] = ContainerConfig (containerName, sourceName, noSysSuffix = self._noSysSuffix, originalName = originalName, calibMode = calibMode, isMet = isMet)
  
  

◆ wantCopy()

def python.ConfigAccumulator.ConfigAccumulator.wantCopy	(	self,
		containerName
	)

ask whether we want/need a copy of the container

This usually only happens if no copy of the container has been
made yet and the copy is needed to allow modifications, etc.

Definition at line 375 of file ConfigAccumulator.py.

     def wantCopy (self, containerName) :
         """ask whether we want/need a copy of the container
  
         This usually only happens if no copy of the container has been
         made yet and the copy is needed to allow modifications, etc.
         """
         if containerName not in self._containerConfig :
             raise Exception ("no source container for: " + containerName)
         return self._containerConfig[containerName].index == 0
  
  

◆ writeName()

def python.ConfigAccumulator.ConfigAccumulator.writeName	(		self,
			containerName,
		*	isMet = `None`
	)

register that the given container will be made and return
its name

Definition at line 339 of file ConfigAccumulator.py.

     def writeName (self, containerName, *, isMet=None) :
         """register that the given container will be made and return
         its name"""
         if containerName not in self._containerConfig :
             self._containerConfig[containerName] = ContainerConfig (containerName, sourceName = None, noSysSuffix = self._noSysSuffix)
         if self._containerConfig[containerName].sourceName is not None :
             raise Exception ("trying to write container configured for input: " + containerName)
         if self._containerConfig[containerName].index != 0 :
             raise Exception ("trying to write container twice: " + containerName)
         self._containerConfig[containerName].index += 1
         if isMet is not None :
             self._containerConfig[containerName].isMet = isMet
         return self._containerConfig[containerName].currentName()
  
  

Member Data Documentation

◆ _algorithms

python.ConfigAccumulator.ConfigAccumulator._algorithms

private

Definition at line 168 of file ConfigAccumulator.py.

◆ _algSeq

python.ConfigAccumulator.ConfigAccumulator._algSeq

private

Definition at line 162 of file ConfigAccumulator.py.

◆ _autoconfigFlags

python.ConfigAccumulator.ConfigAccumulator._autoconfigFlags

private

Definition at line 112 of file ConfigAccumulator.py.

◆ _campaign

python.ConfigAccumulator.ConfigAccumulator._campaign

private

Definition at line 158 of file ConfigAccumulator.py.

◆ _containerConfig

python.ConfigAccumulator.ConfigAccumulator._containerConfig

private

Definition at line 165 of file ConfigAccumulator.py.

◆ _currentAlg

python.ConfigAccumulator.ConfigAccumulator._currentAlg

private

Definition at line 169 of file ConfigAccumulator.py.

◆ _dataType

python.ConfigAccumulator.ConfigAccumulator._dataType

private

Definition at line 154 of file ConfigAccumulator.py.

◆ _dataYear

python.ConfigAccumulator.ConfigAccumulator._dataYear

private

Definition at line 160 of file ConfigAccumulator.py.

◆ _dsid

python.ConfigAccumulator.ConfigAccumulator._dsid

private

Definition at line 157 of file ConfigAccumulator.py.

◆ _eventcutflow

python.ConfigAccumulator.ConfigAccumulator._eventcutflow

private

Definition at line 172 of file ConfigAccumulator.py.

◆ _generatorInfo

python.ConfigAccumulator.ConfigAccumulator._generatorInfo

private

Definition at line 161 of file ConfigAccumulator.py.

◆ _geometry

python.ConfigAccumulator.ConfigAccumulator._geometry

private

Definition at line 156 of file ConfigAccumulator.py.

◆ _hltSummary

python.ConfigAccumulator.ConfigAccumulator._hltSummary

private

Definition at line 173 of file ConfigAccumulator.py.

◆ _isPhyslite

python.ConfigAccumulator.ConfigAccumulator._isPhyslite

private

Definition at line 155 of file ConfigAccumulator.py.

◆ _noSysSuffix

python.ConfigAccumulator.ConfigAccumulator._noSysSuffix

private

Definition at line 164 of file ConfigAccumulator.py.

◆ _noSystematics

python.ConfigAccumulator.ConfigAccumulator._noSystematics

private

Definition at line 163 of file ConfigAccumulator.py.

◆ _outputContainers

python.ConfigAccumulator.ConfigAccumulator._outputContainers

private

Definition at line 166 of file ConfigAccumulator.py.

◆ _pass

python.ConfigAccumulator.ConfigAccumulator._pass

private

Definition at line 167 of file ConfigAccumulator.py.

◆ _runNumber

python.ConfigAccumulator.ConfigAccumulator._runNumber

private

Definition at line 159 of file ConfigAccumulator.py.

◆ _selectionNameExpr

python.ConfigAccumulator.ConfigAccumulator._selectionNameExpr

private

Definition at line 170 of file ConfigAccumulator.py.

◆ CA

python.ConfigAccumulator.ConfigAccumulator.CA

Definition at line 178 of file ConfigAccumulator.py.

The documentation for this class was generated from the following file:

ConfigAccumulator.py

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ addEventCutFlow()

◆ addOutputContainer()

◆ addOutputVar()

◆ addPrivateTool()

◆ addSelection()

◆ autoconfigFlags()

◆ calibMode()

◆ campaign()

◆ copyName()

◆ createAlgorithm()

◆ createPublicTool()

◆ createService()

◆ dataType()

◆ dataYear()

◆ dsid()

◆ generatorInfo()

◆ geometry()

◆ getEventCutFlow()

◆ getFullSelection()

◆ getOutputContainerOrigin()

◆ getOutputVars()

◆ getPreselection()

◆ getSelectionCutFlow()

◆ getSelectionNames()

◆ hltSummary()

◆ isMetContainer()

◆ isPhyslite()

◆ nextPass()

◆ noSystematics()

◆ originalName()

◆ readName()

◆ readNameAndSelection()

◆ runNumber()

◆ setSourceName()

◆ wantCopy()

◆ writeName()

Member Data Documentation

◆ _algorithms

◆ _algSeq

◆ _autoconfigFlags

◆ _campaign

◆ _containerConfig

◆ _currentAlg

◆ _dataType

◆ _dataYear

◆ _dsid

◆ _eventcutflow

◆ _generatorInfo

◆ _geometry

◆ _hltSummary

◆ _isPhyslite

◆ _noSysSuffix

◆ _noSystematics

◆ _outputContainers

◆ _pass

◆ _runNumber

◆ _selectionNameExpr

◆ CA

◆ init()