plotting.PlotterFolder Class Reference

Public Member Functions
def	__init__ (self, name, possibleDqmFolders, dqmSubFolders, plotFolder, fallbackNames, fallbackDqmSubFolders, tableCreators)
def	create (self, files, labels, dqmSubFolder, isPileupSample=True, requireAllHistograms=False)
def	draw (self, *args, **kwargs)
def	getDQMSubFolders (self, limitOnlyTo=None)
def	getName (self)
def	getPage (self)
def	getPossibleDQMFolders (self)
def	getPurpose (self)
def	getSection (self)
def	getSelectionName (self, dqmSubFolder)
def	getSelectionNameIterator (self, dqmSubFolder)
def	getTableCreators (self)
def	onlyForBHadron (self)
def	onlyForConversion (self)
def	onlyForElectron (self)
def	onlyForPileup (self)

Private Attributes
	_dqmSubFolders
	_fallbackDqmSubFolders
	_fallbackNames
	_name
	_plotFolder
	_possibleDqmFolders
	_tableCreators

Detailed Description

Plotter for one DQM folder.

This class is supposed to be instantiated by the Plotter class (or
PlotterItem, to be more specific), and not used directly by the
user.

Definition at line 2698 of file plotting.py.

Constructor & Destructor Documentation

__init__()

def plotting.PlotterFolder.__init__	(		self,
			name,
			possibleDqmFolders,
			dqmSubFolders,
			plotFolder,
			fallbackNames,
			fallbackDqmSubFolders,
			tableCreators
	)

Constructor

Arguments:
name               -- Name of the folder (is used in the output directory naming)
possibleDqmFolders -- List of strings for possible directories of histograms in TFiles
dqmSubFolders      -- List of lists of strings for list of subfolders per input file, or None if no subfolders
plotFolder         -- PlotFolder object
fallbackNames      -- List of names for backward compatibility (can be empty). These are used only by validation.Validation (class responsible of the release validation workflow) in case the reference file pointed by 'name' does not exist.
fallbackDqmSubFolders -- List of dicts of (string->string) for mapping the subfolder names found in the first file to another names. Use case is comparing files that have different iteration naming convention.
tableCreators      -- List of PlotterTableItem objects for tables to be created from this folder

Definition at line 2705 of file plotting.py.

    def __init__(self, name, possibleDqmFolders, dqmSubFolders, plotFolder, fallbackNames, fallbackDqmSubFolders, tableCreators):
        """
        Constructor
 
        Arguments:
        name               -- Name of the folder (is used in the output directory naming)
        possibleDqmFolders -- List of strings for possible directories of histograms in TFiles
        dqmSubFolders      -- List of lists of strings for list of subfolders per input file, or None if no subfolders
        plotFolder         -- PlotFolder object
        fallbackNames      -- List of names for backward compatibility (can be empty). These are used only by validation.Validation (class responsible of the release validation workflow) in case the reference file pointed by 'name' does not exist.
        fallbackDqmSubFolders -- List of dicts of (string->string) for mapping the subfolder names found in the first file to another names. Use case is comparing files that have different iteration naming convention.
        tableCreators      -- List of PlotterTableItem objects for tables to be created from this folder
        """
        self._name = name
        self._possibleDqmFolders = possibleDqmFolders
        self._plotFolder = plotFolder
        #self._dqmSubFolders = [map(lambda sf: DQMSubFolder(sf, self._plotFolder.translateSubFolder(sf)), lst) for lst in dqmSubFolders]
        if dqmSubFolders is None:
            self._dqmSubFolders = None
        else:
            # Match the subfolders between files in case the lists differ
            # equality is by the 'translated' name
            subfolders = {}
            for sf_list in dqmSubFolders:
                for sf in sf_list:
                    sf_translated = self._plotFolder.translateSubFolder(sf)
                    if sf_translated is not None and not sf_translated in subfolders:
                        subfolders[sf_translated] = DQMSubFolder(sf, sf_translated)
 
            self._dqmSubFolders = subfolders.values()
            self._dqmSubFolders.sort(key=lambda sf: sf.subfolder)
 
        self._fallbackNames = fallbackNames
        self._fallbackDqmSubFolders = fallbackDqmSubFolders
        self._tableCreators = tableCreators
 

Member Function Documentation

create()

def plotting.PlotterFolder.create	(		self,
			files,
			labels,
			dqmSubFolder,
			isPileupSample = True,
			requireAllHistograms = False
	)

Create histograms from a list of TFiles.
Arguments:
files  -- List of TFiles
labels -- List of strings for legend labels corresponding the files
dqmSubFolder -- DQMSubFolder object for a subfolder (or None for no subfolder)
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 2795 of file plotting.py.

    def create(self, files, labels, dqmSubFolder, isPileupSample=True, requireAllHistograms=False):
        """Create histograms from a list of TFiles.
        Arguments:
        files  -- List of TFiles
        labels -- List of strings for legend labels corresponding the files
        dqmSubFolder -- DQMSubFolder object for a subfolder (or None for no subfolder)
        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)
        """
 
        subfolder = dqmSubFolder.subfolder if dqmSubFolder is not None else None
        neventsHisto = self._plotFolder.getNumberOfEventsHistogram()
        dirsNEvents = []
 
        for tfile in files:
            ret = _getDirectoryDetailed(tfile, self._possibleDqmFolders, subfolder)
            # If file and any of possibleDqmFolders exist but subfolder does not, try the fallbacks
            if ret is GetDirectoryCode.SubDirNotExist:
                for fallbackFunc in self._fallbackDqmSubFolders:
                    fallback = fallbackFunc(subfolder)
                    if fallback is not None:
                        ret = _getDirectoryDetailed(tfile, self._possibleDqmFolders, fallback)
                        if ret is not GetDirectoryCode.SubDirNotExist:
                            break
            d = GetDirectoryCode.codesToNone(ret)
            nev = None
            if neventsHisto is not None and tfile is not None:
                hnev = _getObject(tfile, neventsHisto)
                if hnev is not None:
                    nev = hnev.GetEntries()
            dirsNEvents.append( (d, nev) )
 
        self._plotFolder.create(dirsNEvents, labels, isPileupSample, requireAllHistograms)
 

References plotting.PlotterFolder._fallbackDqmSubFolders, plotting._getDirectoryDetailed(), plotting._getObject(), plotting.PlotterFolder._plotFolder, and plotting.PlotterFolder._possibleDqmFolders.

draw()

def plotting.PlotterFolder.draw	(		self,
		*	args,
		**	kwargs
	)

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

Definition at line 2829 of file plotting.py.

    def draw(self, *args, **kwargs):
        """Draw and save all plots using settings of a given algorithm."""
        return self._plotFolder.draw(*args, **kwargs)
 
 

References plotting.PlotterFolder._plotFolder.

getDQMSubFolders()

def plotting.PlotterFolder.getDQMSubFolders	(		self,
			limitOnlyTo = None
	)

Get list of subfolders, possibly limiting to some of them.

Keyword arguments:
limitOnlyTo -- Object depending on the PlotFolder type for limiting the set of subfolders to be processed

Definition at line 2768 of file plotting.py.

    def getDQMSubFolders(self, limitOnlyTo=None):
        """Get list of subfolders, possibly limiting to some of them.
 
        Keyword arguments:
        limitOnlyTo -- Object depending on the PlotFolder type for limiting the set of subfolders to be processed
        """
 
        if self._dqmSubFolders is None:
            return [None]
 
        if limitOnlyTo is None:
            return self._dqmSubFolders
 
        return [s for s in self._dqmSubFolders if self._plotFolder.limitSubFolder(limitOnlyTo, s.translated)]
 

References plotting.PlotterFolder._dqmSubFolders, and plotting.PlotterFolder._plotFolder.

getName()

def plotting.PlotterFolder.getName

(

self

)

Definition at line 2741 of file plotting.py.

    def getName(self):
        return self._name
 

References FP420HitsObject._name, TrackerHitsObject._name, PGeometricDet::Item._name, TrackingRecHitAlgorithm._name, Logger._name, hcaldqm::DQModule._name, citk::IsolationConeDefinitionBase._name, DrellYanValidation._name, WValidation._name, hcaldqm::flag::Flag._name, hcaldqm::quantity::Quantity._name, HistoParams< T >._name, CutApplicatorBase._name, HistoParams< TH2F >._name, HistoParams< TProfile2D >._name, SequenceTypes.SequencePlaceholder._name, plotting.Subtract._name, plotting.Transform._name, plotting.FakeDuplicate._name, plotting.CutEfficiency._name, plotting.AggregateBins._name, plotting.AggregateHistos._name, plotting.ROC._name, SequenceTypes.TaskPlaceholder._name, plotting.Plot._name, plotting.PlotGroup._name, and plotting.PlotterFolder._name.

getPage()

def plotting.PlotterFolder.getPage

(

self

)

Definition at line 2747 of file plotting.py.

    def getPage(self):
        return self._plotFolder.getPage()
 

References plotting.PlotterFolder._plotFolder.

getPossibleDQMFolders()

def plotting.PlotterFolder.getPossibleDQMFolders

(

self

)

Definition at line 2765 of file plotting.py.

    def getPossibleDQMFolders(self):
        return self._possibleDqmFolders
 

References plotting.PlotterFolder._possibleDqmFolders.

getPurpose()

def plotting.PlotterFolder.getPurpose

(

self

)

Definition at line 2744 of file plotting.py.

    def getPurpose(self):
        return self._plotFolder.getPurpose()
 

References plotting.PlotterFolder._plotFolder.

getSection()

def plotting.PlotterFolder.getSection

(

self

)

Definition at line 2750 of file plotting.py.

    def getSection(self):
        return self._plotFolder.getSection()
 

References plotting.PlotterFolder._plotFolder.

getSelectionName()

def plotting.PlotterFolder.getSelectionName	(		self,
			dqmSubFolder
	)

Definition at line 2792 of file plotting.py.

    def getSelectionName(self, dqmSubFolder):
        return next(self.getSelectionNameIterator(dqmSubFolder))
 

References plotting.PlotterFolder.getSelectionNameIterator(), and GetRecoTauVFromDQM_MC_cff.next.

getSelectionNameIterator()

def plotting.PlotterFolder.getSelectionNameIterator	(		self,
			dqmSubFolder
	)

Get a generator for the 'selection name', looping over the name and fallbackNames

Definition at line 2786 of file plotting.py.

    def getSelectionNameIterator(self, dqmSubFolder):
        """Get a generator for the 'selection name', looping over the name and fallbackNames"""
        for name in [self._name]+self._fallbackNames:
            for selname in self._plotFolder.iterSelectionName(name, dqmSubFolder.translated if dqmSubFolder is not None else None):
                yield selname
 

References plotting.PlotterFolder._fallbackNames, FP420HitsObject._name, TrackerHitsObject._name, PGeometricDet::Item._name, TrackingRecHitAlgorithm._name, Logger._name, hcaldqm::DQModule._name, citk::IsolationConeDefinitionBase._name, DrellYanValidation._name, WValidation._name, hcaldqm::flag::Flag._name, hcaldqm::quantity::Quantity._name, HistoParams< T >._name, CutApplicatorBase._name, HistoParams< TH2F >._name, HistoParams< TProfile2D >._name, SequenceTypes.SequencePlaceholder._name, plotting.Subtract._name, plotting.Transform._name, plotting.FakeDuplicate._name, plotting.CutEfficiency._name, plotting.AggregateBins._name, plotting.AggregateHistos._name, plotting.ROC._name, SequenceTypes.TaskPlaceholder._name, plotting.Plot._name, plotting.PlotGroup._name, plotting.PlotterFolder._name, and plotting.PlotterFolder._plotFolder.

Referenced by plotting.PlotterFolder.getSelectionName().

getTableCreators()

def plotting.PlotterFolder.getTableCreators

(

self

)

Definition at line 2783 of file plotting.py.

    def getTableCreators(self):
        return self._tableCreators
 

References plotting.PlotterFolder._tableCreators.

onlyForBHadron()

def plotting.PlotterFolder.onlyForBHadron

(

self

)

Definition at line 2762 of file plotting.py.

    def onlyForBHadron(self):
        return self._plotFolder.onlyForBHadron()
 

References plotting.PlotterFolder._plotFolder.

onlyForConversion()

def plotting.PlotterFolder.onlyForConversion

(

self

)

Definition at line 2759 of file plotting.py.

    def onlyForConversion(self):
        return self._plotFolder.onlyForConversion()
 

References plotting.PlotterFolder._plotFolder.

onlyForElectron()

def plotting.PlotterFolder.onlyForElectron

(

self

)

Definition at line 2756 of file plotting.py.

    def onlyForElectron(self):
        return self._plotFolder.onlyForElectron()
 

References plotting.PlotterFolder._plotFolder.

onlyForPileup()

def plotting.PlotterFolder.onlyForPileup

(

self

)

Definition at line 2753 of file plotting.py.

    def onlyForPileup(self):
        return self._plotFolder.onlyForPileup()
 

References plotting.PlotterFolder._plotFolder.

Member Data Documentation

_dqmSubFolders

plotting.PlotterFolder._dqmSubFolders

private

Definition at line 2723 of file plotting.py.

Referenced by plotting.PlotterFolder.getDQMSubFolders().

_fallbackDqmSubFolders

plotting.PlotterFolder._fallbackDqmSubFolders

private

Definition at line 2738 of file plotting.py.

Referenced by plotting.PlotterFolder.create(), and plotting.PlotterItem.readDirs().

_fallbackNames

plotting.PlotterFolder._fallbackNames

private

Definition at line 2737 of file plotting.py.

Referenced by plotting.PlotterFolder.getSelectionNameIterator(), and plotting.PlotterItem.readDirs().

_name

plotting.PlotterFolder._name

private

Definition at line 2718 of file plotting.py.

Referenced by trackingPlots.TimePerEventPlot.__str__(), trackingPlots.TimePerTrackPlot.__str__(), trackingPlots.TimePerEventPlot._create(), trackingPlots.TimePerTrackPlot.create(), plotting.PlotterFolder.getName(), plotting.PlotterItem.getName(), plotting.PlotterFolder.getSelectionNameIterator(), validation.SimpleSample.name(), trackingPlots.Iteration.name(), and plotting.PlotterItem.readDirs().

_plotFolder

plotting.PlotterFolder._plotFolder

private

Definition at line 2720 of file plotting.py.

Referenced by plotting.PlotterFolder.create(), plotting.PlotterFolder.draw(), plotting.PlotterFolder.getDQMSubFolders(), plotting.PlotterFolder.getPage(), plotting.PlotterItem.getPlotFolder(), plotting.PlotterFolder.getPurpose(), plotting.PlotterFolder.getSection(), plotting.PlotterFolder.getSelectionNameIterator(), plotting.PlotterFolder.onlyForBHadron(), plotting.PlotterFolder.onlyForConversion(), plotting.PlotterFolder.onlyForElectron(), plotting.PlotterFolder.onlyForPileup(), and plotting.PlotterItem.readDirs().

_possibleDqmFolders

plotting.PlotterFolder._possibleDqmFolders

private

Definition at line 2719 of file plotting.py.

Referenced by plotting.PlotterFolder.create(), and plotting.PlotterFolder.getPossibleDQMFolders().

_tableCreators

plotting.PlotterFolder._tableCreators

private

Definition at line 2739 of file plotting.py.

Referenced by plotting.PlotterItem.appendTableCreator(), plotting.PlotterFolder.getTableCreators(), and plotting.PlotterItem.readDirs().