Namespaces
	AtlRunQueryCache

	AtlRunQueryDQUtils

	AtlRunQueryFastBlobRead

	AtlRunQueryIOV

	AtlRunQueryLookup

	AtlRunQueryMemUtil

	AtlRunQueryTimer

	AtlRunQueryTriggerUtils

	AtlRunQueryUtils

Classes
class	FolderTagResolver

class	TreeDict

Functions
def	worst_status (iovs, *dummy_args)

def	worst (iterable)

def	first (iterable)

def	best (iterable, priorities=[3, 2, 1, -1, 0])

def	best_status (iovs, *dummy_args)

def	iovs_in_time (wanted_start_time, wanted_end_time)

def	get_root_version ()

def	fix_iovkey (iovkey)

def	make_functor (expression, location, global_env={}, input_translation=None)

def	make_floats_pretty (x)

def	pprint_objects (objects, where=stdout)

def	describe_colour (colour)

def	tree (key_wrapper=None)

def	directory_like (*key)

def	get_array (hist)

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

AthConfigFlags	cloneFlagsToActiveConfig (AthConfigFlags flags, str config_name)

Variables
	BUILTIN_NAMES = set(("True", "False"))

	WHITE = None

int	GREY = 0

string	TAIL = lambda s: u' └── {} '.format(s)

string	BRANCH = lambda s: u' ├── {} '.format(s)

string	LINE = lambda s: u' │ {} '.format(s)

string	SPACE = lambda s: u' {} '.format(s)

Function Documentation

◆ best()

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

a min() function whose priorities can be chosen

Definition at line 50 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()

def python.utils.best_status	(		iovs,
		*	dummy_args
	)

Return the worst status. (Different from worst_of).

Definition at line 56 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
	)

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

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

 def cloneFlagsToActiveConfig(
     flags: AthConfigFlags, config_name: str) -> AthConfigFlags:
     """
     do InDet/ITk specific clone and replace of ActiveConfig without checking flags vs config_name
     
     """
     return flags.cloneAndReplace(
         "Tracking.ActiveConfig",
         ("Trigger.ITkTracking." if flags.Detector.GeometryITk else "Trigger.InDetTracking.") + config_name,
         keepOriginal = True
     )

◆ describe_colour()

def python.utils.describe_colour ( colour )

Definition at line 139 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]

◆ directory_like()

def python.utils.directory_like ( * key )

Definition at line 7 of file Reconstruction/RecExample/RecExOnline/python/utils.py.

 def directory_like(*key):
     if len(key) == 1:
         return key[0].split('/',1)
     else:
         return key
  

◆ first()

def python.utils.first ( iterable )

Return the first filled (and not grey) flag

Definition at line 38 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()

def python.utils.fix_iovkey ( iovkey )

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

Definition at line 94 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_array()

def python.utils.get_array ( hist )

Definition at line 13 of file Reconstruction/RecExample/RecExOnline/python/utils.py.

 def get_array(hist):
     arr = hist.GetArray()
     arr.SetSize(hist.GetNbinsX() + 2)
     return np.fromiter(arr, np.float)
  

◆ get_root_version()

def python.utils.get_root_version ( )

Return ROOT version tuple

Definition at line 86 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

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

 def getFlagsForActiveConfig(
     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
     """
     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.warning(
                 "flags.Tracking.ActiveConfig is not for %s but %s",
                 config_name,
                 flags.Tracking.ActiveConfig.input_name,
             )
     else:
  
         log.warning(
             "Menu code invoked ID config without flags.Tracking.ActiveConfig for %s",
             config_name,
         )
  
     if flags.Trigger.useActsTracking:
         return flags.cloneAndReplace("Tracking.ActiveConfig", "Trigger.ActsTracking."+config_name)
     
     return cloneFlagsToActiveConfig(flags, config_name)
  
  
  

◆ iovs_in_time()

def 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 64 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()

def python.utils.make_floats_pretty ( x )

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

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

◆ make_functor()

def 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 100 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()

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

Pretty print a list of IoV-results

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

 def pprint_objects(objects, where=stdout):
     """
     Pretty print a list of IoV-results
     """
     from six import print_
     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)
         

◆ tree()

def python.utils.tree ( key_wrapper = None )

Definition at line 5 of file Reconstruction/RecExample/RecExOnline/python/utils.py.

5 def tree(key_wrapper = None):

6 return lambda : TreeDict({}, key_wrapper)

◆ worst()

def python.utils.worst ( iterable )

Definition at line 22 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()

def python.utils.worst_status	(		iovs,
		*	dummy_args
	)

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

Definition at line 14 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)
  