StandardSmallRJets.py

Go to the documentation of this file.

# Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
 
from JetRecConfig.StandardJetConstits import stdConstitDic as cst
from JetRecConfig.JetRecConfig import registerAsInputConstit
from .JetDefinition import  JetDefinition
 
 
# *********************************************************
# Ghost-associated particles for the standard small R jets 
# *********************************************************
standardghosts =  ["Track","MuonSegment","Truth","Tower"]
 
 
flavourghosts = [ "BHadronsInitial", "BHadronsFinal", "BQuarksFinal",
                  "CHadronsInitial", "CHadronsFinal", "CQuarksFinal",
                  "TausFinal", 
                  "WBosons", "ZBosons", "HBosons", "TQuarksFinal",
                  "Partons",]
 
 
 
 
 
# *********************************************************
# Modifiers for the standard small R jets 
# *********************************************************
# (use tuples rather than lists to prevent accidental modification)
calibmods = (
    "ConstitFourMom",   "CaloEnergies",
    "Calib:T0:mc",
    "Sort","numConstit",
    )
 
calibmods_lowCut = (
    "ConstitFourMom", "CaloEnergies",
    "Calib:T0:mc:JetArea_Residual",
    "Sort","numConstit",
)
 
calibmods_noCut = (
    "ConstitFourMom","CaloEnergies","Sort","numConstit",
)
 
standardmods = (
    "Width",
    "CaloQuality", "TrackMoments","TrackSumMoments",
    "JVF", "JVT", "Charge",
)
 
standardmods_ufo = (
    "Width",
    "CaloQualityFE", "TrackMoments","TrackSumMoments",
    "JVF", "JVT", "Charge",
)
 
clustermods      = ("ECPSFrac","ClusterMoments",) 
truthmods        = ("PartonTruthLabel","JetDeltaRLabel:5000", "JetGhostLabel")
pflowmods        = ("JetIRCSafeLabel",)
 
substrmods = ("nsubjettiness","ecorr")
 
truthlabels = ("JetTaggingTruthLabel:R4TruthDressedWZLabel",) #R4TruthLabel
 
# ********************************************************
# Standard track jet definition
# ********************************************************
AntiKtVR30Rmax4Rmin02PV0Track = JetDefinition("AntiKt", 0.4, cst.PV0Track,
                                              modifiers = ("Sort","JetDeltaRLabel:4500","JetGhostLabel","vr","numConstit"),
                                              ptmin=4000,
                                              VRMinR = 0.02,
                                              VRMassSc = 30000,
                                              lock = True)
 
# These jets are used as ghost, so they also need to be defined as constituents : 
registerAsInputConstit(AntiKtVR30Rmax4Rmin02PV0Track)
 
 
AntiKt4PV0Track = JetDefinition("AntiKt", 0.4, cst.PV0Track,
                                modifiers = ("Sort","numConstit")+truthmods,
                                ptmin=2000,
                                lock = True)
 
 
# *********************************************************
# Standard small R reco jet definitions
# *********************************************************
 
AntiKt4EMPFlow = JetDefinition("AntiKt",0.4,cst.GPFlow,
                               ghostdefs = standardghosts+flavourghosts,
                               modifiers = calibmods+truthmods+standardmods+("Filter_calibThreshold:10000","JetGhostLabel","JetDeltaRInitialLabel:5000","JetGhostInitialLabel","JetQuarkChargeLabel","LArHVCorr","jetiso"),
                               lock = True
)
 
# The following jet collection will be scheduled in derivation production (instead of AntiKt4EMPFlow which is used e.g. at Tier-0)
AntiKt4EMPFlow_deriv = AntiKt4EMPFlow.clone(
    ghostdefs = AntiKt4EMPFlow.ghostdefs+["UnAssocMuonSegment"],
    modifiers = AntiKt4EMPFlow.modifiers+("JetPtAssociation","fJVT","NNJVT","CaloEnergiesClus","JetPileupLabel","qgtransformer")+truthlabels
)
 
AntiKt4EMPFlowML = JetDefinition("AntiKt",0.4,cst.GPFlowML,
                               infix = "ML",
                               ghostdefs = standardghosts+flavourghosts,
                               modifiers = calibmods+truthmods+standardmods+("Filter_calibThreshold:1","JetGhostLabel","JetDeltaRInitialLabel:5000","JetGhostInitialLabel","JetQuarkChargeLabel","LArHVCorr","jetiso"),
                               lock = True
)
 
 
AntiKt4EMPFlow_noElectrons = JetDefinition("AntiKt",0.4,cst.GPFlow_noElectrons,
                                    ghostdefs = standardghosts+flavourghosts,
                                    modifiers = calibmods+truthmods+standardmods+("Filter_calibThreshold:10000","JetGhostLabel","LArHVCorr","jetiso"),
                                    lock = True
)
 
AntiKt4EMPFlow_noMuons = JetDefinition("AntiKt",0.4,cst.GPFlow_noMuons,
                                    ghostdefs = standardghosts+flavourghosts,
                                    modifiers = calibmods+truthmods+standardmods+("Filter_calibThreshold:10000","JetGhostLabel","LArHVCorr","jetiso"),
                                    lock = True
)
 
AntiKt4EMPFlow_noLeptons = JetDefinition("AntiKt",0.4,cst.GPFlow_noLeptons,
                                    ghostdefs = standardghosts+flavourghosts,
                                    modifiers = calibmods+truthmods+standardmods+("Filter_calibThreshold:10000","JetGhostLabel","LArHVCorr","jetiso"),
                                    lock = True
)
 
#Same as AntiKt4EMPFlow but with charged and neutrals linked to muons included.
AntiKt4EMPFlow_inclMuons = JetDefinition("AntiKt",0.4,cst.GPFlow_inclMuons,
                                    ghostdefs = standardghosts+flavourghosts,
                                    modifiers = calibmods+truthmods+standardmods+("Filter_calibThreshold:10000","JetGhostLabel","LArHVCorr","jetiso"),
                                    lock = True
)
 
AntiKt4EMPFlow_tauSeedEleRM = JetDefinition("AntiKt",0.4,cst.GPFlow_tauSeedEleRM,
                                    ghostdefs = standardghosts+flavourghosts,
                                    modifiers = calibmods+truthmods+standardmods+("Filter_calibThreshold:10000","JetGhostLabel","LArHVCorr","jetiso"),
                                    lock = True
)
 
AntiKt4LCTopo = JetDefinition("AntiKt",0.4,cst.LCTopoOrigin,
                              ghostdefs = standardghosts+flavourghosts, 
                              modifiers = calibmods+truthmods+standardmods+clustermods+("Filter_ifnotESD:15000","OriginSetPV","LArHVCorr",
                              "JetDeltaRInitialLabel:5000","JetGhostInitialLabel","JetQuarkChargeLabel"),
                              lock = True,
)
 
AntiKt4EMTopo = JetDefinition("AntiKt",0.4,cst.EMTopoOrigin,
                              ghostdefs = standardghosts+["TrackLRT"]+flavourghosts,
                              modifiers = calibmods+truthmods+standardmods+clustermods+("Filter_calibThreshold:15000","LArHVCorr","jetiso",),
                              lock = True,
)
 
# The following jet collection will be scheduled in derivation production (instead of AntiKt4EMTopo which is used e.g. at Tier-0) 
AntiKt4EMTopo_deriv = AntiKt4EMTopo.clone(
    modifiers = AntiKt4EMTopo.modifiers+("JetPtAssociation",)
)
 
# *********************************************************
# EMPFlow CSSK jets  (no jet calibration available yet,
# thus applying only low pT filter)
# *********************************************************
AntiKt4EMPFlowCSSK = JetDefinition("AntiKt",0.4,cst.GPFlowCSSK,
                                   ghostdefs = standardghosts+flavourghosts,
                                   modifiers = ("ConstitFourMom","CaloEnergies","Sort","Filter:1","JetPtAssociation","LArHVCorr","jetiso","numConstit")+truthmods+standardmods,
                                   ptmin = 2000,
                                   lock = True
)
 
# *********************************************************
# UFO CSSK jets
# *********************************************************
AntiKt4UFOCSSK = JetDefinition("AntiKt",0.4,cst.UFOCSSK,
                               ghostdefs = standardghosts+flavourghosts,
                               modifiers = calibmods+("Filter_calibThreshold:10000","EMScaleMom","JetPtAssociation","CaloEnergiesClus","JetGhostLabel","jetiso")+truthmods+standardmods_ufo,
                               lock = True
)
 
# *********************************************************
# Low and no pT cut containers used in JETMX derivations
# *********************************************************
AntiKt4UFOCSSKNoPtCut = JetDefinition("AntiKt",0.4,cst.UFOCSSK,
                                      infix = "NoPtCut",
                                      ghostdefs = standardghosts+flavourghosts,
                                      modifiers = calibmods_noCut+("Filter:1","EMScaleMom","JetPtAssociation","CaloEnergiesClus","jetiso",)+truthmods+standardmods_ufo,
                                      ptmin = 1,
                                      lock = True
)
 
AntiKt4EMPFlowCSSKNoPtCut = JetDefinition("AntiKt",0.4,cst.GPFlowCSSK,
                                          infix = "NoPtCut",
                                          ghostdefs = standardghosts+flavourghosts,
                                          modifiers = ("ConstitFourMom","CaloEnergies","Sort","Filter:1","JetPtAssociation","jetiso","numConstit")+truthmods+standardmods,
                                          ptmin = 1,
                                          lock = True
)
 
AntiKt4EMPFlowNoPtCut = JetDefinition("AntiKt",0.4,cst.GPFlow,
                                      infix = "NoPtCut",
                                      ghostdefs = standardghosts+flavourghosts,
                                      modifiers = calibmods_lowCut+("Filter:1",)+truthmods+standardmods+("JetPtAssociation","CaloEnergiesClus","jetiso"),
                                      ptmin = 1,
                                      lock = True
)
 
AntiKt4EMPFlowByVertex = JetDefinition("AntiKt", 0.4, cst.GPFlowByVtx,
                                        ghostdefs = standardghosts+flavourghosts,
                                        modifiers = calibmods_lowCut+("Filter:1",)+truthmods+standardmods+substrmods+("JetPtAssociation","CaloEnergiesClus"),
                                        ptmin = 7000,
                                        lock = True,
                                        byVertex = True
)
 
AntiKt4EMTopoNoPtCut = JetDefinition("AntiKt",0.4,cst.EMTopoOrigin,
                                     infix = "NoPtCut",
                                     ghostdefs = standardghosts+flavourghosts,
                                     modifiers = calibmods_lowCut+("Filter:1",)+truthmods+standardmods+clustermods+("JetPtAssociation","jetiso",),
                                     ptmin = 1,
                                     lock = True
)
 
AntiKt4MLTopo = JetDefinition("AntiKt",0.4,cst.MLTopoOrigin,
                                     infix = "",
                                     ghostdefs = standardghosts+flavourghosts,
                                     modifiers = ("CaloEnergies","Sort","numConstit","Filter:1",)+truthmods+standardmods+clustermods+("JetPtAssociation","jetiso",),
                                     ptmin = 1,
                                     lock = True
)
 
AntiKt4UFOCSSKLowPt = JetDefinition("AntiKt",0.4,cst.UFOCSSK,
                                    infix = "LowPt",
                                    ghostdefs = standardghosts+flavourghosts,
                                    modifiers = calibmods_noCut+("Filter:7000","EMScaleMom","JetPtAssociation","CaloEnergiesClus","jetiso",)+truthmods+standardmods_ufo,
                                    ptmin = 1,
                                    lock = True
)
 
AntiKt4EMPFlowLowPt = JetDefinition("AntiKt",0.4,cst.GPFlow,
                                    infix = "LowPt",
                                    ghostdefs = standardghosts+flavourghosts,
                                    modifiers = calibmods_lowCut+("Filter:2000",)+truthmods+standardmods+("JetPtAssociation","jetiso",),
                                    ptmin = 2000,
                                    lock = True
)
 
AntiKt4EMTopoLowPt = JetDefinition("AntiKt",0.4,cst.EMTopoOrigin,
                                   infix = "LowPt",
                                   ghostdefs = standardghosts+flavourghosts,
                                   modifiers = calibmods_lowCut+("Filter:2000",)+truthmods+standardmods+clustermods+("JetPtAssociation","jetiso",),
                                   ptmin = 2000,
                                   lock = True
)
 
# *********************************************************
# Standard small R truth jet definitions
# *********************************************************
 
AntiKt4Truth = JetDefinition("AntiKt",0.4, cst.Truth,
                             ghostdefs = flavourghosts,
                             modifiers = ("Sort", "Width", "jetisoTruth", "numConstit")+truthmods,
                             lock = True,
)
 
# These jets may be used as input for the JetTruthLabelling, so they also need to be defined as constituents:
registerAsInputConstit(AntiKt4Truth)
 
AntiKt2Truth = JetDefinition("AntiKt",0.2, cst.Truth,
                             ghostdefs = flavourghosts,
                             modifiers = ("Sort", "Width", "numConstit")+truthmods,
                             lock = True,
)
 
AntiKt4TruthWZ = JetDefinition("AntiKt",0.4, cst.TruthWZ,
                               ghostdefs = flavourghosts,
                               modifiers = ("Sort", "Width", "jetisoTruth", "numConstit")+truthmods,
                               lock = True,
)
 
AntiKt4TruthDressedWZ = JetDefinition("AntiKt",0.4, cst.TruthDressedWZ,
                                      ghostdefs = flavourghosts,
                                      modifiers = ("Sort", "Width", "jetisoTruth", "numConstit")+truthmods,
                                      lock = True,
)
 
# These jets are used as input for the JetPileupLabel modifier, so they also need to be defined as constituents: 
registerAsInputConstit(AntiKt4TruthDressedWZ)
 
AntiKtVRTruthCharged = JetDefinition("AntiKt",0.4, cst.TruthCharged,
                                     ghostdefs = flavourghosts,
                                     modifiers = ("Sort", "numConstit")+truthmods,
                                     VRMinR = 0.02,
                                     VRMassSc = 30000,
                                     lock = True
)
 
AntiKt4TruthGEN = JetDefinition("AntiKt",0.4, cst.TruthGEN,
                                ptmin = 5000, 
                                ghostdefs = [],
                                modifiers = ("Sort",)+truthmods,
                                ghostarea = 0.,
                                lock = True,
)
AntiKt4TruthGENWZ = AntiKt4TruthGEN.clone(inputdef=cst.TruthGENWZ)
 
AntiKt6TruthGEN   = AntiKt4TruthGEN.clone(radius=0.6)
AntiKt6TruthGENWZ = AntiKt4TruthGENWZ.clone(radius=0.6)
 
 
# *********************************************************
# Support for merged HS/PU jet definitions from simulation
# *********************************************************
 
InTimeAntiKt4Truth = AntiKt4Truth.clone(prefix="InTime")
 
OutOfTimeAntiKt4Truth = AntiKt4Truth.clone(prefix="OutOfTime")
 
# These jets may be used as input for the JetTruthLabelling, so they also need to be defined as constituents:
registerAsInputConstit(InTimeAntiKt4Truth)
 
registerAsInputConstit(OutOfTimeAntiKt4Truth)
 
 
def StandardSmallRJetCfg(flags):
    """Top-level function to schedule the smallR jets in standard reconstruction """
    from JetRecConfig.JetRecConfig import JetRecCfg
 
    standarSmallRList = [
        AntiKt4EMPFlow,
        AntiKt4LCTopo,
        AntiKt4Truth,
        ]
 
    compacc = JetRecCfg( flags, standarSmallRList[0], )
    for jetdef in standarSmallRList[1:]:
        compacc.merge( JetRecCfg( flags, jetdef) )
 
    return compacc