TrackingAnalysisConfig.InDetTrackWorkingPointConfig Class Reference

Inheritance diagram for TrackingAnalysisConfig.InDetTrackWorkingPointConfig:

Collaboration diagram for TrackingAnalysisConfig.InDetTrackWorkingPointConfig:

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

Public Attributes
	additionalCuts
	runTruthFilter
str	cutLevel = "Loose":
	calibFile
	containerName
	selectionName

Detailed Description

the ConfigBlock for the track working point

Definition at line 236 of file TrackingAnalysisConfig.py.

Constructor & Destructor Documentation

__init__()

TrackingAnalysisConfig.InDetTrackWorkingPointConfig.__init__

(

self

)

Definition at line 239 of file TrackingAnalysisConfig.py.

    def __init__ (self) :
        super().__init__ ()
        self.addOption ('containerName', '', type=str,
            noneAction='error',
            info="the name of the input container.",
            meta={'role':'containerRef'})
        self.addOption ('selectionName', '', type=str,
            noneAction='error',
            info="the name of the track selection to define (e.g. `tightPrimary` "
            "or `loose`).",
            meta={'role':'selection'})
        self.addOption ('postfix', None, type=str,
            info="a postfix to apply to decorations and algorithm names. "
            "Typically not needed here as `selectionName` is used internally.")
        self.addOption ('cutLevel', None, type=str,
            noneAction='error',
            info="the selection WP to use. Supported WPs for general "
            "use: `Loose` and `TightPrimary`. For expert studies, further "
            "WPs are available: `NoCut`, `LoosePrimary`, `LooseElectron`, "
            "`LooseMuon`, `LooseTau`, `MinBias`, `HILoose`, `HITight`, "
            "`HILooseOptimized`, `HITightOptimized`.",
            expertMode=["NoCut", "LoosePrimary", "LooseElectron",
            "LooseMuon", "LooseTau", "MinBias", "HILoose", "HITight",
            "HILooseOptimized", "HITightOptimized"],
            meta={'choices':(['Loose','TightPrimary','NoCut','LoosePrimary','LooseElectron','LooseMuon','LooseTau','MinBias','HILoose','HITight','HILooseOptimized','HITightOptimized'],1)})
        self.addOption ('additionalCuts', None, type=dict,
            info="additional cuts to modify the selection WP. Only meant for "
            "expert studies of track selection. Passed as pairs of `cutName: value`. "
            "For an overview of available cuts, see twiki.cern.ch/twiki/bin/viewauth/"
            "AtlasProtected/InDetTrackSelectionTool#List_of_possible_cuts.",
            expertMode=True)
        self.addOption ('vertexContainer', None, type=str,
            info="A vertex collection to be used by the additionalCuts. The leading "
            "primary vertex is passed to the selectionTool to calculate the distance "
            "in the maxZ0 cuts.",
            expertMode=True)
        self.addOption ('runTruthFilter', True, type=bool,
            info="whether to run the `TruthFilterTool`. This tool is only compatible "
            "with the cut levels `Loose` and `TightPrimary`.")
        self.addOption ('calibFile', None, type=str,
            info="name of the calibration file to use for efficiencies "
            "in the `TruthFilter` tool. Expert option to override the "
            "recommendations based on the campaign.",
            expertMode=True)
        self.addOption ('filterToolSeed', None, type=int,
            info="random seed to be used by the `InDetTrackTruthFilterTool`.",
            expertMode=True)
        self.addOption ('fFakeLoose', None, type=float,
            info="the fraction of fake tracks in the `Loose` working point. "
            "Will be used by the `InDetTrackTruthFilterTool`. Expert option to "
            "override the recommendations.",
            expertMode=True)
        self.addOption ('fFakeTight', None, type=float,
            info="the fraction of fake tracks in the `TightPrimary` working "
            "point. Will be used by the `InDetTrackTruthFilterTool`. Expert option "
            "to override the recommendations.",
            expertMode=True)
        self.addOption ('trkEffSystScale', None, type=float,
            info="the track efficiency systematic scale. Will be used "
            "by the `InDetTrackTruthFilterTool`. Expert option to override the "
            "recommendations.",
            expertMode=True)
        self.addOption ('addSelectionToPreselection', True, type=bool,
            info="whether to retain only tracks satisfying the `cutLevel` "
            "requirements.")
 

Member Function Documentation

instanceName()

TrackingAnalysisConfig.InDetTrackWorkingPointConfig.instanceName

(

self

)

Return the instance name for this block

Definition at line 305 of file TrackingAnalysisConfig.py.

    def instanceName (self) :
        """Return the instance name for this block"""
        if self.postfix is not None:
            return self.containerName + self.selectionName + self.postfix
        else:
            return self.containerName + self.selectionName
 

makeAlgs()

TrackingAnalysisConfig.InDetTrackWorkingPointConfig.makeAlgs	(		self,
			config )

Definition at line 312 of file TrackingAnalysisConfig.py.

    def makeAlgs (self, config) :
        log = logging.getLogger('InDetTrackWorkingPointConfig')
 
        selectionPostfix = self.selectionName
        if selectionPostfix != '' and selectionPostfix[0] != '_' :
            selectionPostfix = '_' + selectionPostfix
 
        postfix = self.postfix
        if postfix is None :
            postfix = self.selectionName
        if postfix != '' and postfix[0] != '_' :
            postfix = '_' + postfix
 
        cutLevels = ["NoCut", "Loose", "LoosePrimary", "TightPrimary", "LooseMuon",
                     "LooseElectron", "LooseTau", "MinBias", "HILoose", "HITight",
                     "HILooseOptimized", "HITightOptimized"]
        alg = config.createAlgorithm( 'CP::InDetTrackSelectionAlg', 'InDetTrackSelectionAlg' )
        alg.selectionDecoration = 'selectTrack' + postfix + '_%SYS%,as_bits'
        config.addPrivateTool( 'selectionTool', 'InDet::InDetTrackSelectionTool')
        if self.cutLevel is None:
            log.warning("No selection WP chosen, InDetTrackSelectionTool will run with its default cut level.")
        elif self.cutLevel not in cutLevels:
            raise ValueError (f'Invalid cut level: "{self.cutLevel}", has '
                              'to be one of: ' + ', '.join(cutLevels))
        elif self.cutLevel in ["Loose", "TightPrimary"]:
            alg.selectionTool.CutLevel = self.cutLevel
        else:
            log.warning(f'Using cut level: "{self.cutLevel}" that is not '
                        'meant for general use, but only expert studies.')
            alg.selectionTool.CutLevel = self.cutLevel
 
        if self.additionalCuts:
            for cutName, value in self.additionalCuts.items():
                setattr(alg.selectionTool, cutName, value)
        if self.vertexContainer is not None:
            alg.vertices = self.vertexContainer
 
        # Set up the truth filtering algorithm:
        if config.dataType() is not DataType.Data:
            if self.runTruthFilter:
                if config.isPhyslite():
                    log.warning ('The TruthFilterTool is not compatible with Physlite mode. '
                                 'This tool is skipped for now. Please set "runTruthFilter: '
                                 'False" to get rid of this warning.')
                else:
                    config.addPrivateTool( 'filterTool', 'InDet::InDetTrackTruthFilterTool' )
                    config.addPrivateTool( 'filterTool.trackOriginTool', 'InDet::InDetTrackTruthOriginTool' )
                    # Set working point based on cut level
                    if self.cutLevel == "Loose":
                        alg.filterWP = "LOOSE"
                    elif self.cutLevel == "TightPrimary":
                        alg.filterWP = "TIGHT"
                    else:
                        raise ValueError (f'Attempting to set TruthFilter WP based on cut level: "{self.cutLevel}" '
                                          'that is not supported.')
                    # Set calibFile and fake rates based on campaign
                    if config.geometry() is LHCPeriod.Run2:
                        # Run 2 recommendations (MC20)
                        alg.filterTool.calibFileNomEff = "InDetTrackSystematicsTools/CalibData_22.0_2022-v00/TrackingRecommendations_prelim_rel22.root"
                        alg.filterTool.fFakeLoose = 0.10
                        alg.filterTool.fFakeTight = 1.00
                    elif config.geometry() is LHCPeriod.Run3:
                        if config.campaign() in [Campaign.MC23a, Campaign.MC23d, Campaign.MC23e, Campaign.MC23g]:
                            # 2022/23/24/25/26 recommendations (MC23a/d/e/g)
                            alg.filterTool.calibFileNomEff = "InDetTrackSystematicsTools/CalibData_22.0_2022-v00/TrackingRecommendations_prelim_rel22.root"
                            alg.filterTool.fFakeLoose = 0.40
                            alg.filterTool.fFakeTight = 1.00
                        elif not (self.calibFile and self.fFakeLoose is not None and self.fFakeTight is not None):
                            raise ValueError (f'No efficiency recommendations found for campaign "{config.campaign().value}" in Run 3. '
                                              'Please check that the recommendations exist.')
                    elif not (self.calibFile and self.fFakeLoose is not None and self.fFakeTight is not None):
                        raise ValueError (f'No efficiency recommendations found for geometry "{config.geometry().value}". Please check '
                                          'the configuration.')
                    # Set custom calibFile, fake rates, or random seed
                    if self.calibFile:
                        alg.filterTool.calibFileNomEff = self.calibFile
                    if self.fFakeLoose is not None:
                        alg.filterTool.fFakeLoose = self.fFakeLoose
                    if self.fFakeTight is not None:
                        alg.filterTool.fFakeTight = self.fFakeTight
                    if self.filterToolSeed is not None:
                        alg.filterTool.Seed = self.filterToolSeed
                    if self.trkEffSystScale is not None:
                        alg.filterTool.trkEffSystScale = self.trkEffSystScale
        alg.inDetTracks = config.readName (self.containerName)
        alg.preselection = config.getPreselection (self.containerName, '')
        config.addSelection (self.containerName, self.selectionName, alg.selectionDecoration,
                             preselection=self.addSelectionToPreselection)

Member Data Documentation

additionalCuts

TrackingAnalysisConfig.InDetTrackWorkingPointConfig.additionalCuts

Definition at line 343 of file TrackingAnalysisConfig.py.

calibFile

TrackingAnalysisConfig.InDetTrackWorkingPointConfig.calibFile

Definition at line 386 of file TrackingAnalysisConfig.py.

containerName

TrackingAnalysisConfig.InDetTrackWorkingPointConfig.containerName

Definition at line 398 of file TrackingAnalysisConfig.py.

cutLevel

str TrackingAnalysisConfig.InDetTrackWorkingPointConfig.cutLevel = "Loose":

Definition at line 360 of file TrackingAnalysisConfig.py.

runTruthFilter

TrackingAnalysisConfig.InDetTrackWorkingPointConfig.runTruthFilter

Definition at line 351 of file TrackingAnalysisConfig.py.

selectionName

TrackingAnalysisConfig.InDetTrackWorkingPointConfig.selectionName

Definition at line 398 of file TrackingAnalysisConfig.py.

---

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

• TrackingAnalysisConfig.py