plotting.PlotFolder Class Reference

Inheritance diagram for plotting.PlotFolder:

Public Member Functions
def	__init__
def	append
def	create
def	draw
def	getNumberOfEventsHistogram
def	getPage
def	getPlotGroup
def	getPlotGroups
def	getPurpose
def	getSection
def	iterSelectionName
def	limitSubFolder
def	loopSubFolders
def	onlyForConversion
def	onlyForElectron
def	onlyForPileup
def	set
def	translateSubFolder

Private Attributes
	_labels
	_loopSubFolders
	_numberOfEventsHistogram
	_onlyForConversion
	_onlyForElectron
	_onlyForPileup
	_page
	_plotGroups
	_purpose
	_section

Detailed Description

Represents a collection of PlotGroups, produced from a single folder in a DQM file

Definition at line 2359 of file plotting.py.

Constructor & Destructor Documentation

def plotting.PlotFolder.__init__	(		self,
			plotGroups,
			kwargs
	)

Constructor.

Arguments:
plotGroups     -- List of PlotGroup objects

Keyword arguments
loopSubFolders -- Should the subfolders be looped over? (default: True)
onlyForPileup  -- Plots this folder only for pileup samples
onlyForElectron -- Plots this folder only for electron samples
onlyForConversion -- Plots this folder only for conversion samples
purpose        -- html.PlotPurpose member class for the purpose of the folder, used for grouping of the plots to the HTML pages
page           -- Optional string for the page in HTML generatin
section        -- Optional string for the section within a page in HTML generation
numberOfEventsHistogram -- Optional path to histogram filled once per event. Needed if there are any plots normalized by number of events. Path is relative to "possibleDqmFolders".

Definition at line 2361 of file plotting.py.

    def __init__(self, *plotGroups, **kwargs):
        """Constructor.

        Arguments:
        plotGroups     -- List of PlotGroup objects

        Keyword arguments
        loopSubFolders -- Should the subfolders be looped over? (default: True)
        onlyForPileup  -- Plots this folder only for pileup samples
        onlyForElectron -- Plots this folder only for electron samples
        onlyForConversion -- Plots this folder only for conversion samples
        purpose        -- html.PlotPurpose member class for the purpose of the folder, used for grouping of the plots to the HTML pages
        page           -- Optional string for the page in HTML generatin
        section        -- Optional string for the section within a page in HTML generation
        numberOfEventsHistogram -- Optional path to histogram filled once per event. Needed if there are any plots normalized by number of events. Path is relative to "possibleDqmFolders".
        """
        self._plotGroups = list(plotGroups)
        self._loopSubFolders = kwargs.pop("loopSubFolders", True)
        self._onlyForPileup = kwargs.pop("onlyForPileup", False)
        self._onlyForElectron = kwargs.pop("onlyForElectron", False)
        self._onlyForConversion = kwargs.pop("onlyForConversion", False)
        self._purpose = kwargs.pop("purpose", None)
        self._page = kwargs.pop("page", None)
        self._section = kwargs.pop("section", None)
        self._numberOfEventsHistogram = kwargs.pop("numberOfEventsHistogram", None)
        if len(kwargs) > 0:
            raise Exception("Got unexpected keyword arguments: "+ ",".join(kwargs.keys()))