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.

    def __init__ (self) :
        super (MuonMomentumCalibrationConfig, self).__init__ ()
        self.setBlockName('Muons')
        self.addOption ('inputContainer', '', type=str,
            info="the name of the input muon container. If left empty, automatically defaults "
            "to `AnalysisMuons` for PHYSLITE or `Muons` otherwise.")
        self.addOption ('containerName', '', type=str,
            noneAction='error',
            info="the name of the output container after calibration.",
            meta={'role':'container'})
        self.addOption ('postfix', "", type=str,
            info="a postfix to apply to decorations and algorithm names. "
            "Typically not needed here since the calibration is common to "
            "all muons.")
        self.addOption ('minPt', 3.0*GeV, type=float,
            info=r"$p_\mathrm{T}$ cut (in MeV) to apply to calibrated muons.")
        self.addOption ('recalibratePhyslite', True, type=bool,
            info="whether to run the `CP::MuonCalibrationAndSmearingAlg` on "
            "PHYSLITE derivations.")
        self.addOption ('maxEta', 2.7, type=float,
            info=r"maximum muon $\vert\eta\vert$.")
        self.addOption ('excludeNSWFromPrecisionLayers', False, type=bool,
            info="only for testing purposes, turn on to ignore NSW hits and "
            "fix a crash with older derivations (p-tag <p5834).")
        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.', meta={'choices':(['correctData_CB','correctData_IDMS','notCorrectData_IDMS','notCorrectData_CB','correctData_IDonly','correctData_MSonly'],1)})
        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.')
        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.')
        self.addOption ('decorateTruth', False, type=bool,
            info="decorate truth particle information on the reconstructed one.")
        self.addOption ('writeColumnarToolVariables', False, type=bool,
            info="whether to add variables needed for running the columnar muon tool(s) on the output n-tuple (EXPERIMENTAL).",
            expertMode=True)
        self.addOption ('addGlobalFELinksDep', False, type=bool,
            info="whether to add dependencies for the global FE links (needed for PHYSLITE production)",
            expertMode=True)
 

Member Function Documentation

instanceName()

python.MuonAnalysisConfig.MuonMomentumCalibrationConfig.instanceName

(

self

)

Definition at line 54 of file MuonAnalysisConfig.py.

    def instanceName (self) :
        if self.postfix != "":
            return self.postfix
        else :
            return self.containerName
 

makeAlgs()

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

Definition at line 60 of file MuonAnalysisConfig.py.

    def makeAlgs (self, config) :
 
        log = logging.getLogger('MuonCalibrationConfig')
 
        #make sure that this is sync with
        #PhysicsAnalysis/MuonID/MuonIDAnalysis/MuonMomentumCorrections/MuonMomentumCorrections/MuonCalibTool.h#L31-37
        if self.calibMode == 'correctData_CB':
            calibMode = 0
        elif self.calibMode == 'correctData_IDMS':
            calibMode = 1
        elif self.calibMode == 'notCorrectData_IDMS':
            calibMode = 2
        elif self.calibMode == 'notCorrectData_CB':
            calibMode = 3
        elif self.calibMode == 'correctData_IDonly':
            calibMode = 4
        elif self.calibMode == 'correctData_MSonly':
            calibMode = 5
        else :
            raise ValueError ("invalid calibMode: \"" + self.calibMode + "\". Allowed values are correctData_CB, correctData_IDMS, notCorrectData_IDMS, notCorrectData_CB, correctData_IDonly, correctData_MSonly")
 
        inputContainer = "AnalysisMuons" if config.isPhyslite() else "Muons"
        if self.inputContainer:
            inputContainer = self.inputContainer
        config.setSourceName (self.containerName, inputContainer)
        config.setContainerMeta (self.containerName, 'calibMode', calibMode)
 
        # Set up a shallow copy to decorate
        if config.wantCopy (self.containerName) :
            alg = config.createAlgorithm( 'CP::AsgShallowCopyAlg', 'MuonShallowCopyAlg' )
            alg.input = config.readName (self.containerName)
            alg.output = config.copyName (self.containerName)
            alg.outputType = 'xAOD::MuonContainer'
            decorationList = ['DFCommonJetDr',
                              'DFCommonMuonPassIDCuts',
                              'DFCommonMuonPassPreselection',
                              'neflowisol20_CloseByCorr',
                              'ptvarcone30_Nonprompt_All_MaxWeightTTVA_pt1000_CloseByCorr',
                              'ptvarcone30_Nonprompt_All_MaxWeightTTVA_pt500_CloseByCorr',
                              'topoetcone20_CloseByCorr',
                              'PLIT_TPLTmu_pmuxpromp', 'PLIT_TPLTmu_pnpxall']
            if self.addGlobalFELinksDep:
                decorationList += ['neutralGlobalFELinks', 'chargedGlobalFELinks']
            if config.dataType() is not DataType.Data:
                decorationList += ['TruthLink']
            if self.addGlobalFELinksDep or config.dataType() is not DataType.Data:
                alg.declareDecorations = decorationList
 
        # Set up the eta-cut on all muons prior to everything else
        alg = config.createAlgorithm( 'CP::AsgSelectionAlg',
                               'MuonEtaCutAlg' )
        config.addPrivateTool( 'selectionTool', 'CP::AsgPtEtaSelectionTool' )
        alg.selectionTool.maxEta = self.maxEta
        alg.selectionDecoration = 'selectEta' + self.postfix + ',as_bits'
        alg.particles = config.readName (self.containerName)
        alg.preselection = config.getPreselection (self.containerName, '')
        config.addSelection (self.containerName, '', alg.selectionDecoration)
 
        # Set up the muon calibration and smearing algorithm:
        alg = config.createAlgorithm( 'CP::MuonCalibrationAndSmearingAlg',
                               'MuonCalibrationAndSmearingAlg' )
        config.addPrivateTool( 'calibrationAndSmearingTool',
                        'CP::MuonCalibTool' )
 
        alg.calibrationAndSmearingTool.IsRun3Geo = config.geometry() >= LHCPeriod.Run3
        alg.calibrationAndSmearingTool.calibMode = calibMode
        if config.geometry() is LHCPeriod.Run4:
            log.warning("Disabling NSW hits for Run4 geometry")
            alg.calibrationAndSmearingTool.ExcludeNSWFromPrecisionLayers = True
        else:
            alg.calibrationAndSmearingTool.ExcludeNSWFromPrecisionLayers = self.excludeNSWFromPrecisionLayers and (config.geometry() >= LHCPeriod.Run3)
 
        # Optionally set up a second calibration tool applied only to ZPH muons
        # The calibMode is set to 'correctData_MSonly'.
        if self.useZeroPixMuons:
            config.addPrivateTool( 'calibrationAndSmearingTool_ZeroPix',
                            'CP::MuonCalibTool' )
            alg.calibrationAndSmearingTool_ZeroPix.IsRun3Geo = config.geometry() >= LHCPeriod.Run3
            alg.calibrationAndSmearingTool_ZeroPix.calibMode = 5 # correctData_MSonly
            alg.calibrationAndSmearingTool_ZeroPix.ExcludeNSWFromPrecisionLayers = alg.calibrationAndSmearingTool.ExcludeNSWFromPrecisionLayers
            if self.zeroPixMuonType is not None:
                alg.zeroPixMuonType = self.zeroPixMuonType
 
        alg.muons = config.readName (self.containerName)
        alg.muonsOut = config.copyName (self.containerName)
        alg.preselection = config.getPreselection (self.containerName, '')
        if config.isPhyslite() and not self.recalibratePhyslite :
            alg.skipNominal = True
 
        # Set up the the pt selection
        if self.minPt > 0:
            alg = config.createAlgorithm( 'CP::AsgSelectionAlg', 'MuonPtCutAlg' )
            alg.selectionDecoration = 'selectPt' + self.postfix + ',as_bits'
            config.addPrivateTool( 'selectionTool', 'CP::AsgPtEtaSelectionTool' )
            alg.particles = config.readName (self.containerName)
            alg.selectionTool.minPt = self.minPt
            alg.preselection = config.getPreselection (self.containerName, '')
            config.addSelection (self.containerName, '', alg.selectionDecoration,
                                preselection = True)
 
        alg = config.createAlgorithm( 'CP::AsgEnergyDecoratorAlg', 'EnergyDecorator' )
        alg.particles = config.readName (self.containerName)
 
        config.addOutputVar (self.containerName, 'pt', 'pt')
        config.addOutputVar (self.containerName, 'eta', 'eta', noSys=True)
        config.addOutputVar (self.containerName, 'phi', 'phi', noSys=True)
        config.addOutputVar (self.containerName, 'e_%SYS%', 'e')
        config.addOutputVar (self.containerName, 'charge', 'charge', noSys=True)
 
        # decorate truth information on the reconstructed object:
        if self.decorateTruth and config.dataType() is not DataType.Data:
            config.addOutputVar (self.containerName, "truthType", "truth_type", noSys=True)
            config.addOutputVar (self.containerName, "truthOrigin", "truth_origin", noSys=True)
        
        config.addOutputVar (self.containerName, 'muonType', 'muonType', noSys=True, enabled=self.writeColumnarToolVariables)
 
 

Member Data Documentation

addGlobalFELinksDep

python.MuonAnalysisConfig.MuonMomentumCalibrationConfig.addGlobalFELinksDep

Definition at line 101 of file MuonAnalysisConfig.py.

calibMode

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

Definition at line 66 of file MuonAnalysisConfig.py.

containerName

python.MuonAnalysisConfig.MuonMomentumCalibrationConfig.containerName

Definition at line 84 of file MuonAnalysisConfig.py.

inputContainer

python.MuonAnalysisConfig.MuonMomentumCalibrationConfig.inputContainer

Definition at line 82 of file MuonAnalysisConfig.py.

recalibratePhyslite

python.MuonAnalysisConfig.MuonMomentumCalibrationConfig.recalibratePhyslite

Definition at line 146 of file MuonAnalysisConfig.py.

useZeroPixMuons

python.MuonAnalysisConfig.MuonMomentumCalibrationConfig.useZeroPixMuons

Definition at line 134 of file MuonAnalysisConfig.py.

---

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

• MuonAnalysisConfig.py