GenericMonitoringTool.GenericMonitoringArray Class Reference

Collaboration diagram for GenericMonitoringTool.GenericMonitoringArray:

Public Member Functions
def	__init__ (self, flags, name, dimensions, **kwargs)
def	__getitem__ (self, index)
def	toolList (self)
def	broadcast (self, member, value)
def	defineHistogram (self, varname, title=None, path=None, pattern=None, **kwargs)

Public Attributes
	Tools
	Accessors

Static Private Member Functions
def	_postfixes (dimensions, previous='')

Detailed Description

Array of configurables of GenericMonitoringTool objects

Definition at line 61 of file GenericMonitoringTool.py.

Constructor & Destructor Documentation

__init__()

def GenericMonitoringTool.GenericMonitoringArray.__init__	(		self,
			flags,
			name,
			dimensions,
		**	kwargs
	)

Definition at line 63 of file GenericMonitoringTool.py.

    def __init__(self, flags, name, dimensions, **kwargs):
        self.Tools = {}
        self.Postfixes, self.Accessors = GenericMonitoringArray._postfixes(dimensions)
        for postfix in self.Postfixes:
            self.Tools[postfix] = GenericMonitoringTool(flags, name+postfix,**kwargs)
 

Member Function Documentation

__getitem__()

def GenericMonitoringTool.GenericMonitoringArray.__getitem__	(		self,
			index
	)

Forward operator[] on class to the list of tools

Definition at line 69 of file GenericMonitoringTool.py.

    def __getitem__(self,index):
        '''Forward operator[] on class to the list of tools'''
        return self.toolList()[index]
 

_postfixes()

def GenericMonitoringTool.GenericMonitoringArray._postfixes (   dimensions,   previous = ''  )

staticprivate

Generates a list of subscripts to add to the name of each tool

Arguments:
dimensions -- List containing the lengths of each side of the array off tools
previous -- Strings appended from the other dimensions of the array

Definition at line 138 of file GenericMonitoringTool.py.

    def _postfixes(dimensions, previous=''):
        '''Generates a list of subscripts to add to the name of each tool
 
        Arguments:
        dimensions -- List containing the lengths of each side of the array off tools
        previous -- Strings appended from the other dimensions of the array
        '''
        import collections
        assert isinstance(dimensions,list) and len(dimensions)>0, \
            'GenericMonitoringArray must have list of dimensions.'
        try:
            if dimensions==[1]:
                return [''], {'': ['']}
        except AttributeError: 
            #Evidently not [1]
            pass
        postList = []
        accessorDict = collections.OrderedDict()
        first = dimensions[0]
        if isinstance(first,list):
            iterable = first
        elif isinstance(first,int):
            iterable = range(first)
        else:
            #Assume GaudiConfig2.semantics._ListHelper
            iterable = list(first)
        for i in iterable:
            if len(dimensions)==1:
                postList.append(previous+'_'+str(i))
                accessorDict[previous+'_'+str(i)]=[str(i)]
            else:
                postfixes, accessors = GenericMonitoringArray._postfixes(dimensions[1:],previous+'_'+str(i))
                postList.extend(postfixes)
                for acckey, accval in accessors.items():
                    accessorDict[acckey] = [str(i)] + accval
        return postList, accessorDict
 
 

broadcast()

def GenericMonitoringTool.GenericMonitoringArray.broadcast	(		self,
			member,
			value
	)

Allows one to set attributes of every tool simultaneously

Arguments:
member -- string which contains the name of the attribute to be set
value -- value of the attribute to be set

Definition at line 76 of file GenericMonitoringTool.py.

    def broadcast(self, member, value):
        '''Allows one to set attributes of every tool simultaneously
 
        Arguments:
        member -- string which contains the name of the attribute to be set
        value -- value of the attribute to be set
        '''
        for tool in self.toolList():
            setattr(tool,member,value)
 

defineHistogram()

def GenericMonitoringTool.GenericMonitoringArray.defineHistogram	(		self,
			varname,
			title = None,
			path = None,
			pattern = None,
		**	kwargs
	)

Propogate defineHistogram to each tool, adding a unique tag.

Arguments:
pattern -- if specified, list of n-tuples of indices for plots to create

Definition at line 86 of file GenericMonitoringTool.py.

    def defineHistogram(self, varname, title=None, path=None, pattern=None, **kwargs):
        '''Propogate defineHistogram to each tool, adding a unique tag.
        
        Arguments:
        pattern -- if specified, list of n-tuples of indices for plots to create
        '''
        unAliased = varname.split(';')[0]
        _, aliasBase = _alias(varname)
        if aliasBase is None or aliasBase.strip() == '':
            raise ValueError(f'Unable to define histogram using definition "{varname}" since we cannot determine its name')
        if pattern is not None:
            try:
                iter(pattern)
            except TypeError:
                raise ValueError('Argument to GenericMonitoringArray.defineHistogram must be iterable')
            if not isinstance(pattern, list):
                pattern = list(pattern)
            if len(pattern) == 0: # nothing to do
                return
            if isinstance(pattern[0], (str, int)):
                # assume we have list of strings or ints; convert to list of 1-element tuples
                pattern = [(_2,) for _2 in pattern]
        for postfix, tool in self.Tools.items():
            try:
                accessors = tuple(self.Accessors[postfix])
                if pattern is not None:
                    if accessors not in pattern:
                        continue
                # two options for alias formatting,
                #   a) default convention: (var_0, var_1, etc.)
                #   b) custom formatting: 'alias{0}custom'.format(*(0, 1))
                aliasBaseFormatted = aliasBase.format(*accessors)
                if aliasBaseFormatted==aliasBase:
                    # if format call did not do anything, use default
                    aliased = unAliased+';'+aliasBase+postfix
                else:
                    # if format call changed the alias, use custom
                    aliased = unAliased+';'+aliasBaseFormatted
                if title is not None:
                    kwargs['title'] = title.format(*accessors)
                if path is not None:
                    kwargs['path'] = path.format(*accessors)
            except IndexError as e:
                log.error('In title or path template of histogram {0}, too many positional '\
                    'arguments were requested. Title and path templates were "{1}" and "{2}", '\
                    'while only {3} fillers were given: {4}.'.format(aliasBase, title,\
                    path, len(accessors), accessors))
                raise e
 
            tool.defineHistogram(aliased, **kwargs)
 

toolList()

def GenericMonitoringTool.GenericMonitoringArray.toolList

(

self

)

Definition at line 73 of file GenericMonitoringTool.py.

    def toolList(self):
        return list(self.Tools.values())
 

Member Data Documentation

Accessors

GenericMonitoringTool.GenericMonitoringArray.Accessors

Definition at line 65 of file GenericMonitoringTool.py.

Tools

GenericMonitoringTool.GenericMonitoringArray.Tools

Definition at line 64 of file GenericMonitoringTool.py.

---

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

• GenericMonitoringTool.py