JetMomentToolsConfig Namespace Reference

Functions
def	idTrackSelToolFromJetCtx (trkOpt, trkProperties)
def	getEMScaleMomTool (jetdef, modspec="")
def	getConstitFourMomTool (jetdef, modspec="")
def	getJVFTool (jetdef, modspec)
def	getJVTTool (jetdef, modspec)
def	getNNJvtTool (jetdef, modspec)
def	getTrackMomentsTool (jetdef, modspec)
def	getTrackSumMomentsTool (jetdef, modspec)
def	getOriginCorrVxTool (jetdef, modspec)
def	getJetPtAssociationTool (jetdef, modspec)
def	getQGTaggingTool (jetdef, modspec)
def	getPFlowfJVTTool (jetdef, modspec)
def	getPFlowbJVTTool (jetdef, modspec)
def	getBoostedJetTaggerTool (jetdef, modspec)

Variables
	jetmomentlog = Logging.logging.getLogger('JetMomentToolsConfig')

Function Documentation

getBoostedJetTaggerTool()

def JetMomentToolsConfig.getBoostedJetTaggerTool	(		jetdef,
			modspec
	)

Definition at line 244 of file JetMomentToolsConfig.py.

def getBoostedJetTaggerTool(jetdef, modspec):
 
    jssutils = CompFactory.JSSTaggerUtils("JSSTaggerUtils/MyTagger")
 
    
    bjtTool = CompFactory.BoostedJetTaggerTool("BoostedJetTaggerTool",
                                               MLTagger = jssutils,
                                               DecorationName = "QGTransformer",
                                               CalibArea = "QGConstituentTagger/Nov24",
                                               ConfigFile = "QGTagger_AntiKt04PFlow_Transformer.dat"
                                               )
 
    return bjtTool

getConstitFourMomTool()

def JetMomentToolsConfig.getConstitFourMomTool	(		jetdef,
			modspec = ""
	)

Definition at line 54 of file JetMomentToolsConfig.py.

def getConstitFourMomTool(jetdef, modspec=""):
    
    CaloClusterStates = {
      "UNKNOWN"       : -1,
      "UNCALIBRATED"  :  0,
      "CALIBRATED"    :  1,
      "ALTCALIBRATED" :  2,
      "NSTATES"       :  3
      }
 
    cfourmom = CompFactory.JetConstitFourMomTool("constitfourmom_{0}".format(jetdef.basename))
    if "LCTopo" in jetdef.basename or "EMTopo" in jetdef.basename:
        cfourmom.JetScaleNames = ["DetectorEtaPhi"]
        if "HLT_" in jetdef.fullname():
            cfourmom.AltConstitColls = [""]
            cfourmom.AltConstitScales = [0]
            cfourmom.AltJetScales = ["JetConstitScaleMomentum"]
        else:
            clstate = "CALIBRATED" if "LCTopo" in jetdef.basename else "UNCALIBRATED"
            cfourmom.AltConstitColls = [jetdef.inputdef.inputname]
            cfourmom.AltConstitScales = [CaloClusterStates[clstate]]
            cfourmom.AltJetScales = [""]
    # Drop the LC-calibrated four-mom for EMTopo jets as we only wanted it as a possibility
    # in MET CST calculations but never used it
    elif "PFlow" in jetdef.basename or "UFO" in jetdef.basename:
        cfourmom.JetScaleNames = ["DetectorEtaPhi"]
        cfourmom.AltConstitColls = [""]
        cfourmom.AltConstitScales = [0]
        cfourmom.AltJetScales = ["JetConstitScaleMomentum"]
 
    return cfourmom
 
# Jet vertex fraction with selection.

getEMScaleMomTool()

def JetMomentToolsConfig.getEMScaleMomTool	(		jetdef,
			modspec = ""
	)

Definition at line 32 of file JetMomentToolsConfig.py.

def getEMScaleMomTool(jetdef, modspec=""):
    # This may need updating e.g. for evolving trigger cluster container names
    # We do the non-trivial summation over constituents unless the jets were
    # built directly from EM-scale topoclusters, in which case we can just
    # copy the constituent scale
    useUncalibConstits = False
    if jetdef.inputdef.basetype==xAODType.CaloCluster:
        builtFromEMClusters = jetdef.inputdef.inputname in ["CaloCalTopoClusters","HLT_CaloTopoClustersFS"] and jetdef.inputdef.modifiers==["EM"]
        useUncalibConstits = not builtFromEMClusters
    elif (jetdef.inputdef.basetype==xAODType.ParticleFlow or jetdef.inputdef.basetype==xAODType.FlowElement):
        useUncalibConstits = True
    else:
        raise ValueError("EM scale momentum not defined for input type {}".format(jetdef.inputdef.basetype))
 
    emscalemom = CompFactory.JetEMScaleMomTool(
        "emscalemom_{}".format(jetdef.basename),
        UseUncalibConstits = useUncalibConstits,
        JetContainer = jetdef.fullname(),
    )
 
    return emscalemom
 

getJetPtAssociationTool()

def JetMomentToolsConfig.getJetPtAssociationTool	(		jetdef,
			modspec
	)

Definition at line 169 of file JetMomentToolsConfig.py.

def getJetPtAssociationTool(jetdef, modspec):
 
    from JetRecConfig.JetDefinition import buildJetAlgName
 
    truthJetAlg = buildJetAlgName(jetdef.algorithm, jetdef.radius)+'Truth'+str(modspec)+'Jets'
 
    jetPtAssociation = CompFactory.JetPtAssociationTool('jetPtAssociation',
                                                        MatchingJetContainer = truthJetAlg,
                                                        AssociationName = "GhostTruth")
 
    return jetPtAssociation
 
 

getJVFTool()

def JetMomentToolsConfig.getJVFTool	(		jetdef,
			modspec
	)

Definition at line 90 of file JetMomentToolsConfig.py.

def getJVFTool(jetdef, modspec):
    trkopt = modspec or jetdef.context # allow to overide jetdef.context if modspec is specified
    trackingKeys = jetdef._cflags.Jet.Context[trkopt]
    jvf = CompFactory.JetVertexFractionTool(
        "jvf",
        VertexContainer = trackingKeys["Vertices"],
        AssociatedTracks = trackingKeys["GhostTracksLabel"],
        TrackVertexAssociation = trackingKeys["TVA"],
        TrackParticleContainer  = trackingKeys["Tracks"],
        TrackSelector = idTrackSelToolFromJetCtx(trkopt, trackingKeys),
        SuppressInputDependence = True,
        UseOriginVertex = jetdef.byVertex
    )
    return jvf
 
 
# Jet vertex tagger with selection.

getJVTTool()

def JetMomentToolsConfig.getJVTTool	(		jetdef,
			modspec
	)

Definition at line 107 of file JetMomentToolsConfig.py.

def getJVTTool(jetdef, modspec):
    jvt = CompFactory.JetVertexTaggerTool(
        "jvt",
        VertexContainer = jetdef._cflags.Jet.Context[modspec or jetdef.context]["Vertices"],
        SuppressInputDependence = True,
        UseOriginVertex = jetdef.byVertex
    )
    return jvt
 
# Jet vertex tagger with neural network.

getNNJvtTool()

def JetMomentToolsConfig.getNNJvtTool	(		jetdef,
			modspec
	)

Definition at line 117 of file JetMomentToolsConfig.py.

def getNNJvtTool(jetdef, modspec):
    nnjvt = CompFactory.getComp("JetPileupTag::JetVertexNNTagger")(
        "nnjvt",
        VertexContainer = jetdef._cflags.Jet.Context[modspec or jetdef.context]["Vertices"],
        SuppressInputDependence = True
    )
    return nnjvt
 
 

getOriginCorrVxTool()

def JetMomentToolsConfig.getOriginCorrVxTool	(		jetdef,
			modspec
	)

Definition at line 159 of file JetMomentToolsConfig.py.

def getOriginCorrVxTool(jetdef, modspec):
    origin_setpv = CompFactory.JetOriginCorrectionTool(
      "jetorigin_setpv",
      VertexContainer = jetdef._cflags.Jet.Context[modspec or jetdef.context]["Vertices"],
      OriginCorrectedName = "",
      OnlyAssignPV = True,
    )
    return origin_setpv
 
 

getPFlowbJVTTool()

def JetMomentToolsConfig.getPFlowbJVTTool	(		jetdef,
			modspec
	)

Definition at line 223 of file JetMomentToolsConfig.py.

def getPFlowbJVTTool(jetdef, modspec):
 
    from JetCalibTools import JetCalibToolsConfig
    jetCalibrationTool = JetCalibToolsConfig.getJetCalibToolFromString(jetdef, "AnalysisLatest:mc:JetArea_Residual_EtaJES")
 
    wPFOTool = CompFactory.getComp('CP::WeightPFOTool')("bJVT__wPFO")
 
    trackingKeys = jetdef._cflags.Jet.Context[modspec or jetdef.context]
 
    bJVTTool = CompFactory.JetBalancePFlowJvtTool('bJVT',
                                                  verticesName = trackingKeys["Vertices"],
                                                  TrackVertexAssociation = trackingKeys["TVA"],
                                                  WeightPFOTool = wPFOTool,
                                                  JetCalibrationTool = jetCalibrationTool,
                                                  FEName = jetdef.inputdef.containername,
                                                  ORNameFE = "",
                                                  BjvtRawName = 'DFCommonJets_bJvt',
                                                  includePV = True)
 
    return bJVTTool
 

getPFlowfJVTTool()

def JetMomentToolsConfig.getPFlowfJVTTool	(		jetdef,
			modspec
	)

Definition at line 195 of file JetMomentToolsConfig.py.

def getPFlowfJVTTool(jetdef, modspec):
 
    from JetCalibTools import JetCalibToolsConfig
    calibString = "AnalysisLatest:mc:JetArea_Residual_EtaJES"
    if( modspec and modspec == "CustomVtx" ) :
        if jetdef._cflags.GeoModel.Run is LHCPeriod.Run3:
            calibString = "AnalysisLatest:mc:JetArea_Residual_EtaJES:Kt4EMPFlowNeutEventShape:HggPrimaryVertices"
        else:
            calibString = "AnalysisLatest:mc:JetArea_Residual_EtaJES:Kt4EMPFlowCustomVtxEventShape:HggPrimaryVertices"
    jetCalibrationTool = JetCalibToolsConfig.getJetCalibToolFromString(jetdef, calibString)
 
    wPFOTool = CompFactory.getComp('CP::WeightPFOTool')("fJVT__wPFO")
 
    trackingKeys = jetdef._cflags.Jet.Context[modspec or jetdef.context]
 
    fJVTTool = CompFactory.JetForwardPFlowJvtTool("fJVT",
                                                  verticesName = trackingKeys["Vertices"],
                                                  TrackVertexAssociation = trackingKeys["TVA"],
                                                  WeightPFOTool = wPFOTool,
                                                  JetCalibrationTool = jetCalibrationTool,
                                                  FEName = jetdef.inputdef.containername,
                                                  ORName = "",
                                                  FjvtRawName = "DFCommonJets_fJvt",
                                                  includePV = False)
 
    return fJVTTool
 
 

getQGTaggingTool()

def JetMomentToolsConfig.getQGTaggingTool	(		jetdef,
			modspec
	)

Definition at line 182 of file JetMomentToolsConfig.py.

def getQGTaggingTool(jetdef, modspec):
    trkopt = modspec or jetdef.context # allow to overide jetdef.context if modspec is specified
    trackingKeys = jetdef._cflags.Jet.Context[trkopt]
 
    qgtagging = CompFactory.JetQGTaggerVariableTool('qgtagging',
                                                    VertexContainer = trackingKeys["Vertices"],
                                                    TrackVertexAssociation = trackingKeys["TVA"],
                                                    TrackSelector = idTrackSelToolFromJetCtx(trkopt,trackingKeys),
                                                   )
 
    return qgtagging
 
 

getTrackMomentsTool()

def JetMomentToolsConfig.getTrackMomentsTool	(		jetdef,
			modspec
	)

Definition at line 126 of file JetMomentToolsConfig.py.

def getTrackMomentsTool(jetdef, modspec):
    # retrieve the tracking keys to be used with modspec :
    trkopt = modspec or jetdef.context # allow to overide jetdef.context if modspec is specified    
    trackingKeys = jetdef._cflags.Jet.Context[trkopt]
 
    trackmoments = CompFactory.JetTrackMomentsTool(
        "trkmoms",
        VertexContainer = trackingKeys["Vertices"],
        AssociatedTracks = trackingKeys["GhostTracksLabel"],
        TrackVertexAssociation = trackingKeys["TVA"],
        TrackMinPtCuts = [500, 1000],
        TrackSelector = idTrackSelToolFromJetCtx(trkopt,trackingKeys), 
        DoPFlowMoments = 'PFlow' in jetdef.fullname() or 'UFO' in jetdef.fullname() ,
    )
    return trackmoments
 

getTrackSumMomentsTool()

def JetMomentToolsConfig.getTrackSumMomentsTool	(		jetdef,
			modspec
	)

Definition at line 142 of file JetMomentToolsConfig.py.

def getTrackSumMomentsTool(jetdef, modspec):
    trkopt = modspec or jetdef.context # allow to overide jetdef.context if modspec is specified    
    trackingKeys = jetdef._cflags.Jet.Context[trkopt]
    jettrackselloose = idTrackSelToolFromJetCtx(trkopt,trackingKeys)
    # retrieve the tracking keys to be used with modspec : 
    tracksummoments = CompFactory.JetTrackSumMomentsTool(
        "trksummoms",
        VertexContainer = trackingKeys["Vertices"],
        AssociatedTracks = trackingKeys["GhostTracksLabel"],
        TrackVertexAssociation = trackingKeys["TVA"],
        RequireTrackPV = True,
        TrackSelector = jettrackselloose
    )
    return tracksummoments
 
# This tool sets a decoration saying which the nominal HS PV was.
# Historically it did the origin correction, but now we do this to constituents

idTrackSelToolFromJetCtx()

def JetMomentToolsConfig.idTrackSelToolFromJetCtx	(		trkOpt,
			trkProperties
	)

returns a InDetTrackSelectionTool configured with the jet context corresponding to trkOpt

Definition at line 25 of file JetMomentToolsConfig.py.

def idTrackSelToolFromJetCtx(trkOpt,trkProperties):
    """returns a InDetTrackSelectionTool configured with the jet context corresponding to trkOpt
    """
    from JetRecTools.JetRecToolsConfig import getIDTrackSelectionTool #
    return getIDTrackSelectionTool(f"trackSel{trkOpt}", **trkProperties["trackSelOptions"])
 
 

Variable Documentation

jetmomentlog

JetMomentToolsConfig.jetmomentlog = Logging.logging.getLogger('JetMomentToolsConfig')

Definition at line 17 of file JetMomentToolsConfig.py.