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 26 of file TauAnalysisConfig.py.

Constructor & Destructor Documentation

◆ __init__()

python.TauAnalysisConfig.TauCalibrationConfig.__init__ ( self)

Definition at line 29 of file TauAnalysisConfig.py.

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

Member Function Documentation

◆ instanceName()

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

Definition at line 58 of file TauAnalysisConfig.py.

58 def instanceName (self) :
59 """Return the instance name for this block"""
60 return self.containerName + self.postfix
61

◆ makeAlgs()

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

Definition at line 62 of file TauAnalysisConfig.py.

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

Member Data Documentation

◆ addGlobalFELinksDep

python.TauAnalysisConfig.TauCalibrationConfig.addGlobalFELinksDep

Definition at line 94 of file TauAnalysisConfig.py.

◆ containerName

python.TauAnalysisConfig.TauCalibrationConfig.containerName

Definition at line 78 of file TauAnalysisConfig.py.

◆ decorateExtraVariables

python.TauAnalysisConfig.TauCalibrationConfig.decorateExtraVariables

Definition at line 136 of file TauAnalysisConfig.py.

◆ inputContainer

python.TauAnalysisConfig.TauCalibrationConfig.inputContainer

Definition at line 65 of file TauAnalysisConfig.py.

◆ useGNTau

python.TauAnalysisConfig.TauCalibrationConfig.useGNTau

Definition at line 147 of file TauAnalysisConfig.py.


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