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 2689 of file plotting.py.

Constructor & Destructor Documentation

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 2696 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

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 2786 of file plotting.py.

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

     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)
 

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

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

Definition at line 2820 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)
 
 

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 2759 of file plotting.py.

References plotting.PlotterFolder._dqmSubFolders.

     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)]
 

def plotting.PlotterFolder.getName ( self )

Definition at line 2732 of file plotting.py.

References FP420HitsObject._name, TrackerHitsObject._name, PGeometricDet::Item._name, LikelihoodSpecies._name, TrackingRecHitAlgorithm._name, LikelihoodPdfProduct._name, LikelihoodPdf._name, citk::IsolationConeDefinitionBase._name, Logger._name, hcaldqm::DQModule._name, DrellYanValidation._name, WValidation._name, HistoParams< T >._name, hcaldqm::flag::Flag._name, hcaldqm::quantity::Quantity._name, GeometricTimingDetExtra._name, CutApplicatorBase._name, GeometricDetExtra._name, HistoParams< TH2F >._name, HistoParams< TProfile2D >._name, Vispa.Views.PropertyView.Property._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.

     def getName(self):
         return self._name
 

def plotting.PlotterFolder.getPage ( self )

Definition at line 2738 of file plotting.py.

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

def plotting.PlotterFolder.getPossibleDQMFolders ( self )

Definition at line 2756 of file plotting.py.

References plotting.PlotterFolder._possibleDqmFolders.

     def getPossibleDQMFolders(self):
         return self._possibleDqmFolders
 

def plotting.PlotterFolder.getPurpose ( self )

Definition at line 2735 of file plotting.py.

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

def plotting.PlotterFolder.getSection ( self )

Definition at line 2741 of file plotting.py.

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

def plotting.PlotterFolder.getSelectionName	(	self,
		dqmSubFolder
	)

Definition at line 2783 of file plotting.py.

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

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

def plotting.PlotterFolder.getSelectionNameIterator	(	self,
		dqmSubFolder
	)

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

Definition at line 2777 of file plotting.py.

References plotting.PlotterFolder._fallbackNames, FP420HitsObject._name, TrackerHitsObject._name, PGeometricDet::Item._name, LikelihoodSpecies._name, TrackingRecHitAlgorithm._name, LikelihoodPdfProduct._name, LikelihoodPdf._name, citk::IsolationConeDefinitionBase._name, Logger._name, hcaldqm::DQModule._name, DrellYanValidation._name, WValidation._name, HistoParams< T >._name, hcaldqm::flag::Flag._name, hcaldqm::quantity::Quantity._name, GeometricTimingDetExtra._name, CutApplicatorBase._name, GeometricDetExtra._name, HistoParams< TH2F >._name, HistoParams< TProfile2D >._name, Vispa.Views.PropertyView.Property._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.

Referenced by plotting.PlotterFolder.getSelectionName().

     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
 

def plotting.PlotterFolder.getTableCreators ( self )

Definition at line 2774 of file plotting.py.

References plotting.PlotterFolder._tableCreators.

     def getTableCreators(self):
         return self._tableCreators
 

def plotting.PlotterFolder.onlyForBHadron ( self )

Definition at line 2753 of file plotting.py.

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

def plotting.PlotterFolder.onlyForConversion ( self )

Definition at line 2750 of file plotting.py.

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

def plotting.PlotterFolder.onlyForElectron ( self )

Definition at line 2747 of file plotting.py.

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

def plotting.PlotterFolder.onlyForPileup ( self )

Definition at line 2744 of file plotting.py.

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

Member Data Documentation

plotting.PlotterFolder._dqmSubFolders

private

Definition at line 2714 of file plotting.py.

Referenced by plotting.PlotterFolder.getDQMSubFolders().

plotting.PlotterFolder._fallbackDqmSubFolders

private

Definition at line 2729 of file plotting.py.

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

plotting.PlotterFolder._fallbackNames

private

Definition at line 2728 of file plotting.py.

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

plotting.PlotterFolder._name

private

Definition at line 2709 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().

plotting.PlotterFolder._plotFolder

private

Definition at line 2711 of file plotting.py.

Referenced by plotting.PlotterItem.getPlotFolder(), and plotting.PlotterItem.readDirs().

plotting.PlotterFolder._possibleDqmFolders

private

Definition at line 2710 of file plotting.py.

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

plotting.PlotterFolder._tableCreators

private

Definition at line 2730 of file plotting.py.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation