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

Detailed Description

the ConfigBlock for the tau four-momentum correction

Definition at line 28 of file TauAnalysisConfig.py.

Constructor & Destructor Documentation

◆ __init__()

python.TauAnalysisConfig.TauCalibrationConfig.__init__ ( self)

Definition at line 31 of file TauAnalysisConfig.py.

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

Member Function Documentation

◆ instanceName()

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

Definition at line 60 of file TauAnalysisConfig.py.

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

◆ makeAlgs()

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

Definition at line 64 of file TauAnalysisConfig.py.

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

Member Data Documentation

◆ addGlobalFELinksDep

python.TauAnalysisConfig.TauCalibrationConfig.addGlobalFELinksDep

Definition at line 96 of file TauAnalysisConfig.py.

◆ containerName

python.TauAnalysisConfig.TauCalibrationConfig.containerName

Definition at line 80 of file TauAnalysisConfig.py.

◆ decorateExtraVariables

python.TauAnalysisConfig.TauCalibrationConfig.decorateExtraVariables

Definition at line 138 of file TauAnalysisConfig.py.

◆ inputContainer

python.TauAnalysisConfig.TauCalibrationConfig.inputContainer

Definition at line 67 of file TauAnalysisConfig.py.


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