LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper Class Reference

Inheritance diagram for LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper:

Collaboration diagram for LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper:

Public Member Functions
def	__init__ (self, flags, algClassOrObj=None, name=None, *args, **kwargs)
def	defineDQAlgorithm (self, name, hanConfig, thresholdConfig=None)
def	defineHistogram (self, *args, fillGroup=None, hanConfig={}, paths=[], **kwargs)
def	defineTree (self, *args, fillGroup=None, **kwargs)
def	result (self)

Static Public Member Functions
def	printHanConfig (filename="collisions_run.config")

Public Attributes
	helper
	alg
	fillGroups
	dqEnv

Static Public Attributes
	hanConfigs
	hanAlgConfigs
	hanThresholdConfigs
	SIGNATURES
	HELPURL

Detailed Description

This class is designed to handle registering all of L1Calo's monitoring histograms and trees in a
coherent way. It will also generate the han config file for all the histograms.

Definition at line 5 of file LVL1CaloMonitoringConfig.py.

Constructor & Destructor Documentation

__init__()

def LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper.__init__	(		self,
			flags,
			algClassOrObj = None,
			name = None,
		*	args,
		**	kwargs
	)

Create the configuration helper.

Arguments:
flags -- the configuration flag object
algClassOrObj -- the name you want to assign the family of algorithms

Definition at line 103 of file LVL1CaloMonitoringConfig.py.

    def __init__(self, flags, algClassOrObj = None, name = None, *args, **kwargs):
        '''
        Create the configuration helper.
 
        Arguments:
        flags -- the configuration flag object
        algClassOrObj -- the name you want to assign the family of algorithms
        '''
        from AthenaMonitoring import AthMonitorCfgHelper
        self.helper = AthMonitorCfgHelper(flags,name)
        self.alg = self.helper.addAlgorithm(algClassOrObj,name,*args, **kwargs) if algClassOrObj is not None else None
        self.fillGroups = {}
        self.dqEnv = flags.DQ.Environment # used to decide if should defineTree or not ...
 

Member Function Documentation

defineDQAlgorithm()

def LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper.defineDQAlgorithm	(		self,
			name,
			hanConfig,
			thresholdConfig = None
	)

:param name: name of algorithm
:param hanConfig: dict of algo properties
:param thresholdConfig: dict of thresholds, keys in form of ParName.level
:return:

Definition at line 117 of file LVL1CaloMonitoringConfig.py.

    def defineDQAlgorithm(self,name,hanConfig,thresholdConfig=None):
 
        """
 
        :param name: name of algorithm
        :param hanConfig: dict of algo properties
        :param thresholdConfig: dict of thresholds, keys in form of ParName.level
        :return:
        """
 
        # note: this method will replace any existing alg definition
 
        thresNum = len(self.hanThresholdConfigs)
        if thresholdConfig is not None:
            hanConfig["thresholds"] = f"L1CaloThreshold{thresNum}"
            threshDict = {}
            for parName,limVals in thresholdConfig.items():
                if len(limVals) != 2:
                    raise Exception("must specify two limits: warning and error")
                if parName not in threshDict: threshDict[parName] = {}
                threshDict[parName]["warning"] = limVals[0]
                threshDict[parName]["error"] = limVals[1]
            # see if any existing thresholds are identical, if so we can reuse
            for threshName,thresh in self.hanThresholdConfigs.items():
                if str(thresh)==str(threshDict):
                    threshDict = None
                    hanConfig["thresholds"] = threshName
                    break
            if threshDict is not None: self.hanThresholdConfigs[hanConfig["thresholds"]] = threshDict
        self.hanAlgConfigs[name] = hanConfig
 
        return
 
 

defineHistogram()

def LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper.defineHistogram	(		self,
		*	args,
			fillGroup = None,
			hanConfig = {},
			paths = [],
		**	kwargs
	)

:param path:
:param fillGroup:
:param args:
:param kwargs:
:return:

Definition at line 151 of file LVL1CaloMonitoringConfig.py.

    def defineHistogram(self,*args,fillGroup=None,hanConfig={},paths=[],**kwargs):
        '''
 
        :param path:
        :param fillGroup:
        :param args:
        :param kwargs:
        :return:
        '''
 
        if paths != []:
            for path in paths:
                # create a copy of the histogram in each of the extra locations
                self.defineHistogram(*args,fillGroup=fillGroup,hanConfig=hanConfig,paths=[],path=path,**kwargs)
            return None
 
        argsCopy = list(args) # need to convert tuple to list to convert it
        if ";" not in args[0]:
            argsCopy[0] += ";h_" + argsCopy[0].replace(":","_")
 
        if kwargs.get("path",None) is None:
            # put in the Developer path, under the name of the algorithm
            kwargs["path"] = "Developer/" + self.alg.name
        elif kwargs["path"][-1] == '/':
            kwargs["path"] = kwargs["path"][:-1] # strip trailing slash
        # verify path obeys convention
        splitPath = kwargs["path"].split("/")
        if splitPath[0] not in ["Shifter","Expert","Developer"]:
            raise Exception("Path of histogram invalid, does not start with one of the allowed audiences (Shifter,Expert,Developer)")
 
        # require a hanConfig not in Developer or a detail dir
        if splitPath[0] != "Developer" and splitPath[-1] != "detail" and ("algorithm" not in hanConfig):
            # will default to using GatherData as long as there is a description
            if "description" not in hanConfig:
                raise Exception("Must specify a hanConfig for a Shifter or Expert (non-detail) histogram")
            else:
                hanConfig["algorithm"] = "GatherData" # must have an algo, otherwise wont be valid han config
 
 
        if fillGroup is None: fillGroup = self.alg.name + "_fillGroup"
        if fillGroup not in self.fillGroups:
            self.fillGroups[fillGroup] = self.helper.addGroup(self.alg,fillGroup,topPath="L1Calo")
 
        if "merge" not in kwargs and kwargs.get("type","") !="TEfficiency":
            kwargs["merge"] = "merge" # ensures we don't get a warning about not specifying merge method
        out = self.fillGroups[fillGroup].defineHistogram(*argsCopy,**kwargs)
        histName = argsCopy[0].split(";")[-1]
 
        # add help link for all expert plots
        if splitPath[0] == "Expert":
            linkUrl = self.HELPURL + "#" + "".join(splitPath[1:]+[histName])
            linkUrl = f"<a href=\"{linkUrl}\">Help</a>"
            if "description" not in hanConfig: hanConfig["description"] = linkUrl
            else: hanConfig["description"] += " - " + linkUrl
 
        splitPathWithHist = splitPath + [histName]
        x = L1CaloMonitorCfgHelper.hanConfigs
        for i,p in enumerate(splitPathWithHist):
            key = ("dir " if i!=len(splitPathWithHist)-1 else "hist ") + p
            if key not in x:
                x[key] = {}
            x = x[key]
        hanConfig["output"] = "/".join(["L1Calo"]+splitPath)
        x.update(hanConfig)
 
        return out
 

defineTree()

def LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper.defineTree	(		self,
		*	args,
			fillGroup = None,
		**	kwargs
	)

Definition at line 218 of file LVL1CaloMonitoringConfig.py.

    def defineTree(self,*args,fillGroup=None,**kwargs):
 
        if ";" not in args[0]:
            raise Exception("Must specify a tree name using ';name' suffix")
        treeName = args[0].split(";")[-1]
 
        if "," in args[1]: # catch a subtle typo that can screw up monitoring
            raise Exception("Should not have comma in list of branch names and types")
 
        if kwargs.get("path",None) is None:
            # put in the Developer path, under the name of the algorithm
            kwargs["path"] = "Developer/" + self.alg.name
 
        # verify path obeys convention
        splitPath = kwargs["path"].split("/")
        if splitPath[0] not in ["Developer"]:
            raise Exception("Path of tree invalid, must be in the audience=Developer directory")
 
 
        if fillGroup is None: fillGroup = self.alg.name + "_fillGroup"
        if fillGroup not in self.fillGroups:
            self.fillGroups[fillGroup] = self.helper.addGroup(self.alg,fillGroup,topPath="L1Calo")
 
        # always define a histogram to go with the tree, which will indicate how many entries there are
        # this also ensures we satisfy the requirement that every fillGroup has an object defined
        # (in the cases of running online/tier0 the defineTrees are blocked, but we still need a hist then)
        histName = "h_" + treeName + "_entries"
        argsCopy = list(args)
        argsCopy[0] = argsCopy[0].replace(";"+treeName,";"+histName)
        kwargsCopy = dict(kwargs)
        kwargsCopy["title"] = f"Number of Entries in {treeName} TTree" + ";" + ";".join(kwargsCopy.get("title","").split(";")[1:])
        kwargsCopy["opt"] = ['kCanRebin']
        kwargsCopy["merge"] = "merge"
        is2d = (kwargsCopy["title"].count(";")>1)
        self.defineHistogram(argsCopy[0],type="TH2I" if is2d else "TH1I",xbins=1,xmin=0,xmax=1,ybins=1 if is2d else None,ymin=0,ymax=1,fillGroup=fillGroup,**kwargsCopy)
        if not any([x in self.dqEnv for x in ['tier0','online']]):
            out = self.fillGroups[fillGroup].defineTree(*args,**kwargs)
        else:
            out = None
        return out
 

printHanConfig()

def LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper.printHanConfig (   filename = "collisions_run.config" )

static

Definition at line 23 of file LVL1CaloMonitoringConfig.py.

    def printHanConfig(filename="collisions_run.config"):
        from contextlib import redirect_stdout
        with open(filename,'w') as f:
            with redirect_stdout(f):
                # Note: common configs (see common dir in DataQualityConfiguration) provides following algorithms by default:
                #     algorithm All_Bins_Filled
                #     algorithm Histogram_Effective_Empty
                #     algorithm Histogram_Empty
                #     algorithm Histogram_Not_Empty
                #     algorithm No_OverFlows
                #     algorithm No_UnderFlows
 
                outputs = set()
                def printConf(d,prefix=""):
                    for key,value in d.items():
                        if type(value)==dict:
                            print(prefix,key,"{")
                            if(key=="dir detail" or key=="dir Developer"):
                                print(prefix+"  algorithm = GatherData") # define GatherData as default algo for all of these hists
                            printConf(value,prefix + "  ")
                            print(prefix,"}")
                        else:
                            print(prefix,key,"=",value)
                            # save all output paths to add to output block
                            if key == "output": outputs.add(value)
 
                print("#inputs")
                print("dir L1Calo {")
                printConf(L1CaloMonitorCfgHelper.hanConfigs," ")
                print("}")
                print("#outputs")
                print("output top_level {")
                def printOutputs(d,prefix=""):
                    for key,value in d.items():
                        if(key.startswith("hist ")):
                            pass # do nothing
                        elif type(value)==dict:
                            print(prefix,key.replace("dir ","output "),"{")
                            printOutputs(value,prefix + "  ")
                            print(prefix,"}")
                print("  output L1Calo {")
                printOutputs(L1CaloMonitorCfgHelper.hanConfigs,"   ")
                print("  }")
                print("}")
                # include example of adding algorithms and thresholds
                print("""
#algorithms
algorithm AnyNonZeroBinIsError {
  # Use this algo if want error on any non-zero bin content
  libname = libdqm_summaries.so
  name = Bins_NotEqual_Threshold
  BinThreshold = 0.
  thresholds = th_AnyBinIsError
}
""")
                for algName,algProps in L1CaloMonitorCfgHelper.hanAlgConfigs.items():
                    print(f"algorithm {algName} {{")
                    for propName,propVal in algProps.items():
                        print(f"  {propName} = {propVal}")
                    print("  }")
                print("""
#thresholds
thresholds th_AnyBinIsError {
    limits NBins {
      warning = 0
      error = 1
    }
}
""")
                for threshName,threshProps in L1CaloMonitorCfgHelper.hanThresholdConfigs.items():
                    print(f"thresholds {threshName} {{")
                    for parName,parLims in threshProps.items():
                        print(f"  limits {parName} {{")
                        for limName,limVal in parLims.items():
                            print(f"    {limName} = {limVal}")
                        print("  }")
                    print("}")
 
 
 

result()

def LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper.result

(

self

)

Definition at line 259 of file LVL1CaloMonitoringConfig.py.

    def result(self):
        return self.helper.result()
 
 

Member Data Documentation

alg

LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper.alg

Definition at line 113 of file LVL1CaloMonitoringConfig.py.

dqEnv

LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper.dqEnv

Definition at line 115 of file LVL1CaloMonitoringConfig.py.

fillGroups

LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper.fillGroups

Definition at line 114 of file LVL1CaloMonitoringConfig.py.

hanAlgConfigs

LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper.hanAlgConfigs

static

Definition at line 16 of file LVL1CaloMonitoringConfig.py.

hanConfigs

LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper.hanConfigs

static

Definition at line 15 of file LVL1CaloMonitoringConfig.py.

hanThresholdConfigs

LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper.hanThresholdConfigs

static

Definition at line 17 of file LVL1CaloMonitoringConfig.py.

helper

LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper.helper

Definition at line 112 of file LVL1CaloMonitoringConfig.py.

HELPURL

LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper.HELPURL

static

Definition at line 20 of file LVL1CaloMonitoringConfig.py.

SIGNATURES

LVL1CaloMonitoringConfig.L1CaloMonitorCfgHelper.SIGNATURES

static

Definition at line 19 of file LVL1CaloMonitoringConfig.py.

---

The documentation for this class was generated from the following file:

• LVL1CaloMonitoringConfig.py