IP3DTagConfig Namespace Reference

Functions
	IP3DTagCfg (flags, name='IP3DTag', PrimaryVertexCollectionName="", scheme='', useBTagFlagsDefaults=True, FlipOption='STANDARD', **options)

Function Documentation

IP3DTagCfg()

IP3DTagConfig.IP3DTagCfg	(		flags,
			name = 'IP3DTag',
			PrimaryVertexCollectionName = "",
			scheme = '',
			useBTagFlagsDefaults = True,
			FlipOption = 'STANDARD',
		**	options )

Sets up a IP3DTag tool and returns it.

The following options have BTaggingFlags defaults:

Runmodus                            default: BTagging.RunModus
referenceType                       default: BTagging.ReferenceType
impactParameterView                 default: "3D"
trackGradePartitions                default: [ "Good", "BlaShared", "PixShared", "SctShared", "0HitBLayer" ]
RejectBadTracks                     default: False
jetCollectionList                   default: BTaggingFlags.Jets
unbiasIPEstimation                  default: False (switch to true (better!) when creating new PDFs)
SecVxFinderName                     default: "SV1"
UseCHypo                            default: True

input:             name: The name of the tool (should be unique).
      useBTagFlagsDefaults : Whether to use BTaggingFlags defaults for options that are not specified.
              **options: Python dictionary with options for the tool.
output: The actual tool.

Definition at line 11 of file IP3DTagConfig.py.

def IP3DTagCfg( flags, name = 'IP3DTag', PrimaryVertexCollectionName="", scheme = '', useBTagFlagsDefaults = True,FlipOption='STANDARD', **options ):
    """Sets up a IP3DTag tool and returns it.
 
    The following options have BTaggingFlags defaults:
 
    Runmodus                            default: BTagging.RunModus
    referenceType                       default: BTagging.ReferenceType
    impactParameterView                 default: "3D"
    trackGradePartitions                default: [ "Good", "BlaShared", "PixShared", "SctShared", "0HitBLayer" ]
    RejectBadTracks                     default: False
    jetCollectionList                   default: BTaggingFlags.Jets
    unbiasIPEstimation                  default: False (switch to true (better!) when creating new PDFs)
    SecVxFinderName                     default: "SV1"
    UseCHypo                            default: True
 
    input:             name: The name of the tool (should be unique).
          useBTagFlagsDefaults : Whether to use BTaggingFlags defaults for options that are not specified.
                  **options: Python dictionary with options for the tool.
    output: The actual tool."""
    acc = ComponentAccumulator()
    options['name'] = name
    options['xAODBaseName'] = 'IP3D'
    options['trackAssociationName'] = 'BTagTrackToJetAssociator'
 
    if useBTagFlagsDefaults:
        trackToVertexIPEstimator = acc.popToolsAndMerge(AtlasTrackToVertexIPEstimatorCfg(flags, 'TrkToVxIPEstimator'))
        svForIPTool = acc.popToolsAndMerge(SVForIPToolCfg('SVForIPTool'))
        trackGradeFactory = acc.popToolsAndMerge(IPDetailedTrackGradeFactoryCfg(flags, 'IP3DDetailedTrackGradeFactory'))
        trackSelectorTool = acc.popToolsAndMerge(IPTrackSelectorCfg(flags, 'IP3DTrackSelector'))
        likelihood = acc.popToolsAndMerge(NewLikelihoodToolCfg(flags, 'IP3DNewLikelihoodTool', 'IP3D', scheme))
 
        defaults = { 'Runmodus'                         : flags.BTagging.RunModus,
                     'referenceType'                    : flags.BTagging.ReferenceType,
                     'jetPtMinRef'                      : flags.BTagging.JetPtMinRef,
                     'impactParameterView'              : '3D',
                     'trackGradePartitions'             : flags.BTagging.Grades,
                     'RejectBadTracks'                  : True,
                     'jetCollectionList'                : [], #used only in reference mode
                     'unbiasIPEstimation'               : False,
                     'UseCHypo'                         : True,
                     'SecVxFinderName'                  : 'SV1',
                     'storeTrackParticles': True,
                     'storeTrackParameters': True,
                     'storeIpValues': True,
                     'LikelihoodTool'                   : likelihood,
                     'trackSelectorTool'                : trackSelectorTool,
                     'SVForIPTool'                      : svForIPTool,
                     'trackGradeFactory'                : trackGradeFactory,
                     'TrackToVertexIPEstimator'         : trackToVertexIPEstimator,
                     }
        for option in defaults:
            options.setdefault(option, defaults[option])
 
    # Define the settings for the IP3DNeg ("NEGATIVE_IP_ONLY") and IP2DFlip ("FLIP_SIGN") taggers. 
    # Set as well a different name to distinguish from the "Standard" taggers 
    
    if FlipOption=='NEGATIVE_IP_ONLY':
        negtagoptions = {
            'flipIPSign'      : True,
            'flipZIPSign'     : True,
            'usePosIP'        : True,
            'useNegIP'        : False    
        }
        # make sure that the name includes 'Neg' if setup 'Neg' tagging option
        nameNeg=''
        if 'NegTag' in name:
            nameNeg=name
        elif 'Tag' in name:
            nameNeg=name.replace("Tag","NegTag")
        else:
            nameNeg=name+"Neg"
        options['name'] = nameNeg
        options['xAODBaseName'] = 'IP3DNeg' 
        for option in negtagoptions:
            options.setdefault(option, negtagoptions[option])   
 
    elif FlipOption=='FLIP_SIGN':
        fliptagoptions = {
            'flipIPSign'                   : True,
            'flipZIPSign'                  : True, #would naively say 'True' but in Rel.21 (https://gitlab.cern.ch/atlas/athena/-/blob/21.2/PhysicsAnalysis/JetTagging/JetTagAlgs/BTagging/python/BTaggingConfiguration_IP3DFlipTag.py), the default from 'False' is not changed
            'usePosIP'                     : True,
            'useNegIP'                     : True
        }
        nameFlip=''
        if 'FlipTag' in name:
            nameFlip=name
        elif 'Tag' in name:
            nameFlip=name.replace("Tag","FlipTag")
        else:
            nameFlip=name+"Flip"
        options['name'] = nameFlip
        options['xAODBaseName'] = 'IP3DFlip'
        for option in fliptagoptions:
            options.setdefault(option, fliptagoptions[option])    
 
 
    acc.setPrivateTools(CompFactory.Analysis.IPTag( **options))
   
    return acc