Public Member Functions
def	__init__ (self, name, possibleDirs, plotFolder, fallbackNames=[], fallbackDqmSubFolders=[])

def	appendTableCreator (self, tc)

def	getName (self)

def	getPlotFolder (self)

def	readDirs (self, files)

Private Attributes
	_fallbackDqmSubFolders

	_fallbackNames

	_name

	_plotFolder

	_possibleDirs

	_tableCreators

Detailed Description

Definition at line 2849 of file plotting.py.

Constructor & Destructor Documentation

◆ init()

def plotting.PlotterItem.__init__	(	self,
		name,
		possibleDirs,
		plotFolder,
		fallbackNames = `[]`,
		fallbackDqmSubFolders = `[]`
	)

Constructor

Arguments:
name          -- Name of the folder (is used in the output directory naming)
possibleDirs  -- List of strings for possible directories of histograms in TFiles
plotFolder    -- PlotFolder object

Keyword arguments
fallbackNames -- Optional list of names for backward compatibility. 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 -- Optional list of functions for (string->string) mapping the subfolder names found in the first file to another names (function should return None for no mapping). Use case is comparing files that have different iteration naming convention.

Definition at line 2850 of file plotting.py.

     def __init__(self, name, possibleDirs, plotFolder, fallbackNames=[], fallbackDqmSubFolders=[]):
         """ Constructor
  
         Arguments:
         name          -- Name of the folder (is used in the output directory naming)
         possibleDirs  -- List of strings for possible directories of histograms in TFiles
         plotFolder    -- PlotFolder object
  
         Keyword arguments
         fallbackNames -- Optional list of names for backward compatibility. 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 -- Optional list of functions for (string->string) mapping the subfolder names found in the first file to another names (function should return None for no mapping). Use case is comparing files that have different iteration naming convention.
         """
         self._name = name
         self._possibleDirs = possibleDirs
         self._plotFolder = plotFolder
         self._fallbackNames = fallbackNames
         self._fallbackDqmSubFolders = fallbackDqmSubFolders
         self._tableCreators = []
  

Member Function Documentation

◆ appendTableCreator()

def plotting.PlotterItem.appendTableCreator	(	self,
		tc
	)

Definition at line 2875 of file plotting.py.

     def appendTableCreator(self, tc):
         self._tableCreators.append(tc)
  

References plotting.PlotterFolder._tableCreators, plotting.PlotterItem._tableCreators, and mps_setup.append.

◆ getName()

def plotting.PlotterItem.getName ( self )

Definition at line 2869 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, plotting.PlotterFolder._name, and plotting.PlotterItem._name.

◆ getPlotFolder()

def plotting.PlotterItem.getPlotFolder ( self )

Definition at line 2872 of file plotting.py.

     def getPlotFolder(self):
         return self._plotFolder
  

References plotting.PlotterFolder._plotFolder, and plotting.PlotterItem._plotFolder.

◆ readDirs()

def plotting.PlotterItem.readDirs	(	self,
		files
	)

Read available subfolders from the files

Arguments:
files -- List of strings for paths to files, or list of TFiles

For each file, loop over 'possibleDirs', and read the
subfolders of first one that exists.

Returns a PlotterFolder if at least one file for which one of
'possibleDirs' exists. Otherwise, return None to signal that
there is nothing available for this PlotFolder.

Definition at line 2878 of file plotting.py.

     def readDirs(self, files):
         """Read available subfolders from the files
  
         Arguments:
         files -- List of strings for paths to files, or list of TFiles
  
         For each file, loop over 'possibleDirs', and read the
         subfolders of first one that exists.
  
         Returns a PlotterFolder if at least one file for which one of
         'possibleDirs' exists. Otherwise, return None to signal that
         there is nothing available for this PlotFolder.
         """
         subFolders = None
         if self._plotFolder.loopSubFolders():
             subFolders = []
         possibleDirFound = False
         for fname in files:
             if fname is None:
                 continue
  
             isOpenFile = isinstance(fname, ROOT.TFile)
             if isOpenFile:
                 tfile = fname
             else:
                 tfile = ROOT.TFile.Open(fname)
             for pd in self._possibleDirs:
                 d = tfile.Get(pd)
                 if d:
                     possibleDirFound = True
                     if subFolders is not None:
                         subf = []
                         for key in d.GetListOfKeys():
                             if isinstance(key.ReadObj(), ROOT.TDirectory):
                                 subf.append(key.GetName())
                         subFolders.append(subf)
                     break
  
             if not isOpenFile:
                 tfile.Close()
  
         if not possibleDirFound:
             return None
  
         return PlotterFolder(self._name, self._possibleDirs, subFolders, self._plotFolder, self._fallbackNames, self._fallbackDqmSubFolders, self._tableCreators)
  