ATLAS Offline Software
Functions
python.JetCommonConfig Namespace Reference

Functions

def JetCommonCfg (ConfigFlags)
 
def StandardJetsInDerivCfg (ConfigFlags)
 
def AddBadBatmanCfg (ConfigFlags)
 
def AddDistanceInTrainCfg (ConfigFlags)
 
def AddSidebandEventShapeCfg (ConfigFlags)
 
def AddJvtDecorationAlgCfg (ConfigFlags, algName="JvtPassDecorAlg", jetContainer='AntiKt4EMTopo', **kwargs)
 
def AddEventCleanFlagsCfg (ConfigFlags, workingPoints=['Loose', 'Tight', 'LooseLLP'])
 
def addJetsToSlimmingTool (slimhelper, contentlist, smartlist=[])
 
def addOriginCorrectedClustersToSlimmingTool (slimhelper, writeLC=False, writeEM=False)
 Helper to add origin corrected clusters to output. More...
 

Function Documentation

◆ AddBadBatmanCfg()

def python.JetCommonConfig.AddBadBatmanCfg (   ConfigFlags)
Add bad batman decoration for events with large EMEC-IW noise

Definition at line 55 of file JetCommonConfig.py.

55 def AddBadBatmanCfg(ConfigFlags):
56  """Add bad batman decoration for events with large EMEC-IW noise"""
57 
58  acc = ComponentAccumulator()
59 
60  CommonAugmentation = CompFactory.DerivationFramework.CommonAugmentation
61  from DerivationFrameworkJetEtMiss.JetToolConfig import BadBatmanToolCfg
62  badBatmanTool = acc.getPrimaryAndMerge(BadBatmanToolCfg(ConfigFlags))
63  acc.addEventAlgo(CommonAugmentation("BadBatmanAugmentation", AugmentationTools = [badBatmanTool]))
64 
65  return acc
66 

◆ AddDistanceInTrainCfg()

def python.JetCommonConfig.AddDistanceInTrainCfg (   ConfigFlags)
Add distance in train information to EventInfo

Definition at line 67 of file JetCommonConfig.py.

67 def AddDistanceInTrainCfg(ConfigFlags):
68  """Add distance in train information to EventInfo"""
69  from DerivationFrameworkJetEtMiss.JetToolConfig import DistanceInTrainToolCfg
70 
71  acc = ComponentAccumulator()
72 
73  CommonAugmentation = CompFactory.DerivationFramework.CommonAugmentation
74  distanceInTrainTool = acc.getPrimaryAndMerge(DistanceInTrainToolCfg(ConfigFlags))
75  acc.addEventAlgo(CommonAugmentation("DistanceInTrainAugmentation", AugmentationTools = [distanceInTrainTool]))
76 
77  return acc
78 

◆ AddEventCleanFlagsCfg()

def python.JetCommonConfig.AddEventCleanFlagsCfg (   ConfigFlags,
  workingPoints = ['Loose', 'Tight', 'LooseLLP'] 
)
Add event cleaning flags

Definition at line 117 of file JetCommonConfig.py.

117 def AddEventCleanFlagsCfg(ConfigFlags, workingPoints = ['Loose', 'Tight', 'LooseLLP']):
118  """Add event cleaning flags"""
119 
120  acc = ComponentAccumulator()
121  acc.merge(AddJvtDecorationAlgCfg(ConfigFlags, algName="JvtPassDecorAlg_EMTopo", jetContainer='AntiKt4EMTopo'))
122  acc.merge(AddJvtDecorationAlgCfg(ConfigFlags, algName="JvtPassDecorAlg", jetContainer='AntiKt4EMPFlow'))
123 
124  from DerivationFrameworkTau.TauCommonConfig import AddTauAugmentationCfg
125  acc.merge(AddTauAugmentationCfg(ConfigFlags, prefix="JetCommon", doLoose=True))
126 
127  # Overlap for EMTopo
128  from AssociationUtils.AssociationUtilsConfig import OverlapRemovalToolCfg
129  outputLabel_legacy = 'DFCommonJets_passOR'
130  bJetLabel = '' #default
131  tauLabel = 'DFTauLoose'
132  orTool_legacy = acc.popToolsAndMerge(OverlapRemovalToolCfg(ConfigFlags,outputLabel=outputLabel_legacy,bJetLabel=bJetLabel))
133  algOR_legacy = CompFactory.OverlapRemovalGenUseAlg('OverlapRemovalGenUseAlg_EMTopo',
134  JetKey="AntiKt4EMTopoJets",
135  OverlapLabel=outputLabel_legacy,
136  OverlapRemovalTool=orTool_legacy,
137  TauLabel=tauLabel,
138  BJetLabel=bJetLabel
139  )
140  acc.addEventAlgo(algOR_legacy)
141 
142  # Overlap for EMPFlow
143  outputLabel = 'DFCommonJets_passOR'
144  orTool = acc.popToolsAndMerge(OverlapRemovalToolCfg(ConfigFlags,outputLabel=outputLabel,bJetLabel=bJetLabel))
145  algOR = CompFactory.OverlapRemovalGenUseAlg('OverlapRemovalGenUseAlg',
146  OverlapLabel=outputLabel,
147  OverlapRemovalTool=orTool,
148  TauLabel=tauLabel,
149  BJetLabel=bJetLabel)
150  acc.addEventAlgo(algOR)
151 
152  CommonAugmentation = CompFactory.DerivationFramework.CommonAugmentation
153  from DerivationFrameworkMuons.MuonsToolsConfig import MuonJetDrToolCfg
154  muonJetDrTool = acc.getPrimaryAndMerge(MuonJetDrToolCfg(ConfigFlags, "MuonJetDrTool"))
155  acc.addEventAlgo(CommonAugmentation("DFCommonMuonsKernel2", AugmentationTools = [muonJetDrTool]))
156 
157  from JetSelectorTools.JetSelectorToolsConfig import EventCleaningToolCfg,JetCleaningToolCfg
158 
159  supportedWPs = ['Loose', 'Tight', 'LooseLLP', 'VeryLooseLLP', 'SuperLooseLLP']
160  prefix = "DFCommonJets_"
161  evt_lvl_suppWPs_PFlow = ['LooseBad', 'TightBad']
162 
163  for wp in workingPoints:
164  if wp not in supportedWPs:
165  continue
166 
167  cleaningLevel = wp + 'Bad'
168  # LLP WPs have a slightly different name format
169  if 'LLP' in wp:
170  cleaningLevel = wp.replace('LLP', 'BadLLP')
171 
172  # Add support for TightBad event flag as well
173  doEvent_PFlow=False
174  for evt_swp in evt_lvl_suppWPs_PFlow:
175  if evt_swp == cleaningLevel:
176  doEvent_PFlow=True
177  break
178 
179  doEvent_EMTopo=False
180  if 'Loose' in cleaningLevel:
181  doEvent_EMTopo=True
182 
183 
184  if doEvent_EMTopo:
185  jetCleaningTool_legacy = acc.popToolsAndMerge(JetCleaningToolCfg(
186  ConfigFlags, 'JetCleaningTool_'+cleaningLevel+'_EMTopo',
187  'AntiKt4EMTopo', cleaningLevel, False))
188  acc.addPublicTool(jetCleaningTool_legacy)
189  ecTool_legacy = acc.popToolsAndMerge(EventCleaningToolCfg(
190  ConfigFlags,'EventCleaningTool_'+wp+'_EMTopo', cleaningLevel))
191  ecTool_legacy.JetCleanPrefix = prefix
192  ecTool_legacy.JetContainer = "AntiKt4EMTopoJets"
193  ecTool_legacy.JetCleaningTool = jetCleaningTool_legacy
194  acc.addPublicTool(ecTool_legacy)
195 
196  eventCleanAlg_legacy = CompFactory.EventCleaningTestAlg('EventCleaningTestAlg_'+wp+'_EMTopo',
197  EventCleaningTool=ecTool_legacy,
198  JetCollectionName="AntiKt4EMTopoJets",
199  EventCleanPrefix=prefix,
200  CleaningLevel=cleaningLevel,
201  doEvent=True) # Only store event-level flags for Loose and LooseLLP
202  acc.addEventAlgo(eventCleanAlg_legacy)
203 
204 
205  if doEvent_PFlow:
206  jetCleaningTool = acc.popToolsAndMerge(JetCleaningToolCfg(
207  ConfigFlags, 'JetCleaningTool_'+cleaningLevel,
208  'AntiKt4EMPFlowJets', cleaningLevel, False))
209  acc.addPublicTool(jetCleaningTool)
210 
211  ecTool = acc.popToolsAndMerge(EventCleaningToolCfg(ConfigFlags,'EventCleaningTool_' + wp, cleaningLevel))
212  ecTool.JetCleanPrefix = prefix
213  ecTool.JetContainer = "AntiKt4EMPFlowJets"
214  ecTool.JetCleaningTool = jetCleaningTool
215  acc.addPublicTool(ecTool)
216 
217  eventCleanAlg = CompFactory.EventCleaningTestAlg('EventCleaningTestAlg_'+wp,
218  EventCleaningTool=ecTool,
219  JetCollectionName="AntiKt4EMPFlowJets",
220  EventCleanPrefix=prefix,
221  CleaningLevel=cleaningLevel,
222  doEvent=True) # for PFlow we use Loose and Tight
223  acc.addEventAlgo(eventCleanAlg)
224 
225  return acc
226 
227 

◆ addJetsToSlimmingTool()

def python.JetCommonConfig.addJetsToSlimmingTool (   slimhelper,
  contentlist,
  smartlist = [] 
)

Definition at line 228 of file JetCommonConfig.py.

228 def addJetsToSlimmingTool(slimhelper,contentlist,smartlist=[]):
229  for item in contentlist:
230  if item not in slimhelper.AppendToDictionary:
231  slimhelper.AppendToDictionary.update({item:'xAOD::JetContainer',
232  item+"Aux":'xAOD::JetAuxContainer'})
233  if item in smartlist:
234  slimhelper.SmartCollections.append(item)
235  else:
236  slimhelper.AllVariables.append(item)
237 
238 

◆ AddJvtDecorationAlgCfg()

def python.JetCommonConfig.AddJvtDecorationAlgCfg (   ConfigFlags,
  algName = "JvtPassDecorAlg",
  jetContainer = 'AntiKt4EMTopo',
**  kwargs 
)

Definition at line 104 of file JetCommonConfig.py.

104 def AddJvtDecorationAlgCfg(ConfigFlags, algName = "JvtPassDecorAlg", jetContainer='AntiKt4EMTopo', **kwargs):
105  acc = ComponentAccumulator()
106  # Decorate if jet passed JVT criteria
107  from JetJvtEfficiency.JetJvtEfficiencyToolConfig import getJvtEffToolCfg
108 
109  passJvtTool = acc.popToolsAndMerge(getJvtEffToolCfg(ConfigFlags, jetContainer))
110  passJvtTool.PassJVTKey = "{}Jets.DFCommonJets_passJvt".format(jetContainer)
111  passJvtTool.SuppressOutputDependence = False
112  kwargs.setdefault("Decorators", [passJvtTool])
113  kwargs.setdefault("JetContainer", "{}Jets".format(jetContainer))
114  acc.addEventAlgo(CompFactory.JetDecorationAlg(algName, **kwargs), primary = True)
115  return acc
116 

◆ addOriginCorrectedClustersToSlimmingTool()

def python.JetCommonConfig.addOriginCorrectedClustersToSlimmingTool (   slimhelper,
  writeLC = False,
  writeEM = False 
)

Helper to add origin corrected clusters to output.

Definition at line 242 of file JetCommonConfig.py.

242 def addOriginCorrectedClustersToSlimmingTool(slimhelper,writeLC=False,writeEM=False):
243 
244  slimhelper.ExtraVariables.append('CaloCalTopoClusters.calE.calEta.calPhi.calM')
245 
246  if writeLC:
247  if "LCOriginTopoClusters" not in slimhelper.AppendToDictionary:
248  slimhelper.AppendToDictionary.update({"LCOriginTopoClusters":'xAOD::CaloClusterContainer',
249  "LCOriginTopoClustersAux":'xAOD::ShallowAuxContainer'})
250  slimhelper.ExtraVariables.append('LCOriginTopoClusters.calEta.calPhi.originalObjectLink')
251 
252  if writeEM:
253  if "EMOriginTopoClusters" not in slimhelper.AppendToDictionary:
254  slimhelper.AppendToDictionary.update({"EMOriginTopoClusters":'xAOD::CaloClusterContainer',
255  "EMOriginTopoClustersAux":'xAOD::ShallowAuxContainer'})
256  slimhelper.ExtraVariables.append('EMOriginTopoClusters.calE.calEta.calPhi.originalObjectLink')

◆ AddSidebandEventShapeCfg()

def python.JetCommonConfig.AddSidebandEventShapeCfg (   ConfigFlags)
Special rho definitions for PFlow jets

Definition at line 79 of file JetCommonConfig.py.

79 def AddSidebandEventShapeCfg(ConfigFlags):
80  """Special rho definitions for PFlow jets"""
81  from JetRecConfig.JetRecConfig import getInputAlgs,getConstitPJGAlg,reOrderAlgs
82  from JetRecConfig.StandardJetConstits import stdConstitDic as cst
83  from JetRecConfig.JetInputConfig import buildEventShapeAlg
84 
85  acc = ComponentAccumulator()
86 
87  constit_algs = getInputAlgs(cst.GPFlow, flags=ConfigFlags)
88  constit_algs, ca = reOrderAlgs( [a for a in constit_algs if a is not None])
89 
90  acc.merge(ca)
91  for a in constit_algs:
92  acc.addEventAlgo(a)
93 
94  #Sideband definition
95  acc.addEventAlgo(getConstitPJGAlg(cst.GPFlow, suffix='PUSB'))
96  acc.addEventAlgo(buildEventShapeAlg(cst.GPFlow, '', suffix = 'PUSB' ))
97 
98  #New "sideband" definition when using CHS based on TTVA
99  acc.addEventAlgo(getConstitPJGAlg(cst.GPFlow, suffix='Neut'))
100  acc.addEventAlgo(buildEventShapeAlg(cst.GPFlow, '', suffix = 'Neut' ))
101 
102  return acc
103 

◆ JetCommonCfg()

def python.JetCommonConfig.JetCommonCfg (   ConfigFlags)
Main config for jet reconstruction and decorations

Definition at line 11 of file JetCommonConfig.py.

11 def JetCommonCfg(ConfigFlags):
12  """Main config for jet reconstruction and decorations"""
13 
14  acc = ComponentAccumulator()
15 
16  acc.merge(StandardJetsInDerivCfg(ConfigFlags))
17  if "McEventCollection#GEN_EVENT" not in ConfigFlags.Input.TypedCollections:
18  acc.merge(AddBadBatmanCfg(ConfigFlags))
19  acc.merge(AddDistanceInTrainCfg(ConfigFlags))
20  acc.merge(AddSidebandEventShapeCfg(ConfigFlags))
21  acc.merge(AddEventCleanFlagsCfg(ConfigFlags))
22 
23  return acc
24 
25 

◆ StandardJetsInDerivCfg()

def python.JetCommonConfig.StandardJetsInDerivCfg (   ConfigFlags)
Jet reconstruction needed for PHYS/PHYSLITE

Definition at line 26 of file JetCommonConfig.py.

26 def StandardJetsInDerivCfg(ConfigFlags):
27  """Jet reconstruction needed for PHYS/PHYSLITE"""
28 
29  from JetRecConfig.StandardSmallRJets import AntiKt4EMTopo,AntiKt4EMPFlow,AntiKtVR30Rmax4Rmin02PV0Track
30  from JetRecConfig.StandardLargeRJets import AntiKt10LCTopoTrimmed,AntiKt10UFOCSSKSoftDrop
31  from JetRecConfig.JetRecConfig import JetRecCfg
32  from JetRecConfig.JetConfigFlags import jetInternalFlags
33 
34  acc = ComponentAccumulator()
35 
36  AntiKt4EMTopo_deriv = AntiKt4EMTopo.clone(
37  modifiers = AntiKt4EMTopo.modifiers+("JetPtAssociation","QGTagging")
38  )
39 
40  AntiKt4EMPFlow_deriv = AntiKt4EMPFlow.clone(
41  modifiers = AntiKt4EMPFlow.modifiers+("JetPtAssociation","QGTagging","fJVT","NNJVT","CaloEnergiesClus","JetPileupLabel")
42  )
43 
44  jetList = [AntiKt4EMTopo_deriv, AntiKt4EMPFlow_deriv,
45  AntiKtVR30Rmax4Rmin02PV0Track,
46  AntiKt10LCTopoTrimmed,AntiKt10UFOCSSKSoftDrop]
47 
48  jetInternalFlags.isRecoJob = True
49 
50  for jd in jetList:
51  acc.merge(JetRecCfg(ConfigFlags,jd))
52 
53  return acc
54 
AssociationUtilsConfig.OverlapRemovalToolCfg
def OverlapRemovalToolCfg(ConfigFlags, masterName='OverlapRemovalTool', inputLabel='selected', outputLabel='overlaps', bJetLabel='', maxElePtForBJetAwareOR=100. *1000, boostedLeptons=False, outputPassValue=False, linkOverlapObjects=False, doEleEleOR=False, doElectrons=True, doMuons=True, doJets=True, doTaus=True, doPhotons=True, doFatJets=False, **kwargs)
Definition: AssociationUtilsConfig.py:5
python.JetCommonConfig.JetCommonCfg
def JetCommonCfg(ConfigFlags)
Definition: JetCommonConfig.py:11
python.JetCommonConfig.AddSidebandEventShapeCfg
def AddSidebandEventShapeCfg(ConfigFlags)
Definition: JetCommonConfig.py:79
python.JetAnalysisCommon.ComponentAccumulator
ComponentAccumulator
Definition: JetAnalysisCommon.py:302
vtune_athena.format
format
Definition: vtune_athena.py:14
python.JetRecConfig.getInputAlgs
def getInputAlgs(jetOrConstitdef, flags, context="default", monTool=None)
Definition: JetRecConfig.py:280
python.JetSelectorToolsConfig.EventCleaningToolCfg
def EventCleaningToolCfg(ConfigFlags, name, cleaningLevel)
Definition: JetSelectorToolsConfig.py:14
python.JetCommonConfig.addOriginCorrectedClustersToSlimmingTool
def addOriginCorrectedClustersToSlimmingTool(slimhelper, writeLC=False, writeEM=False)
Helper to add origin corrected clusters to output.
Definition: JetCommonConfig.py:242
python.JetRecConfig.reOrderAlgs
def reOrderAlgs(algs)
Definition: JetRecConfig.py:797
python.MuonsToolsConfig.MuonJetDrToolCfg
def MuonJetDrToolCfg(ConfigFlags, name)
Definition: MuonsToolsConfig.py:6
python.JetInputConfig.buildEventShapeAlg
def buildEventShapeAlg(jetOrConstitdef, inputspec, voronoiRf=0.9, radius=0.4, suffix=None)
Definition: JetInputConfig.py:132
python.JetSelectorToolsConfig.JetCleaningToolCfg
def JetCleaningToolCfg(ConfigFlags, name, jetdef, cleaningLevel, useDecorations)
Definition: JetSelectorToolsConfig.py:6
python.TauCommonConfig.AddTauAugmentationCfg
def AddTauAugmentationCfg(flags, **kwargs)
Definition: TauCommonConfig.py:6
python.JetRecConfig.JetRecCfg
def JetRecCfg(flags, jetdef, returnConfiguredDef=False)
Top level functions returning ComponentAccumulator out of JetDefinition.
Definition: JetRecConfig.py:37
python.JetCommonConfig.addJetsToSlimmingTool
def addJetsToSlimmingTool(slimhelper, contentlist, smartlist=[])
Definition: JetCommonConfig.py:228
python.JetToolConfig.DistanceInTrainToolCfg
def DistanceInTrainToolCfg(ConfigFlags)
Definition: JetToolConfig.py:13
python.JetCommonConfig.AddJvtDecorationAlgCfg
def AddJvtDecorationAlgCfg(ConfigFlags, algName="JvtPassDecorAlg", jetContainer='AntiKt4EMTopo', **kwargs)
Definition: JetCommonConfig.py:104
python.JetRecConfig.getConstitPJGAlg
def getConstitPJGAlg(constitdef, suffix=None, flags=None, parent_jetdef=None)
Definition: JetRecConfig.py:351
python.JetCommonConfig.StandardJetsInDerivCfg
def StandardJetsInDerivCfg(ConfigFlags)
Definition: JetCommonConfig.py:26
python.JetCommonConfig.AddBadBatmanCfg
def AddBadBatmanCfg(ConfigFlags)
Definition: JetCommonConfig.py:55
python.JetJvtEfficiencyToolConfig.getJvtEffToolCfg
def getJvtEffToolCfg(flags, jetalg)
Definition: JetJvtEfficiencyToolConfig.py:16
python.JetCommonConfig.AddDistanceInTrainCfg
def AddDistanceInTrainCfg(ConfigFlags)
Definition: JetCommonConfig.py:67
python.JetToolConfig.BadBatmanToolCfg
def BadBatmanToolCfg(ConfigFlags)
Definition: JetToolConfig.py:6
python.JetCommonConfig.AddEventCleanFlagsCfg
def AddEventCleanFlagsCfg(ConfigFlags, workingPoints=['Loose', 'Tight', 'LooseLLP'])
Definition: JetCommonConfig.py:117