Namespaces
namespace	AtlRunQueryCache
namespace	AtlRunQueryDQUtils
namespace	AtlRunQueryFastBlobRead
namespace	AtlRunQueryIOV
namespace	AtlRunQueryLookup
namespace	AtlRunQueryMemUtil
namespace	AtlRunQueryTimer
namespace	AtlRunQueryTriggerUtils
namespace	AtlRunQueryUtils

Classes
class	FolderTagResolver

Functions
	worst_status (iovs, *dummy_args)
	worst (iterable)
	first (iterable)
	best (iterable, priorities=[3, 2, 1, -1, 0])
	best_status (iovs, *dummy_args)
	iovs_in_time (wanted_start_time, wanted_end_time)
	get_root_version ()
	fix_iovkey (iovkey)
	make_functor (expression, location, global_env={}, input_translation=None)
	make_floats_pretty (x)
	pprint_objects (objects, where=stdout)
	describe_colour (colour)
AthConfigFlags	getFlagsForActiveConfig (AthConfigFlags flags, str config_name, logging.Logger log)
AthConfigFlags	cloneFlagsToActiveConfig (AthConfigFlags flags, str config_name, logging.Logger log)
AthConfigFlags	_cloneFlagsToActiveConfig (AthConfigFlags flags, str config_name)

Variables
dict	BUILTIN_NAMES = {"True", "False"}
	WHITE = None
int	GREY = 0

Detailed Description

Utility module for dataquality specific things

Function Documentation

◆ _cloneFlagsToActiveConfig()

AthConfigFlags python.utils._cloneFlagsToActiveConfig	(	AthConfigFlags	flags,
		str	config_name )

protected

Definition at line 71 of file Trigger/TrigTools/TrigInDetConfig/python/utils.py.

def _cloneFlagsToActiveConfig(flags: AthConfigFlags, config_name: str) -> AthConfigFlags:
 
    prefix = "Trigger.InDetTracking."
    if flags.Detector.GeometryITk:
      prefix = "Trigger.ITkTracking."
      if flags.Trigger.useActsTracking: 
        prefix = "Trigger.ActsTracking."
      
    return flags.cloneAndReplace(
        "Tracking.ActiveConfig",
        prefix + config_name,
        keepOriginal = True
    )

◆ best()

python.utils.best	(		iterable,
			priorities = [3, 2, 1, -1, 0] )

a min() function whose priorities can be chosen

Definition at line 49 of file DataQuality/DQUtils/python/utils.py.

def best(iterable, priorities=[3, 2, 1, -1, 0]):
    """
    a min() function whose priorities can be chosen
    """
    return worst(iterable, [3, 2, 1, -1, 0])
 

◆ best_status()

python.utils.best_status	(		iovs,
		*	dummy_args )

Return the worst status. (Different from worst_of).

Definition at line 55 of file DataQuality/DQUtils/python/utils.py.

def best_status(iovs, *dummy_args):
    """
    Return the worst status. (Different from worst_of).
    """
    if len(iovs) == 1: return iovs[0][2]
    statuses = zip(*iovs)[2]
    return best(statuses)
 

◆ cloneFlagsToActiveConfig()

AthConfigFlags python.utils.cloneFlagsToActiveConfig	(	AthConfigFlags	flags,
		str	config_name,
		logging.Logger	log )

InDet/ITk specific clone and replace of ActiveConfig without checking flags vs config_name

this function should be used only high up in the menu creation where a context of tracking flags 
does not exist yet and is created for the first time in generateChainConfigs function
or there are multiple contexts for ActiveConfig like in LRT

in other cases getFlagsForActiveConfig should be used instead

Definition at line 54 of file Trigger/TrigTools/TrigInDetConfig/python/utils.py.

        flags: AthConfigFlags, config_name: str, log: logging.Logger) -> AthConfigFlags:
 
    """
    InDet/ITk specific clone and replace of ActiveConfig without checking flags vs config_name
    
    this function should be used only high up in the menu creation where a context of tracking flags 
    does not exist yet and is created for the first time in generateChainConfigs function
    or there are multiple contexts for ActiveConfig like in LRT
 
    in other cases getFlagsForActiveConfig should be used instead
    
    """
    
    log.info(f"Cloning tracking config for {config_name} to flags.Tracking.ActiveConfig")
    return _cloneFlagsToActiveConfig(flags, config_name)
 

◆ describe_colour()

python.utils.describe_colour ( colour )

Definition at line 137 of file DataQuality/DQUtils/python/utils.py.

def describe_colour(colour):
    mapping = {
        None: "White",
        -1: "Black",
        0: "Grey",
        1: "Red",
        2: "Yellow",
        3: "Green",
    }
    if colour not in mapping:
        raise RuntimeError("Unknown colour code: %s" % colour)
    return mapping[colour]

◆ first()

python.utils.first ( iterable )

Return the first filled (and not grey) flag

Definition at line 37 of file DataQuality/DQUtils/python/utils.py.

def first(iterable):
    """
    Return the first filled (and not grey) flag
    """
    result = WHITE
    for element in iterable:
        if element not in [WHITE, GREY]:
            return element
        elif element == GREY:
            result = GREY            
    return result
    

◆ fix_iovkey()

python.utils.fix_iovkey ( iovkey )

If an IoV starts on the 0th lumiblock, then move it forward one.

Definition at line 93 of file DataQuality/DQUtils/python/utils.py.

def fix_iovkey(iovkey):
    """
    If an IoV starts on the 0th lumiblock, then move it forward one.
    """    
    return iovkey if iovkey & 0xFFFFFFFF else iovkey+1
 

◆ get_root_version()

python.utils.get_root_version ( )

Return ROOT version tuple

Definition at line 85 of file DataQuality/DQUtils/python/utils.py.

def get_root_version():
    """
    Return ROOT version tuple
    """
    from ROOT import gROOT
    version_code = gROOT.RootVersionCode()
    return (version_code >> 16, version_code >> 8 & 0xFF, version_code & 0xFF)
    

◆ getFlagsForActiveConfig()

AthConfigFlags python.utils.getFlagsForActiveConfig	(	AthConfigFlags	flags,
		str	config_name,
		logging.Logger	log )

Get the flags for the named config, ensure that they are set to be active

Parameters
----------
flags : AthConfigFlags
    The instance of the flags to check
config_name : str
    The name of the desired tracking config
log : logging.Logger
    Logger to print related messages

Returns
-------
Either the current flags instance if all the ActiveConfig is correct or a new
version with cloned flags

the flags correspond to InDet/ITk format

Definition at line 9 of file Trigger/TrigTools/TrigInDetConfig/python/utils.py.

    flags: AthConfigFlags, config_name: str, log: logging.Logger) -> AthConfigFlags:
    
    """Get the flags for the named config, ensure that they are set to be active
 
    Parameters
    ----------
    flags : AthConfigFlags
        The instance of the flags to check
    config_name : str
        The name of the desired tracking config
    log : logging.Logger
        Logger to print related messages
 
    Returns
    -------
    Either the current flags instance if all the ActiveConfig is correct or a new
    version with cloned flags
    
    the flags correspond to InDet/ITk format
    """
 
    if flags.hasFlag("Tracking.ActiveConfig.input_name"):
        if flags.Tracking.ActiveConfig.input_name == config_name:
            log.debug(
                "flags.Tracking.ActiveConfig is for %s",
                flags.Tracking.ActiveConfig.input_name,
            )
            return flags
        else:
            log.info(
                "flags.Tracking.ActiveConfig is not for %s but %s",
                config_name,
                flags.Tracking.ActiveConfig.input_name,
            )
    else:
 
        log.info(
            "Menu code invoked ID config without flags.Tracking.ActiveConfig for %s",
            config_name,
        )
 
    return _cloneFlagsToActiveConfig(flags, config_name)
 
 

◆ iovs_in_time()

python.utils.iovs_in_time	(		wanted_start_time,
			wanted_end_time )

Return a function which selects iovs dependent on they occured 
in the desired time

Definition at line 63 of file DataQuality/DQUtils/python/utils.py.

def iovs_in_time(wanted_start_time, wanted_end_time):
    """
    Return a function which selects iovs dependent on they occured 
    in the desired time
    """
    
    # TODO: Test that this logic gives the same result as 
    # wanted_start < iov_end and wanted_end > iov_start
    
    def test_one(iov):
        start_time, end_time, status = iov
        # Start or end of IoV lies within desired region
        
        return (    # Desired start or end time lies within block
                       start_time <= wanted_start_time <=        end_time or
                       start_time <=   wanted_end_time <=        end_time or
                    # Block lies within desired start or end time
                wanted_start_time <=        start_time <= wanted_end_time or
                wanted_start_time <=          end_time <= wanted_end_time)
             
    return test_one
    

◆ make_floats_pretty()

python.utils.make_floats_pretty ( x )

Definition at line 123 of file DataQuality/DQUtils/python/utils.py.

def make_floats_pretty(x):
    if isinstance(x, float):
        return "%.3f" % x
    return x
    

◆ make_functor()

python.utils.make_functor	(	expression,
		location,
		global_env = {},
		input_translation = None )

Compile an expression, returning the variables used and a functor which can
be called with the namespace in which the expression is run

`expression` is a single python expression to be evaluated
`location` is a string describing where the snippet of code came from
           (in case of exceptions, for debugging)
`global_env` is the global environment in which the expression is executed
`input_translation` is an optional function which is executed on the 
                    functor's arguments before it is executed.

Definition at line 99 of file DataQuality/DQUtils/python/utils.py.

def make_functor(expression, location, global_env={}, input_translation=None):
    """
    Compile an expression, returning the variables used and a functor which can
    be called with the namespace in which the expression is run
    
    `expression` is a single python expression to be evaluated
    `location` is a string describing where the snippet of code came from
               (in case of exceptions, for debugging)
    `global_env` is the global environment in which the expression is executed
    `input_translation` is an optional function which is executed on the 
                        functor's arguments before it is executed.
    """
    compiled = compile(expression, location, "eval")
 
    provided_vars = set(global_env.keys())
    variables = sorted(set(compiled.co_names) - BUILTIN_NAMES - provided_vars)
    if input_translation:
        def functor(locals_={}):
            return eval(compiled, global_env, input_translation(locals_))
    else:
        def functor(locals_={}):
            return eval(compiled, global_env, locals_)
    return variables, functor
    

◆ pprint_objects()

python.utils.pprint_objects	(		objects,
			where = stdout )

Pretty print a list of IoV-results

Definition at line 128 of file DataQuality/DQUtils/python/utils.py.

def pprint_objects(objects, where=stdout):
    """
    Pretty print a list of IoV-results
    """
    for obj in objects:
        since, until = obj[:2]
        args = since, until, "(%s)" % ", ".join(map(str, map(make_floats_pretty, obj[2:])))
        print("[%r -> %r) : %s" % args, file=where)
        

◆ worst()

python.utils.worst ( iterable )

Definition at line 21 of file DataQuality/DQUtils/python/utils.py.

def worst(iterable):
    states = set(iterable)
    
    if not states: return None
    if  -1 in states: return -1
    elif 1 in states: return 1
    elif 2 in states: return 2
    elif 3 in states: return 3
    elif 0 in states: return 0
    elif None in states: return None
    
    raise RuntimeError("Invalid Code present on database?")
 

◆ worst_status()

python.utils.worst_status	(		iovs,
		*	dummy_args )

Return the worst status of multiple IoVs. (Different from worst_of).

Definition at line 13 of file DataQuality/DQUtils/python/utils.py.

def worst_status(iovs, *dummy_args):
    """
    Return the worst status of multiple IoVs. (Different from worst_of).
    """
    if len(iovs) == 1: return iovs[0][2]
    statuses = zip(*iovs)[2]
    return worst(statuses)
 

Variable Documentation

◆ BUILTIN_NAMES

dict python.utils.BUILTIN_NAMES = {"True", "False"}

Definition at line 11 of file DataQuality/DQUtils/python/utils.py.

◆ GREY

int python.utils.GREY = 0

Definition at line 35 of file DataQuality/DQUtils/python/utils.py.

◆ WHITE

python.utils.WHITE = None

Definition at line 34 of file DataQuality/DQUtils/python/utils.py.

Namespaces

Classes

Functions

Variables