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, bool applyD0Bias=True, bool applyZ0Bias=False, bool applyQoverPBias=False)
	makeTrackSmearingTool (config, alg, int seed=None, str calibFile=None)

Public Attributes
	inputContainer
	containerName
	runBiasing
	biasD0
	biasZ0
	biasQoverPsagitta
	customRunNumber
	applyD0Bias
	applyZ0Bias
	applyQoverPBias
	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 ('applyD0Bias', True, type=bool,
            info=r"whether to apply the $d_0$ bias from the calibration map in the "
            "`InDetTrackBiasingTool`. Overrides the default set by the configuration.")
        self.addOption ('applyZ0Bias', False, type=bool,
            info=r"whether to apply the $z_0$ bias from the calibration map in the "
            "`InDetTrackBiasingTool`. Overrides the default set by the configuration.")
        self.addOption ('applyQoverPBias', False, type=bool,
            info=r"whether to apply the $q/p$ sagitta bias from the calibration map in the "
            "`InDetTrackBiasingTool`. Overrides the default set by the configuration.")
        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 (in MeV) 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 74 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 197 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,
                                          self.applyD0Bias,
                                          self.applyZ0Bias,
                                          self.applyQoverPBias)
                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, auxType='float')
 
        # decorate track summary information on the reconstructed object:
        if self.outputTrackSummaryInfo:
            config.addOutputVar (self.containerName, 'numberOfInnermostPixelLayerHits', 'numberOfInnermostPixelLayerHits', noSys=True, auxType='unsigned_char')
            config.addOutputVar (self.containerName, 'numberOfPixelDeadSensors', 'numberOfPixelDeadSensors', noSys=True, auxType='unsigned_char')
            config.addOutputVar (self.containerName, 'numberOfPixelHits', 'numberOfPixelHits', noSys=True, auxType='unsigned_char')
            config.addOutputVar (self.containerName, 'numberOfPixelHoles', 'numberOfPixelHoles', noSys=True, auxType='unsigned_char')
            config.addOutputVar (self.containerName, 'numberOfPixelSharedHits', 'numberOfPixelSharedHits', noSys=True, auxType='unsigned_char')
            config.addOutputVar (self.containerName, 'numberOfSCTDeadSensors', 'numberOfSCTDeadSensors', noSys=True, auxType='unsigned_char')
            config.addOutputVar (self.containerName, 'numberOfSCTHits', 'numberOfSCTHits', noSys=True, auxType='unsigned_char')
            config.addOutputVar (self.containerName, 'numberOfSCTHoles', 'numberOfSCTHoles', noSys=True, auxType='unsigned_char')
            config.addOutputVar (self.containerName, 'numberOfSCTSharedHits', 'numberOfSCTSharedHits', noSys=True, auxType='unsigned_char')
            config.addOutputVar (self.containerName, 'numberOfTRTHits', 'numberOfTRTHits', noSys=True, auxType='unsigned_char')
            config.addOutputVar (self.containerName, 'numberOfTRTOutliers', 'numberOfTRTOutliers', noSys=True, auxType='unsigned_char')
 
 

makeTrackBiasingTool()

TrackingAnalysisConfig.InDetTrackCalibrationConfig.makeTrackBiasingTool ( config, alg, float biasD0 = None, float biasZ0 = None, float biasQoverPsagitta = None, int customRunNumber = None, bool applyD0Bias = True, bool applyZ0Bias = False, bool applyQoverPBias = False )

static

Definition at line 79 of file TrackingAnalysisConfig.py.

                             applyQoverPBias    :   bool=False) :
        toolName = "biasingTool"
        config.addPrivateTool(toolName, "InDet::InDetTrackBiasingTool")
 
        # Configure calibration files and run number ranges per MC campaign.
        # Each calibration file corresponds to events with runNumberBounds[i] < runNumber <= runNumberBounds[i+1];
        # the tool matches the event run number against these ranges at runtime.
        if config.geometry() is LHCPeriod.Run2:
            if config.campaign() is Campaign.MC20a:
                # 2015 + 2016 recommendations (MC20a)
                alg.biasingTool.calibFiles = [
                    "InDetTrackSystematicsTools/CalibData_22.0_2022-v00/REL22_REPRO_2015.root",
                    "InDetTrackSystematicsTools/CalibData_22.0_2022-v00/REL22_REPRO_2016_1stPart.root",
                    "InDetTrackSystematicsTools/CalibData_22.0_2022-v00/REL22_REPRO_2016_2ndPart.root",
                ]
                alg.biasingTool.runNumberBounds = [-1, 296938, 301912, 999999]
            elif config.campaign() is Campaign.MC20d:
                # 2017 recommendations (MC20d)
                alg.biasingTool.calibFiles = [
                    "InDetTrackSystematicsTools/CalibData_22.0_2022-v00/REL22_REPRO_2017_1stPart.root",
                    "InDetTrackSystematicsTools/CalibData_22.0_2022-v00/REL22_REPRO_2017_2ndPart.root",
                ]
                alg.biasingTool.runNumberBounds = [-1, 334842, 999999]
            elif config.campaign() is Campaign.MC20e:
                # 2018 recommendations (MC20e)
                alg.biasingTool.calibFiles = [
                    "InDetTrackSystematicsTools/CalibData_22.0_2022-v00/REL22_REPRO_2018_1stPart.root",
                    "InDetTrackSystematicsTools/CalibData_22.0_2022-v00/REL22_REPRO_2018_2ndPart.root",
                ]
                alg.biasingTool.runNumberBounds = [-1, 353000, 999999]
            else:
                raise ValueError ('No biasing recommendations found for campaign \"'
                                  + config.campaign().value + '\" in Run 2. '
                                  'Please check the configuration.')
        elif config.geometry() is LHCPeriod.Run3:
            if config.campaign() is Campaign.MC23a:
                # 2022 recommendations (MC23a)
                alg.biasingTool.calibFiles = [
                    "dev/InDetTrackSystematicsTools/CalibData_25.2_2025-v00/2022_d0z0qoverp_biasing_factor.root",
                ]
            elif config.campaign() is Campaign.MC23d:
                # 2023 recommendations (MC23d)
                alg.biasingTool.calibFiles = [
                    "dev/InDetTrackSystematicsTools/CalibData_25.2_2025-v00/2023_d0z0qoverp_biasing_factor.root",
                ]
            elif config.campaign() is Campaign.MC23e:
                # 2024 recommendations (MC23e)
                alg.biasingTool.calibFiles = [
                    "dev/InDetTrackSystematicsTools/CalibData_25.2_2025-v00/2024_d0z0qoverp_biasing_factor.root",
                ]
            else:
                raise ValueError ('No biasing recommendations found for campaign \"'
                                  + config.campaign().value + '\" in Run 3. '
                                  'Please check the configuration.')
        else:
            raise ValueError ('No biasing 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
        # By default only the d0 bias is applied; z0 and q/p biasing can be enabled
        # via the applyZ0Bias / applyQoverPBias options once those maps are validated.
        alg.biasingTool.applyD0Bias    = applyD0Bias
        alg.biasingTool.applyZ0Bias    = applyZ0Bias
        alg.biasingTool.applyQoverPBias = applyQoverPBias
        alg.biasingTool.isMC = config.dataType() is not DataType.Data
        pass
 

makeTrackSmearingTool()

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

static

Definition at line 163 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

applyD0Bias

TrackingAnalysisConfig.InDetTrackCalibrationConfig.applyD0Bias

Definition at line 233 of file TrackingAnalysisConfig.py.

applyQoverPBias

TrackingAnalysisConfig.InDetTrackCalibrationConfig.applyQoverPBias

Definition at line 235 of file TrackingAnalysisConfig.py.

applyZ0Bias

TrackingAnalysisConfig.InDetTrackCalibrationConfig.applyZ0Bias

Definition at line 234 of file TrackingAnalysisConfig.py.

biasD0

TrackingAnalysisConfig.InDetTrackCalibrationConfig.biasD0

Definition at line 229 of file TrackingAnalysisConfig.py.

biasQoverPsagitta

TrackingAnalysisConfig.InDetTrackCalibrationConfig.biasQoverPsagitta

Definition at line 231 of file TrackingAnalysisConfig.py.

biasZ0

TrackingAnalysisConfig.InDetTrackCalibrationConfig.biasZ0

Definition at line 230 of file TrackingAnalysisConfig.py.

calibFile

TrackingAnalysisConfig.InDetTrackCalibrationConfig.calibFile

Definition at line 246 of file TrackingAnalysisConfig.py.

containerName

TrackingAnalysisConfig.InDetTrackCalibrationConfig.containerName

Definition at line 203 of file TrackingAnalysisConfig.py.

customRunNumber

TrackingAnalysisConfig.InDetTrackCalibrationConfig.customRunNumber

Definition at line 232 of file TrackingAnalysisConfig.py.

inputContainer

TrackingAnalysisConfig.InDetTrackCalibrationConfig.inputContainer

Definition at line 201 of file TrackingAnalysisConfig.py.

outputTrackSummaryInfo

TrackingAnalysisConfig.InDetTrackCalibrationConfig.outputTrackSummaryInfo

Definition at line 275 of file TrackingAnalysisConfig.py.

runBiasing

TrackingAnalysisConfig.InDetTrackCalibrationConfig.runBiasing

Definition at line 222 of file TrackingAnalysisConfig.py.

smearingToolSeed

TrackingAnalysisConfig.InDetTrackCalibrationConfig.smearingToolSeed

Definition at line 245 of file TrackingAnalysisConfig.py.

---

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

• TrackingAnalysisConfig.py