ATLAS Offline Software
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
python.MuonAnalysisConfig.MuonMomentumCalibrationConfig Class Reference
Inheritance diagram for python.MuonAnalysisConfig.MuonMomentumCalibrationConfig:
Collaboration diagram for python.MuonAnalysisConfig.MuonMomentumCalibrationConfig:

Public Member Functions

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

Public Attributes

str calibMode = 'correctData_CB':
 inputContainer
 containerName
 addGlobalFELinksDep
 useZeroPixMuons
 recalibratePhyslite

Detailed Description

the ConfigBlock for the muon four-momentum correction

Definition at line 15 of file MuonAnalysisConfig.py.

Constructor & Destructor Documentation

◆ __init__()

python.MuonAnalysisConfig.MuonMomentumCalibrationConfig.__init__ ( self)

Definition at line 18 of file MuonAnalysisConfig.py.

18 def __init__ (self) :
19 super (MuonMomentumCalibrationConfig, self).__init__ ()
20 self.setBlockName('Muons')
21 self.addOption ('inputContainer', '', type=str,
22 info="the name of the input muon container. If left empty, automatically defaults "
23 "to `AnalysisMuons` for PHYSLITE or `Muons` otherwise.")
24 self.addOption ('containerName', '', type=str,
25 noneAction='error',
26 info="the name of the output container after calibration.")
27 self.addOption ('postfix', "", type=str,
28 info="a postfix to apply to decorations and algorithm names. "
29 "Typically not needed here since the calibration is common to "
30 "all muons.")
31 self.addOption ('minPt', 3.0*GeV, type=float,
32 info=r"$p_\mathrm{T}$ cut (in MeV) to apply to calibrated muons.")
33 self.addOption ('recalibratePhyslite', True, type=bool,
34 info="whether to run the `CP::MuonCalibrationAndSmearingAlg` on "
35 "PHYSLITE derivations.")
36 self.addOption ('maxEta', 2.7, type=float,
37 info=r"maximum muon $\vert\eta\vert$.")
38 self.addOption ('excludeNSWFromPrecisionLayers', False, type=bool,
39 info="only for testing purposes, turn on to ignore NSW hits and "
40 "fix a crash with older derivations (p-tag <p5834).")
41 self.addOption ('calibMode', 'correctData_CB', type=str, info='calibration mode of the `MuonCalibTool` needed to turn on the sagitta bias corrections and to select the muon track calibration type (CB or ID+MS), see https://atlas-mcp.docs.cern.ch/guidelines/muonmomentumcorrections/index.html#cpmuoncalibtool-tool.')
42 self.addOption ('useZeroPixMuons', False, type=bool, info='if True, a second `MuonCalibTool` instance with calibMode=correctData_MSonly is scheduled and applied only to ZeroPixelHit muons.')
43 self.addOption ('zeroPixMuonType', None, type=int, info='muonType value used for the ZeroPix calibration tool. If left as None, the default xAOD::Muon::MuonType::ZeroPixelHit is used.')
44 self.addOption ('decorateTruth', False, type=bool,
45 info="decorate truth particle information on the reconstructed one.")
46 self.addOption ('writeColumnarToolVariables', False, type=bool,
47 info="whether to add variables needed for running the columnar muon tool(s) on the output n-tuple (EXPERIMENTAL).",
48 expertMode=True)
49 self.addOption ('addGlobalFELinksDep', False, type=bool,
50 info="whether to add dependencies for the global FE links (needed for PHYSLITE production)",
51 expertMode=True)
52

Member Function Documentation

◆ instanceName()

python.MuonAnalysisConfig.MuonMomentumCalibrationConfig.instanceName ( self)

Definition at line 53 of file MuonAnalysisConfig.py.

53 def instanceName (self) :
54 if self.postfix != "":
55 return self.postfix
56 else :
57 return self.containerName
58

◆ makeAlgs()

python.MuonAnalysisConfig.MuonMomentumCalibrationConfig.makeAlgs ( self,
config )

Definition at line 59 of file MuonAnalysisConfig.py.

59 def makeAlgs (self, config) :
60
61 log = logging.getLogger('MuonCalibrationConfig')
62
63 #make sure that this is sync with
64 #PhysicsAnalysis/MuonID/MuonIDAnalysis/MuonMomentumCorrections/MuonMomentumCorrections/MuonCalibTool.h#L31-37
65 if self.calibMode == 'correctData_CB':
66 calibMode = 0
67 elif self.calibMode == 'correctData_IDMS':
68 calibMode = 1
69 elif self.calibMode == 'notCorrectData_IDMS':
70 calibMode = 2
71 elif self.calibMode == 'notCorrectData_CB':
72 calibMode = 3
73 elif self.calibMode == 'correctData_IDonly':
74 calibMode = 4
75 elif self.calibMode == 'correctData_MSonly':
76 calibMode = 5
77 else :
78 raise ValueError ("invalid calibMode: \"" + self.calibMode + "\". Allowed values are correctData_CB, correctData_IDMS, notCorrectData_IDMS, notCorrectData_CB, correctData_IDonly, correctData_MSonly")
79
80 inputContainer = "AnalysisMuons" if config.isPhyslite() else "Muons"
81 if self.inputContainer:
82 inputContainer = self.inputContainer
83 config.setSourceName (self.containerName, inputContainer)
84 config.setContainerMeta (self.containerName, 'calibMode', calibMode)
85
86 # Set up a shallow copy to decorate
87 if config.wantCopy (self.containerName) :
88 alg = config.createAlgorithm( 'CP::AsgShallowCopyAlg', 'MuonShallowCopyAlg' )
89 alg.input = config.readName (self.containerName)
90 alg.output = config.copyName (self.containerName)
91 alg.outputType = 'xAOD::MuonContainer'
92 decorationList = ['DFCommonJetDr',
93 'DFCommonMuonPassIDCuts',
94 'DFCommonMuonPassPreselection',
95 'neflowisol20_CloseByCorr',
96 'ptvarcone30_Nonprompt_All_MaxWeightTTVA_pt1000_CloseByCorr',
97 'ptvarcone30_Nonprompt_All_MaxWeightTTVA_pt500_CloseByCorr',
98 'topoetcone20_CloseByCorr']
99 if self.addGlobalFELinksDep:
100 decorationList += ['neutralGlobalFELinks', 'chargedGlobalFELinks']
101 if config.dataType() is not DataType.Data:
102 decorationList += ['TruthLink']
103 if self.addGlobalFELinksDep or config.dataType() is not DataType.Data:
104 alg.declareDecorations = decorationList
105
106 # Set up the eta-cut on all muons prior to everything else
107 alg = config.createAlgorithm( 'CP::AsgSelectionAlg',
108 'MuonEtaCutAlg' )
109 config.addPrivateTool( 'selectionTool', 'CP::AsgPtEtaSelectionTool' )
110 alg.selectionTool.maxEta = self.maxEta
111 alg.selectionDecoration = 'selectEta' + self.postfix + ',as_bits'
112 alg.particles = config.readName (self.containerName)
113 alg.preselection = config.getPreselection (self.containerName, '')
114 config.addSelection (self.containerName, '', alg.selectionDecoration)
115
116 # Set up the muon calibration and smearing algorithm:
117 alg = config.createAlgorithm( 'CP::MuonCalibrationAndSmearingAlg',
118 'MuonCalibrationAndSmearingAlg' )
119 config.addPrivateTool( 'calibrationAndSmearingTool',
120 'CP::MuonCalibTool' )
121
122 alg.calibrationAndSmearingTool.IsRun3Geo = config.geometry() >= LHCPeriod.Run3
123 alg.calibrationAndSmearingTool.calibMode = calibMode
124 if config.geometry() is LHCPeriod.Run4:
125 log.warning("Disabling NSW hits for Run4 geometry")
126 alg.calibrationAndSmearingTool.ExcludeNSWFromPrecisionLayers = True
127 else:
128 alg.calibrationAndSmearingTool.ExcludeNSWFromPrecisionLayers = self.excludeNSWFromPrecisionLayers and (config.geometry() >= LHCPeriod.Run3)
129
130 # Optionally set up a second calibration tool applied only to ZPH muons
131 # The calibMode is set to 'correctData_MSonly'.
132 if self.useZeroPixMuons:
133 config.addPrivateTool( 'calibrationAndSmearingTool_ZeroPix',
134 'CP::MuonCalibTool' )
135 alg.calibrationAndSmearingTool_ZeroPix.IsRun3Geo = config.geometry() >= LHCPeriod.Run3
136 alg.calibrationAndSmearingTool_ZeroPix.calibMode = 5 # correctData_MSonly
137 alg.calibrationAndSmearingTool_ZeroPix.ExcludeNSWFromPrecisionLayers = alg.calibrationAndSmearingTool.ExcludeNSWFromPrecisionLayers
138 if self.zeroPixMuonType is not None:
139 alg.zeroPixMuonType = self.zeroPixMuonType
140
141 alg.muons = config.readName (self.containerName)
142 alg.muonsOut = config.copyName (self.containerName)
143 alg.preselection = config.getPreselection (self.containerName, '')
144 if config.isPhyslite() and not self.recalibratePhyslite :
145 alg.skipNominal = True
146
147 # Set up the the pt selection
148 if self.minPt > 0:
149 alg = config.createAlgorithm( 'CP::AsgSelectionAlg', 'MuonPtCutAlg' )
150 alg.selectionDecoration = 'selectPt' + self.postfix + ',as_bits'
151 config.addPrivateTool( 'selectionTool', 'CP::AsgPtEtaSelectionTool' )
152 alg.particles = config.readName (self.containerName)
153 alg.selectionTool.minPt = self.minPt
154 alg.preselection = config.getPreselection (self.containerName, '')
155 config.addSelection (self.containerName, '', alg.selectionDecoration,
156 preselection = True)
157
158 alg = config.createAlgorithm( 'CP::AsgEnergyDecoratorAlg', 'EnergyDecorator' )
159 alg.particles = config.readName (self.containerName)
160
161 config.addOutputVar (self.containerName, 'pt', 'pt')
162 config.addOutputVar (self.containerName, 'eta', 'eta', noSys=True)
163 config.addOutputVar (self.containerName, 'phi', 'phi', noSys=True)
164 config.addOutputVar (self.containerName, 'e_%SYS%', 'e')
165 config.addOutputVar (self.containerName, 'charge', 'charge', noSys=True)
166
167 # decorate truth information on the reconstructed object:
168 if self.decorateTruth and config.dataType() is not DataType.Data:
169 config.addOutputVar (self.containerName, "truthType", "truth_type", noSys=True)
170 config.addOutputVar (self.containerName, "truthOrigin", "truth_origin", noSys=True)
171
172 config.addOutputVar (self.containerName, 'muonType', 'muonType', noSys=True, enabled=self.writeColumnarToolVariables)
173
174

Member Data Documentation

◆ addGlobalFELinksDep

python.MuonAnalysisConfig.MuonMomentumCalibrationConfig.addGlobalFELinksDep

Definition at line 99 of file MuonAnalysisConfig.py.

◆ calibMode

str python.MuonAnalysisConfig.MuonMomentumCalibrationConfig.calibMode = 'correctData_CB':

Definition at line 65 of file MuonAnalysisConfig.py.

◆ containerName

python.MuonAnalysisConfig.MuonMomentumCalibrationConfig.containerName

Definition at line 83 of file MuonAnalysisConfig.py.

◆ inputContainer

python.MuonAnalysisConfig.MuonMomentumCalibrationConfig.inputContainer

Definition at line 81 of file MuonAnalysisConfig.py.

◆ recalibratePhyslite

python.MuonAnalysisConfig.MuonMomentumCalibrationConfig.recalibratePhyslite

Definition at line 144 of file MuonAnalysisConfig.py.

◆ useZeroPixMuons

python.MuonAnalysisConfig.MuonMomentumCalibrationConfig.useZeroPixMuons

Definition at line 132 of file MuonAnalysisConfig.py.

The documentation for this class was generated from the following file:
Generated on for ATLAS Offline Software by doxygen 1.16.1