JetRecConfig.py

Go to the documentation of this file.

# Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
 
"""
JetRecConfig: A helper module for configuring jet reconstruction     
 
The functions defined here turn JetDefinition object into ComponentAccumulator or list of algs fully configured
and ready to be inserted in the framework sequence.
 
Author: TJ Khoo, P-A Delsart                                                      
"""
 
 
from AthenaCommon import Logging
jetlog = Logging.logging.getLogger('JetRecConfig')
 
from ROOT import xAODType
xAODType.ObjectType
 
from AthenaConfiguration.ComponentAccumulator import ComponentAccumulator
from AthenaConfiguration.ComponentFactory import CompFactory
 
 
from JetRecConfig.JetDefinition import JetDefinition, JetInputConstitSeq, JetInputConstit, JetInputExternal
from JetRecConfig.JetGrooming import GroomingDefinition
from JetRecConfig.DependencyHelper import solveDependencies, solveGroomingDependencies, aliasToModDef
 
 
__all__ = ["JetRecCfg", "JetInputCfg"]
 
 
 
 
 
def JetRecCfg( flags, jetdef,  returnConfiguredDef=False):
    """Top-level function for running jet finding or grooming.
    
    This returns a ComponentAccumulator that can be merged with others
    from elsewhere in the job and which provides everything needed to
    reconstruct one jet collection.
 
    arguments : 
      - jetdef : jet or grooming definition
      - flags : the configuration flags instance, mainly for input file
    peeking such that we don't attempt to reproduce stuff that's already
    in the input file. And also to be able to invoke building of inputs outside of Jet domain during reco from RAW/RDO.
      - returnConfiguredDef : is for debugging. It will also returns the cloned JetDefinition which contains the calculated dependencies.
 
    """
    
    sequenceName = jetdef.fullname()
    jetlog.info("******************")    
    jetlog.info("Setting up to find {0}".format(sequenceName))
 
    components = ComponentAccumulator()
    from AthenaCommon.CFElements import parOR
    components.addSequence( parOR(sequenceName) )
 
    # call the relevant function according to jetdef_i type 
    if isinstance(jetdef, JetDefinition):
        algs, jetdef_i = getJetDefAlgs(flags, jetdef , True)
    elif isinstance(jetdef, GroomingDefinition):
        algs, jetdef_i = getJetGroomAlgs(flags, jetdef, True)
 
    # FIXME temporarily reorder for serial running
    if flags.Concurrency.NumThreads <= 0:
        jetlog.info("Reordering algorithms in sequence {0}".format(sequenceName))
        algs, ca = reOrderAlgs(algs)
        components.merge(ca)
 
    for a in algs:
 
        if isinstance(a, ComponentAccumulator):
            components.merge(a )
        else:
            components.addEventAlgo( a , sequenceName = sequenceName )
 
    if returnConfiguredDef: return components, jetdef_i
    return components
 
 
def JetInputCfg(flags,jetOrConstitdef , context="default"):    
    """Returns a ComponentAccumulator containing algs needed to build inputs to jet finding as defined by jetOrConstitdef
 
    jetOrConstitdef can either be 
     * a JetDefinition : this happens when called from JetRecCfg, then the jetdef._prereqDic/Order are used.
     * a JetInputConstit : to allow scheduling the corresponding constituents algs independently of any jet alg. 
    
    context is only used if jetOrConstitdef is not a JetDefinition and must refer to a context in StandardJetContext
    """
    components = ComponentAccumulator()
 
    algs = getInputAlgs(jetOrConstitdef, flags, context)
 
    for a in algs:
 
        if isinstance(a, ComponentAccumulator):
            components.merge(a)
        else:
            components.addEventAlgo(a)
    
    return components
 
def PseudoJetCfg(jetdef):
    """Builds a ComponentAccumulator for creating PseudoJetContainer needed by jetdef.
    THIS updates jetdef._internalAtt['finalPJContainer'] 
    """
    components = ComponentAccumulator()
    pjalglist = getPseudoJetAlgs(jetdef)
    for pjalg in pjalglist:
        components.addEventAlgo(pjalg)
    return components
 
 
 
 
 
def getJetDefAlgs(flags, jetdef ,  returnConfiguredDef=False, monTool=None):
    """ Create the algorithms necessary to build the jet collection defined by jetdef.
    
    This internally finds all the dependencies declared into jetdef (through input, ghosts & modifiers) 
    and returns a list of all necessary algs.
 
    if returnConfiguredDef==True, also returns the fully configured clone of jetdef containing solved dependencies (debugging)
 
    monTool is to allow the trigger config to pass a monitoring tool.
 
    returns a list containing either algs or ComponentAccumulator 
      (ComponentAccumulator occurs only (?) in reco from RDO/RAW when we need to build externals such as clusters or tracks : in this case we call the main config functions from external packages)
    """
 
    # Scan the dependencies of this jetdef, also converting all aliases it contains 
    # into config objects and returning a fully configured copy.
 
    jetdef_i = solveDependencies(jetdef, flags=flags)
 
 
    # check if the conditions are compatible with the inputs & modifiers of this jetdef_i.
    # if in reco job we will remove whatever is incompatible and still try to run
    # if not, we raise an exception
    canrun = removeComponentFailingConditions(jetdef_i, raiseOnFailure= flags.Jet.strictMode)
    if not canrun :
        if returnConfiguredDef:
            return [], jetdef_i
        return []
 
    algs = []
 
    # With jetdef_i, we can now instantiate the proper c++ tools and algs.
    
    # algs needed to build the various inputs (constituents, track selection, event density, ...)
    algs += getInputAlgs(jetdef_i, flags , monTool=monTool)
 
    # algs to create fastjet::PseudoJet objects out of the inputs
    algs += getPseudoJetAlgs(jetdef_i)
    
    # Generate a JetRecAlg to run the jet finding and modifiers
    algs += [getJetRecAlg(jetdef_i, monTool=monTool)]
    
    jetlog.info("Scheduled JetAlgorithm instance \"jetalg_{0}\"".format(jetdef_i.fullname()))
    
    if returnConfiguredDef:
        return algs, jetdef_i
    return algs
 
def getJetGroomAlgs(flags, groomdef, returnConfiguredDef=False, monTool=None):
    """Instantiate and schedule all the algorithms needed to run the grooming alg 'groomdef' and
    add them in the ComponentAccumulator 'components'
 
    This function is meant to be called from the top-level JetRecConfig.JetRecCfg
    (groomdef is expected to be non locked and will be modified).
 
    monTool is to allow the trigger config to pass a monitoring tool.
    """
    
    # Find dependencies from modifier aliases and get a fully configured groomdef 
    #  ( This also detects input dependencies, see below)
    groomdef_i = solveGroomingDependencies(groomdef, flags)
    
    # Transfer the input & ghost dependencies onto the parent jet alg,
    # so they are handled when instatiating the parent jet algs
    for prereq  in groomdef_i._prereqOrder:
        #Protection for some modifiers that have three 'arguments'
        if len(prereq.split(':')) > 2:
            continue
        reqType, reqKey = prereq.split(':')
        if reqType=='ghost':
            groomdef_i.ungroomeddef.ghostdefs.append(reqKey)
        elif reqType.endswith('input') : # can be extinput or input
            groomdef_i.ungroomeddef.extrainputs.append(reqKey)
 
    jetlog.info("Scheduling parent alg {} for {} ".format(groomdef.ungroomeddef.fullname(), groomdef.fullname()))
 
    # Retrieve algs needed to build the parent (ungroomed) jets
    # (we always want it even if the parent jets are already in the input file because
    #  we need to rebuild the pseudoJet)
    algs, ungroomeddef_i = getJetDefAlgs(flags, groomdef_i.ungroomeddef , True)
    groomdef_i._ungroomeddef = ungroomeddef_i # set directly the internal members to avoid complication. This is fine, since we've been cloning definitions.
 
    #Filter the modifiers based on the flags
    removeGroomModifFailingConditions(groomdef_i, flags, raiseOnFailure = flags.Jet.strictMode)
 
    algs += [ getJetRecGroomAlg(groomdef_i, monTool=monTool) ]
 
 
    jetlog.info("Scheduled JetAlgorithm instance \"jetalg_{0}\"".format(groomdef_i.fullname()))
 
    if returnConfiguredDef: return algs, groomdef_i
    return algs
 
 
def getJetAlgs(flags, jetdef, returnConfiguredDef=False, monTool=None):
    # Useful helper function For Run-II config style
    if isinstance(jetdef, JetDefinition):
        func = getJetDefAlgs
    elif isinstance(jetdef, GroomingDefinition):
        func = getJetGroomAlgs
 
    return func(flags, jetdef, returnConfiguredDef, monTool)
 
 
 
 
 
def getPseudoJetAlgs(jetdef):
    """ Builds the list of configured PseudoJetAlgorithm needed for this jetdef.
    THIS updates jetdef._internalAtt['finalPJContainer'] 
    (this function is factorized out of PseudoJetCfg so it can be used standalone in the trigger config)
    """
    
    constitpjalg = getConstitPJGAlg(jetdef.inputdef , suffix=None , flags=jetdef._cflags, parent_jetdef = jetdef)
 
    finalPJContainer = str(constitpjalg.OutputContainer)
    pjalglist = [constitpjalg]
    
    # Schedule the ghost PseudoJetAlgs
    ghostlist = [ key for key in jetdef._prereqOrder if key.startswith('ghost:')]
    if ghostlist != []:
        # then we need to schedule a PseudoJetAlg for each ghost collections...
        pjContNames = [finalPJContainer]
        for ghostkey in sorted(ghostlist):
            ghostdef = jetdef._prereqDic[ghostkey]
            ghostpjalg = getGhostPJGAlg( ghostdef, jetdef )
            pjalglist.append(ghostpjalg)
            pjContNames.append( str(ghostpjalg.OutputContainer) ) #
 
        # .. and merge them together with the input constituents
        mergeId = mergedPJId( pjContNames )
        finalPJContainer = str(finalPJContainer)+"_merged"+mergeId
        mergerName = "PJMerger_id"+mergeId
        mergeAlg =CompFactory.PseudoJetMerger(
            mergerName,
            InputPJContainers = pjContNames,
            OutputContainer = finalPJContainer,
        )
        pjalglist.append(mergeAlg)
        
    # set the name of the complete,merged input PseudoJets, so it can be re-used downstream
    jetdef._internalAtt['finalPJContainer'] = finalPJContainer
    return pjalglist
    
 
_mergedPJContainers = dict()
def mergedPJId(pjList):
    """returns a simple unique ID for the list of PseudoJet container in pjList"""
    t = tuple(str(n) for n in pjList) # make sure it is string (it can be DataHandle in old style config)
    currentSize = len(_mergedPJContainers)
    return str(_mergedPJContainers.setdefault(t, currentSize))
 
 
def getInputAlgs(jetOrConstitdef, flags, context="default", monTool=None):
    """Returns the list of configured algs needed to build inputs to jet finding as defined by jetOrConstitdef
    
    jetOrConstitdef can either be 
     * a JetDefinition : this happens when called from JetRecCfg or getJetDefAlgs then the jetdef._prereqDic/Order are used.
     * a JetInputConstit : to allow scheduling the corresponding constituents algs independently of any jet alg. 
 
    context is only used if jetOrConstitdef is not a JetDefinition and must refer to a context in StandardJetContext.
 
    The returned list may contain several algs, including constituent modifications algs, track selection, copying of
    input truth particles and event density calculations
    It may also contain ComponentAccumulator, only (?) in reco from RDO/RAW when we need to build externals such as clusters or tracks : in this case we call the main config functions from external packages)
 
    """
 
    from .JetDefinition import JetInputConstit, JetDefinition
    if isinstance(jetOrConstitdef, JetInputConstit):
        # technically we need a JetDefinition, so just build an empty one only containing our JetInputConstit
        jetlog.info("Setting up jet inputs from JetInputConstit : "+jetOrConstitdef.name)
        jetdef = solveDependencies( JetDefinition('Kt', 0., jetOrConstitdef, context=context), flags )
        canrun = removeComponentFailingConditions(jetdef, raiseOnFailure = flags.Jet.strictMode)
        if not canrun:
            return []
    else:
        jetdef = jetOrConstitdef
    
    jetlog.info("Inspecting input file contents")
 
    # We won't prepare an alg if the input already exists in the in input file 
    try:
        filecontents = jetdef._cflags.Input.Collections
    except Exception:
        filecontents = []
    # local function to check if the container of the JetInputXXXX 'c' is already in filecontents :
    def isInInput( c ):
        cname = c.containername if isinstance(c, JetInputConstit) else c.containername(jetdef,c.specs)
        return cname in filecontents
 
    # Loop over all inputs required by jetdefs and get the corresponding algs
    inputdeps = [ inputkey for inputkey in jetdef._prereqOrder if inputkey.startswith('input:') or inputkey.startswith('extinput:') ]
    algs = []
    for inputfull in inputdeps:
        inputInstance = jetdef._prereqDic[inputfull]
        if isInInput( inputInstance ):
            jetlog.info(f"Input container for {inputInstance} already in input file.")
            continue
        
        # Get the input or external alg
        if isinstance(inputInstance, JetInputConstit):
            alg = getConstitModAlg(jetdef, inputInstance, monTool=monTool)
        else: # it must be a JetInputExternal
            alg = inputInstance.algoBuilder( jetdef, inputInstance.specs ) 
            
        if alg is not None:
            algs.append(alg)
 
    return algs
 
 
 
 
 
def getPJContName( jetOrConstitdef, suffix=None, parent_jetdef = None):
    """Construct the name of the PseudoJetContainer defined by the given JetDef or JetInputConstit.
    This name has to be constructed from various places, so we factorize the definition here.
    """
    cdef = jetOrConstitdef if isinstance(jetOrConstitdef, JetInputConstit) else jetOrConstitdef.inputdef
    _str_containername = cdef.containername(parent_jetdef).split(':')[-1] if callable(cdef.containername) else cdef.containername
    end = '' if suffix is None else f'_{suffix}'
    return f'PseudoJet{_str_containername}{end}'
    
def getConstitPJGAlg(constitdef, suffix=None, flags=None, parent_jetdef = None):
    """returns a configured PseudoJetAlgorithm which converts the inputs defined by constitdef into fastjet::PseudoJet
 
    IMPORTANT : constitdef must have its dependencies solved (i.e. it must result from a solveDependencies() call)
    
    the flags argument is TEMPORARY and will be removed once further dev on PseudoJetAlgorithm is done (see comment below)
    """
    _str_containername = constitdef.containername(parent_jetdef).split(':')[-1] if callable(constitdef.containername) else constitdef.containername
    jetlog.debug("Getting PseudoJetAlg for label {0} from {1}".format(constitdef.name,constitdef.inputname))
    end = '' if suffix is None else f'_{suffix}'
    full_label = constitdef.label + end
    pjgalg = CompFactory.PseudoJetAlgorithm(
        "pjgalg_"+_str_containername+end,
        InputContainer = _str_containername,
        OutputContainer =getPJContName(constitdef, suffix = suffix, parent_jetdef = parent_jetdef),
        Label = full_label,
        SkipNegativeEnergy=True,
        DoByVertex=constitdef.byVertex
        )
    
    # This is a terrible temporary hack to enable running in cosmic runs.
    # There should not be any Properties setting here in a helper function.
    # This will have to be fixed when all the filtering occuring in PseudoJetAlgorithm
    # is removed and done as part of a JetConstituentModSequence.
    if flags is not None:
        from AthenaConfiguration.Enums import BeamType        
        pjgalg.UseChargedPV = (flags.Beam.Type == BeamType.Collisions)
    
    if suffix == 'PUSB':
        pjgalg.UseChargedPV=False
        pjgalg.UseChargedPUsideband=True
    elif suffix == 'Neut':
        pjgalg.UseCharged=False
    # end of HAck
        
    return pjgalg
 
def getGhostPJGAlg(ghostdef, parentjetdef = None):
    """returns a configured PseudoJetAlgorithm which converts the inputs defined by constitdef into fastjet::PseudoJet
    
    The difference for the above is this is dedicated to ghosts which need variations for the Label and the muon segment cases.  
 
    IMPORTANT : ghostdef must have its dependencies solved (i.e. it must result from a solveDependencies() call)
    """
    label = "Ghost"+ghostdef.label # IMPORTANT !! "Ghost" in the label will be interpreted by the C++ side !
    _container_name = ghostdef.containername(parentjetdef).split(":")[1] if callable(ghostdef.containername) else ghostdef.containername
    _output_cont_name_suffix = "" if parentjetdef.context == "default" or _container_name.endswith(parentjetdef.context) else ("_" + parentjetdef.context)
 
    kwargs = dict( 
        InputContainer = _container_name,
        OutputContainer= "PseudoJetGhost"+_container_name + _output_cont_name_suffix,
        Label=              label,
        SkipNegativeEnergy= True,
    )
 
    pjaclass = CompFactory.PseudoJetAlgorithm
    if ghostdef.basetype=="MuonSegment":
        # Muon segments have a specialised type
        pjaclass = CompFactory.MuonSegmentPseudoJetAlgorithm
        kwargs.update( Pt =1e-20 ) # ??,)
        kwargs.pop('SkipNegativeEnergy')
 
    pjgalg = pjaclass( "pjgalg_" + label + "_" + parentjetdef.context, **kwargs )
    return pjgalg
 
 
def getJetRecAlg( jetdef, monTool = None, ftf_suffix = '', extraOutputs = []):
    """Returns the configured JetRecAlg instance corresponding to jetdef
 
    IMPORTANT : jetdef must have its dependencies solved (i.e. it must result from solveDependencies() )
    """
    pjContNames = jetdef._internalAtt['finalPJContainer']
 
    kwargs = {
        "JetAlgorithm": jetdef.algorithm,
        "JetRadius": jetdef.radius,
        "PtMin": jetdef.ptmin,
        "InputPseudoJets": pjContNames,
        "GhostArea": jetdef.ghostarea,
        "JetInputType": int(jetdef.inputdef.jetinputtype),
        "RandomOption": 1,
        "VariableRMinRadius": jetdef.VRMinRadius,
        "VariableRMassScale": jetdef.VRMassScale
    }
 
    jetname = jetdef.fullname()
    if jetdef.byVertex:
        jclust = CompFactory.JetClustererByVertex(
            "builder",
            **kwargs
        )
    else:
        jclust = CompFactory.JetClusterer(
            "builder",
            **kwargs
        )
 
    mods = getJetModifierTools(jetdef)
 
    jra = CompFactory.JetRecAlg(
        "jetrecalg_"+jetname+ftf_suffix,
        Provider = jclust,
        Modifiers = mods,
        OutputContainer = jetname+ftf_suffix,
        )
    if monTool:
        # this option can't be set in AnalysisBase -> set only if explicitly asked :
        jra.MonTool = monTool
 
    # Explicitly register (ghost)associated branches for downstream dependency resolution
    jra.ExtraOutputs = extraOutputs + [
        ('xAOD::JetContainer',f'{jetname}.Ghost{ghost}') for ghost in jetdef.ghostdefs
    ]
    return jra
 
 
def getJetRecGroomAlg(groomdef,monTool=None,extraOutputs=[]):
    """Returns a configured JetRecAlg set-up to perform the grooming defined by 'groomdef' 
    ('monTool' is a temporary placeholder, it is expected to be used in the trigger in the future) 
    """
    jetlog.debug("Configuring grooming alg \"jetalg_{0}\"".format(groomdef.fullname()))
 
 
    # the grooming tool (a IJetProvider instance)
    groomClass = CompFactory.getComp(groomdef.tooltype)
    groomer = groomClass(groomdef.groomalg,
                         UngroomedJets = groomdef.ungroomeddef.fullname(),
                         ParentPseudoJets = groomdef.ungroomeddef._internalAtt['finalPJContainer'],
                         **groomdef.properties)
 
    # get JetModifier list
    mods = getJetModifierTools(groomdef)
 
    # put everything together in a JetRecAlg
    jetname = groomdef.fullname()
    jra = CompFactory.JetRecAlg(
        "jetrecalg_"+jetname,
        Provider = groomer,
        Modifiers = mods,
        OutputContainer = jetname)
 
    if not isAnalysisRelease():
        jra.MonTool = monTool
 
    # Explicitly register (ghost)associated branches for downstream dependency resolution
    jra.ExtraOutputs = extraOutputs + [
        ('xAOD::JetContainer',f'{jetname}.Ghost{ghost}') for ghost in groomdef.ungroomeddef.ghostdefs
    ]
 
    return jra
 
 
 
def getJetCopyAlg(jetsin, jetsoutdef, decorations=[], shallowcopy=True, shallowIO=True, monTool=None):
    """
    Get a JetRecAlg set up to copy a jet collection and apply mods
    In this setup we do not resolve dependencies because typically
    these may be set up already in the original jet collection
    In future we may wish to add a toggle.
 
    The decoration list can be set in order for the decorations
    (jet moments) on the original jets to be propagated to the
    copy collection. Beware of circular dependencies!
    """
    jcopy = CompFactory.JetCopier(
        "copier",
        InputJets = jetsin,
        DecorDeps=decorations,
        ShallowCopy=shallowcopy,
        ShallowIO=shallowIO)
 
    # Convert mod aliases into concrete tools
    mods = []
    for mod in jetsoutdef.modifiers:
        moddef = aliasToModDef(mod,jetsoutdef)
        mods.append(getModifier(jetsoutdef,moddef,moddef.modspec))
 
    jetsoutname = jetsoutdef.fullname()
    jra = CompFactory.JetRecAlg(
        "jetrecalg_copy_"+jetsoutname,
        Provider = jcopy,
        Modifiers = mods,
        OutputContainer = jetsoutname)
    if not isAnalysisRelease():
        jra.MonTool = monTool
 
 
    return jra
 
 
 
def getConstitModAlg(parentjetdef, constitSeq, monTool=None):
    """returns a configured JetConstituentModSequence or None if constit.modifiers == [] 
    
    The JetConstituentModSequence is determined by the JetInputConstitSeq constitSeq . 
    However, details of the configuration of the JetConstituentModSequence may depends on which JetDefinition
    this JetConstituentModSequence is intended for. Thus the function also requires a parentjetdef JetDefinition input
  
    IMPORTANT : parentjetdef & constitSeq must have their dependencies solved (i.e. they must result from solveDependencies() )
    
    See also getConstitModAlg_nojetdef
    """
    
    # JetInputConstit do not need any JetConstituentModSequence
    # (they are only needed to trigger the building of the source container and a PJ algo)
    if not isinstance(constitSeq, JetInputConstitSeq): return
 
    
    inputtype = constitSeq.basetype
 
    sequence = constitSeq.modifiers
    
    modlist = []
 
    #if modlist == []: return
    if constitSeq.inputname == constitSeq.containername: return
    
    for step in sequence:
        modInstance = parentjetdef._prereqDic[ f'cmod:{step}' ]
        if not modInstance.tooltype: continue
 
        toolclass = getattr( CompFactory, modInstance.tooltype)
 
        # update the properties : if some of them are function, just replace by calling this func :
        for k,v in modInstance.properties.items():
            if callable(v) :
                modInstance.properties[k ] = v(parentjetdef, constitSeq )
        
        tool =  toolclass(modInstance.name,**modInstance.properties)
        
        if (inputtype == xAODType.FlowElement or inputtype == xAODType.ParticleFlow) and modInstance.tooltype not in ["CorrectPFOTool","ChargedHadronSubtractionTool"]:
            tool.IgnoreChargedPFO=True
            tool.ApplyToChargedPFO=False
        tool.InputType = inputtype
        modlist.append(tool)
 
    sequenceshort = "".join(sequence)
    seqname = "ConstitMod{0}_{1}".format(sequenceshort,constitSeq.name)    
    inputcontainer = str(constitSeq.inputname)
    outputcontainer = str(constitSeq.containername)
 
    if (inputtype == xAODType.FlowElement or inputtype == xAODType.ParticleFlow):
        # Tweak PF names because ConstModSequence needs to work with
        # up to 4 containers
        def chopPFO(thestring):
            pfostr = "ParticleFlowObjects"
            if thestring.endswith(pfostr):
                return thestring[:-len(pfostr)]
            return thestring
        inputcontainer = chopPFO(inputcontainer)
        outputcontainer = chopPFO(outputcontainer)
 
    doByVertex = constitSeq.byVertex
 
    inChargedFEDecorKeys = []
    inNeutralFEDecorKeys = []
 
    if doByVertex:
        # For by-vertex jet reconstruction, we are performing deep copies of neutral PFOs
        # Need to schedule this algorithm after all decorations have been apllied by using ReadDecorHandleKeys
 
        # https://gitlab.cern.ch/atlas/athena/-/blob/main/Reconstruction/PFlow/PFlowUtils/src/PFlowCellCPDataDecoratorAlgorithm.h
 
        # https://gitlab.cern.ch/atlas/athena/-/blob/main/Reconstruction/PFlow/PFlowUtils/src/PFlowCalibPFODecoratorAlgorithm.h
 
        # https://gitlab.cern.ch/atlas/athena/-/blob/main/Reconstruction/eflowRec/eflowRec/PFEGamFlowElementAssoc.h
 
        # https://gitlab.cern.ch/atlas/athena/-/blob/main/Reconstruction/eflowRec/eflowRec/PFMuonFlowElementAssoc.h       
 
        inChargedFEDecorKeys += ["cellCPData", "FE_ElectronLinks", "FE_PhotonLinks", "FE_MuonLinks"]
        inNeutralFEDecorKeys += ["calpfo_NLeadingTruthParticleBarcodeEnergyPairs", "FE_ElectronLinks", "FE_PhotonLinks", "FE_MuonLinks"]
 
    modseq = CompFactory.JetConstituentModSequence(seqname,
                                                   InputType=inputtype,
                                                   OutputContainer = outputcontainer,
                                                   InputContainer= inputcontainer,
                                                   InChargedFEDecorKeys = inChargedFEDecorKeys,
                                                   InNeutralFEDecorKeys = inNeutralFEDecorKeys,
                                                   Modifiers = modlist,
                                                   DoByVertex = doByVertex
    )
    if monTool:
        modseq.MonTool = monTool
 
    constitmodalg = CompFactory.JetAlgorithm("jetalg_{0}".format(modseq.getName()))
    constitmodalg.Tools = [modseq]
 
    return constitmodalg
 
def getConstitModAlg_nojetdef( constitSeq, flags,context="default", monTool=None):
    """Same as getConstitModAlg. 
    This is a convenient function to obtain a JetConstituentModSequence when it is certain, no JetDef is needed.
    This function just builds a dummy JetDefinition then calls getConstitModAlg
    Needed in the trigger config.
    """
    jetdef = solveDependencies( JetDefinition('Kt', 0., constitSeq, context=context) , flags)
    constitSeq = jetdef._prereqDic['input:'+constitSeq.name] # retrieve the fully configured version of constitSeq
    return getConstitModAlg(jetdef, constitSeq, monTool=monTool)
 
 
def getJetModifierTools( jetdef ):
    """returns the list of configured JetModifier tools needed by this jetdef.
    This is done by instantiating the actual C++ tool as ordered in jetdef._prereqOrder
    """
    modlist = [ key for key in jetdef._prereqOrder if key.startswith('mod:')]
    
    mods = []
    for modkey in modlist:
        moddef = jetdef._prereqDic[modkey]
        modkey = modkey[4:] # remove 'mod:'
        modspec = '' if ':' not in modkey else modkey.split(':',1)[1]
        mod = getModifier(jetdef,moddef,modspec)
        mods.append(mod)
 
    return mods
 
 
def getModifier(jetdef, moddef, modspec, flags=None):
    """Translate JetModifier into a concrete tool"""
    jetlog.verbose("Retrieving modifier {0}".format(str(moddef)))
 
    if flags is not None:
        # then we are called from non JetRecConfig functions: we must update the context according to flags
        jetdef = jetdef.clone()
        jetdef._cflags = flags
        jetdef._contextDic = flags.Jet.Context[jetdef.context]
 
    # Get the modifier tool
    try:
        modtool = moddef.createfn(jetdef, modspec)
    except Exception as e:
        jetlog.error( f"Unhandled modifier specification {modspec} for mod {moddef} acting on jet def {jetdef.basename}!")
        jetlog.error( f"Received exception \"{e}\"" )
        jetlog.error( f"Helper function is \"{moddef.createfn}\"" )
        raise ValueError( f"JetModConfig unable to handle mod {moddef} with spec \"{modspec}\"")
 
 
    # now we overwrite the default properties of the tool, by those
    # set in the moddef :
    for k,v in moddef.properties.items():
        if callable(v) :
            # The value we got is a function : we call it to get the actual value we want to set on the tool
            v = v(jetdef, modspec)
        setattr(modtool, k, v)
    
    return modtool
 
 
    
            
def removeComponentFailingConditions(jetdef, flags=None, raiseOnFailure=True):
    """Filters the lists jetdef.modifiers and jetdef.ghosts (and jetdef._prereqOrder), so only the components
    comptatible with flags are selected. 
    If flags==None : assume jetdef._cflags is properly set (this is done by higher-level functions)
    The compatibility is ultimately tested using the component 'filterfn' attributes.
    Internally calls the function isComponentPassingConditions() (see below) 
    """
    jetlog.info("Standard Reco mode : filtering components in "+str(jetdef))
 
    if jetdef._cflags is None:
        jetdef._cflags = flags
 
    
 
    # ---------
    # first check if the input can be obtained. If not return.
    ok,reason = isComponentPassingConditions( jetdef.inputdef, jetdef._cflags, jetdef)
    if not ok:
        if raiseOnFailure:
            raise Exception(f"JetDefinition {jetdef} can NOT be scheduled. Failure  of input {jetdef.inputdef.name}  reason={reason}" )
        jetlog.info(f"IMPORTANT : removing {jetdef} because input incompatible with job conditions. Reason={reason} ")
        return False
 
    if isinstance( jetdef.inputdef, JetInputConstitSeq):
        # remove ConstitModifiers failing conditions.
        jetdef.inputdef.modifiers = filterJetDefList(jetdef, jetdef.inputdef.modifiers, 'cmod', raiseOnFailure, jetdef._cflags)
        
            
    
    # call the helper function to perform filtering :
    jetdef.ghostdefs = filterJetDefList(jetdef, jetdef.ghostdefs, "ghost", raiseOnFailure, jetdef._cflags)
    jetdef.modifiers = filterJetDefList(jetdef, jetdef.modifiers, "mod", raiseOnFailure, jetdef._cflags)
    # finally filter all possible intermediate dependency :
    filterJetDefList(jetdef, list(jetdef._prereqOrder), "", raiseOnFailure, jetdef._cflags)
    return True
 
 
 
def removeGroomModifFailingConditions(groomdef, flags, raiseOnFailure=True):
 
    groomdef.modifiers = filterJetDefList(groomdef, groomdef.modifiers, "mod", raiseOnFailure, flags)
    filterJetDefList(groomdef, list(groomdef._prereqOrder), "", raiseOnFailure, flags)
 
 
 
# define a helper function to filter components from jet definition
def filterJetDefList(jetdef, inList, compType, raiseOnFailure, flags):
 
    nOut=0
    outList=[]
    basekey= compType+':' if compType!="" else ""
 
    fullname = jetdef.fullname()
 
    # loop over components in the list to be filtered
    for comp in inList:
        fullkey = basekey+comp
        cInstance = jetdef._prereqDic[fullkey]
        ok, reason = isComponentPassingConditions(cInstance, flags, jetdef)
        if not ok :
            if raiseOnFailure:
                raise Exception("JetDefinition {} can NOT be scheduled. Failure  of {} {}  reason={}".format(
                    jetdef, compType, comp, reason) )
 
            nOut+=1
            jetlog.info(f"{fullname} : removing {compType}  {comp}  reason={reason}")
            if fullkey in jetdef._prereqOrder:
                jetdef._prereqOrder.remove(fullkey)
            if compType=='ghost':
                removeFromList(jetdef._prereqOrder, 'input:'+comp)
                removeFromList(jetdef._prereqOrder, 'extinput:'+comp)
        else:
            outList.append(comp)
 
    jetlog.info(" *** Number of {} filtered components = {}  final  list={}".format(compType, nOut, outList) )
 
    return outList
 
 
 
 
def isComponentPassingConditions(component, flags, jetdef):
    """Test if component is compatible with flags.
    This is done by calling component.filterfn AND testing all its prereqs.
    """
    for req in component.prereqs:
        _str_req = req(jetdef) if callable(req) else req
        if _str_req not in jetdef._prereqDic:
            return False, "prereq "+_str_req+" not available"
        reqInstance = jetdef._prereqDic[_str_req]
        ok, reason = isComponentPassingConditions(reqInstance, flags, jetdef)
        if not ok :
            return False, "prereq "+str(reqInstance)+" failed because : "+reason
 
    ok, reason = component.filterfn(flags)
    return ok, reason
 
 
def isAnalysisRelease():
    from AthenaConfiguration.Enums import Project
    return Project.determine() in( Project.AnalysisBase, Project.AthAnalysis)
 
 
def reOrderAlgs(algs):
    """In runIII the scheduler automatically orders algs, so the JetRecConfig helpers do not try to enforce the correct ordering.
    This is not the case in runII config for which this jobO is intended --> This function makes sure some jet-related algs are well ordered.
    """
    def _flatten_CA(cfg, sequence_name="AthAlgSeq"):
        from AthenaConfiguration.ComponentAccumulator import ConfigurationError
        if not isinstance(cfg, ComponentAccumulator):
            raise ConfigurationError('It is not allowed to flatten with multiple top sequences')
 
        if len(cfg._allSequences) != 1:
            raise ConfigurationError('It is not allowed to flatten with multiple top sequences')
 
        sequence = cfg.getSequence(sequence_name)
        if sequence.Sequential:
            raise ConfigurationError('It is not allowed to flatten sequential sequences')
 
        members = []
        for member in sequence.Members:
            if isinstance(member, CompFactory.AthSequencer):
                members.extend(_flatten_CA(cfg, member.getName()))
            else:
                members.append(member)
 
        sequence.Members = members
        return members
 
    algs_tmp = []
    ca = ComponentAccumulator()
    for a in algs:
        if not isinstance(a, ComponentAccumulator) :
            algs_tmp.append(a)
        else:
            _flatten_CA(a)
            ca_algs = list(a._algorithms.keys())
            for algo in ca_algs:
                algs_tmp.append(a.popEventAlgo(algo))
            ca.merge(a)
 
    algs = algs_tmp
    evtDensityAlgs = [(i, alg) for (i, alg) in enumerate(algs) if alg and alg.getType() == 'EventDensityAthAlg' ]
    pjAlgs = [(i, alg) for (i, alg) in enumerate(algs) if alg and alg.getType() == 'PseudoJetAlgorithm' ]
    pairsToswap = []
    for i, edalg in evtDensityAlgs:
        edInput = edalg.EventDensityTool.InputContainer
        for j, pjalg in pjAlgs:
            if j < i:
                continue 
            if edInput == str(pjalg.OutputContainer):
                pairsToswap.append((i, j))
    for i, j in pairsToswap:
        algs[i], algs[j] = algs[j], algs[i]
        
    return algs, ca
 
 
 
def registerAsInputConstit( jetdef ):
    """Make the jet collection described by jetdef available as constituents to other jet finding 
   
    Technically : create  JetInputExternal and JetInputConstit and register them in the relevant look-up dictionnaries.
    the JetInputConstit will have a algoBuilder to generate the JetContainer described by jetdef
    """
    from .StandardJetConstits import stdConstitDic, stdInputExtDic
    jetname = jetdef.fullname()
 
    # define a function to generate the CA for this jetdef
    def jetBuilder(largejetdef,spec):
        return JetRecCfg(largejetdef._cflags, jetdef)
 
    stdInputExtDic[jetname]  = JetInputExternal( jetname, jetname, algoBuilder=jetBuilder)
    stdConstitDic[jetname] = JetInputConstit(jetname, xAODType.Jet, jetname )
    
 
def removeFromList(l, o):
    if o in l:
        l.remove(o)
 
# Run test with command like "python -m JetRecConfig.JetRecConfig"
def JetRecConfigTest(flags=None):
 
    # Config flags steer the job at various levels
    if flags is None:
        from AthenaConfiguration.AllConfigFlags import initConfigFlags
        flags = initConfigFlags()
 
        from AthenaConfiguration.TestDefaults import defaultTestFiles, defaultConditionsTags
        flags.Input.Files = defaultTestFiles.LATEST_AOD_MC
        flags.IOVDb.GlobalTag = defaultConditionsTags.LATEST_MC
 
        flags.lock()
 
    # Get a ComponentAccumulator setting up the fundamental Athena job
    from AthenaConfiguration.MainServicesConfig import MainServicesCfg 
    cfg=MainServicesCfg(flags) 
 
    # Add the components for reading in pool files
    from AthenaPoolCnvSvc.PoolReadConfig import PoolReadCfg
    cfg.merge(PoolReadCfg(flags))
 
    # Add the components from our jet reconstruction job
    from JetRecConfig.StandardSmallRJets import AntiKt4EMTopo
    cfg.merge(JetRecCfg(flags, AntiKt4EMTopo))
 
    cfg.printConfig(withDetails=False,summariseProps=True)
    cfg.run(10)
 
if __name__=="__main__":
    JetRecConfigTest()