python.TrkVertexWeightCalculatorsConfig Namespace Reference

Functions
	SumPt2VertexWeightCalculatorCfg (flags, name="SumPt2VertexWeightCalculator", **kwargs)
	SumPtVertexWeightCalculatorCfg (flags, name="SumPtVertexWeightCalculator", **kwargs)
	GNNVertexWeightCalculatorCfg (flags, name="GNNVertexWeightCalculator", **kwargs)
	BDTVertexWeightCalculatorCfg (flags, **kwargs)
	BDTVertexWeightCalculatorSeqCfg (flags, container='Photons', **kwargs)
	JetRestrictedSumPt2VertexWeightCalculatorCfg (flags, name="JetRestrictedSumPt2VertexWeightCalculator", TrackParticleLocation="InDetTrackParticles", **kwargs)
	DecorateVertexScoreAlgCfg (flags, name="DecorateVertexScoreAlg", **kwargs)
	TrkVertexWeightCalculatorDebugCfg (flags, **kwargs)
	TrkVertexWeightCalculatorBDTDebugRunCfg ()

Variables
	acc = TrkVertexWeightCalculatorBDTDebugRunCfg()
	status = acc.run()

Function Documentation

BDTVertexWeightCalculatorCfg()

python.TrkVertexWeightCalculatorsConfig.BDTVertexWeightCalculatorCfg	(		flags,
		**	kwargs )

Configure the BDTVertexWeightCalculator. Note: this tool needs to be run after the
DecoratePhotonPointingAlg and BuildVertexPointingAlg.
Use BDTVertexWeightCalculatorSeqCfg to have the full sequence.

Definition at line 32 of file TrkConfig/python/TrkVertexWeightCalculatorsConfig.py.

def BDTVertexWeightCalculatorCfg(flags, **kwargs):
    """
    Configure the BDTVertexWeightCalculator. Note: this tool needs to be run after the
    DecoratePhotonPointingAlg and BuildVertexPointingAlg.
    Use BDTVertexWeightCalculatorSeqCfg to have the full sequence.
    """
    acc = ComponentAccumulator()
    kwargs.setdefault(
        "BDTFile", "PhotonVertexSelection/BDT/2023-02-28/global_ggHW_phcount_BDT.root"
    )
    kwargs.setdefault("BDTName", "lgbm")
    kwargs.setdefault("PointingVertexContainerKey", "PhotonPointingVertices")
    tool = CompFactory.BDTVertexWeightCalculator(
        "BDTVertexWeightCalculator", **kwargs
    )
    acc.setPrivateTools(tool)
    return acc
 
 

BDTVertexWeightCalculatorSeqCfg()

python.TrkVertexWeightCalculatorsConfig.BDTVertexWeightCalculatorSeqCfg	(		flags,
			container = 'Photons',
		**	kwargs )

Configure BDTVertexWeightCalculator and the algorithms that are needed to run before.
Optional parameters are passed only to the tool.

Definition at line 51 of file TrkConfig/python/TrkVertexWeightCalculatorsConfig.py.

def BDTVertexWeightCalculatorSeqCfg(flags, container='Photons', **kwargs):
    """
    Configure BDTVertexWeightCalculator and the algorithms that are needed to run before.
    Optional parameters are passed only to the tool.
    """
    acc = ComponentAccumulator()
 
    from PhotonVertexSelection.PhotonVertexSelectionConfig import (
        DecoratePhotonPointingAlgCfg,
        BuildVertexPointingAlgCfg,
    )
 
    # this algorithm decorates the photons with the pointing information
    acc.merge(DecoratePhotonPointingAlgCfg(flags, "DecoratePhotonPointingAlg", PhotonContainerKey=container))
 
    # this algorithm creates the vertex from photon pointing
    acc.merge(
        BuildVertexPointingAlgCfg(
            flags,
            "BuildVertexPointingAlg",
            PhotonContainerKey=container,
            PointingVertexContainerKey=kwargs.get(
                "PointingVertexContainerKey", "PhotonPointingVertices"
            ),
        )
    )
 
    accTool = BDTVertexWeightCalculatorCfg(flags, **kwargs)
    tool = acc.popToolsAndMerge(accTool)
    acc.setPrivateTools(tool)
    return acc
 
 

DecorateVertexScoreAlgCfg()

python.TrkVertexWeightCalculatorsConfig.DecorateVertexScoreAlgCfg	(		flags,
			name = "DecorateVertexScoreAlg",
		**	kwargs )

This algorithm decorates all the vertices with the score computed by a tool.

Definition at line 7 of file TrkVertexFitter/TrkVertexWeightCalculators/python/TrkVertexWeightCalculatorsConfig.py.

def DecorateVertexScoreAlgCfg(flags, name="DecorateVertexScoreAlg", **kwargs):
    """
    This algorithm decorates all the vertices with the score computed by a tool.
    """
    acc = ComponentAccumulator()
    if not kwargs.get("VertexWeightCalculator", None):
        from TrkConfig.TrkVertexWeightCalculatorsConfig import BDTVertexWeightCalculatorSeqCfg
        toolBDTAcc = BDTVertexWeightCalculatorSeqCfg(flags)
        tool = toolBDTAcc.popPrivateTools()
        acc.merge(toolBDTAcc)
        kwargs["VertexWeightCalculator"] = tool
 
    kwargs.setdefault("VertexScoreDecor", "score")
    alg = CompFactory.DecorateVertexScoreAlg(name, **kwargs)
    acc.addEventAlgo(alg)
    return acc
 
 

GNNVertexWeightCalculatorCfg()

python.TrkVertexWeightCalculatorsConfig.GNNVertexWeightCalculatorCfg	(		flags,
			name = "GNNVertexWeightCalculator",
		**	kwargs )

Definition at line 25 of file TrkConfig/python/TrkVertexWeightCalculatorsConfig.py.

                                 **kwargs):
    acc = ComponentAccumulator()
    acc.setPrivateTools(
        CompFactory.GNNVertexWeightCalculator(name, **kwargs))
    return acc
 

JetRestrictedSumPt2VertexWeightCalculatorCfg()

python.TrkVertexWeightCalculatorsConfig.JetRestrictedSumPt2VertexWeightCalculatorCfg	(		flags,
			name = "JetRestrictedSumPt2VertexWeightCalculator",
			TrackParticleLocation = "InDetTrackParticles",
		**	kwargs )

Definition at line 84 of file TrkConfig/python/TrkVertexWeightCalculatorsConfig.py.

    **kwargs):
    acc = ComponentAccumulator()
    kwargs.setdefault("DoSumPt2Selection", True)
    kwargs.setdefault("JetContainer", "AntiKt4EMTopoJets")
    acc.setPrivateTools(
        CompFactory.Trk.JetRestrictedSumPtVertexWeightCalculator(
            name,
            TracksInConeTool=CompFactory.xAOD.TrackParticlesInConeTool(
                'JetVertexTracksInCone',
                TrackParticleLocation=TrackParticleLocation
            ),
            **kwargs,
    ))
    return acc

SumPt2VertexWeightCalculatorCfg()

python.TrkVertexWeightCalculatorsConfig.SumPt2VertexWeightCalculatorCfg	(		flags,
			name = "SumPt2VertexWeightCalculator",
		**	kwargs )

Definition at line 7 of file TrkConfig/python/TrkVertexWeightCalculatorsConfig.py.

                                    **kwargs):
    acc = ComponentAccumulator()
    kwargs.setdefault("DoSumPt2Selection", True)
    acc.setPrivateTools(
        CompFactory.Trk.SumPtVertexWeightCalculator(name, **kwargs))
    return acc
 
 

SumPtVertexWeightCalculatorCfg()

python.TrkVertexWeightCalculatorsConfig.SumPtVertexWeightCalculatorCfg	(		flags,
			name = "SumPtVertexWeightCalculator",
		**	kwargs )

Definition at line 16 of file TrkConfig/python/TrkVertexWeightCalculatorsConfig.py.

                                   **kwargs):
    acc = ComponentAccumulator()
    kwargs.setdefault("DoSumPt2Selection", False)
    acc.setPrivateTools(
        CompFactory.Trk.SumPtVertexWeightCalculator(name, **kwargs))
    return acc
 
 

TrkVertexWeightCalculatorBDTDebugRunCfg()

python.TrkVertexWeightCalculatorsConfig.TrkVertexWeightCalculatorBDTDebugRunCfg

(

)

Definition at line 115 of file TrkVertexFitter/TrkVertexWeightCalculators/python/TrkVertexWeightCalculatorsConfig.py.

def TrkVertexWeightCalculatorBDTDebugRunCfg():
    from AthenaConfiguration.AllConfigFlags import initConfigFlags
 
    flags = initConfigFlags()
    flags.Exec.MaxEvents = 100
    from AthenaConfiguration.TestDefaults import defaultTestFiles
 
    flags.Input.Files = defaultTestFiles.AOD_RUN3_MC
    flags.Output.HISTFileName = "test_tree.root"
    flags.addFlag("Output.TreeName", "tree")
 
    flags.fillFromArgs()
    flags.lock()
    flags.dump()
 
    from AthenaConfiguration.MainServicesConfig import MainServicesCfg
 
    acc = MainServicesCfg(flags)
 
    from AthenaPoolCnvSvc.PoolReadConfig import PoolReadCfg
 
    acc.merge(PoolReadCfg(flags))
 
    acc.merge(TrkVertexWeightCalculatorDebugCfg(flags))
    acc.printConfig(withDetails=True, summariseProps=True)
    acc.store(open("TrkVertexWeightCalculatorBDTConfig.pkl", "wb"))
    return acc
 
 

TrkVertexWeightCalculatorDebugCfg()

python.TrkVertexWeightCalculatorsConfig.TrkVertexWeightCalculatorDebugCfg	(		flags,
		**	kwargs )

This is a test configuration for the TrkVertexWeightCalculator. It is not meant to be run in production.
It produces a ROOT file with a tree containing relevant information to check the performance of the tool.

Definition at line 25 of file TrkVertexFitter/TrkVertexWeightCalculators/python/TrkVertexWeightCalculatorsConfig.py.

def TrkVertexWeightCalculatorDebugCfg(flags, **kwargs):
    """
    This is a test configuration for the TrkVertexWeightCalculator. It is not meant to be run in production.
    It produces a ROOT file with a tree containing relevant information to check the performance of the tool.
    """
    from AthenaCommon.Constants import DEBUG
    from AthenaCommon.Logging import logging
 
    mlog = logging.getLogger("TrkVertexWeightCalculatorBDTDebugCfg")
    mlog.warning(
        "This is a test algorithm, it is not meant to be run in production."
    )
 
    acc = ComponentAccumulator()
    acc.merge(DecorateVertexScoreAlgCfg(flags, **kwargs))
    mlog.info(
        "Setting the output level of BuildVertexPointingAlg, DecorateVertexScoreAlg, DecorateVertexScoreAlg/VertexSelectionTool to DEBUG"
    )
    acc.getEventAlgo("BuildVertexPointingAlg").OutputLevel = DEBUG
    acc.getEventAlgo("DecorateVertexScoreAlg").OutputLevel = DEBUG
    acc.getEventAlgo(
        "DecorateVertexScoreAlg"
    ).VertexWeightCalculator.OutputLevel = DEBUG
 
    from TrkConfig.TrkVertexWeightCalculatorsConfig import (
        SumPt2VertexWeightCalculatorCfg,
    )
 
    tool_pt2 = acc.popToolsAndMerge(SumPt2VertexWeightCalculatorCfg(flags))
    acc.merge(
        DecorateVertexScoreAlgCfg(
            flags,
            "DecorateVertexScoreAlgSumPt2",
            VertexWeightCalculator=tool_pt2,
            VertexScoreDecor="score_sumpt2",
        )
    )
    acc.getEventAlgo("DecorateVertexScoreAlgSumPt2").OutputLevel = DEBUG
 
    tool = CompFactory.Trk.TrueVertexDistanceWeightCalculator()
    acc.merge(
        DecorateVertexScoreAlgCfg(
            flags,
            "DecorateVertexScoreAlgTrueVertexDistance",
            VertexWeightCalculator=tool,
            VertexScoreDecor="score_true_vertex_distance",
        )
    )
    acc.getEventAlgo("DecorateVertexScoreAlgTrueVertexDistance").OutputLevel = DEBUG
 
    sysService = CompFactory.CP.SystematicsSvc("SystematicsSvc", sigmaRecommended=0)
    acc.addService(sysService)
 
    histoSvc = CompFactory.THistSvc(
        Output=[
            f"ANALYSIS DATAFILE='{flags.Output.HISTFileName}' TYPE='ROOT' OPT='RECREATE'"
        ]
    )
    acc.addService(histoSvc)
    acc.setAppProperty("HistogramPersistency", "ROOT")
 
    acc.addEventAlgo(
        CompFactory.CP.TreeMakerAlg("TreeMaker", TreeName=flags.Output.TreeName)
    )
    branches = [
        "EventInfo.runNumber -> runNumber",
        "EventInfo.eventNumber -> eventNumber",
        "EventInfo.actualInteractionsPerCrossing -> actualInteractionsPerCrossing",
        "EventInfo.averageInteractionsPerCrossing -> averageInteractionsPerCrossing",
        "PrimaryVertices.x -> vtx_x",
        "PrimaryVertices.y -> vtx_y",
        "PrimaryVertices.z -> vtx_z",
        "PrimaryVertices.score -> vtx_score",
        "PhotonPointingVertices.z -> z_common",
        "PhotonPointingVertices.nphotons_good -> nphotons_good",
        "PrimaryVertices.score_sumpt2 -> vtx_score_sumpt2",
        "PrimaryVertices.score_true_vertex_distance -> vtx_score_true_vertex_distance",
    ]
    acc.addEventAlgo(
        CompFactory.CP.AsgxAODNTupleMakerAlg(
            "NTupleMaker", TreeName=flags.Output.TreeName, Branches=branches
        )
    )
    acc.addEventAlgo(
        CompFactory.CP.TreeFillerAlg("TreeFiller", TreeName=flags.Output.TreeName)
    )
 
    return acc
 
 

Variable Documentation

acc

python.TrkVertexWeightCalculatorsConfig.acc = TrkVertexWeightCalculatorBDTDebugRunCfg()

Definition at line 145 of file TrkVertexFitter/TrkVertexWeightCalculators/python/TrkVertexWeightCalculatorsConfig.py.

status

python.TrkVertexWeightCalculatorsConfig.status = acc.run()

Definition at line 146 of file TrkVertexFitter/TrkVertexWeightCalculators/python/TrkVertexWeightCalculatorsConfig.py.