Inheritance diagram for JetMonitoringConfig.HistoSpec:

Collaboration diagram for JetMonitoringConfig.HistoSpec:

Public Member Functions
	__init__ (self, name, bins, xvar=None, yvar=None, zvar=None, profile=False, **args)
	groupName (self)
	clone (self, newname, bins=None, xvar=None, yvar=None, zvar=None, **hargs)
	to2DSpec (self, yspec, profile=False, zspec=None)
	toTool (self)
	defineHisto (self, parentAlg, monhelper, path)
	__getattr__ (self, attr)
	__setattr__ (self, attr, value)
	__setitem__ (self, attr, value)
	dump (self, out=None)

Public Attributes
str	is1D = ';' not in name
int	nVar = name.count(';')+1
bool	isProfile = profile
	xvar = retrieveVarToolConf( xvar if xvar is not None else name)
	yvar = None
	zvar = None
	bins = bins
	hargs = ConfigDict( **args)
	name = name
	klass = klass

Protected Member Functions
	_dump (self, writeFunc)

Detailed Description

A dictionary specialized to contain a JetHistoAttributeFiller specification
Invocation is like : spec = HistoSpec( name, bins, ...optional args... ) where 
  - name : a string, from which the name of the Histogram is build.
           AND also the description of variables to be plotted IF none of xvar, yvar or zvar is in the optional args.
           The final name of histos is given by name.replace(':GeV','').replace(';','_')
       ex: 'eta'        --> histo name : 'eta', variable to plot is 'eta'
           'pt:GeV'     --> histo name : 'pt', variable to plot is 'pt' at GeV scale 
           'pt:GeV;eta' --> histo name : 'pt_eta', 2 variables to plot  'pt' at GeV scale on x axis and 'eta' on y axis
  - bins : the binning of the histogram in the form (nbin, min, max) or (nbinX, minX, maxX, nbinY, minY, maxY )
  - optionnal args are : 
     + xvar, yvar, zvar : strings specifying variables
     + profile : boolean, True if the histo is a TProfile (or TProfile2D)     
     + any other args (ex: title) will be forwarded to the mongroup.defineHistogram() function.

Definition at line 240 of file JetMonitoringConfig.py.

Constructor & Destructor Documentation

◆ init()

JetMonitoringConfig.HistoSpec.__init__	(		self,
			name,
			bins,
			xvar = None,
			yvar = None,
			zvar = None,
			profile = False,
		**	args )

Definition at line 255 of file JetMonitoringConfig.py.

    def __init__(self, name , bins,  xvar=None, yvar=None, zvar=None,  profile=False,**args):
        self.is1D = ';' not in name
 
        self.nVar = name.count(';')+1
        self.isProfile = profile
        if self.nVar==1:
            self.xvar = retrieveVarToolConf( xvar if xvar is not None else name)
            self.yvar = None
            self.zvar = None
        elif self.nVar==2:
            xv , yv = name.split(';')
            self.xvar = retrieveVarToolConf( xvar if xvar is not None else xv)
            self.yvar = yvar if yvar is not None else yv            
            self.zvar = None
        else:
            xv , yv, zv = name.split(';')
            self.xvar = xvar if xvar is not None else xv
            self.yvar = yvar if yvar is not None else yv
            self.zvar = zvar if zvar is not None else zv
            self.isProfile = True
        self.name = name.replace(':GeV','')
        self.bins = bins
        self.hargs = ConfigDict( **args)
        ConfigDict.__init__(self, **args)
 

Member Function Documentation

◆ getattr()

JetMonitoringConfig.ConfigDict.__getattr__	(		self,
			attr )

inherited

Definition at line 47 of file JetMonitoringConfig.py.

    def __getattr__(self, attr):
        try:
            return self[attr]
        except KeyError:
            dict.__getattribute__(self,attr)
            #raise AttributeError(attr)
 

◆ setattr()

JetMonitoringConfig.ConfigDict.__setattr__	(	self,
		attr,
		value )

inherited

Definition at line 54 of file JetMonitoringConfig.py.

    def __setattr__(self, attr, value):
        if attr in ['keys', 'clear', 'update', 'pop', 'iteritems', 'values','setdefault','get','has_key','copy']:
            print('ConfigDict ERROR can not assign attribute ', attr)
            return
        dict.__setitem__(self, attr,  value)
        dict.__setattr__(self, attr,  value)

◆ setitem()

JetMonitoringConfig.ConfigDict.__setitem__	(	self,
		attr,
		value )

inherited

Definition at line 60 of file JetMonitoringConfig.py.

    def __setitem__(self, attr, value):
        if attr in ['keys', 'clear', 'update', 'pop', 'iteritems', 'values','setdefault','get','has_key','copy']:
            print('ConfigDict ERROR can not assign attribute ', attr)
            return
        dict.__setitem__(self, attr,  value)
        dict.__setattr__(self, attr,  value)
 
        

◆ _dump()

JetMonitoringConfig.HistoSpec._dump	(		self,
			writeFunc )

protected

Reimplemented from JetMonitoringConfig.ConfigDict.

Definition at line 374 of file JetMonitoringConfig.py.

    def _dump(self, writeFunc):
        def write(s): writeFunc('  '+s)
        writeFunc('HistoSpec("'+self.name+'", '+str(self.bins) )
        for k in [ 'xvar',  'yvar', 'zvar', 'isProfile' ]:
            if self[k] is not None:
                write(' '+k +' = '+str(self[k]))
        write(')')
 
 

◆ clone()

JetMonitoringConfig.HistoSpec.clone	(		self,
			newname,
			bins = None,
			xvar = None,
			yvar = None,
			zvar = None,
		**	hargs )

Reimplemented from JetMonitoringConfig.ToolSpec.

Definition at line 284 of file JetMonitoringConfig.py.

    def clone(self, newname, bins=None,  xvar=None, yvar=None, zvar=None, **hargs):
        c = ConfigDict.clone(self)
        if xvar : c.xvar = xvar
        if yvar : c.yvar = yvar
        if zvar : c.zvar = zvar
        if bins: c.bins = bins
        c.hargs.update(**hargs)
        c.name = newname
        return c
 

◆ defineHisto()

JetMonitoringConfig.HistoSpec.defineHisto	(	self,
		parentAlg,
		monhelper,
		path )

 This function performs the standard monitoring config calls for this JetHisto tool.
      - group = monhelper.addGroup( ... )
      - group.defineHistogram( ... )

Reimplemented from JetMonitoringConfig.ToolSpec.

Definition at line 332 of file JetMonitoringConfig.py.

    def defineHisto(self, parentAlg, monhelper , path):
        """ This function performs the standard monitoring config calls for this JetHisto tool.
              - group = monhelper.addGroup( ... )
              - group.defineHistogram( ... )
        """
 
        # build the arguments to be passed to defineHistogram
        hargs = ConfigDict()
        bins = self.bins
        if self.nVar==1:
            hargs.update(xbins = bins[0],xmin = bins[1], xmax=bins[2],                         
                         type='TH1F',
            )
        elif self.nVar>1:
            hargs.update(xbins = bins[0],xmin = bins[1], xmax=bins[2],
                         ybins = bins[3],ymin = bins[4], ymax=bins[5], 
                         type='TH2F' if not self.isProfile else 'TProfile',                         
            )
            if self.nVar==3:
                hargs.type = 'TProfile2D'
        hargs.update( **self.hargs) # overwrite by user-given args if any
        
        # we create one group for each histoFiller : self.groupName() are unique within a JetMonitoringAlg
        bottomLevelDir = self.bottomLevelDir if self.bottomLevelDir != '' else parentAlg.JetContainerName.Path
        group = monhelper.addGroup(parentAlg, self.groupName(), self.topLevelDir+bottomLevelDir)
 
        # define the variables used by this tool
        #  we encode as 'varx,vary;alias' as requested ny standard monitoring config, see
        #  https://acode-browser1.usatlas.bnl.gov/lxr/source/athena/Control/AthenaMonitoring/python/GenericMonitoringTool.py
        name = retrieveVarToolConf( self.xvar).vname()
        if self.nVar>1:
            name = name +"," + retrieveVarToolConf( self.yvar).vname()
        if self.nVar>2:
            name = name +"," + retrieveVarToolConf( self.zvar).vname()
 
        name = name+";"+self.groupName()
 
        #print(' uuuuuuuuuuu ', self.name , ' --> ', name,  hargs)
        # call the standard histo definition routine :
        group.defineHistogram(name, path=path, **hargs)
 
 

◆ dump()

JetMonitoringConfig.ConfigDict.dump	(		self,
			out = None )

inherited

prints the content of this dict on stdout (default) or in the file 'out'

Definition at line 76 of file JetMonitoringConfig.py.

    def dump(self, out=None):
        """ prints the content of this dict on stdout (default) or in the file 'out' """
        if out is None :
            from sys import stdout
            out = stdout
        _write = out.write
        def write(s, e='\n'): _write(s+e)
        self._dump(write)
        

◆ groupName()

JetMonitoringConfig.HistoSpec.groupName ( self )

Definition at line 280 of file JetMonitoringConfig.py.

    def groupName(self):
        return self.name if self.nVar==1 else self.name.replace(';','_')

◆ to2DSpec()

JetMonitoringConfig.HistoSpec.to2DSpec	(	self,
		yspec,
		profile = False,
		zspec = None )

Merge this histo spec and yspec into a new 2D histo spec

Definition at line 294 of file JetMonitoringConfig.py.

    def to2DSpec(self, yspec, profile=False, zspec=None):
        """ Merge this histo spec and yspec into a new 2D histo spec"""
        tx, ax, _ = self.title.split(';')
        ty, ay, _ = yspec.title.split(';')
        title = ty+' vs '+tx+';'+ax+';'+ay
        name = self.name+';'+yspec.name
        if zspec is not None:
            tz, az, _ = zspec.title.split(';')
            title = tz+' vs '+tx+' and '+ty+';'+ax+';'+ay
 
            name = name + ';'+zspec.name
        s2d = HistoSpec( name, self.bins+yspec.bins,
                         xvar = self.xvar,
                         yvar = yspec.xvar, title=title, profile=profile
        )
        if zspec is not None:
            s2d.zvar = zspec.xvar
        return s2d
 
    
 

◆ toTool()

JetMonitoringConfig.HistoSpec.toTool ( self )

Reimplemented from JetMonitoringConfig.ToolSpec.

Definition at line 315 of file JetMonitoringConfig.py.

    def toTool(self):
        from AthenaConfiguration.ComponentFactory import CompFactory
        vx = retrieveVarToolConf( self.xvar)
        tool = CompFactory.JetHistoAttributeFiller(self.groupName()+"hfiller",
                                       VarX = vx.toTool(),
                                       Group = self.groupName(),
        )
        if self.nVar>1:
            tool.VarY = retrieveVarToolConf( self.yvar).toTool()
            if self.nVar>2:
                tool.VarZ = retrieveVarToolConf( self.zvar).toTool()
            else: tool.VarZ = None
        else : tool.VarY = None
 
        return tool
    
    

Member Data Documentation

◆ bins

JetMonitoringConfig.HistoSpec.bins = bins

Definition at line 276 of file JetMonitoringConfig.py.

◆ hargs

JetMonitoringConfig.HistoSpec.hargs = ConfigDict( **args)

Definition at line 277 of file JetMonitoringConfig.py.

◆ is1D

str JetMonitoringConfig.HistoSpec.is1D = ';' not in name

Definition at line 256 of file JetMonitoringConfig.py.

◆ isProfile

bool JetMonitoringConfig.HistoSpec.isProfile = profile

Definition at line 259 of file JetMonitoringConfig.py.

◆ klass

JetMonitoringConfig.ToolSpec.klass = klass

inherited

Definition at line 163 of file JetMonitoringConfig.py.

◆ name

JetMonitoringConfig.ToolSpec.name = name

inherited

Definition at line 162 of file JetMonitoringConfig.py.

◆ nVar

int JetMonitoringConfig.HistoSpec.nVar = name.count(';')+1

Definition at line 258 of file JetMonitoringConfig.py.

◆ xvar

JetMonitoringConfig.HistoSpec.xvar = retrieveVarToolConf( xvar if xvar is not None else name)

Definition at line 261 of file JetMonitoringConfig.py.

◆ yvar

JetMonitoringConfig.HistoSpec.yvar = None

Definition at line 262 of file JetMonitoringConfig.py.

◆ zvar

JetMonitoringConfig.HistoSpec.zvar = None

Definition at line 263 of file JetMonitoringConfig.py.

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

JetMonitoringConfig.py

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __getattr__()

◆ __setattr__()

◆ __setitem__()

◆ _dump()

◆ clone()

◆ defineHisto()

◆ dump()

◆ groupName()

◆ to2DSpec()

◆ toTool()

Member Data Documentation

◆ bins

◆ hargs

◆ is1D

◆ isProfile

◆ klass

◆ name

◆ nVar

◆ xvar

◆ yvar

◆ zvar

◆ init()

◆ getattr()

◆ setattr()

◆ setitem()