TopoAlgorithms.py

Go to the documentation of this file.

# Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
 
from operator import attrgetter
from enum import Enum
 
from AthenaCommon.Logging import logging
log = logging.getLogger(__name__)
 
from .TopoAlgos import DecisionAlgo, MultiplicityAlgo, SortingAlgo
 
class AlgType(Enum):
    SORT = ('sortingAlgorithms')
    DEC = ('decisionAlgorithms') 
    MULT = ('multiplicityAlgorithms')
 
    def __init__(self, key):
        self.key = key
    
class AlgCategory(Enum):
    TOPO = (1, 'TOPO', 'new topo', 'TopoAlgoDef')
    MUCTPI = (2, 'MUTOPO', 'muctpi topo', 'TopoAlgoDefMuctpi')
    LEGACY = (3, 'R2TOPO', 'legacy topo', 'TopoAlgoDefLegacy')
    MULTI = (4, 'MULTTOPO', 'multiplicity topo', 'TopoAlgoDefMultiplicity')
 
    def __init__(self, _, key, desc, defFile ):
        self.key = key
        self.prefix = key + '_' if key else ''
        self.desc = desc
        self.defFile = defFile
 
    def __str__(self):
        return self.desc
 
    @staticmethod
    def getAllCategories():
        return [ AlgCategory.TOPO, AlgCategory.MUCTPI, AlgCategory.MULTI, AlgCategory.LEGACY ]
            
    @staticmethod
    def getCategoryFromBoardName(boardName):
        if 'muctpi' in boardName.lower():
            currentTopoCategory = AlgCategory.MUCTPI
        elif 'topo' in boardName.lower():
            if 'legacy' in boardName.lower():
                currentTopoCategory = AlgCategory.LEGACY
            else:
                currentTopoCategory = AlgCategory.TOPO
        else:
            raise RuntimeError("Board %s is not a topo board" % boardName )
        return currentTopoCategory
 
 
class MenuTopoAlgorithmsCollection(object):
 
    def __init__(self):
        # all algos that are in menu (new and legacy)
        self.topoAlgos = {}
        for cat in AlgCategory:
            self.topoAlgos[cat] = {}
            if cat in [AlgCategory.TOPO, AlgCategory.MUCTPI, AlgCategory.LEGACY]:
                self.topoAlgos[cat][AlgType.DEC] = {}
                self.topoAlgos[cat][AlgType.SORT] = {}
            elif cat in [AlgCategory.MULTI]:
                self.topoAlgos[cat][AlgType.MULT] = {}
 
    def addAlgo(self, algo, category):
        if type(category) is not AlgCategory:
            raise RuntimeError( "No category is provided when adding topo algo %s to menu" % algo.name)
 
        if isinstance(algo,DecisionAlgo):
            algType = AlgType.DEC
        elif isinstance(algo, SortingAlgo):
            algType = AlgType.SORT
        elif isinstance(algo, MultiplicityAlgo):
            algType = AlgType.MULT
        else:
            raise RuntimeError("Trying to add topo algorithm %s of unknown type %s to the menu" % (algo.name, type(algo)))
 
        if algType not in self.topoAlgos[category]:
            self.topoAlgos[category][algType] = {}
 
        if algo.name in self.topoAlgos[category][algType]:
            raise RuntimeError("Trying to add topo algorithm %s a second time" % algo.name)
 
        self.topoAlgos[category][algType][algo.name] = algo
 
 
    def json(self):
 
        confObj = {}
        for cat in self.topoAlgos:
            confObj[cat.key] = {}
            for typ in self.topoAlgos[cat]:
                confObj[cat.key][typ.key] = {}
                for alg in sorted(self.topoAlgos[cat][typ].values(), key=attrgetter('name')):
                    confObj[cat.key][typ.key][alg.name] = alg.json()
 
        return confObj