ATLAS Offline Software
Loading...
Searching...
No Matches
python.TauAnalysisConfig.TauCalibrationConfig Class Reference
Inheritance diagram for python.TauAnalysisConfig.TauCalibrationConfig:
Collaboration diagram for python.TauAnalysisConfig.TauCalibrationConfig:

Public Member Functions

 __init__ (self)
 instanceName (self)
 makeAlgs (self, config)

Public Attributes

 inputContainer
 containerName
 addGlobalFELinksDep
 decorateExtraVariables
 useGNTau

Detailed Description

the ConfigBlock for the tau four-momentum correction

Definition at line 14 of file TauAnalysisConfig.py.

Constructor & Destructor Documentation

◆ __init__()

python.TauAnalysisConfig.TauCalibrationConfig.__init__ ( self)

Definition at line 17 of file TauAnalysisConfig.py.

17 def __init__ (self) :
18 super (TauCalibrationConfig, self).__init__ ()
19 self.setBlockName('Taus')
20 self.addOption ('inputContainer', '', type=str,
21 info="the name of the input tau-jet container. If left empty, automatically defaults "
22 "to `'AnalysisTauJets'` for PHYSLITE and `'TauJets'` otherwise.")
23 self.addOption ('containerName', '', type=str,
24 noneAction='error',
25 info="the name of the output container after calibration.")
26 self.addOption ('postfix', '', type=str,
27 info="a postfix to apply to decorations and algorithm names. "
28 "Typically not needed here since the calibration is common to "
29 "all tau-jets.")
30 self.addOption ('rerunTruthMatching', True, type=bool,
31 info="whether to rerun truth matching (sets up an instance of "
32 "`CP::TauTruthMatchingAlg`).")
33 self.addOption ('decorateTruth', False, type=bool,
34 info="decorate the truth particle information on the reconstructed one.")
35 self.addOption ('decorateExtraVariables', True, type=bool,
36 info="decorate extra variables for the reconstructed tau-jet.")
37 self.addOption ('addGlobalFELinksDep', False, type=bool,
38 info="whether to add dependencies for the global FE links (needed for PHYSLITE production)",
39 expertMode=True)
40 self.addOption ('useGNTau', False, type=bool,
41 info="use GNTau-based ID instead of RNNTau ID. "
42 "Recommendations: experimental feature and might become default soon.",
43 expertMode=True)
44

Member Function Documentation

◆ instanceName()

python.TauAnalysisConfig.TauCalibrationConfig.instanceName ( self)
Return the instance name for this block

Definition at line 45 of file TauAnalysisConfig.py.

45 def instanceName (self) :
46 """Return the instance name for this block"""
47 return self.containerName + self.postfix
48

◆ makeAlgs()

python.TauAnalysisConfig.TauCalibrationConfig.makeAlgs ( self,
config )

Definition at line 49 of file TauAnalysisConfig.py.

49 def makeAlgs (self, config) :
50
51 # protection for EleRM taus, which are available only from 2024 onward
52 if 'EleRM' in self.inputContainer:
53 if config.dataType() is DataType.Data and config.dataYear() <= 2023:
54 raise RuntimeError("EleRM taus are only available from 2024 dataset onward")
55 elif config.dataType() is not DataType.Data and config.campaign() <= Campaign.MC23d:
56 raise RuntimeError("EleRM taus are only available from 2024 dataset onward")
57
58 postfix = self.postfix
59 if postfix != '' and postfix[0] != '_' :
60 postfix = '_' + postfix
61
62 inputContainer = "AnalysisTauJets" if config.isPhyslite() else "TauJets"
63 if self.inputContainer:
64 inputContainer = self.inputContainer
65 config.setSourceName (self.containerName, inputContainer)
66
67 # Set up a shallow copy to decorate
68 if config.wantCopy (self.containerName) :
69 alg = config.createAlgorithm( 'CP::AsgShallowCopyAlg', 'TauShallowCopyAlg' )
70 alg.input = config.readName (self.containerName)
71 alg.output = config.copyName (self.containerName)
72 alg.outputType = 'xAOD::TauJetContainer'
73 decorations = []
74 if self.addGlobalFELinksDep:
75 decorations += ['neutralGlobalFELinks', 'chargedGlobalFELinks']
76 if config.dataType() is not DataType.Data:
77 decorations += ['IsTruthMatched', 'truthJetLink', 'truthParticleLink']
78 if decorations:
79 alg.declareDecorations = decorations
80
81 # Set up the tau truth matching algorithm:
82 if self.rerunTruthMatching and config.dataType() is not DataType.Data:
83 alg = config.createAlgorithm( 'CP::TauTruthMatchingAlg',
84 'TauTruthMatchingAlg' )
85 config.addPrivateTool( 'matchingTool',
86 'TauAnalysisTools::TauTruthMatchingTool' )
87 alg.matchingTool.TruthJetContainerName = 'AntiKt4TruthDressedWZJets'
88 alg.taus = config.readName (self.containerName)
89 alg.preselection = config.getPreselection (self.containerName, '')
90
91 # decorate truth tau information on the reconstructed object:
92 if self.decorateTruth and config.dataType() is not DataType.Data:
93 alg = config.createAlgorithm( 'CP::TauTruthDecorationsAlg',
94 'TauTruthDecorationsAlg',
95 reentrant=True )
96 alg.taus = config.readName (self.containerName, nominal=True)
97 alg.doubleDecorations = ['pt_vis', 'pt_invis', 'eta_vis', 'eta_invis', 'phi_vis', 'phi_invis', 'm_vis', 'm_invis']
98 alg.floatDecorations = []
99 alg.intDecorations = ['pdgId']
100 alg.unsignedIntDecorations = ['classifierParticleOrigin', 'classifierParticleType']
101 alg.charDecorations = ['IsHadronicTau']
102 alg.prefix = 'truth_'
103
104 # these are "_ListHelper" objects, and not "list", need to copy to lists to allow concatenate
105 for var in ['DecayMode', 'ParticleType', 'PartonTruthLabelID'] + alg.doubleDecorations[:] + alg.floatDecorations[:] + alg.intDecorations[:] + alg.unsignedIntDecorations[:] + alg.charDecorations[:]:
106 branchName = alg.prefix + var
107 if 'classifierParticle' in var:
108 branchOutput = alg.prefix + var.replace('classifierParticle', '').lower()
109 else:
110 branchOutput = branchName
111 config.addOutputVar (self.containerName, branchName, branchOutput, noSys=True)
112
113 # Decorate extra variables
114 if self.decorateExtraVariables:
115 alg = config.createAlgorithm( 'CP::TauExtraVariablesAlg',
116 'TauExtraVariablesAlg',
117 reentrant=True )
118 alg.taus = config.readName (self.containerName, nominal=True)
119
120 # Set up the tau 4-momentum smearing algorithm:
121 alg = config.createAlgorithm( 'CP::TauSmearingAlg', 'TauSmearingAlg' )
122 config.addPrivateTool( 'smearingTool', 'TauAnalysisTools::TauSmearingTool' )
123 alg.smearingTool.useFastSim = config.dataType() is DataType.FastSim
124 alg.smearingTool.Campaign = "mc23" if config.geometry() is LHCPeriod.Run3 else "mc20"
125 if config.geometry() is LHCPeriod.Run2 and self.useGNTau:
126 raise RuntimeError("Tau Smearing recommendations with GNTau are not yet available for Run2")
127 alg.smearingTool.useGNTau = self.useGNTau
128 alg.taus = config.readName (self.containerName)
129 alg.tausOut = config.copyName (self.containerName)
130 config.setExtraOutputs ({('xAOD::IParticleContainer' , 'StoreGateSvc+' + config.readName(self.containerName, nominal=True) + '.RNNEleScoreSigTrans_v1')})
131 alg.preselection = config.getPreselection (self.containerName, '')
132
133 # Additional decorations
134 alg = config.createAlgorithm( 'CP::AsgEnergyDecoratorAlg', 'EnergyDecorator' )
135 alg.particles = config.readName (self.containerName)
136
137 config.addOutputVar (self.containerName, 'pt', 'pt')
138 config.addOutputVar (self.containerName, 'eta', 'eta', noSys=True)
139 config.addOutputVar (self.containerName, 'phi', 'phi', noSys=True)
140 config.addOutputVar (self.containerName, 'e_%SYS%', 'e')
141 config.addOutputVar (self.containerName, 'charge', 'charge', noSys=True)
142 config.addOutputVar (self.containerName, 'NNDecayMode', 'NNDecayMode', noSys=True, auxType='int')
143 config.addOutputVar (self.containerName, 'passTATTauMuonOLR', 'passTATTauMuonOLR', noSys=True, auxType='char')
144 config.addOutputVar (self.containerName, 'TESCompatibility', 'TESCompatibility')
145 if self.decorateExtraVariables:
146 config.addOutputVar (self.containerName, 'nTracksCharged', 'nTracksCharged', noSys=True)
147
148

Member Data Documentation

◆ addGlobalFELinksDep

python.TauAnalysisConfig.TauCalibrationConfig.addGlobalFELinksDep

Definition at line 74 of file TauAnalysisConfig.py.

◆ containerName

python.TauAnalysisConfig.TauCalibrationConfig.containerName

Definition at line 65 of file TauAnalysisConfig.py.

◆ decorateExtraVariables

python.TauAnalysisConfig.TauCalibrationConfig.decorateExtraVariables

Definition at line 114 of file TauAnalysisConfig.py.

◆ inputContainer

python.TauAnalysisConfig.TauCalibrationConfig.inputContainer

Definition at line 52 of file TauAnalysisConfig.py.

◆ useGNTau

python.TauAnalysisConfig.TauCalibrationConfig.useGNTau

Definition at line 125 of file TauAnalysisConfig.py.


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