PixelAthMonitoringBase Namespace Reference

Classes
struct	AccumulatorArrays
struct	VecAccumulator2DMap
	helper class to accumulate points to fill a 2D plot with More...

Functions
	getLayerGroup (helper, alg, layer)
	define2DProfHist (helper, alg, name, title, path, type='TProfile2D', doWeight=False, lifecycle='run', zmin=None, zmax=None, opt='', histname=None, onlylayers=baselayers)
	define2DProfPerFEHist (helper, alg, name, title, path, type='TProfile2D', doWeight=False, lifecycle='run', zmin=None, zmax=None, opt='', histname=None, onlylayers=baselayers)
	definePP0Histos (helper, alg, name, title, path, opt='')
	define1DProfLumiLayers (helper, alg, name, title, path, yaxistext, type='TProfile', opt='', histname=None, onlylayers=layers)
	defineMapVsLumiLayers (helper, alg, name, title, path, xaxistext, yaxistext, ybins, ymins, binsizes=[1.0], ylabels=None, opt='', type='TH2F', histname=None, onlylayers=layers)
	define1DLayers (helper, alg, name, title, path, xaxistext, yaxistext, xbins, xmins, binsizes=[1.0], type='TH1F', histname=None, onlylayers=layers)
	addOnTrackTxt (name, ontrack, wSpace=False)
	addOnTrackToPath (name, ontrack)
	fullDressTitle (name, ontrack, xaxistext, yaxistext)

Detailed Description

@file PixelAthMonitoringBase.py
@brief Helper functions for Run 3 Pixel monitoring algorithm configuration

Function Documentation

addOnTrackToPath()

PixelAthMonitoringBase.addOnTrackToPath	(		name,
			ontrack )

Definition at line 529 of file PixelAthMonitoringBase.py.

def addOnTrackToPath(name, ontrack):
    if ontrack:
        name += 'OnTrack/'
    else:
        name += '/'
    return name
 

addOnTrackTxt()

PixelAthMonitoringBase.addOnTrackTxt	(		name,
			ontrack,
			wSpace = False )

Definition at line 521 of file PixelAthMonitoringBase.py.

def addOnTrackTxt(name, ontrack, wSpace=False):
    if ontrack:
        if wSpace:
            name += ' OnTrack'
        else:
            name += 'OnTrack'
    return name
 

define1DLayers()

PixelAthMonitoringBase.define1DLayers	(		helper,
			alg,
			name,
			title,
			path,
			xaxistext,
			yaxistext,
			xbins,
			xmins,
			binsizes = [1.0],
			type = 'TH1F',
			histname = None,
			onlylayers = layers )

This function configures 1D (Profile) histograms for Pixel layers.

Arguments:
     helper     -- AthMonitorCfgHelper(Old) instance
     alg        -- algorithm Configurable object returned from addAlgorithm
     name       -- Root name of variables and histogram (Name = name+'_'+layer)
     title      -- Title of histogram (Title = title +' '+layer)
     path       -- Path in ouput file for histogram
     xaxistext  -- X-axis title
     yaxistext  -- Y-axis title
     type       -- Type of histogram
     histname   -- alternative root name of the histogram (to be filled with the same variables defined by 'name' above)
     onlylayers -- sublist of layers

Definition at line 486 of file PixelAthMonitoringBase.py.

def define1DLayers(helper, alg, name, title, path, xaxistext, yaxistext, xbins, xmins, binsizes=[1.0], type='TH1F', histname=None, onlylayers=layers):
    '''
    This function configures 1D (Profile) histograms for Pixel layers.
 
    Arguments:
         helper     -- AthMonitorCfgHelper(Old) instance
         alg        -- algorithm Configurable object returned from addAlgorithm
         name       -- Root name of variables and histogram (Name = name+'_'+layer)
         title      -- Title of histogram (Title = title +' '+layer)
         path       -- Path in ouput file for histogram
         xaxistext  -- X-axis title
         yaxistext  -- Y-axis title
         type       -- Type of histogram
         histname   -- alternative root name of the histogram (to be filled with the same variables defined by 'name' above)
         onlylayers -- sublist of layers
    '''
    assert(set(onlylayers).issubset(layers))
    if histname is None:
        histname = name
    for idx,layer in enumerate(layers):
        if layer not in onlylayers: 
            continue
        fulltitle   = title + ', {0}'.format(layer) + runtext + xaxistext + yaxistext
        layerGroup = getLayerGroup(helper, alg, layer)
        fullvarstring = '{0}_{1}'.format(name,'val')
        fullvarstring += ';' + histname  + '_{0}'.format(layer)
        if ( len(xbins)==1 and len(xmins)==1 and len(binsizes)==1):
            layerGroup.defineHistogram(fullvarstring, 
                                        type=type, path=path, title=fulltitle,
                                        xbins=xbins[0], xmin=xmins[0], xmax=xmins[0]+binsizes[0]*xbins[0])
        elif (len(xbins)==len(layers) and len(xmins)==len(layers) and len(binsizes)==len(layers)):
            layerGroup.defineHistogram(fullvarstring, 
                                        type=type, path=path, title=fulltitle,
                                        xbins=xbins[idx], xmin=xmins[idx], xmax=xmins[idx]+binsizes[idx]*xbins[idx])
 

define1DProfLumiLayers()

PixelAthMonitoringBase.define1DProfLumiLayers	(		helper,
			alg,
			name,
			title,
			path,
			yaxistext,
			type = 'TProfile',
			opt = '',
			histname = None,
			onlylayers = layers )

This function configures 1D (Profile) vs lumi histograms for Pixel layers.

Arguments:
     helper    -- AthMonitorCfgHelper(Old) instance
     alg       -- algorithm Configurable object returned from addAlgorithm
     name      -- Name of histogram (Name = name_layer)
     title     -- Title of histogram (Title = title +' '+layer)
     path      -- Path in ouput file for histogram
     yaxistext -- Text on the y-axis
     type      -- Type of histogram (TH1D, TProfile)
     opt       -- history depth of a histogram e.g. 'kLBNHistoryDepth=10' or 'kLive=100'
     histname  -- another way of naming the histogram(s), useful when multiple histograms are filled from exactly the same variables, but in a different way 
     onlylayers -- sublist of layers

Definition at line 401 of file PixelAthMonitoringBase.py.

def define1DProfLumiLayers(helper, alg, name, title, path, yaxistext, type='TProfile', opt='', histname=None, onlylayers=layers):
    '''
    This function configures 1D (Profile) vs lumi histograms for Pixel layers.
 
    Arguments:
         helper    -- AthMonitorCfgHelper(Old) instance
         alg       -- algorithm Configurable object returned from addAlgorithm
         name      -- Name of histogram (Name = name_layer)
         title     -- Title of histogram (Title = title +' '+layer)
         path      -- Path in ouput file for histogram
         yaxistext -- Text on the y-axis
         type      -- Type of histogram (TH1D, TProfile)
         opt       -- history depth of a histogram e.g. 'kLBNHistoryDepth=10' or 'kLive=100'
         histname  -- another way of naming the histogram(s), useful when multiple histograms are filled from exactly the same variables, but in a different way 
         onlylayers -- sublist of layers
    '''
    assert(set(onlylayers).issubset(layers))
    if histname is None:
        histname = name
    if "kLive" in opt:
        xbins = int(opt.split('=')[1])
    else:
        xbins = lumibinsx
    for layer in layers:
        if layer not in onlylayers: 
            continue
        fulltitle   = title + ', {0}'.format(layer) + runtext + lumitext + yaxistext
        fullvarstring = '{0}_{1}'.format(name,'lb')
        if 'Profile' in type: fullvarstring += ',{0}_{1}'.format(name, 'val')
        fullvarstring += ';' + histname + '_{0}'.format(layer)
        layerGroup = getLayerGroup(helper, alg, layer)
        layerGroup.defineHistogram(fullvarstring, 
                                    type=type, path=path, title=fulltitle,
                                    xbins=xbins, xmin=-0.5, xmax=-0.5+xbins, opt=opt)
 

define2DProfHist()

PixelAthMonitoringBase.define2DProfHist	(		helper,
			alg,
			name,
			title,
			path,
			type = 'TProfile2D',
			doWeight = False,
			lifecycle = 'run',
			zmin = None,
			zmax = None,
			opt = '',
			histname = None,
			onlylayers = baselayers )

This function configures 2D (Profile) histograms (or maps) for Pixel base (i.e. w/o split in 2D/3D in IBL) layers.

Arguments:
     helper     -- AthMonitorCfgHelper(Old) instance
     alg        -- algorithm - Configurable object returned from addAlgorithm
     name       -- Name of histogram (Name = name_layer)
     title      -- Title of histogram (Title = title +' '+layer)
     path       -- Path in output file for histogram
     type       -- Type of histogram (TH2D, TProfile2D)
     lifecycle  -- global life duration of histograms (run, lowStat [i.e. 20 LB], lumiblock) - APPLIES to MonGroup only
     zmin(zmax) -- fix the displayed range - simply chopping the range!!!
     opt        -- history depth of a histogram e.g. 'kLBNHistoryDepth=10'
     histname   -- another way of naming the histogram(s), useful when multiple histograms are filled from exactly the same variables, but in a different way
     onlylayers -- sublist of Pixel layers

Definition at line 281 of file PixelAthMonitoringBase.py.

def define2DProfHist(helper, alg, name, title, path, type='TProfile2D', doWeight=False, lifecycle='run', zmin=None, zmax=None, opt='', histname=None, onlylayers=baselayers):
    '''
    This function configures 2D (Profile) histograms (or maps) for Pixel base (i.e. w/o split in 2D/3D in IBL) layers.
 
    Arguments:
         helper     -- AthMonitorCfgHelper(Old) instance
         alg        -- algorithm - Configurable object returned from addAlgorithm
         name       -- Name of histogram (Name = name_layer)
         title      -- Title of histogram (Title = title +' '+layer)
         path       -- Path in output file for histogram
         type       -- Type of histogram (TH2D, TProfile2D)
         lifecycle  -- global life duration of histograms (run, lowStat [i.e. 20 LB], lumiblock) - APPLIES to MonGroup only
         zmin(zmax) -- fix the displayed range - simply chopping the range!!!
         opt        -- history depth of a histogram e.g. 'kLBNHistoryDepth=10'
         histname   -- another way of naming the histogram(s), useful when multiple histograms are filled from exactly the same variables, but in a different way
         onlylayers -- sublist of Pixel layers
    '''
    assert(set(onlylayers).issubset(baselayers))
    if histname is None:
        histname = name
    for i, layer in enumerate(baselayers):
        if layer not in onlylayers: 
            continue
        fulltitle   = title + ', {0}'.format(layer) + runtext + etatxt[i] + phitext
        layerGroup = getLayerGroup(helper, alg, layer)
 
        fullvarstring = '{0}_{1},{0}_{2}'.format(name, 'em', 'pm')
        weightvar = ''
        if 'Profile' in type: 
            fullvarstring += ',{0}_{1}'.format(name, 'val')
        elif doWeight:
            weightvar = '{0}_{1}'.format(name, 'val') # re-use the same variable for TH2 for now.
            
        fullvarstring += ';' + histname + '_{0}'.format(layer)
        layerGroup.defineHistogram(fullvarstring, 
                                    type=type, path=path, title=fulltitle, weight=weightvar,
                                    xbins=xbinsl[i], xmin=xminsl[i], xmax=xminsl[i]+xbinsl[i], 
                                    ybins=ybinsl[i], ymin=-0.5, ymax=-0.5+ybinsl[i],
                                    zmin=zmin, zmax=zmax,
                                    duration=lifecycle,
                                    opt=opt, xlabels=LabelX[i], ylabels=LabelY[i])
 

define2DProfPerFEHist()

PixelAthMonitoringBase.define2DProfPerFEHist	(		helper,
			alg,
			name,
			title,
			path,
			type = 'TProfile2D',
			doWeight = False,
			lifecycle = 'run',
			zmin = None,
			zmax = None,
			opt = '',
			histname = None,
			onlylayers = baselayers )

This function configures 2D (Profile) histograms (or maps) for Pixel base (i.e. w/o split in 2D/3D in IBL) layers per FE.

Arguments:
     helper     -- AthMonitorCfgHelper(Old) instance
     alg        -- algorithm - Configurable object returned from addAlgorithm
     name       -- Name of histogram (Name = name_layer)
     title      -- Title of histogram (Title = title +' '+layer)
     path       -- Path in output file for histogram
     type       -- Type of histogram (TH2D, TProfile2D)
     lifecycle  -- global life duration of histograms (run, lowStat [i.e. 20 LB], lumiblock) - APPLIES to MonGroup only
     zmin(zmax) -- fix the displayed range - simply chopping the range!!!
     opt        -- history depth of a histogram e.g. 'kLBNHistoryDepth=10'
     histname   -- another way of naming the histogram(s), useful when multiple histograms are filled from exactly the same variables, but in a different way
     onlylayers -- sublist of Pixel layers

Definition at line 323 of file PixelAthMonitoringBase.py.

def define2DProfPerFEHist(helper, alg, name, title, path, type='TProfile2D', doWeight=False, lifecycle='run', zmin=None, zmax=None, opt='', histname=None, onlylayers=baselayers):
    '''
    This function configures 2D (Profile) histograms (or maps) for Pixel base (i.e. w/o split in 2D/3D in IBL) layers per FE.
 
    Arguments:
         helper     -- AthMonitorCfgHelper(Old) instance
         alg        -- algorithm - Configurable object returned from addAlgorithm
         name       -- Name of histogram (Name = name_layer)
         title      -- Title of histogram (Title = title +' '+layer)
         path       -- Path in output file for histogram
         type       -- Type of histogram (TH2D, TProfile2D)
         lifecycle  -- global life duration of histograms (run, lowStat [i.e. 20 LB], lumiblock) - APPLIES to MonGroup only
         zmin(zmax) -- fix the displayed range - simply chopping the range!!!
         opt        -- history depth of a histogram e.g. 'kLBNHistoryDepth=10'
         histname   -- another way of naming the histogram(s), useful when multiple histograms are filled from exactly the same variables, but in a different way
         onlylayers -- sublist of Pixel layers
    '''
    assert(set(onlylayers).issubset(baselayers))
    if histname is None:
        histname = name
    for i, layer in enumerate(baselayers):
        if layer not in onlylayers: 
            continue
        fulltitle   = title + ', {0}'.format(layer) + runtext + etatxt[i] + phitext
        layerGroup = getLayerGroup(helper, alg, layer)
 
        fullvarstring = '{0}_{1},{0}_{2}'.format(name, 'em', 'pm')
        weightvar = ''
        if 'Profile' in type: 
            fullvarstring += ',{0}_{1}'.format(name, 'val')
        elif doWeight:
            weightvar = '{0}_{1}'.format(name, 'val') # re-use the same variable for TH2 for now.
            
        fullvarstring += ';' + histname + '_{0}'.format(layer)
        layerGroup.defineHistogram(fullvarstring, 
                                    type=type, path=path, title=fulltitle, weight=weightvar,
                                    xbins=xbinsfel[i], xmin=xminsfel[i], xmax=xminsfel[i]+xbinsfel[i], 
                                    ybins=ybinsfel[i], ymin=-0.5, ymax=-0.5+ybinsfel[i],
                                    zmin=zmin, zmax=zmax,
                                    duration=lifecycle,
                                    opt=opt, xlabels=LabelFEX[i], ylabels=LabelFEY[i])
 
 

defineMapVsLumiLayers()

PixelAthMonitoringBase.defineMapVsLumiLayers	(		helper,
			alg,
			name,
			title,
			path,
			xaxistext,
			yaxistext,
			ybins,
			ymins,
			binsizes = [1.0],
			ylabels = None,
			opt = '',
			type = 'TH2F',
			histname = None,
			onlylayers = layers )

This function configures 2D histograms vs lumi for Pixel base (i.e. w/o split in 2D/3D in IBL) layers.

Arguments:
     helper  -- AthMonitorCfgHelper(Old) instance
     alg     -- algorithm Configurable object returned from addAlgorithm
     name    -- Name of histogram (Name = name_layer)
     title   -- Title of histogram (Title = title +' '+layer)
     path    -- Path in ouput file for histogram
     ybins, ymin, ymax, yaxistext
             -- Configure Y-axis
     opt     -- history depth of a histogram e.g. 'kLBNHistoryDepth=10' or 'kLive=100'
     type    -- Type of histogram (TH2I, TH2F, TProfile2D)
     histname-- alternative root name of the histogram (to be filled with the same variables defined by 'name' above)
     onlylayers -- sublist of Pixel layers

Definition at line 436 of file PixelAthMonitoringBase.py.

def defineMapVsLumiLayers(helper, alg, name, title, path, xaxistext, yaxistext, ybins, ymins, binsizes=[1.0], ylabels=None, opt='', type='TH2F', histname=None, onlylayers=layers):
    '''
    This function configures 2D histograms vs lumi for Pixel base (i.e. w/o split in 2D/3D in IBL) layers.
 
    Arguments:
         helper  -- AthMonitorCfgHelper(Old) instance
         alg     -- algorithm Configurable object returned from addAlgorithm
         name    -- Name of histogram (Name = name_layer)
         title   -- Title of histogram (Title = title +' '+layer)
         path    -- Path in ouput file for histogram
         ybins, ymin, ymax, yaxistext
                 -- Configure Y-axis
         opt     -- history depth of a histogram e.g. 'kLBNHistoryDepth=10' or 'kLive=100'
         type    -- Type of histogram (TH2I, TH2F, TProfile2D)
         histname-- alternative root name of the histogram (to be filled with the same variables defined by 'name' above)
         onlylayers -- sublist of Pixel layers
    '''
    assert(set(onlylayers).issubset(layers))
    if histname is None:
        histname = name
    if "kLive" in opt:
        xbins = int(opt.split('=')[1])
    else:
        xbins = lumibinsx
    for idx,layer in enumerate(layers):
        if layer not in onlylayers: 
            continue
        fulltitle   = title + ', {0}'.format(layer) + runtext + lumitext + yaxistext
        layerGroup = getLayerGroup(helper, alg, layer)
        fullvarstring = '{0}_{1}'.format(name,'lb')
        if 'Profile' in type: fullvarstring += ',{0}_{1}'.format(name, 'cat')
        fullvarstring += ',{0}_{1}'.format(name, 'val')
        fullvarstring += ';' + histname  + '_{0}'.format(layer)
        if ( len(ybins)==1 and len(ymins)==1 and len(binsizes)==1):
            layerGroup.defineHistogram(fullvarstring, 
                                       type=type, path=path, title=fulltitle,
                                       xbins=xbins, xmin=-0.5, xmax=-0.5+xbins,
                                       ybins=ybins[0], ymin=ymins[0], ymax=ymins[0]+binsizes[0]*ybins[0], opt=opt)
        elif (len(ybins)==len(layers) and len(ymins)==len(layers) and len(binsizes)==len(layers) and len(ylabels)==len(layers)):
            layerGroup.defineHistogram(fullvarstring, 
                                       type=type, path=path, title=fulltitle,
                                       xbins=xbins, xmin=-0.5, xmax=-0.5+xbins,
                                       ybins=ybins[idx], ymin=ymins[idx], ymax=ymins[idx]+binsizes[idx]*ybins[idx], ylabels=ylabels[idx], opt=opt)
        elif (len(ybins)==len(layers) and len(ymins)==len(layers) and len(binsizes)==1 and ylabels is None):
            layerGroup.defineHistogram(fullvarstring, 
                                       type=type, path=path, title=fulltitle,
                                       xbins=xbins, xmin=-0.5, xmax=-0.5+xbins,
                                       ybins=ybins[idx], ymin=ymins[idx], ymax=ymins[idx]+ybins[idx], opt=opt)
 
 

definePP0Histos()

PixelAthMonitoringBase.definePP0Histos	(		helper,
			alg,
			name,
			title,
			path,
			opt = '' )

This function configures TProfile histograms for Pixel layers per pp0 or ROD.

Arguments:
     helper  -- AthMonitorCfgHelper(Old) instance
     alg     -- algorithm Configurable object returned from addAlgorithm
     name    -- Name of histogram (Name = name_layer)
     title   -- Title of histogram (Title = title +' '+layer)
     path    -- Path in ouput file for histogram
     opt     -- history depth of a histogram e.g. 'kLBNHistoryDepth=10'

Definition at line 366 of file PixelAthMonitoringBase.py.

def definePP0Histos(helper, alg, name, title, path, opt=''):
    '''
    This function configures TProfile histograms for Pixel layers per pp0 or ROD.
 
    Arguments:
         helper  -- AthMonitorCfgHelper(Old) instance
         alg     -- algorithm Configurable object returned from addAlgorithm
         name    -- Name of histogram (Name = name_layer)
         title   -- Title of histogram (Title = title +' '+layer)
         path    -- Path in ouput file for histogram
         opt     -- history depth of a histogram e.g. 'kLBNHistoryDepth=10'
    '''
 
    for i, layer in enumerate(pp0layers):
        if i<2:
            xatxt = ';sector'
        else :
            xatxt = ';stave'
        yatxt = ';average # clusters per event per '
        if i>4:
            yatxt += 'FE'
        else :
            yatxt += 'module'
        fulltitle   = title + ', {0}'.format(layer) + runtext + xatxt + yatxt
        groupname   = name  + '_{0}'.format(layer)
        layerGroup = getLayerGroup(helper, alg, layer)
        fullvarstring = '{0}_{1},{0}_{2}'.format(name, 'pospp0x', 'val')
        fullvarstring += ';' + groupname
        layerGroup.defineHistogram(fullvarstring, 
                                    type='TProfile', path=path, title=fulltitle,
                                    xbins=pp0xbins[i], xmin=-0.5, xmax=-0.5+pp0xbins[i],
                                    opt=opt, xlabels=PP0LabelX[i])
 
 
 

fullDressTitle()

PixelAthMonitoringBase.fullDressTitle	(		name,
			ontrack,
			xaxistext,
			yaxistext )

Definition at line 536 of file PixelAthMonitoringBase.py.

def fullDressTitle(name, ontrack, xaxistext, yaxistext):
    if ontrack:
        name += ' OnTrack'
    name += runtext + xaxistext + yaxistext
    return name

getLayerGroup()

PixelAthMonitoringBase.getLayerGroup	(		helper,
			alg,
			layer )

Definition at line 273 of file PixelAthMonitoringBase.py.

def getLayerGroup(helper, alg, layer):
    if alg not in layergroups:
        layergroups[alg] = {}
    if layer not in layergroups[alg]:
        layergroups[alg][layer] = helper.addGroup(alg, layer)
    return layergroups[alg][layer]