python.MCTruthCommonConfig Namespace Reference

Functions
def	TruthMetaDataWriterCfg (flags, name)
def	HepMCtoXAODTruthCfg (flags)
def	AddTruthJetsCfg (flags)
def	AddTruthMETCfg (flags)
def	PreJetMCTruthAugmentationsCfg (flags, **kwargs)
def	PostJetMCTruthAugmentationsCfg (flags, **kwargs)
def	AddStandardTruthContentsCfg (flags, decorationDressing='dressedPhoton', includeTausInDressingPhotonRemoval=False, prefix='')
def	AddParentAndDownstreamParticlesCfg (flags, generations=1, parents=[6], prefix='TopQuark', collection_prefix=None, rejectHadronChildren=False)
def	AddBosonsAndDownstreamParticlesCfg (flags, generations=1, rejectHadronChildren=False)
	Add taus and their downstream particles (immediate and further decay products) in a special collection def addTausAndDownstreamParticles(kernel=None, generations=1): return addParentAndDownstreamParticles(kernel=kernel, generations=generations, parents=[15], prefix='Tau') More...
def	AddTopQuarkAndDownstreamParticlesCfg (flags, generations=1, rejectHadronChildren=False)
def	AddTauAndDownstreamParticlesCfg (flags, generations=-1, rejectHadronChildren=False)
def	AddHFAndDownstreamParticlesCfg (flags, **kwargs)
	Add electrons, photons, and their downstream particles in a special collection def addEgammaAndDownstreamParticles(kernel=None, generations=1): return addParentAndDownstreamParticles(kernel=kernel, generations=generations, parents=[11,22], prefix='Egamma') More...
def	AddPVCollectionCfg (flags)
def	AddHardScatterCollectionCfg (flags, generations=1)
def	AddTruthCollectionNavigationDecorationsCfg (flags, TruthCollections=[], prefix='')
def	AddBSMAndDownstreamParticlesCfg (flags, generations=-1)
def	AddBornLeptonCollectionCfg (flags)
def	AddLargeRJetD2Cfg (flags)
def	AddTruthEnergyDensityCfg (flags)
def	AddMiniTruthCollectionLinksCfg (flags, **kwargs)
def	addTruth3ContentToSlimmerTool (slimmer)

Function Documentation

AddBornLeptonCollectionCfg()

def python.MCTruthCommonConfig.AddBornLeptonCollectionCfg

(

flags

)

Add born leptons as a mini collection

Definition at line 369 of file MCTruthCommonConfig.py.

def AddBornLeptonCollectionCfg(flags):
    """Add born leptons as a mini collection"""
    acc = ComponentAccumulator()
    # Set up a tool to keep the taus and all downstream particles
    from DerivationFrameworkMCTruth.TruthDerivationToolsConfig import TruthBornLeptonCollectionMakerCfg
    DFCommonBornLeptonCollTool = acc.getPrimaryAndMerge(TruthBornLeptonCollectionMakerCfg(flags,
                                                                                          name              = "DFCommonBornLeptonCollTool",
                                                                                          NewCollectionName ="BornLeptons"))
    CommonAugmentation = CompFactory.DerivationFramework.CommonAugmentation
    acc.addEventAlgo(CommonAugmentation("MCTruthCommonBornLeptonsKernel", AugmentationTools = [DFCommonBornLeptonCollTool] ))
    return acc
 

AddBosonsAndDownstreamParticlesCfg()

def python.MCTruthCommonConfig.AddBosonsAndDownstreamParticlesCfg	(		flags,
			generations = 1,
			rejectHadronChildren = False
	)

Add taus and their downstream particles (immediate and further decay products) in a special collection def addTausAndDownstreamParticles(kernel=None, generations=1): return addParentAndDownstreamParticles(kernel=kernel, generations=generations, parents=[15], prefix='Tau')

Add W bosons and their downstream particles def addWbosonsAndDownstreamParticles(kernel=None, generations=1, rejectHadronChildren=False): return addParentAndDownstreamParticles(kernel=kernel, generations=generations, parents=[24], prefix='Wboson', rejectHadronChildren=rejectHadronChildren)

Add bosons and downstream particles (not photons/gluons)

Definition at line 243 of file MCTruthCommonConfig.py.

def AddBosonsAndDownstreamParticlesCfg(flags,
                                       generations=1,
                                       rejectHadronChildren=False):
    """Add bosons and downstream particles (not photons/gluons)"""
    return AddParentAndDownstreamParticlesCfg(flags,
                                              generations          = generations,
                                              parents              = [23,24,25],
                                              prefix               = 'Bosons',
                                              rejectHadronChildren = rejectHadronChildren)
 
# Add top quark and their downstream particles

AddBSMAndDownstreamParticlesCfg()

def python.MCTruthCommonConfig.AddBSMAndDownstreamParticlesCfg	(		flags,
			generations = -1
	)

Add BSM particles and their downstream particles in a special collection

Definition at line 353 of file MCTruthCommonConfig.py.

def AddBSMAndDownstreamParticlesCfg(flags, generations=-1):
    """Add BSM particles and their downstream particles in a special collection"""
    acc = ComponentAccumulator()
    # Set up a tool to keep the taus and all downstream particles
     
    DFCommonBSMAndDecaysTool = acc.getPrimaryAndMerge(TruthDecayCollectionMakerCfg(flags,
                                                                                   name              = "DFCommonBSMAndDecaysTool",
                                                                                   NewCollectionName = "TruthBSMWithDecay",
                                                                                   KeepBSM           = True,
                                                                                   Generations       = generations))
    CommonAugmentation = CompFactory.DerivationFramework.CommonAugmentation
    acc.addEventAlgo(CommonAugmentation(name              = "MCTruthCommonBSMAndDecaysKernel",
                                        AugmentationTools = [DFCommonBSMAndDecaysTool] ))
    return acc
 
# Add a mini-collection for the born leptons

AddHardScatterCollectionCfg()

def python.MCTruthCommonConfig.AddHardScatterCollectionCfg	(		flags,
			generations = 1
	)

Add a mini-collection for the hard scatter and N subsequent generations

Definition at line 331 of file MCTruthCommonConfig.py.

def AddHardScatterCollectionCfg(flags, generations=1):
    """Add a mini-collection for the hard scatter and N subsequent generations"""
    # Set up a tool to keep the taus and all downstream particles
    acc = ComponentAccumulator()
    return acc
 
# Add navigation decorations on the truth collections

AddHFAndDownstreamParticlesCfg()

def python.MCTruthCommonConfig.AddHFAndDownstreamParticlesCfg	(		flags,
		**	kwargs
	)

Add electrons, photons, and their downstream particles in a special collection def addEgammaAndDownstreamParticles(kernel=None, generations=1): return addParentAndDownstreamParticles(kernel=kernel, generations=generations, parents=[11,22], prefix='Egamma')

Add b/c-hadrons and their downstream particles

Definition at line 293 of file MCTruthCommonConfig.py.

def AddHFAndDownstreamParticlesCfg(flags, **kwargs):
    """Add b/c-hadrons and their downstream particles"""
    kwargs.setdefault("addB",True)
    kwargs.setdefault("addC",True)
    kwargs.setdefault("generations",-1)
    kwargs.setdefault("prefix",'')
    acc = ComponentAccumulator()
    # Set up a tool to keep b- and c-quarks and all downstream particles
    from DerivationFrameworkMCTruth.TruthDerivationToolsConfig import TruthDecayCollectionMakerCfg
    DFCommonHFAndDecaysTool = acc.getPrimaryAndMerge(TruthDecayCollectionMakerCfg(
        flags,
        name=kwargs['prefix']+"DFCommonHFAndDecaysTool",
        NewCollectionName=kwargs['prefix']+"TruthHFWithDecay",
        KeepBHadrons=kwargs['addB'],
        KeepCHadrons=kwargs['addC'],
        Generations=kwargs['generations']))
    acc.addEventAlgo(CompFactory.DerivationFramework.CommonAugmentation(
        kwargs['prefix']+"MCTruthCommonHFAndDecaysKernel",
        AugmentationTools = [DFCommonHFAndDecaysTool] ))
    return acc
 
 
# Add a one-vertex-per event "primary vertex" container

AddLargeRJetD2Cfg()

def python.MCTruthCommonConfig.AddLargeRJetD2Cfg

(

flags

)

Add large-R jet D2 variable

Definition at line 381 of file MCTruthCommonConfig.py.

def AddLargeRJetD2Cfg(flags):
    """Add large-R jet D2 variable"""
    #Extra classifier for D2 variable
    acc = ComponentAccumulator()
    from DerivationFrameworkMCTruth.TruthDerivationToolsConfig import TruthD2DecoratorCfg
    theTruthD2Decorator = acc.getPrimaryAndMerge(TruthD2DecoratorCfg(flags,
                                                                     name            = "TruthD2Decorator",
                                                                     JetContainerKey = "AntiKt10TruthSoftDropBeta100Zcut10Jets",
                                                                     DecorationName  = "D2"))
    TruthD2DecoratorKernel = CompFactory.DerivationFramework.CommonAugmentation
    acc.addEventAlgo(TruthD2DecoratorKernel("TRUTHD2Kernel", AugmentationTools = [theTruthD2Decorator] ))
    return acc
 
# Truth energy density tools

AddMiniTruthCollectionLinksCfg()

def python.MCTruthCommonConfig.AddMiniTruthCollectionLinksCfg	(		flags,
		**	kwargs
	)

Tool to move pointers to new mini truth collections

Definition at line 434 of file MCTruthCommonConfig.py.

def AddMiniTruthCollectionLinksCfg(flags, **kwargs):
    """Tool to move pointers to new mini truth collections"""
    acc = ComponentAccumulator()
    kwargs.setdefault("doElectrons",True)
    kwargs.setdefault("doPhotons",True)
    kwargs.setdefault("doMuons",True) 
    aug_tools = []
    from DerivationFrameworkMCTruth.TruthDerivationToolsConfig import TruthLinkRepointToolCfg
    if kwargs['doElectrons']:
        electron_relink = acc.getPrimaryAndMerge(TruthLinkRepointToolCfg(
            flags,
            name="ElMiniCollectionTruthLinkTool",
            RecoCollection="Electrons", 
            TargetCollections=["TruthMuons","TruthPhotons","TruthElectrons"]))
        aug_tools += [ electron_relink ]
    if kwargs['doPhotons']:
        photon_relink = acc.getPrimaryAndMerge(TruthLinkRepointToolCfg(
            flags,
            name="PhMiniCollectionTruthLinkTool",
            RecoCollection="Photons", 
            TargetCollections=["TruthMuons","TruthPhotons","TruthElectrons"]))
        aug_tools += [ photon_relink ]
    if kwargs['doMuons']:
        muon_relink = acc.getPrimaryAndMerge(TruthLinkRepointToolCfg(
            flags,
            name="MuMiniCollectionTruthLinkTool",
            RecoCollection="Muons", 
            TargetCollections=["TruthMuons","TruthPhotons","TruthElectrons"]))
        aug_tools += [ muon_relink ]
    for i, tool in enumerate(aug_tools):
        acc.addEventAlgo(CompFactory.DerivationFramework.CommonAugmentation(
        "MiniCollectionTruthLinkKernelNo{num}".format(num=i+1),
        AugmentationTools = [tool] ))
    return acc
 

AddParentAndDownstreamParticlesCfg()

def python.MCTruthCommonConfig.AddParentAndDownstreamParticlesCfg	(		flags,
			generations = 1,
			parents = [6],
			prefix = 'TopQuark',
			collection_prefix = None,
			rejectHadronChildren = False
	)

Configure tools for adding immediate parents and descendants

Definition at line 204 of file MCTruthCommonConfig.py.

def AddParentAndDownstreamParticlesCfg(flags,
                                       generations=1,
                                       parents=[6],
                                       prefix='TopQuark',
                                       collection_prefix=None,
                                       rejectHadronChildren=False):
    """Configure tools for adding immediate parents and descendants"""
    acc = ComponentAccumulator()
    collection_name=collection_prefix+'WithDecay' if collection_prefix is not None else 'Truth'+prefix+'WithDecay'
    # Set up a tool to keep the W/Z/H bosons and all downstream particles
    collection_maker = acc.getPrimaryAndMerge(TruthDecayCollectionMakerCfg(flags,
                                                                           name                 ='DFCommon'+prefix+'AndDecaysTool',
                                                                           NewCollectionName    = collection_name,
                                                                           PDGIDsToKeep         = parents,
                                                                           Generations          = generations,
                                                                           RejectHadronChildren = rejectHadronChildren))
    CommonAugmentation = CompFactory.DerivationFramework.CommonAugmentation
    kernel_name = 'MCTruthCommon'+prefix+'AndDecaysKernel'
    acc.addEventAlgo(CommonAugmentation(kernel_name, AugmentationTools = [collection_maker] ))
    return acc
 
# Next two don't seem to be used for anything...

AddPVCollectionCfg()

def python.MCTruthCommonConfig.AddPVCollectionCfg

(

flags

)

Add a one-vertex-per event "primary vertex" container

Definition at line 316 of file MCTruthCommonConfig.py.

def AddPVCollectionCfg(flags):
    """Add a one-vertex-per event "primary vertex" container"""
    acc = ComponentAccumulator()
    # Set up a tool to keep the primary vertices
    from DerivationFrameworkMCTruth.TruthDerivationToolsConfig import TruthPVCollectionMakerCfg
    DFCommonTruthPVCollTool = acc.getPrimaryAndMerge(TruthPVCollectionMakerCfg( 
        flags,
        name="DFCommonTruthPVCollTool",
        NewCollectionName="TruthPrimaryVertices"))
    acc.addEventAlgo(CompFactory.DerivationFramework.CommonAugmentation(
        "MCTruthCommonTruthPVCollKernel",
        AugmentationTools = [DFCommonTruthPVCollTool] ))
    return acc
 
# Add a mini-collection for the hard scatter and N subsequent generations

AddStandardTruthContentsCfg()

def python.MCTruthCommonConfig.AddStandardTruthContentsCfg	(		flags,
			decorationDressing = 'dressedPhoton',
			includeTausInDressingPhotonRemoval = False,
			prefix = ''
	)

Definition at line 165 of file MCTruthCommonConfig.py.

def AddStandardTruthContentsCfg(flags,
                                decorationDressing='dressedPhoton',
                                includeTausInDressingPhotonRemoval=False,
                                prefix=''):
 
    acc = ComponentAccumulator()
 
    # Schedule HepMC->xAOD truth conversion
    acc.merge(HepMCtoXAODTruthCfg(flags))
 
    # Local flag
    isEVNT = False
    if "McEventCollection#GEN_EVENT" in flags.Input.TypedCollections: isEVNT = True
    # Tools that must come before jets
    acc.merge(PreJetMCTruthAugmentationsCfg(flags,decorationDressing = decorationDressing))
    # Should photons that are dressed onto taus also be removed from truth jets?
    if includeTausInDressingPhotonRemoval:
        acc.getPublicTool("DFCommonTruthTauDressingTool").decorationName=decorationDressing
    # Jets and MET
    acc.merge(AddTruthJetsCfg(flags))
    acc.merge(AddTruthMETCfg(flags))
    # Tools that must come after jets
    acc.merge(PostJetMCTruthAugmentationsCfg(flags, decorationDressing = decorationDressing))
    # Add back the navigation contect for the collections we want
    acc.merge(AddTruthCollectionNavigationDecorationsCfg(flags, ["TruthElectrons", "TruthMuons", "TruthPhotons", "TruthTaus", "TruthNeutrinos", "TruthBSM", "TruthBottom", "TruthTop", "TruthBoson"], prefix=prefix))
    # Some more additions for standard TRUTH3
    acc.merge(AddBosonsAndDownstreamParticlesCfg(flags))
    if isEVNT: acc.merge(AddLargeRJetD2Cfg(flags))
    # Special collection for BSM particles
    acc.merge(AddBSMAndDownstreamParticlesCfg(flags))
    # Special collection for Born leptons
    acc.merge(AddBornLeptonCollectionCfg(flags))
    # Special collection for hard scatter (matrix element) - save TWO extra generations of particles
    acc.merge(AddHardScatterCollectionCfg(flags, 2))
    # Energy density for isolation corrections
    if isEVNT: acc.merge(AddTruthEnergyDensityCfg(flags))
 
    return acc
 

AddTauAndDownstreamParticlesCfg()

def python.MCTruthCommonConfig.AddTauAndDownstreamParticlesCfg	(		flags,
			generations = -1,
			rejectHadronChildren = False
	)

Add tau and downstream particles

Definition at line 264 of file MCTruthCommonConfig.py.

def AddTauAndDownstreamParticlesCfg(flags,
                                   generations=-1,
                                   rejectHadronChildren=False):
    """Add tau and downstream particles"""
    return AddParentAndDownstreamParticlesCfg(flags,
                                              generations=generations,
                                              parents=[15],
                                              prefix='Taus',
                                              rejectHadronChildren=rejectHadronChildren)
 
# Following commented methods don't seem to be used for anything...
 
#def addBottomQuarkAndDownstreamParticles(kernel=None, generations=1, rejectHadronChildren=False):
#   return addParentAndDownstreamParticles(kernel=kernel,
#                                          generations=generations,
#                                          parents=[5],
#                                          prefix='BottomQuark',
#                                          rejectHadronChildren=rejectHadronChildren)
#
#

AddTopQuarkAndDownstreamParticlesCfg()

def python.MCTruthCommonConfig.AddTopQuarkAndDownstreamParticlesCfg	(		flags,
			generations = 1,
			rejectHadronChildren = False
	)

Add top quarks and downstream particles

Definition at line 254 of file MCTruthCommonConfig.py.

def AddTopQuarkAndDownstreamParticlesCfg(flags,
                                         generations=1,
                                         rejectHadronChildren=False):
    """Add top quarks and downstream particles"""
    return AddParentAndDownstreamParticlesCfg(flags,
                                              generations=generations,
                                              parents=[6],
                                              prefix='TopQuark',
                                              rejectHadronChildren=rejectHadronChildren)
 

addTruth3ContentToSlimmerTool()

def python.MCTruthCommonConfig.addTruth3ContentToSlimmerTool

(

slimmer

)

Definition at line 469 of file MCTruthCommonConfig.py.

def addTruth3ContentToSlimmerTool(slimmer):
    slimmer.AllVariables += [
        "MET_Truth",
        "TruthElectrons",
        "TruthMuons",
        "TruthPhotons",
        "TruthTaus",
        "TruthNeutrinos",
        "TruthBSM",
        "TruthBottom",
        "TruthTop",
        "TruthBoson",
        "TruthForwardProtons",
        "BornLeptons",
        "TruthBosonsWithDecayParticles",
        "TruthBosonsWithDecayVertices",
        "TruthBSMWithDecayParticles",
        "TruthBSMWithDecayVertices",
        "HardScatterParticles",
        "HardScatterVertices",
    ]
    slimmer.ExtraVariables += [
        "AntiKt4TruthDressedWZJets.GhostCHadronsFinalCount.GhostBHadronsFinalCount.pt.HadronConeExclTruthLabelID.ConeTruthLabelID.PartonTruthLabelID.TrueFlavor",
        "AntiKt10TruthSoftDropBeta100Zcut10Jets.pt.Tau1_wta.Tau2_wta.Tau3_wta.D2",
        "TruthEvents.Q.XF1.XF2.PDGID1.PDGID2.PDFID1.PDFID2.X1.X2.crossSection"]

AddTruthCollectionNavigationDecorationsCfg()

def python.MCTruthCommonConfig.AddTruthCollectionNavigationDecorationsCfg	(		flags,
			TruthCollections = [],
			prefix = ''
	)

Tool to add navigation decorations on the truth collections

Definition at line 338 of file MCTruthCommonConfig.py.

def AddTruthCollectionNavigationDecorationsCfg(flags, TruthCollections=[], prefix=''):
    """Tool to add navigation decorations on the truth collections"""
    acc = ComponentAccumulator() 
    if len(TruthCollections)==0: return
    # Set up a tool to add the navigation decorations
    from DerivationFrameworkMCTruth.TruthDerivationToolsConfig import TruthNavigationDecoratorCfg
    DFCommonTruthNavigationDecorator = acc.getPrimaryAndMerge(TruthNavigationDecoratorCfg(flags,
                                                                                          name             = prefix+'DFCommonTruthNavigationDecorator',
                                                                                          InputCollections = TruthCollections))
    CommonAugmentation = CompFactory.DerivationFramework.CommonAugmentation
    acc.addEventAlgo(CommonAugmentation(prefix+"MCTruthNavigationDecoratorKernel",
                                        AugmentationTools = [DFCommonTruthNavigationDecorator] ))
    return acc
 
# Add BSM particles and their downstream particles (immediate and further decay products) in a special collection

AddTruthEnergyDensityCfg()

def python.MCTruthCommonConfig.AddTruthEnergyDensityCfg

(

flags

)

Truth energy density tools

Definition at line 395 of file MCTruthCommonConfig.py.

def AddTruthEnergyDensityCfg(flags):
    """Truth energy density tools"""
    acc = ComponentAccumulator()
    from EventShapeTools.EventDensityConfig import configEventDensityTool
    from JetRecConfig.StandardJetConstits import stdConstitDic as cst
    EventDensityAthAlg = CompFactory.EventDensityAthAlg 
    # Algorithms for the energy density - needed only if e/gamma hasn't set things up already
    DFCommonTruthCentralEDTool = configEventDensityTool("DFCommonTruthCentralEDTool",
                                                        cst.Truth,
                                                        0.5,
                                                        AbsRapidityMax      = 1.5,
                                                        OutputContainer     = "TruthIsoCentralEventShape",
                                                       )
    acc.addPublicTool(DFCommonTruthCentralEDTool)
    acc.addEventAlgo(EventDensityAthAlg("DFCommonTruthCentralEDAlg", EventDensityTool = DFCommonTruthCentralEDTool ))
    DFCommonTruthForwardEDTool = configEventDensityTool("DFCommonTruthForwardEDTool",
                                                        cst.Truth,
                                                        0.5,
                                                        AbsRapidityMin      = 1.5,
                                                        AbsRapidityMax      = 3.0,
                                                        OutputContainer     = "TruthIsoForwardEventShape",
                                                       )
    acc.addPublicTool(DFCommonTruthForwardEDTool)
    acc.addEventAlgo(EventDensityAthAlg("DFCommonTruthForwardEDAlg", EventDensityTool = DFCommonTruthForwardEDTool ))
 
    # Now add the tool to do the decoration
    DFCommonTruthEDDecorator = CompFactory.DerivationFramework.TruthEDDecorator("DFCommonTruthEDDecorator",
                                                                                EventInfoName="EventInfo",
                                                                                EnergyDensityKeys=["TruthIsoCentralEventShape","TruthIsoForwardEventShape"],
                                                                                DecorationSuffix="_rho"
                                                                               )
    acc.addPublicTool(DFCommonTruthEDDecorator)
    
    DFCommonTruthEDKernel = CompFactory.DerivationFramework.CommonAugmentation
    acc.addEventAlgo(DFCommonTruthEDKernel("DFCommonTruthEDKernel", AugmentationTools = [DFCommonTruthEDDecorator] ))
    return acc
 
 
# Sets up modifiers to move pointers to old truth collections to new mini truth collections

AddTruthJetsCfg()

def python.MCTruthCommonConfig.AddTruthJetsCfg

(

flags

)

Definition at line 62 of file MCTruthCommonConfig.py.

def AddTruthJetsCfg(flags):
    acc = ComponentAccumulator()
 
    from JetRecConfig.StandardSmallRJets import AntiKt4Truth,AntiKt4TruthWZ,AntiKt4TruthDressedWZ,AntiKtVRTruthCharged
    from JetRecConfig.StandardLargeRJets import AntiKt10TruthTrimmed,AntiKt10TruthSoftDrop
    from JetRecConfig.JetRecConfig import JetRecCfg
    from JetRecConfig.JetConfigFlags import jetInternalFlags
 
    jetInternalFlags.isRecoJob = True
 
    jetList = [AntiKt4Truth,AntiKt4TruthWZ,AntiKt4TruthDressedWZ,AntiKtVRTruthCharged,
               AntiKt10TruthTrimmed,AntiKt10TruthSoftDrop]
 
    for jd in jetList:
        acc.merge(JetRecCfg(flags,jd))
 
    return acc
 
# Helper for scheduling the truth MET collection

AddTruthMETCfg()

def python.MCTruthCommonConfig.AddTruthMETCfg

(

flags

)

Definition at line 81 of file MCTruthCommonConfig.py.

def AddTruthMETCfg(flags):
 
    acc = ComponentAccumulator()
 
    # Only do this if the truth MET is not present
    # This should handle EVNT correctly without an explicit check
    if ( "MissingETContainer#MET_Truth") not in flags.Input.TypedCollections:
        from METReconstruction.METTruth_Cfg import METTruth_Cfg
        acc.merge(METTruth_Cfg(flags))
 
    return acc
 

HepMCtoXAODTruthCfg()

def python.MCTruthCommonConfig.HepMCtoXAODTruthCfg

(

flags

)

Conversion of HepMC to xAOD truth

Definition at line 19 of file MCTruthCommonConfig.py.

def HepMCtoXAODTruthCfg(flags):
    """Conversion of HepMC to xAOD truth"""
    acc = ComponentAccumulator()
 
    # Only run for MC input
    if flags.Input.isMC is False:
        raise RuntimeError("Common MC truth building requested for non-MC input")
 
    # Local steering flag to identify EVNT input
    # Commented because the block it is needed for isn't working (TruthMetaData)
    isEVNT = False
 
    # Ensure EventInfoCnvAlg is scheduled
    if "EventInfo#McEventInfo" in flags.Input.TypedCollections and "xAOD::EventInfo#EventInfo" not in flags.Input.TypedCollections:
        from xAODEventInfoCnv.xAODEventInfoCnvConfig import EventInfoCnvAlgCfg
        acc.merge(EventInfoCnvAlgCfg(flags, inputKey="McEventInfo", outputKey="EventInfo", disableBeamSpot=True))
 
    # Build truth collection if input is HepMC. Must be scheduled first to allow slimming.
    # Input file is event generator output (EVNT)
    from xAODTruthCnv.xAODTruthCnvConfig import GEN_EVNT2xAODCfg
    if "McEventCollection#GEN_EVENT" in flags.Input.TypedCollections:                  
        acc.merge(GEN_EVNT2xAODCfg(flags,name="GEN_EVNT2xAOD",AODContainerName="GEN_EVENT"))
        isEVNT = True 
    # Input file is simulation output (HITS)
    elif "McEventCollection#TruthEvent" in flags.Input.TypedCollections:
        acc.merge(GEN_EVNT2xAODCfg(flags,name="GEN_EVNT2xAOD",AODContainerName="TruthEvent"))
        # This is not really EVNT, but we do need to treat it like EVNT for Metadata
        isEVNT = True
    # Input file already has xAOD truth. Don't do anything.
    elif "xAOD::TruthEventContainer#TruthEvents" in flags.Input.TypedCollections:
        pass
    else:
        raise RuntimeError("No recognised HepMC truth information found in the input")
 
    # If it isn't available, make a truth meta data object (will hold MC Event Weights)
    if "TruthMetaDataContainer#TruthMetaData" not in flags.Input.TypedCollections and not isEVNT:
        # If we are going to be making the truth collection (isEVNT) then this will be made elsewhere
        acc.merge(TruthMetaDataWriterCfg(flags, name = 'DFCommonTruthMetaDataWriter'))
 
    return acc
 
 
# Helper for adding truth jet collections via new jet config

PostJetMCTruthAugmentationsCfg()

def python.MCTruthCommonConfig.PostJetMCTruthAugmentationsCfg	(		flags,
		**	kwargs
	)

Definition at line 128 of file MCTruthCommonConfig.py.

def PostJetMCTruthAugmentationsCfg(flags, **kwargs):
 
    acc = ComponentAccumulator()
 
    # Tau collections are built separately
    # truth tau matching needs truth jets, truth electrons and truth muons
    from DerivationFrameworkTau.TauTruthCommonConfig import TauTruthToolsCfg
    acc.merge(TauTruthToolsCfg(flags))
    from DerivationFrameworkMCTruth.TruthDerivationToolsConfig import DFCommonTruthTauDressingToolCfg
    augmentationToolsList = [ acc.getPrimaryAndMerge(DFCommonTruthTauDressingToolCfg(flags)) ]
 
    #Save the post-shower HT and MET filter values that will make combining filtered samples easier (adds to the EventInfo)
    from DerivationFrameworkMCTruth.GenFilterToolConfig import GenFilterToolCfg
    # schedule the special truth building tools and add them to a common augmentation; note taus are handled separately below
    from DerivationFrameworkMCTruth.TruthDerivationToolsConfig import DFCommonTruthDressedWZQGLabelToolCfg
    augmentationToolsList += [ acc.getPrimaryAndMerge(GenFilterToolCfg(flags)) ,
                               acc.getPrimaryAndMerge(DFCommonTruthDressedWZQGLabelToolCfg(flags))]
 
    # SUSY signal decorations
    from DerivationFrameworkSUSY.DecorateSUSYProcessConfig import IsSUSYSignalRun3
    if IsSUSYSignalRun3(flags):
        from DerivationFrameworkSUSY.DecorateSUSYProcessConfig import SUSYSignalTaggerCfg
        augmentationToolsList += [ acc.getPrimaryAndMerge(SUSYSignalTaggerCfg(flags, 'MCTruthCommon')) ]
 
    CommonAugmentation = CompFactory.DerivationFramework.CommonAugmentation
    for i, tool in enumerate(augmentationToolsList):
        acc.addEventAlgo(CommonAugmentation(name = "MCTruthCommonPostJetKernelNo{num}".format(num = i+1), 
                                        AugmentationTools = [tool]))
 
    # add SoW of individual SUSY final states, relies on augmentation from DecorateSUSYProcess()
    if IsSUSYSignalRun3(flags):
        from DerivationFrameworkSUSY.SUSYWeightMetadataConfig import AddSUSYWeightsCfg
        acc.merge(AddSUSYWeightsCfg(flags))
 
    return(acc)
 
# This adds the entirety of TRUTH3

PreJetMCTruthAugmentationsCfg()

def python.MCTruthCommonConfig.PreJetMCTruthAugmentationsCfg	(		flags,
		**	kwargs
	)

Definition at line 93 of file MCTruthCommonConfig.py.

def PreJetMCTruthAugmentationsCfg(flags, **kwargs):
 
    acc = ComponentAccumulator()
 
    augmentationToolsList = []
 
    # These augmentations do *not* require truth jets at all
    # If requested, add a decoration to photons that were used in the dressing
 
    from DerivationFrameworkMCTruth.TruthDerivationToolsConfig import ( DFCommonTruthElectronDressingToolCfg, 
    DFCommonTruthMuonDressingToolCfg, DFCommonTruthClassificationToolCfg, DFCommonTruthMuonToolCfg, DFCommonTruthElectronToolCfg,
    DFCommonTruthPhotonToolSimCfg, DFCommonTruthNeutrinoToolCfg, DFCommonTruthBottomToolCfg, DFCommonTruthTopToolCfg, 
    DFCommonTruthBosonToolCfg, DFCommonTruthBSMToolCfg, DFCommonTruthForwardProtonToolCfg, DFCommonTruthElectronIsolationTool1Cfg,
    DFCommonTruthElectronIsolationTool2Cfg, DFCommonTruthMuonIsolationTool1Cfg, DFCommonTruthMuonIsolationTool2Cfg, 
    DFCommonTruthPhotonIsolationTool1Cfg, DFCommonTruthPhotonIsolationTool2Cfg, DFCommonTruthPhotonIsolationTool3Cfg ) 
    
    # schedule the special truth building tools and add them to a common augmentation; note taus are handled separately below
    for item in [ DFCommonTruthClassificationToolCfg, DFCommonTruthMuonToolCfg, DFCommonTruthElectronToolCfg,
    DFCommonTruthPhotonToolSimCfg, DFCommonTruthNeutrinoToolCfg, DFCommonTruthBottomToolCfg, DFCommonTruthTopToolCfg,
    DFCommonTruthBosonToolCfg, DFCommonTruthBSMToolCfg, DFCommonTruthElectronIsolationTool1Cfg,
    DFCommonTruthElectronIsolationTool2Cfg, DFCommonTruthMuonIsolationTool1Cfg, DFCommonTruthMuonIsolationTool2Cfg,
    DFCommonTruthPhotonIsolationTool1Cfg, DFCommonTruthPhotonIsolationTool2Cfg, DFCommonTruthPhotonIsolationTool3Cfg]:    
        augmentationToolsList.append(acc.getPrimaryAndMerge(item(flags)))
    augmentationToolsList.append(acc.getPrimaryAndMerge(DFCommonTruthForwardProtonToolCfg(flags)))
 
    if 'decorationDressing' in kwargs:
        augmentationToolsList.append(acc.getPrimaryAndMerge(DFCommonTruthElectronDressingToolCfg(flags, decorationName = kwargs['decorationDressing'])))
        augmentationToolsList.append(acc.getPrimaryAndMerge(DFCommonTruthMuonDressingToolCfg(flags, decorationName = kwargs['decorationDressing'])))
 
    for i, tool in enumerate(augmentationToolsList):
        acc.addEventAlgo(CompFactory.DerivationFramework.CommonAugmentation(name ="MCTruthCommonPreJetKernelNo{num}".format(num = i+1), AugmentationTools = [tool]))
    
    return(acc)
 
 

TruthMetaDataWriterCfg()

def python.MCTruthCommonConfig.TruthMetaDataWriterCfg	(		flags,
			name
	)

Definition at line 11 of file MCTruthCommonConfig.py.

def TruthMetaDataWriterCfg(flags, name):
    acc = ComponentAccumulator()
    theTruthMetaDataWriter =  CompFactory.DerivationFramework.TruthMetaDataWriter(name)
    acc.addPublicTool(theTruthMetaDataWriter)
    CommonAugmentation = CompFactory.DerivationFramework.CommonAugmentation
    acc.addEventAlgo(CommonAugmentation(f"{name}Kernel", AugmentationTools = [theTruthMetaDataWriter]))
    return acc