plotting.PlotFolder Class Reference

Inheritance diagram for plotting.PlotFolder:

Public Member Functions
def	__init__ (self, *plotGroups, **kwargs)
def	append (self, plotGroup)
def	create (self, dirsNEvents, labels, isPileupSample=True, requireAllHistograms=False)
def	draw (self, prefix=None, separate=False, saveFormat=".pdf", ratio=True, directory="")
def	getNumberOfEventsHistogram (self)
def	getPage (self)
def	getPlotGroup (self, name)
def	getPlotGroups (self)
def	getPurpose (self)
def	getSection (self)
def	iterSelectionName (self, plotFolderName, translatedDqmSubFolder)
def	limitSubFolder (self, limitOnlyTo, translatedDqmSubFolder)
def	loopSubFolders (self)
def	onlyForBHadron (self)
def	onlyForConversion (self)
def	onlyForElectron (self)
def	onlyForPileup (self)
def	set (self, plotGroups)
def	translateSubFolder (self, dqmSubFolderName)

Private Attributes
	_labels
	_loopSubFolders
	_numberOfEventsHistogram
	_onlyForBHadron
	_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 2543 of file plotting.py.

Constructor & Destructor Documentation

__init__()

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
onlyForBHadron -- Plots this folder only for B-hadron 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".

Reimplemented in trackingPlots.TrackingPlotFolder.

Definition at line 2546 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
        onlyForBHadron -- Plots this folder only for B-hadron 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._onlyForBHadron = kwargs.pop("onlyForBHadron", 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()))
 

Member Function Documentation

append()

def plotting.PlotFolder.append	(		self,
			plotGroup
	)

Definition at line 2605 of file plotting.py.

    def append(self, plotGroup):
        self._plotGroups.append(plotGroup)
 

References plotting.PlotFolder._plotGroups.

Referenced by diclist.diclist.add().

create()

def plotting.PlotFolder.create	(		self,
			dirsNEvents,
			labels,
			isPileupSample = True,
			requireAllHistograms = False
	)

Create histograms from a list of TFiles.

Arguments:
dirsNEvents   -- List of (TDirectory, nevents) pairs
labels -- List of strings for legend labels corresponding the files
isPileupSample -- Is sample pileup (some PlotGroups may limit themselves to pileup)
requireAllHistograms -- If True, a plot is produced if histograms from all files are present (default: False)

Definition at line 2620 of file plotting.py.

    def create(self, dirsNEvents, labels, isPileupSample=True, requireAllHistograms=False):
        """Create histograms from a list of TFiles.
 
        Arguments:
        dirsNEvents   -- List of (TDirectory, nevents) pairs
        labels -- List of strings for legend labels corresponding the files
        isPileupSample -- Is sample pileup (some PlotGroups may limit themselves to pileup)
        requireAllHistograms -- If True, a plot is produced if histograms from all files are present (default: False)
        """
 
        if len(dirsNEvents) != len(labels):
            raise Exception("len(dirsNEvents) should be len(labels), now they are %d and %d" % (len(dirsNEvents), len(labels)))
 
        self._labels = labels
 
        for pg in self._plotGroups:
            if pg.onlyForPileup() and not isPileupSample:
                continue
            pg.create(dirsNEvents, requireAllHistograms)
 

draw()

def plotting.PlotFolder.draw	(		self,
			prefix = None,
			separate = False,
			saveFormat = ".pdf",
			ratio = True,
			directory = ""
	)

Draw and save all plots using settings of a given algorithm.

Arguments:
prefix   -- Optional string for file name prefix (default None)
separate -- Save the plots of a group to separate files instead of a file per group (default False)
saveFormat   -- String specifying the plot format (default '.pdf')
ratio    -- Add ratio to the plot (default True)
directory -- Directory where to save the file (default "")

Definition at line 2640 of file plotting.py.

    def draw(self, prefix=None, separate=False, saveFormat=".pdf", ratio=True, directory=""):
        """Draw and save all plots using settings of a given algorithm.
 
        Arguments:
        prefix   -- Optional string for file name prefix (default None)
        separate -- Save the plots of a group to separate files instead of a file per group (default False)
        saveFormat   -- String specifying the plot format (default '.pdf')
        ratio    -- Add ratio to the plot (default True)
        directory -- Directory where to save the file (default "")
        """
        ret = []
 
        for pg in self._plotGroups:
            ret.extend(pg.draw(self._labels, prefix=prefix, separate=separate, saveFormat=saveFormat, ratio=ratio, directory=directory))
        return ret
 
 

References DigiInvestigatorHistogramMaker._labels, SeedMultiplicityAnalyzer._labels, hitfit::Constraint_Intermed_Labels._labels, plotting.PlotFolder._labels, and plotting.PlotFolder._plotGroups.

getNumberOfEventsHistogram()

def plotting.PlotFolder.getNumberOfEventsHistogram

(

self

)

Definition at line 2602 of file plotting.py.

    def getNumberOfEventsHistogram(self):
        return self._numberOfEventsHistogram
 

References plotting.PlotFolder._numberOfEventsHistogram.

getPage()

def plotting.PlotFolder.getPage

(

self

)

Definition at line 2596 of file plotting.py.

    def getPage(self):
        return self._page
 

References html.Table._page, and plotting.PlotFolder._page.

getPlotGroup()

def plotting.PlotFolder.getPlotGroup	(		self,
			name
	)

Definition at line 2614 of file plotting.py.

    def getPlotGroup(self, name):
        for pg in self._plotGroups:
            if pg.getName() == name:
                return pg
        raise Exception("No PlotGroup named '%s'" % name)
 

References plotting.PlotFolder._plotGroups.

getPlotGroups()

def plotting.PlotFolder.getPlotGroups

(

self

)

Definition at line 2611 of file plotting.py.

    def getPlotGroups(self):
        return self._plotGroups
 

References plotting.PlotFolder._plotGroups.

getPurpose()

def plotting.PlotFolder.getPurpose

(

self

)

Definition at line 2593 of file plotting.py.

    def getPurpose(self):
        return self._purpose
 

References html.Table._purpose, and plotting.PlotFolder._purpose.

getSection()

def plotting.PlotFolder.getSection

(

self

)

Definition at line 2599 of file plotting.py.

    def getSection(self):
        return self._section
 

References html.Table._section, and plotting.PlotFolder._section.

iterSelectionName()

def plotting.PlotFolder.iterSelectionName	(		self,
			plotFolderName,
			translatedDqmSubFolder
	)

Iterate over possible selections name (used in output directory name and legend) from the name of PlotterFolder, and a return value of translateSubFolder

Reimplemented in trackingPlots.TrackingPlotFolder.

Definition at line 2668 of file plotting.py.

    def iterSelectionName(self, plotFolderName, translatedDqmSubFolder):
        """Iterate over possible selections name (used in output directory name and legend) from the name of PlotterFolder, and a return value of translateSubFolder"""
        ret = ""
        if plotFolderName != "":
            ret += "_"+plotFolderName
        if translatedDqmSubFolder is not None:
            ret += "_"+translatedDqmSubFolder
        yield ret
 

limitSubFolder()

def plotting.PlotFolder.limitSubFolder	(		self,
			limitOnlyTo,
			translatedDqmSubFolder
	)

Return True if this subfolder should be processed

Arguments:
limitOnlyTo            -- List/set/similar containing the translatedDqmSubFolder
translatedDqmSubFolder -- Return value of translateSubFolder

Reimplemented in trackingPlots.TrackingPlotFolder.

Definition at line 2677 of file plotting.py.

    def limitSubFolder(self, limitOnlyTo, translatedDqmSubFolder):
        """Return True if this subfolder should be processed
 
        Arguments:
        limitOnlyTo            -- List/set/similar containing the translatedDqmSubFolder
        translatedDqmSubFolder -- Return value of translateSubFolder
        """
        return translatedDqmSubFolder in limitOnlyTo
 

loopSubFolders()

def plotting.PlotFolder.loopSubFolders

(

self

)

Return True if the PlotGroups of this folder should be applied to the all subfolders

Definition at line 2576 of file plotting.py.

    def loopSubFolders(self):
        """Return True if the PlotGroups of this folder should be applied to the all subfolders"""
        return self._loopSubFolders
 

References plotting.PlotFolder._loopSubFolders.

onlyForBHadron()

def plotting.PlotFolder.onlyForBHadron

(

self

)

Definition at line 2590 of file plotting.py.

    def onlyForBHadron(self):
        return self._onlyForBHadron
 

References plotting.PlotFolder._onlyForBHadron.

onlyForConversion()

def plotting.PlotFolder.onlyForConversion

(

self

)

Definition at line 2587 of file plotting.py.

    def onlyForConversion(self):
        return self._onlyForConversion
 

References plotting.PlotFolder._onlyForConversion.

onlyForElectron()

def plotting.PlotFolder.onlyForElectron

(

self

)

Definition at line 2584 of file plotting.py.

    def onlyForElectron(self):
        return self._onlyForElectron
 

References plotting.PlotFolder._onlyForElectron.

onlyForPileup()

def plotting.PlotFolder.onlyForPileup

(

self

)

Return True if the folder is intended only for pileup samples

Definition at line 2580 of file plotting.py.

    def onlyForPileup(self):
        """Return True if the folder is intended only for pileup samples"""
        return self._onlyForPileup
 

References plotting.PlotFolder._onlyForPileup.

set()

def plotting.PlotFolder.set	(		self,
			plotGroups
	)

Definition at line 2608 of file plotting.py.

    def set(self, plotGroups):
        self._plotGroups = plotGroups
 

References plotting.PlotFolder._plotGroups.

translateSubFolder()

def plotting.PlotFolder.translateSubFolder	(		self,
			dqmSubFolderName
	)

Method called to (possibly) translate a subfolder name to more 'readable' form

The implementation in this (base) class just returns the
argument. The idea is that a deriving class might want to do
something more complex (like trackingPlots.TrackingPlotFolder
does)

Reimplemented in trackingPlots.TrackingPlotFolder.

Definition at line 2658 of file plotting.py.

    def translateSubFolder(self, dqmSubFolderName):
        """Method called to (possibly) translate a subfolder name to more 'readable' form
 
        The implementation in this (base) class just returns the
        argument. The idea is that a deriving class might want to do
        something more complex (like trackingPlots.TrackingPlotFolder
        does)
        """
        return dqmSubFolderName
 

Member Data Documentation

_labels

plotting.PlotFolder._labels

private

Definition at line 2633 of file plotting.py.

Referenced by validation.SimpleValidation._doPlots(), and plotting.PlotFolder.draw().

_loopSubFolders

plotting.PlotFolder._loopSubFolders

private

Definition at line 2564 of file plotting.py.

Referenced by plotting.PlotFolder.loopSubFolders().

_numberOfEventsHistogram

plotting.PlotFolder._numberOfEventsHistogram

private

Definition at line 2572 of file plotting.py.

Referenced by plotting.PlotFolder.getNumberOfEventsHistogram().

_onlyForBHadron

plotting.PlotFolder._onlyForBHadron

private

Definition at line 2568 of file plotting.py.

Referenced by plotting.PlotFolder.onlyForBHadron().

_onlyForConversion

plotting.PlotFolder._onlyForConversion

private

Definition at line 2567 of file plotting.py.

Referenced by plotting.PlotFolder.onlyForConversion().

_onlyForElectron

plotting.PlotFolder._onlyForElectron

private

Definition at line 2566 of file plotting.py.

Referenced by plotting.PlotFolder.onlyForElectron().

_onlyForPileup

plotting.PlotFolder._onlyForPileup

private

Definition at line 2565 of file plotting.py.

Referenced by trackingPlots.TrackingSeedingLayerTable.onlyForPileup(), plotting.PlotGroup.onlyForPileup(), and plotting.PlotFolder.onlyForPileup().

_page

plotting.PlotFolder._page

private

Definition at line 2570 of file plotting.py.

Referenced by vertexPlots.VertexSummaryTable.getPage(), trackingPlots.TrackingSummaryTable.getPage(), trackingPlots.TrackingTimingTable.getPage(), and plotting.PlotFolder.getPage().

_plotGroups

plotting.PlotFolder._plotGroups

private

Definition at line 2563 of file plotting.py.

Referenced by plotting.PlotFolder.append(), plotting.PlotFolder.draw(), plotting.PlotFolder.getPlotGroup(), plotting.PlotFolder.getPlotGroups(), and plotting.PlotFolder.set().

_purpose

plotting.PlotFolder._purpose

private

Definition at line 2569 of file plotting.py.

Referenced by vertexPlots.VertexSummaryTable.getPurpose(), trackingPlots.TrackingSummaryTable.getPurpose(), trackingPlots.TrackingTimingTable.getPurpose(), and plotting.PlotFolder.getPurpose().

_section

plotting.PlotFolder._section

private

Definition at line 2571 of file plotting.py.

Referenced by trackingPlots.TrackingSummaryTable.getSection(), trackingPlots.TrackingTimingTable.getSection(), and plotting.PlotFolder.getSection().