TrackingAnalysisConfig.InDetTrackCalibrationConfig Class Reference

Inheritance diagram for TrackingAnalysisConfig.InDetTrackCalibrationConfig:

Collaboration diagram for TrackingAnalysisConfig.InDetTrackCalibrationConfig:

Public Member Functions
	__init__ (self)
	instanceName (self)
	makeAlgs (self, config)

Static Public Member Functions
	makeTrackBiasingTool (config, alg, float biasD0=None, float biasZ0=None, float biasQoverPsagitta=None, int customRunNumber=None)
	makeTrackSmearingTool (config, alg, int seed=None, str calibFile=None)

Public Attributes
	inputContainer
	containerName
	runBiasing
	biasD0
	biasZ0
	biasQoverPsagitta
	customRunNumber
	smearingToolSeed
	calibFile
	outputTrackSummaryInfo

Detailed Description

the ConfigBlock for the track impact parameter correction

Definition at line 12 of file TrackingAnalysisConfig.py.

Constructor & Destructor Documentation

__init__()

TrackingAnalysisConfig.InDetTrackCalibrationConfig.__init__

(

self

)

Definition at line 15 of file TrackingAnalysisConfig.py.

    def __init__ (self) :
        super (InDetTrackCalibrationConfig, self).__init__ ()
        self.setBlockName ('InDetTracks')
        self.addOption ('inputContainer', '', type=str,
            info="the name of the input track container.")
        self.addOption ('containerName', '', type=str,
            noneAction='error',
            info="the name of the output container after calibration.")
        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 tracks.")
        self.addOption ('runBiasing', True, type=bool,
            info="whether to run the `InDetTrackBiasingTool`. Allows the user to "
            "disable the tool if no recommendations are available. This should "
            "not be used in an analysis.")
        self.addOption ('biasD0', None, type=float,
            info="a manual bias to $d_0$ in mm. Will be applied by the "
            "`InDetTrackBiasingTool`. Expert option in addition to the "
            "recommendations.",
            expertMode=True)
        self.addOption ('biasZ0', None, type=float,
            info="a manual bias to $z_0$ in mm. Will be applied by the "
            "`InDetTrackBiasingTool`. Expert option in addition to the "
            "recommendations.",
            expertMode=True)
        self.addOption ('biasQoverPsagitta', None, type=float,
            info="a manual bias to $Q/p$ in TeV$^{-1}$. Will be applied "
            "by the `InDetTrackBiasingTool`. Expert option in addition to the "
            "recommendations.",
            expertMode=True)
        self.addOption ('customRunNumber', None, type=int,
            info="manually sets the `runNumber` in the `InDetTrackBiasingTool`. "
            "Expert option leads to use of different recommendations. Default is "
            "retrieved from `EventInfo`.",
            expertMode=True)
        self.addOption ('calibFile', None, type=str,
            info="name of the calibration file to use for the CTIDE "
            "calibration. Expert option to override the recommendations "
            "based on the campaign.",
            expertMode=True)
        self.addOption ('smearingToolSeed', None, type=int,
            info="random seed to be used by the `InDetTrackSmearingTool`.",
            expertMode=True)
        self.addOption ('minPt', 0.5*GeV, type=float,
            info=r"the minimum $p_\mathrm{T}$ cut to apply to calibrated tracks.")
        self.addOption ('maxEta', 2.5, type=float,
            info=r"maximum track $\vert\eta\vert$.")
        self.addOption ('outputTrackSummaryInfo', False, type=bool,
            info="decorate track summary information on the reconstructed objects.")
 

Member Function Documentation

instanceName()

TrackingAnalysisConfig.InDetTrackCalibrationConfig.instanceName

(

self

)

Return the instance name for this block

Definition at line 65 of file TrackingAnalysisConfig.py.

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

makeAlgs()

TrackingAnalysisConfig.InDetTrackCalibrationConfig.makeAlgs	(		self,
			config )

Definition at line 129 of file TrackingAnalysisConfig.py.

    def makeAlgs (self, config) :
        log = logging.getLogger('InDetTrackCalibrationConfig')
 
        inputContainer = "InDetTrackParticles"
        if self.inputContainer:
            inputContainer = self.inputContainer
        config.setSourceName (self.containerName, inputContainer)
 
        # Set up a shallow copy to decorate
        if config.wantCopy (self.containerName) :
            alg = config.createAlgorithm( 'CP::AsgShallowCopyAlg', 'InDetTrackShallowCopyAlg' )
            alg.input = config.readName (self.containerName)
            alg.output = config.copyName (self.containerName)
 
        # Set up the eta-cut on all tracks prior to everything else
        alg = config.createAlgorithm( 'CP::AsgSelectionAlg', 'InDetTrackEtaCutAlg' )
        alg.selectionDecoration = 'selectEta' + self.postfix + ',as_bits'
        config.addPrivateTool( 'selectionTool', 'CP::AsgPtEtaSelectionTool' )
        alg.selectionTool.maxEta = self.maxEta
        alg.particles = config.readName (self.containerName)
        alg.preselection = config.getPreselection (self.containerName, '')
        config.addSelection (self.containerName, '', alg.selectionDecoration)
 
        # Set up the biasing algorithm. The recommendations is to bias MC instead of unbiasing Data:
        if config.dataType() is not DataType.Data:
            if not self.runBiasing:
                log.warning('Disabling the biasing tool for now. This should not '
                            'be used in an analysis.')
            else:
                alg = config.createAlgorithm( 'CP::InDetTrackBiasingAlg', 'InDetTrackBiasingAlg' )
                self.makeTrackBiasingTool(config,
                                          alg,
                                          self.biasD0,
                                          self.biasZ0,
                                          self.biasQoverPsagitta,
                                          self.customRunNumber)
                alg.inDetTracks = config.readName (self.containerName)
                alg.inDetTracksOut = config.copyName (self.containerName)
                alg.preselection = config.getPreselection (self.containerName, '')
 
        # Set up the smearing algorithm:
        if config.dataType() is not DataType.Data:
            alg = config.createAlgorithm( 'CP::InDetTrackSmearingAlg', 'InDetTrackSmearingAlg' )
            self.makeTrackSmearingTool(config,
                                       alg,
                                       self.smearingToolSeed,
                                       self.calibFile)
            alg.inDetTracks = config.readName (self.containerName)
            alg.inDetTracksOut = config.copyName (self.containerName)
            alg.preselection = config.getPreselection (self.containerName, '')
 
        if self.minPt > 0 : # Set up the the pt selection
            alg = config.createAlgorithm( 'CP::AsgSelectionAlg', 'InDetTrackPtCutAlg' )
            alg.selectionDecoration = 'selectPt' + self.postfix + ',as_bits'
            config.addPrivateTool( 'selectionTool', 'CP::AsgPtEtaSelectionTool' )
            alg.selectionTool.minPt = self.minPt
            alg.particles = config.readName (self.containerName)
            alg.preselection = config.getPreselection (self.containerName, '')
            config.addSelection (self.containerName, '', alg.selectionDecoration,
                                 preselection=True)
 
        # Multiple variables are not included in the SmartCollection (momentum, eta, charge)
        alg = config.createAlgorithm( 'CP::InDetTrackExtraVarDecoratorAlg', 'ExtraVarDecorator' )
        alg.inDetTracks = config.readName(self.containerName)
 
        config.addOutputVar (self.containerName, 'pt_%SYS%', 'pt')
        config.addOutputVar (self.containerName, 'eta_%SYS%', 'eta', noSys=True)
        config.addOutputVar (self.containerName, 'phi', 'phi', noSys=True)
        config.addOutputVar (self.containerName, 'charge_%SYS%', 'charge', noSys=True)
        config.addOutputVar (self.containerName, 'qOverP', 'qOverP')
        config.addOutputVar (self.containerName, 'd0', 'd0')
        config.addOutputVar (self.containerName, 'z0', 'z0')
        config.addOutputVar (self.containerName, 'vz', 'vz', noSys=True)
 
        # decorate track summary information on the reconstructed object:
        if self.outputTrackSummaryInfo:
            config.addOutputVar (self.containerName, 'numberOfInnermostPixelLayerHits', 'numberOfInnermostPixelLayerHits', noSys=True)
            config.addOutputVar (self.containerName, 'numberOfPixelDeadSensors', 'numberOfPixelDeadSensors', noSys=True)
            config.addOutputVar (self.containerName, 'numberOfPixelHits', 'numberOfPixelHits', noSys=True)
            config.addOutputVar (self.containerName, 'numberOfPixelHoles', 'numberOfPixelHoles', noSys=True)
            config.addOutputVar (self.containerName, 'numberOfPixelSharedHits', 'numberOfPixelSharedHits', noSys=True)
            config.addOutputVar (self.containerName, 'numberOfSCTDeadSensors', 'numberOfSCTDeadSensors', noSys=True)
            config.addOutputVar (self.containerName, 'numberOfSCTHits', 'numberOfSCTHits', noSys=True)
            config.addOutputVar (self.containerName, 'numberOfSCTHoles', 'numberOfSCTHoles', noSys=True)
            config.addOutputVar (self.containerName, 'numberOfSCTSharedHits', 'numberOfSCTSharedHits', noSys=True)
            config.addOutputVar (self.containerName, 'numberOfTRTHits', 'numberOfTRTHits', noSys=True)
            config.addOutputVar (self.containerName, 'numberOfTRTOutliers', 'numberOfTRTOutliers', noSys=True)
 
 

makeTrackBiasingTool()

TrackingAnalysisConfig.InDetTrackCalibrationConfig.makeTrackBiasingTool ( config, alg, float biasD0 = None, float biasZ0 = None, float biasQoverPsagitta = None, int customRunNumber = None )

static

Definition at line 70 of file TrackingAnalysisConfig.py.

                             customRunNumber    :   int=None) :
        toolName = "biasingTool"
        config.addPrivateTool(toolName, "InDet::InDetTrackBiasingTool")
        if config.geometry() is LHCPeriod.Run3:
            raise ValueError ('Recommendations are not yet available in Run 3.')
        elif config.geometry() is not LHCPeriod.Run2:
            raise ValueError ('No recommendations found for geometry \"'
                              + config.geometry().value + '\". Please check '
                              'the configuration.')
        if biasD0:
            alg.biasingTool.biasD0 = biasD0
        if biasZ0:
            alg.biasingTool.biasZ0 = biasZ0
        if biasQoverPsagitta:
            alg.biasingTool.biasQoverPsagitta = biasQoverPsagitta
        if customRunNumber:
            alg.biasingTool.runNumber = customRunNumber
        pass
 

makeTrackSmearingTool()

TrackingAnalysisConfig.InDetTrackCalibrationConfig.makeTrackSmearingTool ( config, alg, int seed = None, str calibFile = None )

static

Definition at line 95 of file TrackingAnalysisConfig.py.

                              calibFile :   str=None) :
        toolName = "smearingTool"
        config.addPrivateTool(toolName, "InDet::InDetTrackSmearingTool")
        if seed:
            alg.smearingTool.Seed = seed
        if calibFile:
            alg.tackSmearingTool.calibFileIP_CTIDE = calibFile
        else:
            if config.geometry() is LHCPeriod.Run2:
                # Run 2 recommendations (MC20)
                alg.smearingTool.calibFileIP_CTIDE = "InDetTrackSystematicsTools/CalibData_22.0_2022-v00/d0z0_smearing_factors_Run2_v2.root"
            elif config.geometry() is LHCPeriod.Run3:
                if config.campaign() is Campaign.MC23a:
                    # 2022 recommendations (MC23a)
                    alg.smearingTool.calibFileIP_CTIDE = "InDetTrackSystematicsTools/CalibData_25.2_2025-v00/2022_d0z0_smearing_factors_v2.root"
                elif config.campaign() is Campaign.MC23d:
                    # 2023 recommendations (MC23d)
                    alg.smearingTool.calibFileIP_CTIDE = "InDetTrackSystematicsTools/CalibData_25.2_2025-v00/2023_d0z0_smearing_factors_v2.root"
                elif config.campaign() is Campaign.MC23e:
                    # 2024 recommendations (MC23e)
                    alg.smearingTool.calibFileIP_CTIDE = "InDetTrackSystematicsTools/CalibData_25.2_2025-v00/2024_d0z0_smearing_factors.root"
                else:
                    raise ValueError ('No recommendations found for campaign \"'
                                      + config.campaign().value + '\" in Run 3. '
                                      'Please check that the recommendations exist.')
            else:
                raise ValueError ('No recommendations found for geometry \"'
                                  + config.geometry().value + '\". Please check '
                                  'the configuration.')
        pass
 

Member Data Documentation

biasD0

TrackingAnalysisConfig.InDetTrackCalibrationConfig.biasD0

Definition at line 161 of file TrackingAnalysisConfig.py.

biasQoverPsagitta

TrackingAnalysisConfig.InDetTrackCalibrationConfig.biasQoverPsagitta

Definition at line 163 of file TrackingAnalysisConfig.py.

biasZ0

TrackingAnalysisConfig.InDetTrackCalibrationConfig.biasZ0

Definition at line 162 of file TrackingAnalysisConfig.py.

calibFile

TrackingAnalysisConfig.InDetTrackCalibrationConfig.calibFile

Definition at line 175 of file TrackingAnalysisConfig.py.

containerName

TrackingAnalysisConfig.InDetTrackCalibrationConfig.containerName

Definition at line 135 of file TrackingAnalysisConfig.py.

customRunNumber

TrackingAnalysisConfig.InDetTrackCalibrationConfig.customRunNumber

Definition at line 164 of file TrackingAnalysisConfig.py.

inputContainer

TrackingAnalysisConfig.InDetTrackCalibrationConfig.inputContainer

Definition at line 133 of file TrackingAnalysisConfig.py.

outputTrackSummaryInfo

TrackingAnalysisConfig.InDetTrackCalibrationConfig.outputTrackSummaryInfo

Definition at line 204 of file TrackingAnalysisConfig.py.

runBiasing

TrackingAnalysisConfig.InDetTrackCalibrationConfig.runBiasing

Definition at line 154 of file TrackingAnalysisConfig.py.

smearingToolSeed

TrackingAnalysisConfig.InDetTrackCalibrationConfig.smearingToolSeed

Definition at line 174 of file TrackingAnalysisConfig.py.

---

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

• TrackingAnalysisConfig.py